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     // If the return values from and to are the same, there is no selection.
 178     virtual void GetSelection(long* from, long* to) const = 0;
 179
 180     virtual wxString GetStringSelection() const;
 181
 182     // operations
 183     // ----------
 184
 185     // editing
 186     virtual void Clear() = 0;
 187     virtual void Replace(long from, long to, const wxString& value) = 0;
 188     virtual void Remove(long from, long to) = 0;
 189
 190     // load/save the controls contents from/to the file
 191     virtual bool LoadFile(const wxString& file);
 192     virtual bool SaveFile(const wxString& file = wxEmptyString);
 193
 194     // clears the dirty flag
 195     virtual void DiscardEdits() = 0;
 196
 197     // set the max number of characters which may be entered in a single line
 198     // text control
 199     virtual void SetMaxLength(unsigned long WXUNUSED(len)) { }
 200
 201     // writing text inserts it at the current position, appending always
 202     // inserts it at the end
 203     virtual void WriteText(const wxString& text) = 0;
 204     virtual void AppendText(const wxString& text) = 0;
 205
 206     // insert the character which would have resulted from this key event,
 207     // return TRUE if anything has been inserted
 208     virtual bool EmulateKeyPress(const wxKeyEvent& event);
 209
 210     // text control under some platforms supports the text styles: these
 211     // methods allow to apply the given text style to the given selection or to
 212     // set/get the style which will be used for all appended text
 213     virtual bool SetStyle(long start, long end, const wxTextAttr& style);
 214     virtual bool SetDefaultStyle(const wxTextAttr& style);
 215     virtual const wxTextAttr& GetDefaultStyle() const;
 216
 217     // translate between the position (which is just an index in the text ctrl
 218     // considering all its contents as a single strings) and (x, y) coordinates
 219     // which represent column and line.
 220     virtual long XYToPosition(long x, long y) const = 0;
 221     virtual bool PositionToXY(long pos, long *x, long *y) const = 0;
 222
 223     virtual void ShowPosition(long pos) = 0;
 224
 225     // Clipboard operations
 226     virtual void Copy() = 0;
 227     virtual void Cut() = 0;
 228     virtual void Paste() = 0;
 229
 230     virtual bool CanCopy() const;
 231     virtual bool CanCut() const;
 232     virtual bool CanPaste() const;
 233
 234     // Undo/redo
 235     virtual void Undo() = 0;
 236     virtual void Redo() = 0;
 237
 238     virtual bool CanUndo() const = 0;
 239     virtual bool CanRedo() const = 0;
 240
 241     // Insertion point
 242     virtual void SetInsertionPoint(long pos) = 0;
 243     virtual void SetInsertionPointEnd() = 0;
 244     virtual long GetInsertionPoint() const = 0;
 245     virtual long GetLastPosition() const = 0;
 246
 247     virtual void SetSelection(long from, long to) = 0;
 248     virtual void SelectAll();
 249     virtual void SetEditable(bool editable) = 0;
 250
 251     // override streambuf method
 252 #ifndef NO_TEXT_WINDOW_STREAM
 253     int overflow(int i);
 254 #endif // NO_TEXT_WINDOW_STREAM
 255
 256     // stream-like insertion operators: these are always available, whether we
 257     // were, or not, compiled with streambuf support
 258     wxTextCtrl& operator<<(const wxString& s);
 259     wxTextCtrl& operator<<(int i);
 260     wxTextCtrl& operator<<(long i);
 261     wxTextCtrl& operator<<(float f);
 262     wxTextCtrl& operator<<(double d);
 263     wxTextCtrl& operator<<(const wxChar c);
 264
 265     // obsolete functions
 266 #if WXWIN_COMPATIBILITY
 267     bool Modified() const { return IsModified(); }
 268 #endif
 269
 270 protected:
 271     // the name of the last file loaded with LoadFile() which will be used by
 272     // SaveFile() by default
 273     wxString m_filename;
 274
 275     // the text style which will be used for any new text added to the control
 276     wxTextAttr m_defaultStyle;
 277 };
 278
 279 // ----------------------------------------------------------------------------
 280 // include the platform-dependent class definition
 281 // ----------------------------------------------------------------------------
 282
 283 #if defined(__WXX11__)
 284     #include "wx/x11/textctrl.h"
 285 #elif defined(__WXUNIVERSAL__)
 286     #include "wx/univ/textctrl.h"
 287 #elif defined(__WXMSW__)
 288     #include "wx/msw/textctrl.h"
 289 #elif defined(__WXMOTIF__)
 290     #include "wx/motif/textctrl.h"
 291 #elif defined(__WXGTK__)
 292     #include "wx/gtk/textctrl.h"
 293 #elif defined(__WXMAC__)
 294     #include "wx/mac/textctrl.h"
 295 #elif defined(__WXPM__)
 296     #include "wx/os2/textctrl.h"
 297 #elif defined(__WXSTUBS__)
 298     #include "wx/stubs/textctrl.h"
 299 #endif
 300
 301 // ----------------------------------------------------------------------------
 302 // wxTextCtrl events
 303 // ----------------------------------------------------------------------------
 304
 305 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
 306
 307 BEGIN_DECLARE_EVENT_TYPES()
 308     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_UPDATED, 7)
 309     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_ENTER, 8)
 310     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_URL, 13)
 311     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_MAXLEN, 14)
 312 END_DECLARE_EVENT_TYPES()
 313
 314 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
 315
 316 class WXDLLEXPORT wxTextUrlEvent : public wxCommandEvent
 317 {
 318 public:
 319     wxTextUrlEvent(int id, const wxMouseEvent& evtMouse,
 320                    long start, long end)
 321         : wxCommandEvent(wxEVT_COMMAND_TEXT_URL, id),
 322           m_evtMouse(evtMouse)
 323         { m_start = start; m_end = end; }
 324
 325     // get the mouse event which happend over the URL
 326     const wxMouseEvent& GetMouseEvent() const { return m_evtMouse; }
 327
 328     // get the start of the URL
 329     long GetURLStart() const { return m_start; }
 330
 331     // get the end of the URL
 332     long GetURLEnd() const { return m_end; }
 333
 334 protected:
 335     // the corresponding mouse event
 336     wxMouseEvent m_evtMouse;
 337
 338     // the start and end indices of the URL in the text control
 339     long m_start,
 340          m_end;
 341
 342 private:
 343     DECLARE_DYNAMIC_CLASS(wxTextUrlEvent)
 344
 345 public:
 346     // for wxWin RTTI only, don't use
 347     wxTextUrlEvent() { }
 348 };
 349
 350 typedef void (wxEvtHandler::*wxTextUrlEventFunction)(wxTextUrlEvent&);
 351
 352 #define EVT_TEXT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
 353 #define EVT_TEXT_ENTER(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
 354 #define EVT_TEXT_URL(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_URL, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxTextUrlEventFunction) & fn, (wxObject *) NULL ),
 355 #define EVT_TEXT_MAXLEN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_MAXLEN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
 356
 357 #ifndef NO_TEXT_WINDOW_STREAM
 358
 359 // ----------------------------------------------------------------------------
 360 // wxStreamToTextRedirector: this class redirects all data sent to the given
 361 // C++ stream to the wxTextCtrl given to its ctor during its lifetime.
 362 // ----------------------------------------------------------------------------
 363
 364 class WXDLLEXPORT wxStreamToTextRedirector
 365 {
 366 public:
 367     wxStreamToTextRedirector(wxTextCtrl *text, wxSTD ostream *ostr = NULL)
 368         : m_ostr(ostr ? *ostr : wxSTD cout)
 369     {
 370         m_sbufOld = m_ostr.rdbuf();
 371         m_ostr.rdbuf(text);
 372     }
 373
 374     ~wxStreamToTextRedirector()
 375     {
 376         m_ostr.rdbuf(m_sbufOld);
 377     }
 378
 379 private:
 380     // the stream we're redirecting
 381     wxSTD ostream&   m_ostr;
 382
 383     // the old streambuf (before we changed it)
 384     wxSTD streambuf *m_sbufOld;
 385 };
 386
 387 #endif // !NO_TEXT_WINDOW_STREAM
 388
 389 #endif // wxUSE_TEXTCTRL
 390
 391 #endif
 392     // _WX_TEXTCTRL_H_BASE_