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