user/wxLayout/wxlwindow.h

   1 /*-*- c++ -*-********************************************************
   2  * wxLwindow.h : a scrolled Window for displaying/entering rich text*
   3  *                                                                  *
   4  * (C) 1998,1999 by Karsten Ballüder (Ballueder@usa.net)            *
   5  *                                                                  *
   6  * $Id$
   7  *******************************************************************/
   8 #ifndef WXLWINDOW_H
   9 #define WXLWINDOW_H
  10
  11 #ifdef __GNUG__
  12 #   pragma interface "wxlwindow.h"
  13 #endif
  14
  15 #ifndef USE_PCH
  16 #  include   <wx/wx.h>
  17 #endif
  18
  19 #include   "wxllist.h"
  20
  21 #ifndef WXLOWIN_MENU_FIRST
  22 #   define WXLOWIN_MENU_FIRST 12000
  23 #endif
  24
  25 enum
  26 {
  27    WXLOWIN_MENU_LARGER = WXLOWIN_MENU_FIRST,
  28    WXLOWIN_MENU_SMALLER,
  29    WXLOWIN_MENU_UNDERLINE_ON,
  30    WXLOWIN_MENU_UNDERLINE_OFF,
  31    WXLOWIN_MENU_BOLD_ON,
  32    WXLOWIN_MENU_BOLD_OFF,
  33    WXLOWIN_MENU_ITALICS_ON,
  34    WXLOWIN_MENU_ITALICS_OFF,
  35    WXLOWIN_MENU_ROMAN,
  36    WXLOWIN_MENU_TYPEWRITER,
  37    WXLOWIN_MENU_SANSSERIF,
  38    WXLOWIN_MENU_RCLICK,
  39    WXLOWIN_MENU_LCLICK,
  40    WXLOWIN_MENU_DBLCLICK,
  41    WXLOWIN_MENU_LAST = WXLOWIN_MENU_DBLCLICK
  42 };
  43
  44 /**
  45    This class is a rich text editing widget.
  46 */
  47 class wxLayoutWindow : public wxScrolledWindow
  48 {
  49 public:
  50    /** Constructor.
  51        @param parent parent window to display this panel in
  52    */
  53    wxLayoutWindow(wxWindow *parent);
  54
  55    /// Destructor.
  56    virtual ~wxLayoutWindow();
  57
  58    /**@name Editing functionality */
  59    //@{
  60    /// Clears the window and sets default parameters.
  61    void Clear(int family = wxROMAN,
  62               int size=12,
  63               int style=wxNORMAL,
  64               int weight=wxNORMAL,
  65               int underline=0,
  66               char const *fg="black",
  67               char const *bg="white")
  68       {
  69          GetLayoutList()->Clear(family,size,style,weight,underline,fg,bg);
  70          SetBackgroundColour(*GetLayoutList()->GetDefaults()->GetBGColour());
  71          SetDirty();
  72          DoPaint();
  73       }
  74
  75    /// Enable or disable editing, i.e. processing of keystrokes.
  76    void SetEditable(bool toggle) { m_Editable = toggle; }
  77    /// Query whether list can be edited by user.
  78    bool IsEditable(void) const { return m_Editable; }
  79
  80    //@}
  81
  82    void EnablePopup(bool enable = true) { m_DoPopupMenu = enable; }
  83
  84    /** Redraws the window.
  85        @param scrollToCursor if true, scroll the window so that the
  86        cursor becomes visible
  87    */
  88    void DoPaint(bool scrollToCursor = false);
  89
  90 #ifdef __WXMSW__
  91    virtual long MSWGetDlgCode();
  92 #endif //MSW
  93
  94    /// if exact == false, assume 50% extra size for the future
  95    void ResizeScrollbars(bool exact = false);  // don't change this to true!
  96
  97    /// if the flag is true, we send events when user clicks on embedded objects
  98    inline void SetMouseTracking(bool doIt = true) { m_doSendEvents = doIt; }
  99
 100    /* Returns a pointer to the wxLayoutList object.
 101       @return the list
 102    */
 103    wxLayoutList * GetLayoutList(void) { return m_llist; }
 104
 105    /**@name Callbacks */
 106    //@{
 107    void OnPaint(wxPaintEvent &event);
 108    void OnChar(wxKeyEvent& event);
 109    void OnMenu(wxCommandEvent& event);
 110    void OnLeftMouseClick(wxMouseEvent& event)  { OnMouse(WXLOWIN_MENU_LCLICK, event); }
 111    void OnRightMouseClick(wxMouseEvent& event) { OnMouse(WXLOWIN_MENU_RCLICK, event); }
 112    void OnMouseDblClick(wxMouseEvent& event)   { OnMouse(WXLOWIN_MENU_DBLCLICK, event); }
 113    void OnSetFocus(wxFocusEvent &ev);
 114    void OnKillFocus(wxFocusEvent &ev);
 115    //@}
 116
 117    /// Creates a wxMenu for use as a format popup.
 118    static wxMenu * MakeFormatMenu(void);
 119    /// Set dirty flag.
 120    void SetDirty(void) { m_Dirty = true; }
 121 protected:
 122    /**@name Dirty flag handling for optimisations. */
 123    //@{
 124    /// Query whether window needs redrawing.
 125    bool IsDirty(void) const { return m_Dirty; }
 126    /// Reset dirty flag.
 127    void ResetDirty(void) { m_Dirty = false; }
 128    //@}
 129 protected:
 130    /// generic function for mouse events processing
 131    void OnMouse(int eventId, wxMouseEvent& event);
 132
 133    /// for sending events
 134    wxWindow *m_Parent;
 135    /// Shall we send events?
 136    bool m_doSendEvents;
 137    /// Where does the current view start?
 138    int m_ViewStartX; int m_ViewStartY;
 139    /// Do we currently have the focus?
 140    bool m_HaveFocus;
 141    /// do we handle clicks of the right mouse button?
 142    bool m_DoPopupMenu;
 143    /// the menu
 144    wxMenu * m_PopupMenu;
 145    /// for derived classes, set when mouse is clicked
 146    wxPoint m_ClickPosition;
 147    /// for scrollbar calculations:
 148    int m_maxx;
 149    int m_maxy;
 150    int m_lineHeight;
 151 private:
 152    /// The layout list to be displayed.
 153    wxLayoutList *m_llist;
 154
 155    /// Can user edit the window?
 156    bool m_Editable;
 157    /// Is list dirty?
 158    bool         m_Dirty;
 159    wxMemoryDC  *m_memDC;
 160    wxBitmap    *m_bitmap;
 161    wxPoint      m_bitmapSize;
 162
 163    DECLARE_EVENT_TABLE()
 164 };
 165
 166 #endif