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