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