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
  49 // ----------------------------------------------------------------------------
  50 // constants
  51 // ----------------------------------------------------------------------------
  52
  53 WXDLLEXPORT_DATA(extern const wxChar*) wxTextCtrlNameStr;
  54 WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
  55
  56 // ----------------------------------------------------------------------------
  57 // wxTextCtrl style flags
  58 // ----------------------------------------------------------------------------
  59
  60 // the flag bits 0x0001, 2, 4 and 8 are free but should be used only for the
  61 // things which don't make sense for a text control used by wxTextEntryDialog
  62 // because they would otherwise conflict with wxOK, wxCANCEL, wxCENTRE
  63 #define wxTE_READONLY       0x0010
  64 #define wxTE_MULTILINE      0x0020
  65 #define wxTE_PROCESS_TAB    0x0040
  66
  67 // this style means to use RICHEDIT control and does something only under wxMSW
  68 // and Win32 and is silently ignored under all other platforms
  69 #define wxTE_RICH           0x0080
  70 #define wxTE_NO_VSCROLL     0x0100
  71 #define wxTE_AUTO_SCROLL    0x0200
  72 #define wxTE_PROCESS_ENTER  0x0400
  73 #define wxTE_PASSWORD       0x0800
  74
  75 // automatically detect the URLs and generate the events when mouse is
  76 // moved/clicked over an URL
  77 //
  78 // this is for Win32 richedit controls only so far
  79 #define wxTE_AUTO_URL       0x1000
  80
  81 // by default, the Windows text control doesn't show the selection when it
  82 // doesn't have focus - use this style to force it to always show it
  83 #define wxTE_NOHIDESEL      0x2000
  84
  85 // use wxHSCROLL to not wrap text at all, wxTE_LINEWRAP to wrap it at any
  86 // position and wxTE_WORDWRAP to wrap at words boundary
  87 #define wxTE_DONTWRAP       wxHSCROLL
  88 #define wxTE_LINEWRAP       0x4000
  89 #define wxTE_WORDWRAP       0x0000  // it's just == !wxHSCROLL
  90
  91 // ----------------------------------------------------------------------------
  92 // wxTextAttr: a structure containing the visual attributes of a text
  93 // ----------------------------------------------------------------------------
  94
  95 class WXDLLEXPORT wxTextAttr
  96 {
  97 public:
  98     // ctors
  99     wxTextAttr() { }
 100     wxTextAttr(const wxColour& colText,
 101                const wxColour& colBack = wxNullColour,
 102                const wxFont& font = wxNullFont)
 103         : m_colText(colText), m_colBack(colBack), m_font(font) { }
 104
 105     // setters
 106     void SetTextColour(const wxColour& colText) { m_colText = colText; }
 107     void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; }
 108     void SetFont(const wxFont& font) { m_font = font; }
 109
 110     // accessors
 111     bool HasTextColour() const { return m_colText.Ok(); }
 112     bool HasBackgroundColour() const { return m_colBack.Ok(); }
 113     bool HasFont() const { return m_font.Ok(); }
 114
 115     // setters
 116     const wxColour& GetTextColour() const { return m_colText; }
 117     const wxColour& GetBackgroundColour() const { return m_colBack; }
 118     const wxFont& GetFont() const { return m_font; }
 119
 120     // returns false if we have any attributes set, true otherwise
 121     bool IsDefault() const
 122     {
 123         return !HasTextColour() && !HasBackgroundColour() && !HasFont();
 124     }
 125
 126 private:
 127     wxColour m_colText,
 128              m_colBack;
 129     wxFont   m_font;
 130 };
 131
 132 // ----------------------------------------------------------------------------
 133 // wxTextCtrl: a single or multiple line text zone where user can enter and
 134 // edit text
 135 // ----------------------------------------------------------------------------
 136
 137 class WXDLLEXPORT wxTextCtrlBase : public wxControl
 138 #ifndef NO_TEXT_WINDOW_STREAM
 139                                  , public wxSTD streambuf
 140 #endif
 141
 142 {
 143 public:
 144     // creation
 145     // --------
 146
 147     wxTextCtrlBase();
 148     ~wxTextCtrlBase();
 149
 150     // accessors
 151     // ---------
 152
 153     virtual wxString GetValue() const = 0;
 154     virtual void SetValue(const wxString& value) = 0;
 155
 156     virtual int GetLineLength(long lineNo) const = 0;
 157     virtual wxString GetLineText(long lineNo) const = 0;
 158     virtual int GetNumberOfLines() const = 0;
 159
 160     virtual bool IsModified() const = 0;
 161     virtual bool IsEditable() const = 0;
 162
 163     // If the return values from and to are the same, there is no selection.
 164     virtual void GetSelection(long* from, long* to) const = 0;
 165
 166     virtual wxString GetStringSelection() const;
 167
 168     // operations
 169     // ----------
 170
 171     // editing
 172     virtual void Clear() = 0;
 173     virtual void Replace(long from, long to, const wxString& value) = 0;
 174     virtual void Remove(long from, long to) = 0;
 175
 176     // load/save the controls contents from/to the file
 177     virtual bool LoadFile(const wxString& file);
 178     virtual bool SaveFile(const wxString& file = wxEmptyString);
 179
 180     // clears the dirty flag
 181     virtual void DiscardEdits() = 0;
 182
 183     // set the max number of characters which may be entered in a single line
 184     // text control
 185     virtual void SetMaxLength(unsigned long WXUNUSED(len)) { }
 186
 187     // writing text inserts it at the current position, appending always
 188     // inserts it at the end
 189     virtual void WriteText(const wxString& text) = 0;
 190     virtual void AppendText(const wxString& text) = 0;
 191
 192     // text control under some platforms supports the text styles: these
 193     // methods allow to apply the given text style to the given selection or to
 194     // set/get the style which will be used for all appended text
 195     virtual bool SetStyle(long start, long end, const wxTextAttr& style);
 196     virtual bool SetDefaultStyle(const wxTextAttr& style);
 197     virtual const wxTextAttr& GetDefaultStyle() const;
 198
 199     // translate between the position (which is just an index in the text ctrl
 200     // considering all its contents as a single strings) and (x, y) coordinates
 201     // which represent column and line.
 202     virtual long XYToPosition(long x, long y) const = 0;
 203     virtual bool PositionToXY(long pos, long *x, long *y) const = 0;
 204
 205     virtual void ShowPosition(long pos) = 0;
 206
 207     // Clipboard operations
 208     virtual void Copy() = 0;
 209     virtual void Cut() = 0;
 210     virtual void Paste() = 0;
 211
 212     virtual bool CanCopy() const;
 213     virtual bool CanCut() const;
 214     virtual bool CanPaste() const;
 215
 216     // Undo/redo
 217     virtual void Undo() = 0;
 218     virtual void Redo() = 0;
 219
 220     virtual bool CanUndo() const = 0;
 221     virtual bool CanRedo() const = 0;
 222
 223     // Insertion point
 224     virtual void SetInsertionPoint(long pos) = 0;
 225     virtual void SetInsertionPointEnd() = 0;
 226     virtual long GetInsertionPoint() const = 0;
 227     virtual long GetLastPosition() const = 0;
 228
 229     virtual void SetSelection(long from, long to) = 0;
 230     virtual void SelectAll();
 231     virtual void SetEditable(bool editable) = 0;
 232
 233     // override streambuf method
 234 #ifndef NO_TEXT_WINDOW_STREAM
 235     int overflow(int i);
 236 #endif // NO_TEXT_WINDOW_STREAM
 237
 238     // stream-like insertion operators: these are always available, whether we
 239     // were, or not, compiled with streambuf support
 240     wxTextCtrl& operator<<(const wxString& s);
 241     wxTextCtrl& operator<<(int i);
 242     wxTextCtrl& operator<<(long i);
 243     wxTextCtrl& operator<<(float f);
 244     wxTextCtrl& operator<<(double d);
 245     wxTextCtrl& operator<<(const wxChar c);
 246
 247     // obsolete functions
 248 #if WXWIN_COMPATIBILITY
 249     bool Modified() const { return IsModified(); }
 250 #endif
 251
 252 protected:
 253     // the name of the last file loaded with LoadFile() which will be used by
 254     // SaveFile() by default
 255     wxString m_filename;
 256
 257     // the text style which will be used for any new text added to the control
 258     wxTextAttr m_defaultStyle;
 259 };
 260
 261 // ----------------------------------------------------------------------------
 262 // include the platform-dependent class definition
 263 // ----------------------------------------------------------------------------
 264
 265 #if defined(__WXUNIVERSAL__)
 266     #include "wx/univ/textctrl.h"
 267 #elif defined(__WXMSW__)
 268     #include "wx/msw/textctrl.h"
 269 #elif defined(__WXMOTIF__)
 270     #include "wx/motif/textctrl.h"
 271 #elif defined(__WXGTK__)
 272     #include "wx/gtk/textctrl.h"
 273 #elif defined(__WXMAC__)
 274     #include "wx/mac/textctrl.h"
 275 #elif defined(__WXPM__)
 276     #include "wx/os2/textctrl.h"
 277 #elif defined(__WXSTUBS__)
 278     #include "wx/stubs/textctrl.h"
 279 #endif
 280
 281 // ----------------------------------------------------------------------------
 282 // wxTextCtrl events
 283 // ----------------------------------------------------------------------------
 284
 285 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
 286
 287 BEGIN_DECLARE_EVENT_TYPES()
 288     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_UPDATED, 7)
 289     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_ENTER, 8)
 290     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_URL, 13)
 291     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_MAXLEN, 14)
 292 END_DECLARE_EVENT_TYPES()
 293
 294 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
 295
 296 class WXDLLEXPORT wxTextUrlEvent : public wxCommandEvent
 297 {
 298 public:
 299     wxTextUrlEvent(int id, const wxMouseEvent& evtMouse,
 300                    long start, long end)
 301         : wxCommandEvent(wxEVT_COMMAND_TEXT_URL, id),
 302           m_evtMouse(evtMouse)
 303         { m_start = start; m_end = end; }
 304
 305     // get the mouse event which happend over the URL
 306     const wxMouseEvent& GetMouseEvent() const { return m_evtMouse; }
 307
 308     // get the start of the URL
 309     long GetURLStart() const { return m_start; }
 310
 311     // get the end of the URL
 312     long GetURLEnd() const { return m_end; }
 313
 314 protected:
 315     // the corresponding mouse event
 316     wxMouseEvent m_evtMouse;
 317
 318     // the start and end indices of the URL in the text control
 319     long m_start,
 320          m_end;
 321
 322 private:
 323     DECLARE_DYNAMIC_CLASS(wxTextUrlEvent)
 324
 325 public:
 326     // for wxWin RTTI only, don't use
 327     wxTextUrlEvent() { }
 328 };
 329
 330 typedef void (wxEvtHandler::*wxTextUrlEventFunction)(wxTextUrlEvent&);
 331
 332 #define EVT_TEXT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
 333 #define EVT_TEXT_ENTER(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
 334 #define EVT_TEXT_URL(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_URL, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxTextUrlEventFunction) & fn, (wxObject *) NULL ),
 335 #define EVT_TEXT_MAXLEN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_MAXLEN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
 336
 337 #ifndef NO_TEXT_WINDOW_STREAM
 338
 339 // ----------------------------------------------------------------------------
 340 // wxStreamToTextRedirector: this class redirects all data sent to the given
 341 // C++ stream to the wxTextCtrl given to its ctor during its lifetime.
 342 // ----------------------------------------------------------------------------
 343
 344 class WXDLLEXPORT wxStreamToTextRedirector
 345 {
 346 public:
 347     wxStreamToTextRedirector(wxTextCtrl *text, wxSTD ostream *ostr = NULL)
 348         : m_ostr(ostr ? *ostr : wxSTD cout)
 349     {
 350         m_sbufOld = m_ostr.rdbuf();
 351         m_ostr.rdbuf(text);
 352     }
 353
 354     ~wxStreamToTextRedirector()
 355     {
 356         m_ostr.rdbuf(m_sbufOld);
 357     }
 358
 359 private:
 360     // the stream we're redirecting
 361     wxSTD ostream&   m_ostr;
 362
 363     // the old streambuf (before we changed it)
 364     wxSTD streambuf *m_sbufOld;
 365 };
 366
 367 #endif // !NO_TEXT_WINDOW_STREAM
 368
 369 #endif // wxUSE_TEXTCTRL
 370
 371 #endif
 372     // _WX_TEXTCTRL_H_BASE_