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__) || defined(_WINDLL) || defined(WXUSINGDLL) || defined(WXMAKINGDLL)
  34     #define NO_TEXT_WINDOW_STREAM
  35 #endif
  36
  37 // the streambuf which is used in the declaration of wxTextCtrlBase below is not compatible
  38 // with the standard-conforming implementation found in newer egcs versions
  39 // (that is, the libstdc++ v3 that is shipped with it)
  40 #if defined(__GNUC__)&&( (__GNUC__>2) ||( (__GNUC__==2)&&(__GNUC_MINOR__>97) ) )
  41     #define NO_TEXT_WINDOW_STREAM
  42 #endif
  43
  44 #ifndef NO_TEXT_WINDOW_STREAM
  45     #if wxUSE_STD_IOSTREAM
  46         #include "wx/ioswrap.h"    // for iostream classes if we need them
  47     #else // !wxUSE_STD_IOSTREAM
  48         // can't compile this feature in if we don't use streams at all
  49         #define NO_TEXT_WINDOW_STREAM
  50     #endif // wxUSE_STD_IOSTREAM/!wxUSE_STD_IOSTREAM
  51 #endif
  52
  53 class WXDLLEXPORT wxTextCtrl;
  54
  55 // ----------------------------------------------------------------------------
  56 // constants
  57 // ----------------------------------------------------------------------------
  58
  59 WXDLLEXPORT_DATA(extern const wxChar*) wxTextCtrlNameStr;
  60 WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
  61
  62 // ----------------------------------------------------------------------------
  63 // wxTextCtrl style flags
  64 // ----------------------------------------------------------------------------
  65
  66 // the flag bits 0x0001, 2, 4 and 8 are free but should be used only for the
  67 // things which don't make sense for a text control used by wxTextEntryDialog
  68 // because they would otherwise conflict with wxOK, wxCANCEL, wxCENTRE
  69 #define wxTE_READONLY       0x0010
  70 #define wxTE_MULTILINE      0x0020
  71 #define wxTE_PROCESS_TAB    0x0040
  72
  73 // this style means to use RICHEDIT control and does something only under wxMSW
  74 // and Win32 and is silently ignored under all other platforms
  75 #define wxTE_RICH           0x0080
  76 #define wxTE_NO_VSCROLL     0x0100
  77 #define wxTE_AUTO_SCROLL    0x0200
  78 #define wxTE_PROCESS_ENTER  0x0400
  79 #define wxTE_PASSWORD       0x0800
  80
  81 // automatically detect the URLs and generate the events when mouse is
  82 // moved/clicked over an URL
  83 //
  84 // this is for Win32 richedit controls only so far
  85 #define wxTE_AUTO_URL       0x1000
  86
  87 // by default, the Windows text control doesn't show the selection when it
  88 // doesn't have focus - use this style to force it to always show it
  89 #define wxTE_NOHIDESEL      0x2000
  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     // operations
 167     // ----------
 168
 169     // editing
 170     virtual void Clear() = 0;
 171     virtual void Replace(long from, long to, const wxString& value) = 0;
 172     virtual void Remove(long from, long to) = 0;
 173
 174     // load/save the controls contents from/to the file
 175     virtual bool LoadFile(const wxString& file);
 176     virtual bool SaveFile(const wxString& file = wxEmptyString);
 177
 178     // clears the dirty flag
 179     virtual void DiscardEdits() = 0;
 180
 181     // set the max number of characters which may be entered in a single line
 182     // text control
 183     virtual void SetMaxLength(unsigned long WXUNUSED(len)) { }
 184
 185     // writing text inserts it at the current position, appending always
 186     // inserts it at the end
 187     virtual void WriteText(const wxString& text) = 0;
 188     virtual void AppendText(const wxString& text) = 0;
 189
 190     // text control under some platforms supports the text styles: these
 191     // methods allow to apply the given text style to the given selection or to
 192     // set/get the style which will be used for all appended text
 193     virtual bool SetStyle(long start, long end, const wxTextAttr& style);
 194     virtual bool SetDefaultStyle(const wxTextAttr& style);
 195     virtual const wxTextAttr& GetDefaultStyle() const;
 196
 197     // translate between the position (which is just an index in the text ctrl
 198     // considering all its contents as a single strings) and (x, y) coordinates
 199     // which represent column and line.
 200     virtual long XYToPosition(long x, long y) const = 0;
 201     virtual bool PositionToXY(long pos, long *x, long *y) const = 0;
 202
 203     virtual void ShowPosition(long pos) = 0;
 204
 205     // Clipboard operations
 206     virtual void Copy() = 0;
 207     virtual void Cut() = 0;
 208     virtual void Paste() = 0;
 209
 210     virtual bool CanCopy() const;
 211     virtual bool CanCut() const;
 212     virtual bool CanPaste() const;
 213
 214     // Undo/redo
 215     virtual void Undo() = 0;
 216     virtual void Redo() = 0;
 217
 218     virtual bool CanUndo() const = 0;
 219     virtual bool CanRedo() const = 0;
 220
 221     // Insertion point
 222     virtual void SetInsertionPoint(long pos) = 0;
 223     virtual void SetInsertionPointEnd() = 0;
 224     virtual long GetInsertionPoint() const = 0;
 225     virtual long GetLastPosition() const = 0;
 226
 227     virtual void SetSelection(long from, long to) = 0;
 228     virtual void SelectAll();
 229     virtual void SetEditable(bool editable) = 0;
 230
 231     // streambuf methods
 232 #ifndef NO_TEXT_WINDOW_STREAM
 233     int overflow(int i);
 234     int sync();
 235     int underflow();
 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 private:
 261 #ifndef NO_TEXT_WINDOW_STREAM
 262 #if !wxUSE_IOSTREAMH
 263     char *m_streambuf;
 264 #endif
 265 #endif
 266 };
 267
 268 // ----------------------------------------------------------------------------
 269 // include the platform-dependent class definition
 270 // ----------------------------------------------------------------------------
 271
 272 #if defined(__WXUNIVERSAL__)
 273     #include "wx/univ/textctrl.h"
 274 #elif defined(__WXMSW__)
 275     #include "wx/msw/textctrl.h"
 276 #elif defined(__WXMOTIF__)
 277     #include "wx/motif/textctrl.h"
 278 #elif defined(__WXGTK__)
 279     #include "wx/gtk/textctrl.h"
 280 #elif defined(__WXMAC__)
 281     #include "wx/mac/textctrl.h"
 282 #elif defined(__WXPM__)
 283     #include "wx/os2/textctrl.h"
 284 #elif defined(__WXSTUBS__)
 285     #include "wx/stubs/textctrl.h"
 286 #endif
 287
 288 // ----------------------------------------------------------------------------
 289 // wxTextCtrl events
 290 // ----------------------------------------------------------------------------
 291
 292 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
 293
 294 BEGIN_DECLARE_EVENT_TYPES()
 295     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_UPDATED, 7)
 296     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_ENTER, 8)
 297     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_URL, 13)
 298     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_MAXLEN, 14)
 299 END_DECLARE_EVENT_TYPES()
 300
 301 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
 302
 303 class WXDLLEXPORT wxTextUrlEvent : public wxCommandEvent
 304 {
 305 public:
 306     wxTextUrlEvent(int id, const wxMouseEvent& evtMouse,
 307                    long start, long end)
 308         : wxCommandEvent(wxEVT_COMMAND_TEXT_URL, id),
 309           m_evtMouse(evtMouse)
 310         { m_start = start; m_end = end; }
 311
 312     // get the mouse event which happend over the URL
 313     const wxMouseEvent& GetMouseEvent() const { return m_evtMouse; }
 314
 315     // get the start of the URL
 316     long GetURLStart() const { return m_start; }
 317
 318     // get the end of the URL
 319     long GetURLEnd() const { return m_end; }
 320
 321 protected:
 322     // the corresponding mouse event
 323     wxMouseEvent m_evtMouse;
 324
 325     // the start and end indices of the URL in the text control
 326     long m_start,
 327          m_end;
 328
 329 private:
 330     DECLARE_DYNAMIC_CLASS(wxTextUrlEvent)
 331
 332 public:
 333     // for wxWin RTTI only, don't use
 334     wxTextUrlEvent() { }
 335 };
 336
 337 typedef void (wxEvtHandler::*wxTextUrlEventFunction)(wxTextUrlEvent&);
 338
 339 #define EVT_TEXT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
 340 #define EVT_TEXT_ENTER(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
 341 #define EVT_TEXT_URL(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_URL, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxTextUrlEventFunction) & fn, (wxObject *) NULL ),
 342 #define EVT_TEXT_MAXLEN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_MAXLEN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
 343
 344 #endif // wxUSE_TEXTCTRL
 345
 346 #endif
 347     // _WX_TEXTCTRL_H_BASE_