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