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_MOUSEMOVE,
  42    WXLOWIN_MENU_LAST = WXLOWIN_MENU_MOUSEMOVE
  43 };
  44
  45 /**
  46    This class is a rich text editing widget.
  47 */
  48 class wxLayoutWindow : public wxScrolledWindow
  49 {
  50 public:
  51    /** Constructor.
  52        @param parent parent window to display this panel in
  53    */
  54    wxLayoutWindow(wxWindow *parent);
  55
  56    /// Destructor.
  57    virtual ~wxLayoutWindow();
  58
  59    /**@name Editing functionality */
  60    //@{
  61    /// Clears the window and sets default parameters.
  62    void Clear(int family = wxROMAN,
  63               int size=12,
  64               int style=wxNORMAL,
  65               int weight=wxNORMAL,
  66               int underline=0,
  67               wxColour *fg=NULL,
  68               wxColour *bg=NULL)
  69       {
  70          GetLayoutList()->Clear(family,size,style,weight,underline,fg,bg);
  71          SetBackgroundColour(GetLayoutList()->GetDefaults()->GetBGColour());
  72          ResizeScrollbars(true);
  73          SetDirty();
  74          SetModified(false);
  75          wxRect r;
  76          int w,h;
  77          r.x = r.y = 0; GetSize(&w,&h);
  78          r.width = w;
  79          r.height = h;
  80          DoPaint(&r);
  81       }
  82    /** Sets a background image, only used on screen, not on printouts.
  83        @param bitmap a pointer to a wxBitmap or NULL to remove it
  84    */
  85    void SetBackgroundBitmap(wxBitmap *bitmap = NULL)
  86       {
  87          if(m_BGbitmap) delete m_BGbitmap;
  88          m_BGbitmap = bitmap;
  89       }
  90    /// Enable or disable editing, i.e. processing of keystrokes.
  91    void SetEditable(bool toggle) { m_Editable = toggle; }
  92    /// Query whether list can be edited by user.
  93    bool IsEditable(void) const { return m_Editable; }
  94    /// Pastes text from clipboard.
  95    void Paste(void);
  96
  97    //@}
  98
  99    void EnablePopup(bool enable = true) { m_DoPopupMenu = enable; }
 100
 101    /** Sets the wrap margin.
 102        @param margin set this to 0 to disable it
 103    */
 104    void SetWrapMargin(CoordType margin) { m_WrapMargin = margin; }
 105
 106    /** Redraws the window.
 107        Internally, this stores the parameter and calls a refresh on
 108        wxMSW, draws directly on wxGTK.
 109    */
 110    void DoPaint(const wxRect *updateRect);
 111
 112 #ifdef __WXMSW__
 113    virtual long MSWGetDlgCode();
 114 #endif //MSW
 115
 116    /// if exact == false, assume 50% extra size for the future
 117    void ResizeScrollbars(bool exact = false);  // don't change this to true!
 118
 119    /// if the flag is true, we send events when user clicks on embedded objects
 120    inline void SetMouseTracking(bool doIt = true) { m_doSendEvents = doIt; }
 121
 122    /* Returns a pointer to the wxLayoutList object.
 123       @return the list
 124    */
 125    wxLayoutList * GetLayoutList(void) { return m_llist; }
 126
 127    /**@name Callbacks */
 128    //@{
 129    void OnPaint(wxPaintEvent &event);
 130    void OnChar(wxKeyEvent& event);
 131    void OnKeyUp(wxKeyEvent& event);
 132    void OnMenu(wxCommandEvent& event);
 133    void OnLeftMouseClick(wxMouseEvent& event)  { OnMouse(WXLOWIN_MENU_LCLICK, event); }
 134    void OnRightMouseClick(wxMouseEvent& event) { OnMouse(WXLOWIN_MENU_RCLICK, event); }
 135    void OnMouseDblClick(wxMouseEvent& event)   { OnMouse(WXLOWIN_MENU_DBLCLICK, event); }
 136    void OnMouseMove(wxMouseEvent &event)       { OnMouse(WXLOWIN_MENU_MOUSEMOVE, event) ; }
 137    void OnSetFocus(wxFocusEvent &ev);
 138    void OnKillFocus(wxFocusEvent &ev);
 139    //@}
 140
 141    /// Creates a wxMenu for use as a format popup.
 142    static wxMenu * MakeFormatMenu(void);
 143    /**@name Dirty flag handling for optimisations. */
 144    //@{
 145    /// Set dirty flag.
 146    void SetDirty(void) { m_Dirty = true; }
 147    /// Query whether window needs redrawing.
 148    bool IsDirty(void) const { return m_Dirty; }
 149    /// Reset dirty flag.
 150    void ResetDirty(void) { m_Dirty = false; }
 151    //@}
 152    /// Redraws the window, used by DoPaint() or OnPaint().
 153    void InternalPaint(const wxRect *updateRect);
 154
 155    /// Has list been modified/edited?
 156    bool IsModified(void) const { return m_Modified; }
 157    /// Mark list as modified or unchanged.
 158    void SetModified(bool modified = true) { m_Modified = modified; }
 159
 160 protected:
 161    /// generic function for mouse events processing
 162    void OnMouse(int eventId, wxMouseEvent& event);
 163
 164    /// for sending events
 165    wxWindow *m_Parent;
 166    /// Shall we send events?
 167    bool m_doSendEvents;
 168    /// Where does the current view start?
 169    int m_ViewStartX; int m_ViewStartY;
 170    /// Do we currently have the focus?
 171    bool m_HaveFocus;
 172    /// do we handle clicks of the right mouse button?
 173    bool m_DoPopupMenu;
 174    /// Should InternalPaint() scroll to cursor.
 175    bool m_ScrollToCursor;
 176    /// Do we currently have a non-standard cursor?
 177    bool m_HandCursor;
 178    /// the menu
 179    wxMenu * m_PopupMenu;
 180    /// for derived classes, set when mouse is clicked
 181    wxPoint m_ClickPosition;
 182    /// for scrollbar calculations:
 183    int m_maxx;
 184    int m_maxy;
 185    int m_lineHeight;
 186 private:
 187    /// The layout list to be displayed.
 188    wxLayoutList *m_llist;
 189    /// Can user edit the window?
 190    bool m_Editable;
 191    /// Are we currently building a selection with the keyboard?
 192    bool m_Selecting;
 193    /// wrap margin
 194    CoordType    m_WrapMargin;
 195    /// Is list dirty (for redraws, internal use)?
 196    bool         m_Dirty;
 197    /// Has list been edited?
 198    bool         m_Modified;
 199    wxMemoryDC  *m_memDC;
 200    wxBitmap    *m_bitmap;
 201    wxPoint      m_bitmapSize;
 202    /// a pointer to a bitmap for the background
 203    wxBitmap    *m_BGbitmap;
 204    DECLARE_EVENT_TABLE()
 205 };
 206
 207 #endif