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