include/wx/gtk1/textctrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/gtk/textctrl.h
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Created:     01/02/97
   6 // Id:          $Id$
   7 // Copyright:   (c) 1998 Robert Roebling
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef __GTKTEXTCTRLH__
  12 #define __GTKTEXTCTRLH__
  13
  14 //-----------------------------------------------------------------------------
  15 // wxTextCtrl
  16 //-----------------------------------------------------------------------------
  17
  18 class WXDLLIMPEXP_CORE wxTextCtrl: public wxTextCtrlBase
  19 {
  20 public:
  21     wxTextCtrl() { Init(); }
  22     wxTextCtrl(wxWindow *parent,
  23                wxWindowID id,
  24                const wxString &value = wxEmptyString,
  25                const wxPoint &pos = wxDefaultPosition,
  26                const wxSize &size = wxDefaultSize,
  27                long style = 0,
  28                const wxValidator& validator = wxDefaultValidator,
  29                const wxString &name = wxTextCtrlNameStr);
  30
  31     ~wxTextCtrl();
  32
  33     bool Create(wxWindow *parent,
  34                 wxWindowID id,
  35                 const wxString &value = wxEmptyString,
  36                 const wxPoint &pos = wxDefaultPosition,
  37                 const wxSize &size = wxDefaultSize,
  38                 long style = 0,
  39                 const wxValidator& validator = wxDefaultValidator,
  40                 const wxString &name = wxTextCtrlNameStr);
  41
  42     // implement base class pure virtuals
  43     // ----------------------------------
  44
  45     virtual wxString GetValue() const;
  46     virtual void SetValue(const wxString& value);
  47
  48     virtual int GetLineLength(long lineNo) const;
  49     virtual wxString GetLineText(long lineNo) const;
  50     virtual int GetNumberOfLines() const;
  51
  52     virtual bool IsModified() const;
  53     virtual bool IsEditable() const;
  54
  55     // If the return values from and to are the same, there is no selection.
  56     virtual void GetSelection(long* from, long* to) const;
  57
  58     // operations
  59     // ----------
  60
  61     // editing
  62     virtual void Clear();
  63     virtual void Replace(long from, long to, const wxString& value);
  64     virtual void Remove(long from, long to);
  65
  66     // sets/clears the dirty flag
  67     virtual void MarkDirty();
  68     virtual void DiscardEdits();
  69
  70     virtual void SetMaxLength(unsigned long len);
  71
  72     // writing text inserts it at the current position, appending always
  73     // inserts it at the end
  74     virtual void WriteText(const wxString& text);
  75     virtual void AppendText(const wxString& text);
  76
  77     // apply text attribute to the range of text (only works with richedit
  78     // controls)
  79     virtual bool SetStyle(long start, long end, const wxTextAttr& style);
  80
  81     // translate between the position (which is just an index in the text ctrl
  82     // considering all its contents as a single strings) and (x, y) coordinates
  83     // which represent column and line.
  84     virtual long XYToPosition(long x, long y) const;
  85     virtual bool PositionToXY(long pos, long *x, long *y) const;
  86
  87     virtual void ShowPosition(long pos);
  88
  89 #ifdef __WXGTK20__
  90     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
  91     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
  92                                             wxTextCoord *col,
  93                                             wxTextCoord *row) const
  94     {
  95         return wxTextCtrlBase::HitTest(pt, col, row);
  96     }
  97 #endif // __WXGTK20__
  98
  99     // Clipboard operations
 100     virtual void Copy();
 101     virtual void Cut();
 102     virtual void Paste();
 103
 104     // Undo/redo
 105     virtual void Undo();
 106     virtual void Redo();
 107
 108     virtual bool CanUndo() const;
 109     virtual bool CanRedo() const;
 110
 111     // Insertion point
 112     virtual void SetInsertionPoint(long pos);
 113     virtual void SetInsertionPointEnd();
 114     virtual long GetInsertionPoint() const;
 115     virtual wxTextPos GetLastPosition() const;
 116
 117     virtual void SetSelection(long from, long to);
 118     virtual void SetEditable(bool editable);
 119
 120     virtual bool Enable( bool enable = true );
 121
 122     // Implementation from now on
 123     void OnDropFiles( wxDropFilesEvent &event );
 124     void OnChar( wxKeyEvent &event );
 125
 126     void OnCut(wxCommandEvent& event);
 127     void OnCopy(wxCommandEvent& event);
 128     void OnPaste(wxCommandEvent& event);
 129     void OnUndo(wxCommandEvent& event);
 130     void OnRedo(wxCommandEvent& event);
 131
 132     void OnUpdateCut(wxUpdateUIEvent& event);
 133     void OnUpdateCopy(wxUpdateUIEvent& event);
 134     void OnUpdatePaste(wxUpdateUIEvent& event);
 135     void OnUpdateUndo(wxUpdateUIEvent& event);
 136     void OnUpdateRedo(wxUpdateUIEvent& event);
 137
 138     bool SetFont(const wxFont& font);
 139     bool SetForegroundColour(const wxColour& colour);
 140     bool SetBackgroundColour(const wxColour& colour);
 141
 142     GtkWidget* GetConnectWidget();
 143     bool IsOwnGtkWindow( GdkWindow *window );
 144     void DoApplyWidgetStyle(GtkRcStyle *style);
 145     void CalculateScrollbar();
 146     void OnInternalIdle();
 147
 148 #ifdef __WXGTK20__
 149     void SetUpdateFont(bool WXUNUSED(update)) { }
 150 #else // !__WXGTK20__
 151     void SetUpdateFont(bool update) { m_updateFont = update; }
 152     void UpdateFontIfNeeded();
 153 #endif // __WXGTK20__/!__WXGTK20__
 154
 155     void SetModified() { m_modified = true; }
 156
 157     // GTK+ textctrl is so dumb that you need to freeze/thaw it manually to
 158     // avoid horrible flicker/scrolling back and forth
 159     virtual void Freeze();
 160     virtual void Thaw();
 161
 162     // textctrl specific scrolling
 163     virtual bool ScrollLines(int lines);
 164     virtual bool ScrollPages(int pages);
 165
 166     // implementation only from now on
 167
 168     // wxGTK-specific: called recursively by Enable,
 169     // to give widgets an oppprtunity to correct their colours after they
 170     // have been changed by Enable
 171     virtual void OnParentEnable( bool enable ) ;
 172
 173     // tell the control to ignore next text changed signal
 174     void IgnoreNextTextUpdate();
 175
 176     // should we ignore the changed signal? always resets the flag
 177     bool IgnoreTextUpdate();
 178
 179     static wxVisualAttributes
 180     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 181
 182 protected:
 183     virtual wxSize DoGetBestSize() const;
 184
 185     // common part of all ctors
 186     void Init();
 187
 188     // get the vertical adjustment, if any, NULL otherwise
 189     GtkAdjustment *GetVAdj() const;
 190
 191     // scroll the control by the given number of pixels, return true if the
 192     // scroll position changed
 193     bool DoScroll(GtkAdjustment *adj, int diff);
 194
 195     // Widgets that use the style->base colour for the BG colour should
 196     // override this and return true.
 197     virtual bool UseGTKStyleBase() const { return true; }
 198
 199 #ifdef __WXGTK20__
 200     // has the control been frozen by Freeze()?
 201     bool IsFrozen() const { return m_frozenness > 0; }
 202 #endif
 203
 204 private:
 205     // change the font for everything in this control
 206     void ChangeFontGlobally();
 207
 208     GtkWidget  *m_text;
 209     GtkWidget  *m_vScrollbar;
 210
 211     bool        m_modified:1;
 212     bool        m_vScrollbarVisible:1;
 213 #ifndef __WXGTK20__
 214     bool        m_updateFont:1;
 215 #endif // !__WXGTK20__
 216     bool        m_ignoreNextUpdate:1;
 217
 218 #ifdef __WXGTK20__
 219     // Our text buffer. Convenient, and holds the buffer while using
 220     // a dummy one when m_frozenness > 0
 221     GtkTextBuffer *m_buffer;
 222
 223     // number of calls to Freeze() minus number of calls to Thaw()
 224     unsigned int m_frozenness;
 225
 226     // For wxTE_AUTO_URL
 227     void OnUrlMouseEvent(wxMouseEvent&);
 228     GdkCursor *m_gdkHandCursor;
 229     GdkCursor *m_gdkXTermCursor;
 230 #endif
 231
 232     DECLARE_EVENT_TABLE()
 233     DECLARE_DYNAMIC_CLASS(wxTextCtrl)
 234 };
 235
 236 #endif // __GTKTEXTCTRLH__
 237