make access specifiers for the virtual functions match their access in the base class...
[wxWidgets.git] / 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) Vadim Zeitlin
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 #include "wx/defs.h"
20
21 #if wxUSE_TEXTCTRL
22
23 #include "wx/control.h" // the base class
24 #include "wx/dynarray.h" // wxArrayInt
25 #include "wx/gdicmn.h" // wxPoint
26
27 // Open Watcom 1.3 does allow only ios::rdbuf() while
28 // we want something with streambuf parameter
29 // Also, can't use streambuf if making or using a DLL :-(
30
31 #if defined(__WATCOMC__) || \
32 defined(__MWERKS__) || \
33 (defined(__WINDOWS__) && (defined(WXUSINGDLL) || defined(WXMAKINGDLL)))
34 #define wxHAS_TEXT_WINDOW_STREAM 0
35 #elif wxUSE_STD_IOSTREAM
36 #include "wx/ioswrap.h"
37 #define wxHAS_TEXT_WINDOW_STREAM 1
38 #else
39 #define wxHAS_TEXT_WINDOW_STREAM 0
40 #endif
41
42 #if WXWIN_COMPATIBILITY_2_4 && !wxHAS_TEXT_WINDOW_STREAM
43 // define old flag if one could use it somewhere
44 #define NO_TEXT_WINDOW_STREAM
45 #endif
46
47 class WXDLLEXPORT wxTextCtrl;
48 class WXDLLEXPORT wxTextCtrlBase;
49
50 // ----------------------------------------------------------------------------
51 // wxTextCtrl types
52 // ----------------------------------------------------------------------------
53
54 // wxTextPos is the position in the text
55 typedef long wxTextPos;
56
57 // wxTextCoord is the line or row number (which should have been unsigned but
58 // is long for backwards compatibility)
59 typedef long wxTextCoord;
60
61 // ----------------------------------------------------------------------------
62 // constants
63 // ----------------------------------------------------------------------------
64
65 extern WXDLLEXPORT_DATA(const wxChar) wxTextCtrlNameStr[];
66
67 // this is intentionally not enum to avoid warning fixes with
68 // typecasting from enum type to wxTextCoord
69 const wxTextCoord wxOutOfRangeTextCoord = -1;
70 const wxTextCoord wxInvalidTextCoord = -2;
71
72 // ----------------------------------------------------------------------------
73 // wxTextCtrl style flags
74 // ----------------------------------------------------------------------------
75
76 // the flag bit 0x0001 s free but should be used only for the things which
77 // don't make sense for a text control used by wxTextEntryDialog because they
78 // would otherwise conflict with wxOK, wxCANCEL, wxCENTRE
79
80 #define wxTE_NO_VSCROLL 0x0002
81 #define wxTE_AUTO_SCROLL 0x0008
82
83 #define wxTE_READONLY 0x0010
84 #define wxTE_MULTILINE 0x0020
85 #define wxTE_PROCESS_TAB 0x0040
86
87 // alignment flags
88 #define wxTE_LEFT 0x0000 // 0x0000
89 #define wxTE_CENTER wxALIGN_CENTER_HORIZONTAL // 0x0100
90 #define wxTE_RIGHT wxALIGN_RIGHT // 0x0200
91 #define wxTE_CENTRE wxTE_CENTER
92
93 // this style means to use RICHEDIT control and does something only under wxMSW
94 // and Win32 and is silently ignored under all other platforms
95 #define wxTE_RICH 0x0080
96
97 #define wxTE_PROCESS_ENTER 0x0400
98 #define wxTE_PASSWORD 0x0800
99
100 // automatically detect the URLs and generate the events when mouse is
101 // moved/clicked over an URL
102 //
103 // this is for Win32 richedit and wxGTK2 multiline controls only so far
104 #define wxTE_AUTO_URL 0x1000
105
106 // by default, the Windows text control doesn't show the selection when it
107 // doesn't have focus - use this style to force it to always show it
108 #define wxTE_NOHIDESEL 0x2000
109
110 // use wxHSCROLL to not wrap text at all, wxTE_CHARWRAP to wrap it at any
111 // position and wxTE_WORDWRAP to wrap at words boundary
112 //
113 // if no wrapping style is given at all, the control wraps at word boundary
114 #define wxTE_DONTWRAP wxHSCROLL
115 #define wxTE_CHARWRAP 0x4000 // wrap at any position
116 #define wxTE_WORDWRAP 0x0001 // wrap only at words boundaries
117 #define wxTE_BESTWRAP 0x0000 // this is the default
118
119 // obsolete synonym
120 #define wxTE_LINEWRAP wxTE_CHARWRAP
121
122 // force using RichEdit version 2.0 or 3.0 instead of 1.0 (default) for
123 // wxTE_RICH controls - can be used together with or instead of wxTE_RICH
124 #define wxTE_RICH2 0x8000
125
126 // reuse wxTE_RICH2's value for CAPEDIT control on Windows CE
127 #if defined(__SMARTPHONE__) || defined(__POCKETPC__)
128 #define wxTE_CAPITALIZE wxTE_RICH2
129 #else
130 #define wxTE_CAPITALIZE 0
131 #endif
132
133 // ----------------------------------------------------------------------------
134 // wxTextCtrl::HitTest return values
135 // ----------------------------------------------------------------------------
136
137 // the point asked is ...
138 enum wxTextCtrlHitTestResult
139 {
140 wxTE_HT_UNKNOWN = -2, // this means HitTest() is simply not implemented
141 wxTE_HT_BEFORE, // either to the left or upper
142 wxTE_HT_ON_TEXT, // directly on
143 wxTE_HT_BELOW, // below [the last line]
144 wxTE_HT_BEYOND // after [the end of line]
145 };
146 // ... the character returned
147
148 // ----------------------------------------------------------------------------
149 // Types for wxTextAttr
150 // ----------------------------------------------------------------------------
151
152 // Alignment
153
154 enum wxTextAttrAlignment
155 {
156 wxTEXT_ALIGNMENT_DEFAULT,
157 wxTEXT_ALIGNMENT_LEFT,
158 wxTEXT_ALIGNMENT_CENTRE,
159 wxTEXT_ALIGNMENT_CENTER = wxTEXT_ALIGNMENT_CENTRE,
160 wxTEXT_ALIGNMENT_RIGHT,
161 wxTEXT_ALIGNMENT_JUSTIFIED
162 };
163
164 // Flags to indicate which attributes are being applied
165
166 #define wxTEXT_ATTR_TEXT_COLOUR 0x0001
167 #define wxTEXT_ATTR_BACKGROUND_COLOUR 0x0002
168 #define wxTEXT_ATTR_FONT_FACE 0x0004
169 #define wxTEXT_ATTR_FONT_SIZE 0x0008
170 #define wxTEXT_ATTR_FONT_WEIGHT 0x0010
171 #define wxTEXT_ATTR_FONT_ITALIC 0x0020
172 #define wxTEXT_ATTR_FONT_UNDERLINE 0x0040
173 #define wxTEXT_ATTR_FONT \
174 ( wxTEXT_ATTR_FONT_FACE | wxTEXT_ATTR_FONT_SIZE | wxTEXT_ATTR_FONT_WEIGHT | \
175 wxTEXT_ATTR_FONT_ITALIC | wxTEXT_ATTR_FONT_UNDERLINE )
176 #define wxTEXT_ATTR_ALIGNMENT 0x0080
177 #define wxTEXT_ATTR_LEFT_INDENT 0x0100
178 #define wxTEXT_ATTR_RIGHT_INDENT 0x0200
179 #define wxTEXT_ATTR_TABS 0x0400
180
181 // ----------------------------------------------------------------------------
182 // wxTextAttr: a structure containing the visual attributes of a text
183 // ----------------------------------------------------------------------------
184
185 class WXDLLEXPORT wxTextAttr
186 {
187 public:
188 // ctors
189 wxTextAttr() { Init(); }
190 wxTextAttr(const wxColour& colText,
191 const wxColour& colBack = wxNullColour,
192 const wxFont& font = wxNullFont,
193 wxTextAttrAlignment alignment = wxTEXT_ALIGNMENT_DEFAULT);
194
195 // operations
196 void Init();
197
198 // operators
199 void operator= (const wxTextAttr& attr);
200
201 // setters
202 void SetTextColour(const wxColour& colText) { m_colText = colText; m_flags |= wxTEXT_ATTR_TEXT_COLOUR; }
203 void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; m_flags |= wxTEXT_ATTR_BACKGROUND_COLOUR; }
204 void SetFont(const wxFont& font, long flags = wxTEXT_ATTR_FONT) { m_font = font; m_flags |= flags; }
205 void SetAlignment(wxTextAttrAlignment alignment) { m_textAlignment = alignment; m_flags |= wxTEXT_ATTR_ALIGNMENT; }
206 void SetTabs(const wxArrayInt& tabs) { m_tabs = tabs; m_flags |= wxTEXT_ATTR_TABS; }
207 void SetLeftIndent(int indent, int subIndent = 0) { m_leftIndent = indent; m_leftSubIndent = subIndent; m_flags |= wxTEXT_ATTR_LEFT_INDENT; }
208 void SetRightIndent(int indent) { m_rightIndent = indent; m_flags |= wxTEXT_ATTR_RIGHT_INDENT; }
209 void SetFlags(long flags) { m_flags = flags; }
210
211 // accessors
212 bool HasTextColour() const { return m_colText.Ok() && HasFlag(wxTEXT_ATTR_TEXT_COLOUR) ; }
213 bool HasBackgroundColour() const { return m_colBack.Ok() && HasFlag(wxTEXT_ATTR_BACKGROUND_COLOUR) ; }
214 bool HasFont() const { return m_font.Ok() && HasFlag(wxTEXT_ATTR_FONT) ; }
215 bool HasAlignment() const { return (m_textAlignment != wxTEXT_ALIGNMENT_DEFAULT) || ((m_flags & wxTEXT_ATTR_ALIGNMENT) != 0) ; }
216 bool HasTabs() const { return (m_flags & wxTEXT_ATTR_TABS) != 0 ; }
217 bool HasLeftIndent() const { return (m_flags & wxTEXT_ATTR_LEFT_INDENT) != 0 ; }
218 bool HasRightIndent() const { return (m_flags & wxTEXT_ATTR_RIGHT_INDENT) != 0 ; }
219 bool HasFlag(long flag) const { return (m_flags & flag) != 0; }
220
221 const wxColour& GetTextColour() const { return m_colText; }
222 const wxColour& GetBackgroundColour() const { return m_colBack; }
223 const wxFont& GetFont() const { return m_font; }
224 wxTextAttrAlignment GetAlignment() const { return m_textAlignment; }
225 const wxArrayInt& GetTabs() const { return m_tabs; }
226 long GetLeftIndent() const { return m_leftIndent; }
227 long GetLeftSubIndent() const { return m_leftSubIndent; }
228 long GetRightIndent() const { return m_rightIndent; }
229 long GetFlags() const { return m_flags; }
230
231 // returns false if we have any attributes set, true otherwise
232 bool IsDefault() const
233 {
234 return !HasTextColour() && !HasBackgroundColour() && !HasFont() && !HasAlignment() &&
235 !HasTabs() && !HasLeftIndent() && !HasRightIndent() ;
236 }
237
238 // return the attribute having the valid font and colours: it uses the
239 // attributes set in attr and falls back first to attrDefault and then to
240 // the text control font/colours for those attributes which are not set
241 static wxTextAttr Combine(const wxTextAttr& attr,
242 const wxTextAttr& attrDef,
243 const wxTextCtrlBase *text);
244
245 private:
246 long m_flags;
247 wxColour m_colText,
248 m_colBack;
249 wxFont m_font;
250 wxTextAttrAlignment m_textAlignment;
251 wxArrayInt m_tabs; // array of int: tab stops in 1/10 mm
252 int m_leftIndent; // left indent in 1/10 mm
253 int m_leftSubIndent; // left indent for all but the first
254 // line in a paragraph relative to the
255 // first line, in 1/10 mm
256 int m_rightIndent; // right indent in 1/10 mm
257 };
258
259 // ----------------------------------------------------------------------------
260 // wxTextCtrl: a single or multiple line text zone where user can enter and
261 // edit text
262 // ----------------------------------------------------------------------------
263
264 class WXDLLEXPORT wxTextCtrlBase : public wxControl
265 #if wxHAS_TEXT_WINDOW_STREAM
266 , public wxSTD streambuf
267 #endif
268
269 {
270 public:
271 // creation
272 // --------
273
274 wxTextCtrlBase(){}
275 ~wxTextCtrlBase(){}
276
277 // accessors
278 // ---------
279
280 virtual wxString GetValue() const = 0;
281 virtual void SetValue(const wxString& value) = 0;
282
283 virtual wxString GetRange(long from, long to) const;
284
285 virtual int GetLineLength(long lineNo) const = 0;
286 virtual wxString GetLineText(long lineNo) const = 0;
287 virtual int GetNumberOfLines() const = 0;
288
289 virtual bool IsModified() const = 0;
290 virtual bool IsEditable() const = 0;
291
292 // more readable flag testing methods
293 bool IsSingleLine() const { return !HasFlag(wxTE_MULTILINE); }
294 bool IsMultiLine() const { return !IsSingleLine(); }
295
296 // If the return values from and to are the same, there is no selection.
297 virtual void GetSelection(long* from, long* to) const = 0;
298
299 virtual wxString GetStringSelection() const;
300
301 // operations
302 // ----------
303
304 // editing
305 virtual void Clear() = 0;
306 virtual void Replace(long from, long to, const wxString& value) = 0;
307 virtual void Remove(long from, long to) = 0;
308
309 // load/save the controls contents from/to the file
310 virtual bool LoadFile(const wxString& file);
311 virtual bool SaveFile(const wxString& file = wxEmptyString);
312
313 // sets/clears the dirty flag
314 virtual void MarkDirty() = 0;
315 virtual void DiscardEdits() = 0;
316
317 // set the max number of characters which may be entered in a single line
318 // text control
319 virtual void SetMaxLength(unsigned long WXUNUSED(len)) { }
320
321 // writing text inserts it at the current position, appending always
322 // inserts it at the end
323 virtual void WriteText(const wxString& text) = 0;
324 virtual void AppendText(const wxString& text) = 0;
325
326 // insert the character which would have resulted from this key event,
327 // return true if anything has been inserted
328 virtual bool EmulateKeyPress(const wxKeyEvent& event);
329
330 // text control under some platforms supports the text styles: these
331 // methods allow to apply the given text style to the given selection or to
332 // set/get the style which will be used for all appended text
333 virtual bool SetStyle(long start, long end, const wxTextAttr& style);
334 virtual bool GetStyle(long position, wxTextAttr& style);
335 virtual bool SetDefaultStyle(const wxTextAttr& style);
336 virtual const wxTextAttr& GetDefaultStyle() const;
337
338 // translate between the position (which is just an index in the text ctrl
339 // considering all its contents as a single strings) and (x, y) coordinates
340 // which represent column and line.
341 virtual long XYToPosition(long x, long y) const = 0;
342 virtual bool PositionToXY(long pos, long *x, long *y) const = 0;
343
344 virtual void ShowPosition(long pos) = 0;
345
346 // find the character at position given in pixels
347 //
348 // NB: pt is in device coords (not adjusted for the client area origin nor
349 // scrolling)
350 virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
351 virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
352 wxTextCoord *col,
353 wxTextCoord *row) const;
354
355 // Clipboard operations
356 virtual void Copy() = 0;
357 virtual void Cut() = 0;
358 virtual void Paste() = 0;
359
360 virtual bool CanCopy() const;
361 virtual bool CanCut() const;
362 virtual bool CanPaste() const;
363
364 // Undo/redo
365 virtual void Undo() = 0;
366 virtual void Redo() = 0;
367
368 virtual bool CanUndo() const = 0;
369 virtual bool CanRedo() const = 0;
370
371 // Insertion point
372 virtual void SetInsertionPoint(long pos) = 0;
373 virtual void SetInsertionPointEnd() = 0;
374 virtual long GetInsertionPoint() const = 0;
375 virtual wxTextPos GetLastPosition() const = 0;
376
377 virtual void SetSelection(long from, long to) = 0;
378 virtual void SelectAll();
379 virtual void SetEditable(bool editable) = 0;
380
381 // stream-like insertion operators: these are always available, whether we
382 // were, or not, compiled with streambuf support
383 wxTextCtrl& operator<<(const wxString& s);
384 wxTextCtrl& operator<<(int i);
385 wxTextCtrl& operator<<(long i);
386 wxTextCtrl& operator<<(float f);
387 wxTextCtrl& operator<<(double d);
388 wxTextCtrl& operator<<(const wxChar c);
389
390 // do the window-specific processing after processing the update event
391 virtual void DoUpdateWindowUI(wxUpdateUIEvent& event);
392
393 virtual bool ShouldInheritColours() const { return false; }
394
395 protected:
396 // override streambuf method
397 #if wxHAS_TEXT_WINDOW_STREAM
398 int overflow(int i);
399 #endif // wxHAS_TEXT_WINDOW_STREAM
400
401 // the name of the last file loaded with LoadFile() which will be used by
402 // SaveFile() by default
403 wxString m_filename;
404
405 // the text style which will be used for any new text added to the control
406 wxTextAttr m_defaultStyle;
407
408 DECLARE_NO_COPY_CLASS(wxTextCtrlBase)
409 };
410
411 // ----------------------------------------------------------------------------
412 // include the platform-dependent class definition
413 // ----------------------------------------------------------------------------
414
415 #if defined(__WXX11__)
416 #include "wx/x11/textctrl.h"
417 #elif defined(__WXUNIVERSAL__)
418 #include "wx/univ/textctrl.h"
419 #elif defined(__SMARTPHONE__) && defined(__WXWINCE__)
420 #include "wx/msw/wince/textctrlce.h"
421 #elif defined(__WXMSW__)
422 #include "wx/msw/textctrl.h"
423 #elif defined(__WXMOTIF__)
424 #include "wx/motif/textctrl.h"
425 #elif defined(__WXGTK20__)
426 #include "wx/gtk/textctrl.h"
427 #elif defined(__WXGTK__)
428 #include "wx/gtk1/textctrl.h"
429 #elif defined(__WXMAC__)
430 #include "wx/mac/textctrl.h"
431 #elif defined(__WXCOCOA__)
432 #include "wx/cocoa/textctrl.h"
433 #elif defined(__WXPM__)
434 #include "wx/os2/textctrl.h"
435 #endif
436
437 // ----------------------------------------------------------------------------
438 // wxTextCtrl events
439 // ----------------------------------------------------------------------------
440
441 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
442
443 BEGIN_DECLARE_EVENT_TYPES()
444 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_UPDATED, 7)
445 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_ENTER, 8)
446 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_URL, 13)
447 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_MAXLEN, 14)
448 END_DECLARE_EVENT_TYPES()
449
450 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
451
452 class WXDLLEXPORT wxTextUrlEvent : public wxCommandEvent
453 {
454 public:
455 wxTextUrlEvent(int winid, const wxMouseEvent& evtMouse,
456 long start, long end)
457 : wxCommandEvent(wxEVT_COMMAND_TEXT_URL, winid)
458 , m_evtMouse(evtMouse), m_start(start), m_end(end)
459 { }
460
461 // get the mouse event which happend over the URL
462 const wxMouseEvent& GetMouseEvent() const { return m_evtMouse; }
463
464 // get the start of the URL
465 long GetURLStart() const { return m_start; }
466
467 // get the end of the URL
468 long GetURLEnd() const { return m_end; }
469
470 protected:
471 // the corresponding mouse event
472 wxMouseEvent m_evtMouse;
473
474 // the start and end indices of the URL in the text control
475 long m_start,
476 m_end;
477
478 private:
479 DECLARE_DYNAMIC_CLASS_NO_COPY(wxTextUrlEvent)
480
481 public:
482 // for wxWin RTTI only, don't use
483 wxTextUrlEvent() : m_evtMouse(), m_start(0), m_end(0) { }
484 };
485
486 typedef void (wxEvtHandler::*wxTextUrlEventFunction)(wxTextUrlEvent&);
487
488 #define wxTextEventHandler(func) wxCommandEventHandler(func)
489 #define wxTextUrlEventHandler(func) \
490 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxTextUrlEventFunction, &func)
491
492 #define wx__DECLARE_TEXTEVT(evt, id, fn) \
493 wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_ ## evt, id, wxTextEventHandler(fn))
494
495 #define wx__DECLARE_TEXTURLEVT(evt, id, fn) \
496 wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_ ## evt, id, wxTextUrlEventHandler(fn))
497
498 #define EVT_TEXT(id, fn) wx__DECLARE_TEXTEVT(UPDATED, id, fn)
499 #define EVT_TEXT_ENTER(id, fn) wx__DECLARE_TEXTEVT(ENTER, id, fn)
500 #define EVT_TEXT_URL(id, fn) wx__DECLARE_TEXTURLEVT(URL, id, fn)
501 #define EVT_TEXT_MAXLEN(id, fn) wx__DECLARE_TEXTEVT(MAXLEN, id, fn)
502
503 #if wxHAS_TEXT_WINDOW_STREAM
504
505 // ----------------------------------------------------------------------------
506 // wxStreamToTextRedirector: this class redirects all data sent to the given
507 // C++ stream to the wxTextCtrl given to its ctor during its lifetime.
508 // ----------------------------------------------------------------------------
509
510 class WXDLLEXPORT wxStreamToTextRedirector
511 {
512 private:
513 void Init(wxTextCtrl *text)
514 {
515 m_sbufOld = m_ostr.rdbuf();
516 m_ostr.rdbuf(text);
517 }
518
519 public:
520 wxStreamToTextRedirector(wxTextCtrl *text)
521 : m_ostr(wxSTD cout)
522 {
523 Init(text);
524 }
525
526 wxStreamToTextRedirector(wxTextCtrl *text, wxSTD ostream *ostr)
527 : m_ostr(*ostr)
528 {
529 Init(text);
530 }
531
532 ~wxStreamToTextRedirector()
533 {
534 m_ostr.rdbuf(m_sbufOld);
535 }
536
537 private:
538 // the stream we're redirecting
539 wxSTD ostream& m_ostr;
540
541 // the old streambuf (before we changed it)
542 wxSTD streambuf *m_sbufOld;
543 };
544
545 #endif // wxHAS_TEXT_WINDOW_STREAM
546
547 #endif // wxUSE_TEXTCTRL
548
549 #endif
550 // _WX_TEXTCTRL_H_BASE_