1 ///////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxTextCtrlBase class - the interface of wxTextCtrl
4 // Author: Vadim Zeitlin
8 // Copyright: (c) Vadim Zeitlin
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_TEXTCTRL_H_BASE_
13 #define _WX_TEXTCTRL_H_BASE_
15 // ----------------------------------------------------------------------------
17 // ----------------------------------------------------------------------------
23 #include "wx/control.h" // the base class
24 #include "wx/dynarray.h" // wxArrayInt
25 #include "wx/gdicmn.h" // wxPoint
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 :-(
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
39 #define wxHAS_TEXT_WINDOW_STREAM 0
42 class WXDLLEXPORT wxTextCtrl
;
43 class WXDLLEXPORT wxTextCtrlBase
;
45 // ----------------------------------------------------------------------------
47 // ----------------------------------------------------------------------------
49 // wxTextPos is the position in the text
50 typedef long wxTextPos
;
52 // wxTextCoord is the line or row number (which should have been unsigned but
53 // is long for backwards compatibility)
54 typedef long wxTextCoord
;
56 // ----------------------------------------------------------------------------
58 // ----------------------------------------------------------------------------
60 extern WXDLLEXPORT_DATA(const wxChar
) wxTextCtrlNameStr
[];
62 // this is intentionally not enum to avoid warning fixes with
63 // typecasting from enum type to wxTextCoord
64 const wxTextCoord wxOutOfRangeTextCoord
= -1;
65 const wxTextCoord wxInvalidTextCoord
= -2;
67 // ----------------------------------------------------------------------------
68 // wxTextCtrl style flags
69 // ----------------------------------------------------------------------------
71 #define wxTE_NO_VSCROLL 0x0002
72 #define wxTE_AUTO_SCROLL 0x0008
74 #define wxTE_READONLY 0x0010
75 #define wxTE_MULTILINE 0x0020
76 #define wxTE_PROCESS_TAB 0x0040
79 #define wxTE_LEFT 0x0000 // 0x0000
80 #define wxTE_CENTER wxALIGN_CENTER_HORIZONTAL // 0x0100
81 #define wxTE_RIGHT wxALIGN_RIGHT // 0x0200
82 #define wxTE_CENTRE wxTE_CENTER
84 // this style means to use RICHEDIT control and does something only under wxMSW
85 // and Win32 and is silently ignored under all other platforms
86 #define wxTE_RICH 0x0080
88 #define wxTE_PROCESS_ENTER 0x0400
89 #define wxTE_PASSWORD 0x0800
91 // automatically detect the URLs and generate the events when mouse is
92 // moved/clicked over an URL
94 // this is for Win32 richedit and wxGTK2 multiline controls only so far
95 #define wxTE_AUTO_URL 0x1000
97 // by default, the Windows text control doesn't show the selection when it
98 // doesn't have focus - use this style to force it to always show it
99 #define wxTE_NOHIDESEL 0x2000
101 // use wxHSCROLL to not wrap text at all, wxTE_CHARWRAP to wrap it at any
102 // position and wxTE_WORDWRAP to wrap at words boundary
104 // if no wrapping style is given at all, the control wraps at word boundary
105 #define wxTE_DONTWRAP wxHSCROLL
106 #define wxTE_CHARWRAP 0x4000 // wrap at any position
107 #define wxTE_WORDWRAP 0x0001 // wrap only at words boundaries
108 #define wxTE_BESTWRAP 0x0000 // this is the default
110 #if WXWIN_COMPATIBILITY_2_6
112 #define wxTE_LINEWRAP wxTE_CHARWRAP
113 #endif // WXWIN_COMPATIBILITY_2_6
115 // force using RichEdit version 2.0 or 3.0 instead of 1.0 (default) for
116 // wxTE_RICH controls - can be used together with or instead of wxTE_RICH
117 #define wxTE_RICH2 0x8000
119 // reuse wxTE_RICH2's value for CAPEDIT control on Windows CE
120 #if defined(__SMARTPHONE__) || defined(__POCKETPC__)
121 #define wxTE_CAPITALIZE wxTE_RICH2
123 #define wxTE_CAPITALIZE 0
126 // ----------------------------------------------------------------------------
127 // wxTextCtrl file types
128 // ----------------------------------------------------------------------------
130 #define wxTEXT_TYPE_ANY 0
132 // ----------------------------------------------------------------------------
133 // wxTextCtrl::HitTest return values
134 // ----------------------------------------------------------------------------
136 // the point asked is ...
137 enum wxTextCtrlHitTestResult
139 wxTE_HT_UNKNOWN
= -2, // this means HitTest() is simply not implemented
140 wxTE_HT_BEFORE
, // either to the left or upper
141 wxTE_HT_ON_TEXT
, // directly on
142 wxTE_HT_BELOW
, // below [the last line]
143 wxTE_HT_BEYOND
// after [the end of line]
145 // ... the character returned
147 // ----------------------------------------------------------------------------
148 // Types for wxTextAttr
149 // ----------------------------------------------------------------------------
153 enum wxTextAttrAlignment
155 wxTEXT_ALIGNMENT_DEFAULT
,
156 wxTEXT_ALIGNMENT_LEFT
,
157 wxTEXT_ALIGNMENT_CENTRE
,
158 wxTEXT_ALIGNMENT_CENTER
= wxTEXT_ALIGNMENT_CENTRE
,
159 wxTEXT_ALIGNMENT_RIGHT
,
160 wxTEXT_ALIGNMENT_JUSTIFIED
163 // Flags to indicate which attributes are being applied
165 #define wxTEXT_ATTR_TEXT_COLOUR 0x0001
166 #define wxTEXT_ATTR_BACKGROUND_COLOUR 0x0002
167 #define wxTEXT_ATTR_FONT_FACE 0x0004
168 #define wxTEXT_ATTR_FONT_SIZE 0x0008
169 #define wxTEXT_ATTR_FONT_WEIGHT 0x0010
170 #define wxTEXT_ATTR_FONT_ITALIC 0x0020
171 #define wxTEXT_ATTR_FONT_UNDERLINE 0x0040
172 #define wxTEXT_ATTR_FONT \
173 ( wxTEXT_ATTR_FONT_FACE | wxTEXT_ATTR_FONT_SIZE | wxTEXT_ATTR_FONT_WEIGHT | \
174 wxTEXT_ATTR_FONT_ITALIC | wxTEXT_ATTR_FONT_UNDERLINE )
175 #define wxTEXT_ATTR_ALIGNMENT 0x0080
176 #define wxTEXT_ATTR_LEFT_INDENT 0x0100
177 #define wxTEXT_ATTR_RIGHT_INDENT 0x0200
178 #define wxTEXT_ATTR_TABS 0x0400
180 // ----------------------------------------------------------------------------
181 // wxTextAttr: a structure containing the visual attributes of a text
182 // ----------------------------------------------------------------------------
184 class WXDLLEXPORT wxTextAttr
188 wxTextAttr() { Init(); }
189 wxTextAttr(const wxColour
& colText
,
190 const wxColour
& colBack
= wxNullColour
,
191 const wxFont
& font
= wxNullFont
,
192 wxTextAttrAlignment alignment
= wxTEXT_ALIGNMENT_DEFAULT
);
197 // merges the attributes of the base and the overlay objects and returns
198 // the result; the parameter attributes take precedence
200 // WARNING: the order of arguments is the opposite of Combine()
201 static wxTextAttr
Merge(const wxTextAttr
& base
, const wxTextAttr
& overlay
)
203 return Combine(overlay
, base
, NULL
);
206 // merges the attributes of this object and overlay
207 void Merge(const wxTextAttr
& overlay
)
209 *this = Merge(*this, overlay
);
214 void operator= (const wxTextAttr
& attr
);
217 void SetTextColour(const wxColour
& colText
) { m_colText
= colText
; m_flags
|= wxTEXT_ATTR_TEXT_COLOUR
; }
218 void SetBackgroundColour(const wxColour
& colBack
) { m_colBack
= colBack
; m_flags
|= wxTEXT_ATTR_BACKGROUND_COLOUR
; }
219 void SetFont(const wxFont
& font
, long flags
= wxTEXT_ATTR_FONT
) { m_font
= font
; m_flags
|= flags
; }
220 void SetAlignment(wxTextAttrAlignment alignment
) { m_textAlignment
= alignment
; m_flags
|= wxTEXT_ATTR_ALIGNMENT
; }
221 void SetTabs(const wxArrayInt
& tabs
) { m_tabs
= tabs
; m_flags
|= wxTEXT_ATTR_TABS
; }
222 void SetLeftIndent(int indent
, int subIndent
= 0) { m_leftIndent
= indent
; m_leftSubIndent
= subIndent
; m_flags
|= wxTEXT_ATTR_LEFT_INDENT
; }
223 void SetRightIndent(int indent
) { m_rightIndent
= indent
; m_flags
|= wxTEXT_ATTR_RIGHT_INDENT
; }
224 void SetFlags(long flags
) { m_flags
= flags
; }
227 bool HasTextColour() const { return m_colText
.Ok() && HasFlag(wxTEXT_ATTR_TEXT_COLOUR
) ; }
228 bool HasBackgroundColour() const { return m_colBack
.Ok() && HasFlag(wxTEXT_ATTR_BACKGROUND_COLOUR
) ; }
229 bool HasFont() const { return m_font
.Ok() && HasFlag(wxTEXT_ATTR_FONT
) ; }
230 bool HasAlignment() const { return (m_textAlignment
!= wxTEXT_ALIGNMENT_DEFAULT
) || ((m_flags
& wxTEXT_ATTR_ALIGNMENT
) != 0) ; }
231 bool HasTabs() const { return (m_flags
& wxTEXT_ATTR_TABS
) != 0 ; }
232 bool HasLeftIndent() const { return (m_flags
& wxTEXT_ATTR_LEFT_INDENT
) != 0 ; }
233 bool HasRightIndent() const { return (m_flags
& wxTEXT_ATTR_RIGHT_INDENT
) != 0 ; }
234 bool HasFlag(long flag
) const { return (m_flags
& flag
) != 0; }
236 const wxColour
& GetTextColour() const { return m_colText
; }
237 const wxColour
& GetBackgroundColour() const { return m_colBack
; }
238 const wxFont
& GetFont() const { return m_font
; }
239 wxTextAttrAlignment
GetAlignment() const { return m_textAlignment
; }
240 const wxArrayInt
& GetTabs() const { return m_tabs
; }
241 long GetLeftIndent() const { return m_leftIndent
; }
242 long GetLeftSubIndent() const { return m_leftSubIndent
; }
243 long GetRightIndent() const { return m_rightIndent
; }
244 long GetFlags() const { return m_flags
; }
246 // returns false if we have any attributes set, true otherwise
247 bool IsDefault() const
249 return !HasTextColour() && !HasBackgroundColour() && !HasFont() && !HasAlignment() &&
250 !HasTabs() && !HasLeftIndent() && !HasRightIndent() ;
253 // return the attribute having the valid font and colours: it uses the
254 // attributes set in attr and falls back first to attrDefault and then to
255 // the text control font/colours for those attributes which are not set
256 static wxTextAttr
Combine(const wxTextAttr
& attr
,
257 const wxTextAttr
& attrDef
,
258 const wxTextCtrlBase
*text
);
265 wxTextAttrAlignment m_textAlignment
;
266 wxArrayInt m_tabs
; // array of int: tab stops in 1/10 mm
267 int m_leftIndent
; // left indent in 1/10 mm
268 int m_leftSubIndent
; // left indent for all but the first
269 // line in a paragraph relative to the
270 // first line, in 1/10 mm
271 int m_rightIndent
; // right indent in 1/10 mm
274 // ----------------------------------------------------------------------------
275 // wxTextCtrl: a single or multiple line text zone where user can enter and
277 // ----------------------------------------------------------------------------
279 class WXDLLEXPORT wxTextCtrlBase
: public wxControl
280 #if wxHAS_TEXT_WINDOW_STREAM
281 , public wxSTD streambuf
290 virtual ~wxTextCtrlBase(){}
295 virtual wxString
GetValue() const = 0;
296 virtual bool IsEmpty() const { return GetValue().empty(); }
298 virtual void SetValue(const wxString
& value
)
299 { DoSetValue(value
, SetValue_SendEvent
); }
300 virtual void ChangeValue(const wxString
& value
)
301 { DoSetValue(value
); }
303 virtual wxString
GetRange(long from
, long to
) const;
305 virtual int GetLineLength(long lineNo
) const = 0;
306 virtual wxString
GetLineText(long lineNo
) const = 0;
307 virtual int GetNumberOfLines() const = 0;
309 virtual bool IsModified() const = 0;
310 virtual bool IsEditable() const = 0;
312 // more readable flag testing methods
313 bool IsSingleLine() const { return !HasFlag(wxTE_MULTILINE
); }
314 bool IsMultiLine() const { return !IsSingleLine(); }
316 // If the return values from and to are the same, there is no selection.
317 virtual void GetSelection(long* from
, long* to
) const = 0;
319 virtual wxString
GetStringSelection() const;
325 virtual void Clear() = 0;
326 virtual void Replace(long from
, long to
, const wxString
& value
) = 0;
327 virtual void Remove(long from
, long to
) = 0;
329 // load/save the control's contents from/to a file
330 bool LoadFile(const wxString
& file
, int fileType
= wxTEXT_TYPE_ANY
) { return DoLoadFile(file
, fileType
); }
331 bool SaveFile(const wxString
& file
= wxEmptyString
, int fileType
= wxTEXT_TYPE_ANY
);
333 // implementation for loading/saving
334 virtual bool DoLoadFile(const wxString
& file
, int fileType
);
335 virtual bool DoSaveFile(const wxString
& file
, int fileType
);
337 // sets/clears the dirty flag
338 virtual void MarkDirty() = 0;
339 virtual void DiscardEdits() = 0;
340 void SetModified(bool modified
)
348 // set the max number of characters which may be entered in a single line
350 virtual void SetMaxLength(unsigned long WXUNUSED(len
)) { }
352 // writing text inserts it at the current position, appending always
353 // inserts it at the end
354 virtual void WriteText(const wxString
& text
) = 0;
355 virtual void AppendText(const wxString
& text
) = 0;
357 // insert the character which would have resulted from this key event,
358 // return true if anything has been inserted
359 virtual bool EmulateKeyPress(const wxKeyEvent
& event
);
361 // text control under some platforms supports the text styles: these
362 // methods allow to apply the given text style to the given selection or to
363 // set/get the style which will be used for all appended text
364 virtual bool SetStyle(long start
, long end
, const wxTextAttr
& style
);
365 virtual bool GetStyle(long position
, wxTextAttr
& style
);
366 virtual bool SetDefaultStyle(const wxTextAttr
& style
);
367 virtual const wxTextAttr
& GetDefaultStyle() const;
369 // translate between the position (which is just an index in the text ctrl
370 // considering all its contents as a single strings) and (x, y) coordinates
371 // which represent column and line.
372 virtual long XYToPosition(long x
, long y
) const = 0;
373 virtual bool PositionToXY(long pos
, long *x
, long *y
) const = 0;
375 virtual void ShowPosition(long pos
) = 0;
377 // find the character at position given in pixels
379 // NB: pt is in device coords (not adjusted for the client area origin nor
381 virtual wxTextCtrlHitTestResult
HitTest(const wxPoint
& pt
, long *pos
) const;
382 virtual wxTextCtrlHitTestResult
HitTest(const wxPoint
& pt
,
384 wxTextCoord
*row
) const;
386 // Clipboard operations
387 virtual void Copy() = 0;
388 virtual void Cut() = 0;
389 virtual void Paste() = 0;
391 virtual bool CanCopy() const;
392 virtual bool CanCut() const;
393 virtual bool CanPaste() const;
396 virtual void Undo() = 0;
397 virtual void Redo() = 0;
399 virtual bool CanUndo() const = 0;
400 virtual bool CanRedo() const = 0;
403 virtual void SetInsertionPoint(long pos
) = 0;
404 virtual void SetInsertionPointEnd() = 0;
405 virtual long GetInsertionPoint() const = 0;
406 virtual wxTextPos
GetLastPosition() const = 0;
408 virtual void SetSelection(long from
, long to
) = 0;
409 virtual void SelectAll();
410 virtual void SetEditable(bool editable
) = 0;
412 // stream-like insertion operators: these are always available, whether we
413 // were, or not, compiled with streambuf support
414 wxTextCtrl
& operator<<(const wxString
& s
);
415 wxTextCtrl
& operator<<(int i
);
416 wxTextCtrl
& operator<<(long i
);
417 wxTextCtrl
& operator<<(float f
);
418 wxTextCtrl
& operator<<(double d
);
419 wxTextCtrl
& operator<<(const wxChar c
);
421 // generate the wxEVT_COMMAND_TEXT_UPDATED event, like SetValue() does
422 void SendTextUpdatedEvent();
424 // do the window-specific processing after processing the update event
425 virtual void DoUpdateWindowUI(wxUpdateUIEvent
& event
);
427 virtual bool ShouldInheritColours() const { return false; }
430 // override streambuf method
431 #if wxHAS_TEXT_WINDOW_STREAM
433 #endif // wxHAS_TEXT_WINDOW_STREAM
435 // flags for DoSetValue(): common part of SetValue() and ChangeValue() and
436 // also used to implement WriteText() in wxMSW
439 SetValue_SendEvent
= 1,
440 SetValue_SelectionOnly
= 2
443 virtual void DoSetValue(const wxString
& value
, int flags
= 0) = 0;
446 // the name of the last file loaded with LoadFile() which will be used by
447 // SaveFile() by default
450 // the text style which will be used for any new text added to the control
451 wxTextAttr m_defaultStyle
;
453 DECLARE_NO_COPY_CLASS(wxTextCtrlBase
)
454 DECLARE_ABSTRACT_CLASS(wxTextCtrlBase
)
457 // ----------------------------------------------------------------------------
458 // include the platform-dependent class definition
459 // ----------------------------------------------------------------------------
461 #if defined(__WXX11__)
462 #include "wx/x11/textctrl.h"
463 #elif defined(__WXUNIVERSAL__)
464 #include "wx/univ/textctrl.h"
465 #elif defined(__SMARTPHONE__) && defined(__WXWINCE__)
466 #include "wx/msw/wince/textctrlce.h"
467 #elif defined(__WXMSW__)
468 #include "wx/msw/textctrl.h"
469 #elif defined(__WXMOTIF__)
470 #include "wx/motif/textctrl.h"
471 #elif defined(__WXGTK20__)
472 #include "wx/gtk/textctrl.h"
473 #elif defined(__WXGTK__)
474 #include "wx/gtk1/textctrl.h"
475 #elif defined(__WXMAC__)
476 #include "wx/mac/textctrl.h"
477 #elif defined(__WXCOCOA__)
478 #include "wx/cocoa/textctrl.h"
479 #elif defined(__WXPM__)
480 #include "wx/os2/textctrl.h"
483 // ----------------------------------------------------------------------------
485 // ----------------------------------------------------------------------------
487 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
489 BEGIN_DECLARE_EVENT_TYPES()
490 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_UPDATED
, 7)
491 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_ENTER
, 8)
492 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_URL
, 13)
493 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_MAXLEN
, 14)
494 END_DECLARE_EVENT_TYPES()
496 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
498 class WXDLLEXPORT wxTextUrlEvent
: public wxCommandEvent
501 wxTextUrlEvent(int winid
, const wxMouseEvent
& evtMouse
,
502 long start
, long end
)
503 : wxCommandEvent(wxEVT_COMMAND_TEXT_URL
, winid
)
504 , m_evtMouse(evtMouse
), m_start(start
), m_end(end
)
507 // get the mouse event which happend over the URL
508 const wxMouseEvent
& GetMouseEvent() const { return m_evtMouse
; }
510 // get the start of the URL
511 long GetURLStart() const { return m_start
; }
513 // get the end of the URL
514 long GetURLEnd() const { return m_end
; }
517 // the corresponding mouse event
518 wxMouseEvent m_evtMouse
;
520 // the start and end indices of the URL in the text control
525 DECLARE_DYNAMIC_CLASS_NO_COPY(wxTextUrlEvent
)
528 // for wxWin RTTI only, don't use
529 wxTextUrlEvent() : m_evtMouse(), m_start(0), m_end(0) { }
532 typedef void (wxEvtHandler::*wxTextUrlEventFunction
)(wxTextUrlEvent
&);
534 #define wxTextEventHandler(func) wxCommandEventHandler(func)
535 #define wxTextUrlEventHandler(func) \
536 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxTextUrlEventFunction, &func)
538 #define wx__DECLARE_TEXTEVT(evt, id, fn) \
539 wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_ ## evt, id, wxTextEventHandler(fn))
541 #define wx__DECLARE_TEXTURLEVT(evt, id, fn) \
542 wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_ ## evt, id, wxTextUrlEventHandler(fn))
544 #define EVT_TEXT(id, fn) wx__DECLARE_TEXTEVT(UPDATED, id, fn)
545 #define EVT_TEXT_ENTER(id, fn) wx__DECLARE_TEXTEVT(ENTER, id, fn)
546 #define EVT_TEXT_URL(id, fn) wx__DECLARE_TEXTURLEVT(URL, id, fn)
547 #define EVT_TEXT_MAXLEN(id, fn) wx__DECLARE_TEXTEVT(MAXLEN, id, fn)
549 #if wxHAS_TEXT_WINDOW_STREAM
551 // ----------------------------------------------------------------------------
552 // wxStreamToTextRedirector: this class redirects all data sent to the given
553 // C++ stream to the wxTextCtrl given to its ctor during its lifetime.
554 // ----------------------------------------------------------------------------
556 class WXDLLEXPORT wxStreamToTextRedirector
559 void Init(wxTextCtrl
*text
)
561 m_sbufOld
= m_ostr
.rdbuf();
566 wxStreamToTextRedirector(wxTextCtrl
*text
)
572 wxStreamToTextRedirector(wxTextCtrl
*text
, wxSTD ostream
*ostr
)
578 ~wxStreamToTextRedirector()
580 m_ostr
.rdbuf(m_sbufOld
);
584 // the stream we're redirecting
585 wxSTD ostream
& m_ostr
;
587 // the old streambuf (before we changed it)
588 wxSTD streambuf
*m_sbufOld
;
591 #endif // wxHAS_TEXT_WINDOW_STREAM
593 #endif // wxUSE_TEXTCTRL
596 // _WX_TEXTCTRL_H_BASE_