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