include/wx/textctrl.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        textctrl.h
   3 // Purpose:     wxTextCtrlBase class - the interface of wxTextCtrl
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     13.07.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) wxWindows team
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_TEXTCTRL_H_BASE_
  13 #define _WX_TEXTCTRL_H_BASE_
  14
  15 // ----------------------------------------------------------------------------
  16 // headers
  17 // ----------------------------------------------------------------------------
  18
  19 #ifdef __GNUG__
  20     #pragma interface "textctrlbase.h"
  21 #endif
  22
  23 #include "wx/defs.h"
  24
  25 #if wxUSE_TEXTCTRL
  26
  27 #include "wx/control.h"         // the base class
  28
  29 // 16-bit Borland 4.0 doesn't seem to allow multiple inheritance with wxWindow
  30 // and streambuf: it complains about deriving a huge class from the huge class
  31 // streambuf. !! Also, can't use streambuf if making or using a DLL :-(
  32
  33 #if (defined(__BORLANDC__)) || defined(__MWERKS__) || \
  34     defined(WXUSINGDLL) || defined(WXMAKINGDLL)
  35     #define NO_TEXT_WINDOW_STREAM
  36 #endif
  37
  38 #ifndef NO_TEXT_WINDOW_STREAM
  39     #if wxUSE_STD_IOSTREAM
  40         #include "wx/ioswrap.h"    // for iostream classes if we need them
  41     #else // !wxUSE_STD_IOSTREAM
  42         // can't compile this feature in if we don't use streams at all
  43         #define NO_TEXT_WINDOW_STREAM
  44     #endif // wxUSE_STD_IOSTREAM/!wxUSE_STD_IOSTREAM
  45 #endif
  46
  47 class WXDLLEXPORT wxTextCtrl;
  48 class WXDLLEXPORT wxTextCtrlBase;
  49
  50 // ----------------------------------------------------------------------------
  51 // constants
  52 // ----------------------------------------------------------------------------
  53
  54 WXDLLEXPORT_DATA(extern const wxChar*) wxTextCtrlNameStr;
  55 WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
  56
  57 // ----------------------------------------------------------------------------
  58 // wxTextCtrl style flags
  59 // ----------------------------------------------------------------------------
  60
  61 // the flag bits 0x0001, 2, 4 and 8 are free but should be used only for the
  62 // things which don't make sense for a text control used by wxTextEntryDialog
  63 // because they would otherwise conflict with wxOK, wxCANCEL, wxCENTRE
  64 #define wxTE_READONLY       0x0010
  65 #define wxTE_MULTILINE      0x0020
  66 #define wxTE_PROCESS_TAB    0x0040
  67
  68 // this style means to use RICHEDIT control and does something only under wxMSW
  69 // and Win32 and is silently ignored under all other platforms
  70 #define wxTE_RICH           0x0080
  71 #define wxTE_NO_VSCROLL     0x0100
  72 #define wxTE_AUTO_SCROLL    0x0200
  73 #define wxTE_PROCESS_ENTER  0x0400
  74 #define wxTE_PASSWORD       0x0800
  75
  76 // automatically detect the URLs and generate the events when mouse is
  77 // moved/clicked over an URL
  78 //
  79 // this is for Win32 richedit controls only so far
  80 #define wxTE_AUTO_URL       0x1000
  81
  82 // by default, the Windows text control doesn't show the selection when it
  83 // doesn't have focus - use this style to force it to always show it
  84 #define wxTE_NOHIDESEL      0x2000
  85
  86 // use wxHSCROLL to not wrap text at all, wxTE_LINEWRAP to wrap it at any
  87 // position and wxTE_WORDWRAP to wrap at words boundary
  88 #define wxTE_DONTWRAP       wxHSCROLL
  89 #define wxTE_LINEWRAP       0x4000
  90 #define wxTE_WORDWRAP       0x0000  // it's just == !wxHSCROLL
  91
  92 // force using RichEdit version 2.0 or 3.0 instead of 1.0 (default) for
  93 // wxTE_RICH controls - can be used together with or instead of wxTE_RICH
  94 #define wxTE_RICH2          0x8000
  95
  96 // ----------------------------------------------------------------------------
  97 // wxTextAttr: a structure containing the visual attributes of a text
  98 // ----------------------------------------------------------------------------
  99
 100 class WXDLLEXPORT wxTextAttr
 101 {
 102 public:
 103     // ctors
 104     wxTextAttr() { }
 105     wxTextAttr(const wxColour& colText,
 106                const wxColour& colBack = wxNullColour,
 107                const wxFont& font = wxNullFont)
 108         : m_colText(colText), m_colBack(colBack), m_font(font) { }
 109
 110     // setters
 111     void SetTextColour(const wxColour& colText) { m_colText = colText; }
 112     void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; }
 113     void SetFont(const wxFont& font) { m_font = font; }
 114
 115     // accessors
 116     bool HasTextColour() const { return m_colText.Ok(); }
 117     bool HasBackgroundColour() const { return m_colBack.Ok(); }
 118     bool HasFont() const { return m_font.Ok(); }
 119
 120     // setters
 121     const wxColour& GetTextColour() const { return m_colText; }
 122     const wxColour& GetBackgroundColour() const { return m_colBack; }
 123     const wxFont& GetFont() const { return m_font; }
 124
 125     // returns false if we have any attributes set, true otherwise
 126     bool IsDefault() const
 127     {
 128         return !HasTextColour() && !HasBackgroundColour() && !HasFont();
 129     }
 130
 131     // return the attribute having the valid font and colours: it uses the
 132     // attributes set in attr and falls back first to attrDefault and then to
 133     // the text control font/colours for those attributes which are not set
 134     static wxTextAttr Combine(const wxTextAttr& attr,
 135                               const wxTextAttr& attrDef,
 136                               const wxTextCtrlBase *text);
 137
 138 private:
 139     wxColour m_colText,
 140              m_colBack;
 141     wxFont   m_font;
 142 };
 143
 144 // ----------------------------------------------------------------------------
 145 // wxTextCtrl: a single or multiple line text zone where user can enter and
 146 // edit text
 147 // ----------------------------------------------------------------------------
 148
 149 class WXDLLEXPORT wxTextCtrlBase : public wxControl
 150 #ifndef NO_TEXT_WINDOW_STREAM
 151                                  , public wxSTD streambuf
 152 #endif
 153
 154 {
 155 public:
 156     // creation
 157     // --------
 158
 159     wxTextCtrlBase();
 160     ~wxTextCtrlBase();
 161
 162     // accessors
 163     // ---------
 164
 165     virtual wxString GetValue() const = 0;
 166     virtual void SetValue(const wxString& value) = 0;
 167
 168     virtual wxString GetRange(long from, long to) const;
 169
 170     virtual int GetLineLength(long lineNo) const = 0;
 171     virtual wxString GetLineText(long lineNo) const = 0;
 172     virtual int GetNumberOfLines() const = 0;
 173
 174     virtual bool IsModified() const = 0;
 175     virtual bool IsEditable() const = 0;
 176
 177     // more readable flag testing methods
 178     bool IsSingleLine() const { return !(GetWindowStyle() & wxTE_MULTILINE); }
 179     bool IsMultiLine() const { return !IsSingleLine(); }
 180
 181     // If the return values from and to are the same, there is no selection.
 182     virtual void GetSelection(long* from, long* to) const = 0;
 183
 184     virtual wxString GetStringSelection() const;
 185
 186     // operations
 187     // ----------
 188
 189     // editing
 190     virtual void Clear() = 0;
 191     virtual void Replace(long from, long to, const wxString& value) = 0;
 192     virtual void Remove(long from, long to) = 0;
 193
 194     // load/save the controls contents from/to the file
 195     virtual bool LoadFile(const wxString& file);
 196     virtual bool SaveFile(const wxString& file = wxEmptyString);
 197
 198     // clears the dirty flag
 199     virtual void DiscardEdits() = 0;
 200
 201     // set the max number of characters which may be entered in a single line
 202     // text control
 203     virtual void SetMaxLength(unsigned long WXUNUSED(len)) { }
 204
 205     // writing text inserts it at the current position, appending always
 206     // inserts it at the end
 207     virtual void WriteText(const wxString& text) = 0;
 208     virtual void AppendText(const wxString& text) = 0;
 209
 210     // insert the character which would have resulted from this key event,
 211     // return TRUE if anything has been inserted
 212     virtual bool EmulateKeyPress(const wxKeyEvent& event);
 213
 214     // text control under some platforms supports the text styles: these
 215     // methods allow to apply the given text style to the given selection or to
 216     // set/get the style which will be used for all appended text
 217     virtual bool SetStyle(long start, long end, const wxTextAttr& style);
 218     virtual bool SetDefaultStyle(const wxTextAttr& style);
 219     virtual const wxTextAttr& GetDefaultStyle() const;
 220
 221     // translate between the position (which is just an index in the text ctrl
 222     // considering all its contents as a single strings) and (x, y) coordinates
 223     // which represent column and line.
 224     virtual long XYToPosition(long x, long y) const = 0;
 225     virtual bool PositionToXY(long pos, long *x, long *y) const = 0;
 226
 227     virtual void ShowPosition(long pos) = 0;
 228
 229     // Clipboard operations
 230     virtual void Copy() = 0;
 231     virtual void Cut() = 0;
 232     virtual void Paste() = 0;
 233
 234     virtual bool CanCopy() const;
 235     virtual bool CanCut() const;
 236     virtual bool CanPaste() const;
 237
 238     // Undo/redo
 239     virtual void Undo() = 0;
 240     virtual void Redo() = 0;
 241
 242     virtual bool CanUndo() const = 0;
 243     virtual bool CanRedo() const = 0;
 244
 245     // Insertion point
 246     virtual void SetInsertionPoint(long pos) = 0;
 247     virtual void SetInsertionPointEnd() = 0;
 248     virtual long GetInsertionPoint() const = 0;
 249     virtual long GetLastPosition() const = 0;
 250
 251     virtual void SetSelection(long from, long to) = 0;
 252     virtual void SelectAll();
 253     virtual void SetEditable(bool editable) = 0;
 254
 255     // override streambuf method
 256 #ifndef NO_TEXT_WINDOW_STREAM
 257     int overflow(int i);
 258 #endif // NO_TEXT_WINDOW_STREAM
 259
 260     // stream-like insertion operators: these are always available, whether we
 261     // were, or not, compiled with streambuf support
 262     wxTextCtrl& operator<<(const wxString& s);
 263     wxTextCtrl& operator<<(int i);
 264     wxTextCtrl& operator<<(long i);
 265     wxTextCtrl& operator<<(float f);
 266     wxTextCtrl& operator<<(double d);
 267     wxTextCtrl& operator<<(const wxChar c);
 268
 269     // obsolete functions
 270 #if WXWIN_COMPATIBILITY
 271     bool Modified() const { return IsModified(); }
 272 #endif
 273
 274 protected:
 275     // the name of the last file loaded with LoadFile() which will be used by
 276     // SaveFile() by default
 277     wxString m_filename;
 278
 279     // the text style which will be used for any new text added to the control
 280     wxTextAttr m_defaultStyle;
 281 };
 282
 283 // ----------------------------------------------------------------------------
 284 // include the platform-dependent class definition
 285 // ----------------------------------------------------------------------------
 286
 287 #if defined(__WXX11__)
 288     #include "wx/x11/textctrl.h"
 289 #elif defined(__WXUNIVERSAL__)
 290     #include "wx/univ/textctrl.h"
 291 #elif defined(__WXMSW__)
 292     #include "wx/msw/textctrl.h"
 293 #elif defined(__WXMOTIF__)
 294     #include "wx/motif/textctrl.h"
 295 #elif defined(__WXGTK__)
 296     #include "wx/gtk/textctrl.h"
 297 #elif defined(__WXMAC__)
 298     #include "wx/mac/textctrl.h"
 299 #elif defined(__WXPM__)
 300     #include "wx/os2/textctrl.h"
 301 #elif defined(__WXSTUBS__)
 302     #include "wx/stubs/textctrl.h"
 303 #endif
 304
 305 // ----------------------------------------------------------------------------
 306 // wxTextCtrl events
 307 // ----------------------------------------------------------------------------
 308
 309 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
 310
 311 BEGIN_DECLARE_EVENT_TYPES()
 312     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_UPDATED, 7)
 313     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_ENTER, 8)
 314     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_URL, 13)
 315     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_MAXLEN, 14)
 316 END_DECLARE_EVENT_TYPES()
 317
 318 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
 319
 320 class WXDLLEXPORT wxTextUrlEvent : public wxCommandEvent
 321 {
 322 public:
 323     wxTextUrlEvent(int id, const wxMouseEvent& evtMouse,
 324                    long start, long end)
 325         : wxCommandEvent(wxEVT_COMMAND_TEXT_URL, id)
 326         , m_evtMouse(evtMouse), m_start(start), m_end(end)
 327         { }
 328
 329     // get the mouse event which happend over the URL
 330     const wxMouseEvent& GetMouseEvent() const { return m_evtMouse; }
 331
 332     // get the start of the URL
 333     long GetURLStart() const { return m_start; }
 334
 335     // get the end of the URL
 336     long GetURLEnd() const { return m_end; }
 337
 338 protected:
 339     // the corresponding mouse event
 340     wxMouseEvent m_evtMouse;
 341
 342     // the start and end indices of the URL in the text control
 343     long m_start,
 344          m_end;
 345
 346 private:
 347     DECLARE_DYNAMIC_CLASS(wxTextUrlEvent)
 348
 349 public:
 350     // for wxWin RTTI only, don't use
 351     wxTextUrlEvent() : m_evtMouse(), m_start(0), m_end(0) { }
 352 };
 353
 354 typedef void (wxEvtHandler::*wxTextUrlEventFunction)(wxTextUrlEvent&);
 355
 356 #define EVT_TEXT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
 357 #define EVT_TEXT_ENTER(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
 358 #define EVT_TEXT_URL(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_URL, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxTextUrlEventFunction) & fn, (wxObject *) NULL ),
 359 #define EVT_TEXT_MAXLEN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_MAXLEN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
 360
 361 #ifndef NO_TEXT_WINDOW_STREAM
 362
 363 // ----------------------------------------------------------------------------
 364 // wxStreamToTextRedirector: this class redirects all data sent to the given
 365 // C++ stream to the wxTextCtrl given to its ctor during its lifetime.
 366 // ----------------------------------------------------------------------------
 367
 368 class WXDLLEXPORT wxStreamToTextRedirector
 369 {
 370 public:
 371     wxStreamToTextRedirector(wxTextCtrl *text, wxSTD ostream *ostr = NULL)
 372         : m_ostr(ostr ? *ostr : wxSTD cout)
 373     {
 374         m_sbufOld = m_ostr.rdbuf();
 375         m_ostr.rdbuf(text);
 376     }
 377
 378     ~wxStreamToTextRedirector()
 379     {
 380         m_ostr.rdbuf(m_sbufOld);
 381     }
 382
 383 private:
 384     // the stream we're redirecting
 385     wxSTD ostream&   m_ostr;
 386
 387     // the old streambuf (before we changed it)
 388     wxSTD streambuf *m_sbufOld;
 389 };
 390
 391 #endif // !NO_TEXT_WINDOW_STREAM
 392
 393 #endif // wxUSE_TEXTCTRL
 394
 395 #endif
 396     // _WX_TEXTCTRL_H_BASE_