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