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) wxWidgets 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 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  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 #include "wx/dynarray.h"        // wxArrayInt
  29 #include "wx/gdicmn.h"          // wxPoint
  30
  31 // 16-bit Borland 4.0 doesn't seem to allow multiple inheritance with wxWindow
  32 // and streambuf: it complains about deriving a huge class from the huge class
  33 // streambuf. !! Also, can't use streambuf if making or using a DLL :-(
  34
  35 #if (defined(__BORLANDC__)) || defined(__MWERKS__) || \
  36     (defined(__WINDOWS__) && (defined(WXUSINGDLL) || defined(WXMAKINGDLL)))
  37     #define NO_TEXT_WINDOW_STREAM
  38 #endif
  39
  40 #ifndef NO_TEXT_WINDOW_STREAM
  41     #if wxUSE_STD_IOSTREAM
  42         #include "wx/ioswrap.h"    // derivation: we need the full decls.
  43     #else // !wxUSE_STD_IOSTREAM
  44         // can't compile this feature in if we don't use streams at all
  45         #define NO_TEXT_WINDOW_STREAM
  46     #endif // wxUSE_STD_IOSTREAM/!wxUSE_STD_IOSTREAM
  47 #endif
  48
  49 #if defined(__WXMSW__) && defined(__MINGW32__)
  50     #include "wx/msw/winundef.h"
  51 #endif
  52
  53 class WXDLLEXPORT wxTextCtrl;
  54 class WXDLLEXPORT wxTextCtrlBase;
  55
  56 // ----------------------------------------------------------------------------
  57 // wxTextCtrl types
  58 // ----------------------------------------------------------------------------
  59
  60 // wxTextPos is the position in the text
  61 typedef long wxTextPos;
  62
  63 // wxTextCoord is the line or row number (which should have been unsigned but
  64 // is long for backwards compatibility)
  65 typedef long wxTextCoord;
  66
  67 // ----------------------------------------------------------------------------
  68 // constants
  69 // ----------------------------------------------------------------------------
  70
  71 WXDLLEXPORT_DATA(extern const wxChar*) wxTextCtrlNameStr;
  72
  73 // ----------------------------------------------------------------------------
  74 // wxTextCtrl style flags
  75 // ----------------------------------------------------------------------------
  76
  77 // the flag bits 0x0001, and 0x0004 are free but should be used only for the
  78 // things which don't make sense for a text control used by wxTextEntryDialog
  79 // because they would otherwise conflict with wxOK, wxCANCEL, wxCENTRE
  80
  81 #define wxTE_NO_VSCROLL     0x0002
  82 #define wxTE_AUTO_SCROLL    0x0008
  83
  84 #define wxTE_READONLY       0x0010
  85 #define wxTE_MULTILINE      0x0020
  86 #define wxTE_PROCESS_TAB    0x0040
  87
  88 // alignment flags
  89 #define wxTE_LEFT           0x0000                    // 0x0000
  90 #define wxTE_CENTER         wxALIGN_CENTER_HORIZONTAL // 0x0100
  91 #define wxTE_RIGHT          wxALIGN_RIGHT             // 0x0200
  92 #define wxTE_CENTRE         wxTE_CENTER
  93
  94 // this style means to use RICHEDIT control and does something only under wxMSW
  95 // and Win32 and is silently ignored under all other platforms
  96 #define wxTE_RICH           0x0080
  97
  98 #define wxTE_PROCESS_ENTER  0x0400
  99 #define wxTE_PASSWORD       0x0800
 100
 101 // automatically detect the URLs and generate the events when mouse is
 102 // moved/clicked over an URL
 103 //
 104 // this is for Win32 richedit controls only so far
 105 #define wxTE_AUTO_URL       0x1000
 106
 107 // by default, the Windows text control doesn't show the selection when it
 108 // doesn't have focus - use this style to force it to always show it
 109 #define wxTE_NOHIDESEL      0x2000
 110
 111 // use wxHSCROLL to not wrap text at all, wxTE_LINEWRAP to wrap it at any
 112 // position and wxTE_WORDWRAP to wrap at words boundary
 113 #define wxTE_DONTWRAP       wxHSCROLL
 114 #define wxTE_LINEWRAP       0x4000
 115 #define wxTE_WORDWRAP       0x0000  // it's just == !wxHSCROLL
 116
 117 // force using RichEdit version 2.0 or 3.0 instead of 1.0 (default) for
 118 // wxTE_RICH controls - can be used together with or instead of wxTE_RICH
 119 #define wxTE_RICH2          0x8000
 120
 121 // ----------------------------------------------------------------------------
 122 // wxTextCtrl::HitTest return values
 123 // ----------------------------------------------------------------------------
 124
 125 // the point asked is ...
 126 enum wxTextCtrlHitTestResult
 127 {
 128     wxTE_HT_UNKNOWN = -2,   // this means HitTest() is simply not implemented
 129     wxTE_HT_BEFORE,         // either to the left or upper
 130     wxTE_HT_ON_TEXT,        // directly on
 131     wxTE_HT_BELOW,          // below [the last line]
 132     wxTE_HT_BEYOND          // after [the end of line]
 133 };
 134 // ... the character returned
 135
 136 // ----------------------------------------------------------------------------
 137 // Types for wxTextAttr
 138 // ----------------------------------------------------------------------------
 139
 140 // Alignment
 141
 142 enum wxTextAttrAlignment
 143 {
 144     wxTEXT_ALIGNMENT_DEFAULT,
 145     wxTEXT_ALIGNMENT_LEFT,
 146     wxTEXT_ALIGNMENT_CENTRE,
 147     wxTEXT_ALIGNMENT_CENTER = wxTEXT_ALIGNMENT_CENTRE,
 148     wxTEXT_ALIGNMENT_RIGHT,
 149     wxTEXT_ALIGNMENT_JUSTIFIED
 150 };
 151
 152 // Flags to indicate which attributes are being applied
 153
 154 #define wxTEXT_ATTR_TEXT_COLOUR             0x0001
 155 #define wxTEXT_ATTR_BACKGROUND_COLOUR       0x0002
 156 #define wxTEXT_ATTR_FONT_FACE               0x0004
 157 #define wxTEXT_ATTR_FONT_SIZE               0x0008
 158 #define wxTEXT_ATTR_FONT_WEIGHT             0x0010
 159 #define wxTEXT_ATTR_FONT_ITALIC             0x0020
 160 #define wxTEXT_ATTR_FONT_UNDERLINE          0x0040
 161 #define wxTEXT_ATTR_FONT \
 162   wxTEXT_ATTR_FONT_FACE | wxTEXT_ATTR_FONT_SIZE | wxTEXT_ATTR_FONT_WEIGHT | wxTEXT_ATTR_FONT_ITALIC | wxTEXT_ATTR_FONT_UNDERLINE
 163 #define wxTEXT_ATTR_ALIGNMENT               0x0080
 164 #define wxTEXT_ATTR_LEFT_INDENT             0x0100
 165 #define wxTEXT_ATTR_RIGHT_INDENT            0x0200
 166 #define wxTEXT_ATTR_TABS                    0x0400
 167
 168 // ----------------------------------------------------------------------------
 169 // wxTextAttr: a structure containing the visual attributes of a text
 170 // ----------------------------------------------------------------------------
 171
 172 class WXDLLEXPORT wxTextAttr
 173 {
 174 public:
 175     // ctors
 176     wxTextAttr() { Init(); }
 177     wxTextAttr(const wxColour& colText,
 178                const wxColour& colBack = wxNullColour,
 179                const wxFont& font = wxNullFont,
 180                wxTextAttrAlignment alignment = wxTEXT_ALIGNMENT_DEFAULT);
 181
 182     // operations
 183     void Init();
 184
 185     // operators
 186     void operator= (const wxTextAttr& attr);
 187
 188     // setters
 189     void SetTextColour(const wxColour& colText) { m_colText = colText; m_flags |= wxTEXT_ATTR_TEXT_COLOUR; }
 190     void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; m_flags |= wxTEXT_ATTR_BACKGROUND_COLOUR; }
 191     void SetFont(const wxFont& font, long flags = wxTEXT_ATTR_FONT) { m_font = font; m_flags |= flags; }
 192     void SetAlignment(wxTextAttrAlignment alignment) { m_textAlignment = alignment; m_flags |= wxTEXT_ATTR_ALIGNMENT; }
 193     void SetTabs(const wxArrayInt& tabs) { m_tabs = tabs; m_flags |= wxTEXT_ATTR_TABS; }
 194     void SetLeftIndent(int indent, int subIndent = 0) { m_leftIndent = indent; m_leftSubIndent = subIndent; m_flags |= wxTEXT_ATTR_LEFT_INDENT; }
 195     void SetRightIndent(int indent) { m_rightIndent = indent; m_flags |= wxTEXT_ATTR_RIGHT_INDENT; }
 196     void SetFlags(long flags) { m_flags = flags; }
 197
 198     // accessors
 199     bool HasTextColour() const { return m_colText.Ok() && HasFlag(wxTEXT_ATTR_TEXT_COLOUR) ; }
 200     bool HasBackgroundColour() const { return m_colBack.Ok() && HasFlag(wxTEXT_ATTR_BACKGROUND_COLOUR) ; }
 201     bool HasFont() const { return m_font.Ok() && HasFlag(wxTEXT_ATTR_FONT) ; }
 202     bool HasAlignment() const { return (m_textAlignment != wxTEXT_ALIGNMENT_DEFAULT) || ((m_flags & wxTEXT_ATTR_ALIGNMENT) != 0) ; }
 203     bool HasTabs() const { return (m_flags & wxTEXT_ATTR_TABS) != 0 ; }
 204     bool HasLeftIndent() const { return (m_flags & wxTEXT_ATTR_LEFT_INDENT) != 0 ; }
 205     bool HasRightIndent() const { return (m_flags & wxTEXT_ATTR_RIGHT_INDENT) != 0 ; }
 206     bool HasFlag(long flag) const { return (m_flags & flag) != 0; }
 207
 208     const wxColour& GetTextColour() const { return m_colText; }
 209     const wxColour& GetBackgroundColour() const { return m_colBack; }
 210     const wxFont& GetFont() const { return m_font; }
 211     wxTextAttrAlignment GetAlignment() const { return m_textAlignment; }
 212     const wxArrayInt& GetTabs() const { return m_tabs; }
 213     long GetLeftIndent() const { return m_leftIndent; }
 214     long GetLeftSubIndent() const { return m_leftSubIndent; }
 215     long GetRightIndent() const { return m_rightIndent; }
 216     long GetFlags() const { return m_flags; }
 217
 218     // returns false if we have any attributes set, true otherwise
 219     bool IsDefault() const
 220     {
 221         return !HasTextColour() && !HasBackgroundColour() && !HasFont() && !HasAlignment() &&
 222                !HasTabs() && !HasLeftIndent() && !HasRightIndent() ;
 223     }
 224
 225     // return the attribute having the valid font and colours: it uses the
 226     // attributes set in attr and falls back first to attrDefault and then to
 227     // the text control font/colours for those attributes which are not set
 228     static wxTextAttr Combine(const wxTextAttr& attr,
 229                               const wxTextAttr& attrDef,
 230                               const wxTextCtrlBase *text);
 231
 232 private:
 233     long                m_flags;
 234     wxColour            m_colText,
 235                         m_colBack;
 236     wxFont              m_font;
 237     wxTextAttrAlignment m_textAlignment;
 238     wxArrayInt          m_tabs; // array of int: tab stops in 1/10 mm
 239     int                 m_leftIndent; // left indent in 1/10 mm
 240     int                 m_leftSubIndent; // left indent for all but the first
 241                                          // line in a paragraph relative to the
 242                                          // first line, in 1/10 mm
 243     int                 m_rightIndent; // right indent in 1/10 mm
 244 };
 245
 246 // ----------------------------------------------------------------------------
 247 // wxTextCtrl: a single or multiple line text zone where user can enter and
 248 // edit text
 249 // ----------------------------------------------------------------------------
 250
 251 class WXDLLEXPORT wxTextCtrlBase : public wxControl
 252 #ifndef NO_TEXT_WINDOW_STREAM
 253                                  , public wxSTD streambuf
 254 #endif
 255
 256 {
 257 public:
 258     // creation
 259     // --------
 260
 261     wxTextCtrlBase(){}
 262     ~wxTextCtrlBase(){}
 263
 264     // accessors
 265     // ---------
 266
 267     virtual wxString GetValue() const = 0;
 268     virtual void SetValue(const wxString& value) = 0;
 269
 270     virtual wxString GetRange(long from, long to) const;
 271
 272     virtual int GetLineLength(long lineNo) const = 0;
 273     virtual wxString GetLineText(long lineNo) const = 0;
 274     virtual int GetNumberOfLines() const = 0;
 275
 276     virtual bool IsModified() const = 0;
 277     virtual bool IsEditable() const = 0;
 278
 279     // more readable flag testing methods
 280     bool IsSingleLine() const { return !(GetWindowStyle() & wxTE_MULTILINE); }
 281     bool IsMultiLine() const { return !IsSingleLine(); }
 282
 283     // If the return values from and to are the same, there is no selection.
 284     virtual void GetSelection(long* from, long* to) const = 0;
 285
 286     virtual wxString GetStringSelection() const;
 287
 288     // operations
 289     // ----------
 290
 291     // editing
 292     virtual void Clear() = 0;
 293     virtual void Replace(long from, long to, const wxString& value) = 0;
 294     virtual void Remove(long from, long to) = 0;
 295
 296     // load/save the controls contents from/to the file
 297     virtual bool LoadFile(const wxString& file);
 298     virtual bool SaveFile(const wxString& file = wxEmptyString);
 299
 300     // sets/clears the dirty flag
 301     virtual void MarkDirty() = 0;
 302     virtual void DiscardEdits() = 0;
 303
 304     // set the max number of characters which may be entered in a single line
 305     // text control
 306     virtual void SetMaxLength(unsigned long WXUNUSED(len)) { }
 307
 308     // writing text inserts it at the current position, appending always
 309     // inserts it at the end
 310     virtual void WriteText(const wxString& text) = 0;
 311     virtual void AppendText(const wxString& text) = 0;
 312
 313     // insert the character which would have resulted from this key event,
 314     // return true if anything has been inserted
 315     virtual bool EmulateKeyPress(const wxKeyEvent& event);
 316
 317     // text control under some platforms supports the text styles: these
 318     // methods allow to apply the given text style to the given selection or to
 319     // set/get the style which will be used for all appended text
 320     virtual bool SetStyle(long start, long end, const wxTextAttr& style);
 321     virtual bool GetStyle(long position, wxTextAttr& style);
 322     virtual bool SetDefaultStyle(const wxTextAttr& style);
 323     virtual const wxTextAttr& GetDefaultStyle() const;
 324
 325     // translate between the position (which is just an index in the text ctrl
 326     // considering all its contents as a single strings) and (x, y) coordinates
 327     // which represent column and line.
 328     virtual long XYToPosition(long x, long y) const = 0;
 329     virtual bool PositionToXY(long pos, long *x, long *y) const = 0;
 330
 331     virtual void ShowPosition(long pos) = 0;
 332
 333     // find the character at position given in pixels
 334     //
 335     // NB: pt is in device coords (not adjusted for the client area origin nor
 336     //     scrolling)
 337     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
 338     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
 339                                             wxTextCoord *col,
 340                                             wxTextCoord *row) const;
 341
 342     // Clipboard operations
 343     virtual void Copy() = 0;
 344     virtual void Cut() = 0;
 345     virtual void Paste() = 0;
 346
 347     virtual bool CanCopy() const;
 348     virtual bool CanCut() const;
 349     virtual bool CanPaste() const;
 350
 351     // Undo/redo
 352     virtual void Undo() = 0;
 353     virtual void Redo() = 0;
 354
 355     virtual bool CanUndo() const = 0;
 356     virtual bool CanRedo() const = 0;
 357
 358     // Insertion point
 359     virtual void SetInsertionPoint(long pos) = 0;
 360     virtual void SetInsertionPointEnd() = 0;
 361     virtual long GetInsertionPoint() const = 0;
 362     virtual long GetLastPosition() const = 0;
 363
 364     virtual void SetSelection(long from, long to) = 0;
 365     virtual void SelectAll();
 366     virtual void SetEditable(bool editable) = 0;
 367
 368     // override streambuf method
 369 #ifndef NO_TEXT_WINDOW_STREAM
 370     int overflow(int i);
 371 #endif // NO_TEXT_WINDOW_STREAM
 372
 373     // stream-like insertion operators: these are always available, whether we
 374     // were, or not, compiled with streambuf support
 375     wxTextCtrl& operator<<(const wxString& s);
 376     wxTextCtrl& operator<<(int i);
 377     wxTextCtrl& operator<<(long i);
 378     wxTextCtrl& operator<<(float f);
 379     wxTextCtrl& operator<<(double d);
 380     wxTextCtrl& operator<<(const wxChar c);
 381
 382     // do the window-specific processing after processing the update event
 383     virtual void DoUpdateWindowUI(wxUpdateUIEvent& event);
 384
 385     virtual bool ShouldInheritColours() const { return false; }
 386
 387 protected:
 388     // the name of the last file loaded with LoadFile() which will be used by
 389     // SaveFile() by default
 390     wxString m_filename;
 391
 392     // the text style which will be used for any new text added to the control
 393     wxTextAttr m_defaultStyle;
 394
 395     DECLARE_NO_COPY_CLASS(wxTextCtrlBase)
 396 };
 397
 398 // ----------------------------------------------------------------------------
 399 // include the platform-dependent class definition
 400 // ----------------------------------------------------------------------------
 401
 402 #if defined(__WXX11__)
 403     #include "wx/x11/textctrl.h"
 404 #elif defined(__WXUNIVERSAL__)
 405     #include "wx/univ/textctrl.h"
 406 #elif defined(__SMARTPHONE__) && defined(__WXWINCE__)
 407     #include "wx/msw/wince/textctrlce.h"
 408 #elif defined(__WXMSW__)
 409     #include "wx/msw/textctrl.h"
 410 #elif defined(__WXMOTIF__)
 411     #include "wx/motif/textctrl.h"
 412 #elif defined(__WXGTK__)
 413     #include "wx/gtk/textctrl.h"
 414 #elif defined(__WXMAC__)
 415     #include "wx/mac/textctrl.h"
 416 #elif defined(__WXCOCOA__)
 417     #include "wx/cocoa/textctrl.h"
 418 #elif defined(__WXPM__)
 419     #include "wx/os2/textctrl.h"
 420 #endif
 421
 422 // ----------------------------------------------------------------------------
 423 // wxTextCtrl events
 424 // ----------------------------------------------------------------------------
 425
 426 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
 427
 428 BEGIN_DECLARE_EVENT_TYPES()
 429     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_UPDATED, 7)
 430     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_ENTER, 8)
 431     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_URL, 13)
 432     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_MAXLEN, 14)
 433 END_DECLARE_EVENT_TYPES()
 434
 435 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
 436
 437 class WXDLLEXPORT wxTextUrlEvent : public wxCommandEvent
 438 {
 439 public:
 440     wxTextUrlEvent(int winid, const wxMouseEvent& evtMouse,
 441                    long start, long end)
 442         : wxCommandEvent(wxEVT_COMMAND_TEXT_URL, winid)
 443         , m_evtMouse(evtMouse), m_start(start), m_end(end)
 444         { }
 445
 446     // get the mouse event which happend over the URL
 447     const wxMouseEvent& GetMouseEvent() const { return m_evtMouse; }
 448
 449     // get the start of the URL
 450     long GetURLStart() const { return m_start; }
 451
 452     // get the end of the URL
 453     long GetURLEnd() const { return m_end; }
 454
 455 protected:
 456     // the corresponding mouse event
 457     wxMouseEvent m_evtMouse;
 458
 459     // the start and end indices of the URL in the text control
 460     long m_start,
 461          m_end;
 462
 463 private:
 464     DECLARE_DYNAMIC_CLASS_NO_COPY(wxTextUrlEvent)
 465
 466 public:
 467     // for wxWin RTTI only, don't use
 468     wxTextUrlEvent() : m_evtMouse(), m_start(0), m_end(0) { }
 469 };
 470
 471 typedef void (wxEvtHandler::*wxTextUrlEventFunction)(wxTextUrlEvent&);
 472
 473 #define EVT_TEXT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_UPDATED, id, wxID_ANY, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxCommandEventFunction, & fn ), (wxObject *) NULL ),
 474 #define EVT_TEXT_ENTER(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_ENTER, id, wxID_ANY, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxCommandEventFunction, & fn ), (wxObject *) NULL ),
 475 #define EVT_TEXT_URL(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_URL, id, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction)  wxStaticCastEvent( wxTextUrlEventFunction, & fn ), (wxObject *) NULL ),
 476 #define EVT_TEXT_MAXLEN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_MAXLEN, id, wxID_ANY, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxCommandEventFunction, & fn ), (wxObject *) NULL ),
 477
 478 #ifndef NO_TEXT_WINDOW_STREAM
 479
 480 // ----------------------------------------------------------------------------
 481 // wxStreamToTextRedirector: this class redirects all data sent to the given
 482 // C++ stream to the wxTextCtrl given to its ctor during its lifetime.
 483 // ----------------------------------------------------------------------------
 484
 485 class WXDLLEXPORT wxStreamToTextRedirector
 486 {
 487 private:
 488     void Init(wxTextCtrl *text)
 489     {
 490         m_sbufOld = m_ostr.rdbuf();
 491         m_ostr.rdbuf(text);
 492     }
 493
 494 public:
 495     wxStreamToTextRedirector(wxTextCtrl *text)
 496         : m_ostr(wxSTD cout)
 497     {
 498         Init(text);
 499     }
 500
 501     wxStreamToTextRedirector(wxTextCtrl *text, wxSTD ostream *ostr)
 502         : m_ostr(*ostr)
 503     {
 504         Init(text);
 505     }
 506
 507     ~wxStreamToTextRedirector()
 508     {
 509         m_ostr.rdbuf(m_sbufOld);
 510     }
 511
 512 private:
 513     // the stream we're redirecting
 514     wxSTD ostream&   m_ostr;
 515
 516     // the old streambuf (before we changed it)
 517     wxSTD streambuf *m_sbufOld;
 518 };
 519
 520 #endif // !NO_TEXT_WINDOW_STREAM
 521
 522 #endif // wxUSE_TEXTCTRL
 523
 524 #endif
 525     // _WX_TEXTCTRL_H_BASE_