1 ///////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxTextCtrlBase class - the interface of wxTextCtrl
4 // Author: Vadim Zeitlin
8 // Copyright: (c) wxWidgets team
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_TEXTCTRL_H_BASE_
13 #define _WX_TEXTCTRL_H_BASE_
15 // ----------------------------------------------------------------------------
17 // ----------------------------------------------------------------------------
19 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
20 #pragma interface "textctrlbase.h"
27 #include "wx/control.h" // the base class
28 #include "wx/dynarray.h" // wxArrayInt
29 #include "wx/gdicmn.h" // wxPoint
31 // 16-bit Borland 4.0 doesn't seem to allow multiple inheritance with wxWindow
32 // and streambuf: it complains about deriving a huge class from the huge class
33 // streambuf. !! Also, can't use streambuf if making or using a DLL :-(
35 #if (defined(__BORLANDC__)) || defined(__MWERKS__) || \
36 (defined(__WINDOWS__) && (defined(WXUSINGDLL) || defined(WXMAKINGDLL)))
37 #define NO_TEXT_WINDOW_STREAM
40 #ifndef NO_TEXT_WINDOW_STREAM
41 #if wxUSE_STD_IOSTREAM
42 #include "wx/ioswrap.h" // derivation: we need the full decls.
43 #else // !wxUSE_STD_IOSTREAM
44 // can't compile this feature in if we don't use streams at all
45 #define NO_TEXT_WINDOW_STREAM
46 #endif // wxUSE_STD_IOSTREAM/!wxUSE_STD_IOSTREAM
49 #if defined(__WXMSW__) && defined(__MINGW32__)
50 #include "wx/msw/winundef.h"
53 class WXDLLEXPORT wxTextCtrl
;
54 class WXDLLEXPORT wxTextCtrlBase
;
56 // ----------------------------------------------------------------------------
58 // ----------------------------------------------------------------------------
60 // wxTextPos is the position in the text
61 typedef long wxTextPos
;
63 // wxTextCoord is the line or row number (which should have been unsigned but
64 // is long for backwards compatibility)
65 typedef long wxTextCoord
;
67 // ----------------------------------------------------------------------------
69 // ----------------------------------------------------------------------------
71 extern WXDLLEXPORT_DATA(const wxChar
*) wxTextCtrlNameStr
;
73 // this is intentionally not enum to avoid warning fixes with
74 // typecasting from enum type to wxTextCoord
75 const wxTextCoord wxOutOfRangeTextCoord
= -1;
76 const wxTextCoord wxInvalidTextCoord
= -2;
78 // ----------------------------------------------------------------------------
79 // wxTextCtrl style flags
80 // ----------------------------------------------------------------------------
82 // the flag bits 0x0001, and 0x0004 are free but should be used only for the
83 // things which don't make sense for a text control used by wxTextEntryDialog
84 // because they would otherwise conflict with wxOK, wxCANCEL, wxCENTRE
86 #define wxTE_NO_VSCROLL 0x0002
87 #define wxTE_AUTO_SCROLL 0x0008
89 #define wxTE_READONLY 0x0010
90 #define wxTE_MULTILINE 0x0020
91 #define wxTE_PROCESS_TAB 0x0040
94 #define wxTE_LEFT 0x0000 // 0x0000
95 #define wxTE_CENTER wxALIGN_CENTER_HORIZONTAL // 0x0100
96 #define wxTE_RIGHT wxALIGN_RIGHT // 0x0200
97 #define wxTE_CENTRE wxTE_CENTER
99 // this style means to use RICHEDIT control and does something only under wxMSW
100 // and Win32 and is silently ignored under all other platforms
101 #define wxTE_RICH 0x0080
103 #define wxTE_PROCESS_ENTER 0x0400
104 #define wxTE_PASSWORD 0x0800
106 // automatically detect the URLs and generate the events when mouse is
107 // moved/clicked over an URL
109 // this is for Win32 richedit controls only so far
110 #define wxTE_AUTO_URL 0x1000
112 // by default, the Windows text control doesn't show the selection when it
113 // doesn't have focus - use this style to force it to always show it
114 #define wxTE_NOHIDESEL 0x2000
116 // use wxHSCROLL to not wrap text at all, wxTE_LINEWRAP to wrap it at any
117 // position and wxTE_WORDWRAP to wrap at words boundary
118 #define wxTE_DONTWRAP wxHSCROLL
119 #define wxTE_LINEWRAP 0x4000
120 #define wxTE_WORDWRAP 0x0000 // it's just == !wxHSCROLL
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
126 // ----------------------------------------------------------------------------
127 // wxTextCtrl::HitTest return values
128 // ----------------------------------------------------------------------------
130 // the point asked is ...
131 enum wxTextCtrlHitTestResult
133 wxTE_HT_UNKNOWN
= -2, // this means HitTest() is simply not implemented
134 wxTE_HT_BEFORE
, // either to the left or upper
135 wxTE_HT_ON_TEXT
, // directly on
136 wxTE_HT_BELOW
, // below [the last line]
137 wxTE_HT_BEYOND
// after [the end of line]
139 // ... the character returned
141 // ----------------------------------------------------------------------------
142 // Types for wxTextAttr
143 // ----------------------------------------------------------------------------
147 enum wxTextAttrAlignment
149 wxTEXT_ALIGNMENT_DEFAULT
,
150 wxTEXT_ALIGNMENT_LEFT
,
151 wxTEXT_ALIGNMENT_CENTRE
,
152 wxTEXT_ALIGNMENT_CENTER
= wxTEXT_ALIGNMENT_CENTRE
,
153 wxTEXT_ALIGNMENT_RIGHT
,
154 wxTEXT_ALIGNMENT_JUSTIFIED
157 // Flags to indicate which attributes are being applied
159 #define wxTEXT_ATTR_TEXT_COLOUR 0x0001
160 #define wxTEXT_ATTR_BACKGROUND_COLOUR 0x0002
161 #define wxTEXT_ATTR_FONT_FACE 0x0004
162 #define wxTEXT_ATTR_FONT_SIZE 0x0008
163 #define wxTEXT_ATTR_FONT_WEIGHT 0x0010
164 #define wxTEXT_ATTR_FONT_ITALIC 0x0020
165 #define wxTEXT_ATTR_FONT_UNDERLINE 0x0040
166 #define wxTEXT_ATTR_FONT \
167 wxTEXT_ATTR_FONT_FACE | wxTEXT_ATTR_FONT_SIZE | wxTEXT_ATTR_FONT_WEIGHT | wxTEXT_ATTR_FONT_ITALIC | wxTEXT_ATTR_FONT_UNDERLINE
168 #define wxTEXT_ATTR_ALIGNMENT 0x0080
169 #define wxTEXT_ATTR_LEFT_INDENT 0x0100
170 #define wxTEXT_ATTR_RIGHT_INDENT 0x0200
171 #define wxTEXT_ATTR_TABS 0x0400
173 // ----------------------------------------------------------------------------
174 // wxTextAttr: a structure containing the visual attributes of a text
175 // ----------------------------------------------------------------------------
177 class WXDLLEXPORT wxTextAttr
181 wxTextAttr() { Init(); }
182 wxTextAttr(const wxColour
& colText
,
183 const wxColour
& colBack
= wxNullColour
,
184 const wxFont
& font
= wxNullFont
,
185 wxTextAttrAlignment alignment
= wxTEXT_ALIGNMENT_DEFAULT
);
191 void operator= (const wxTextAttr
& attr
);
194 void SetTextColour(const wxColour
& colText
) { m_colText
= colText
; m_flags
|= wxTEXT_ATTR_TEXT_COLOUR
; }
195 void SetBackgroundColour(const wxColour
& colBack
) { m_colBack
= colBack
; m_flags
|= wxTEXT_ATTR_BACKGROUND_COLOUR
; }
196 void SetFont(const wxFont
& font
, long flags
= wxTEXT_ATTR_FONT
) { m_font
= font
; m_flags
|= flags
; }
197 void SetAlignment(wxTextAttrAlignment alignment
) { m_textAlignment
= alignment
; m_flags
|= wxTEXT_ATTR_ALIGNMENT
; }
198 void SetTabs(const wxArrayInt
& tabs
) { m_tabs
= tabs
; m_flags
|= wxTEXT_ATTR_TABS
; }
199 void SetLeftIndent(int indent
, int subIndent
= 0) { m_leftIndent
= indent
; m_leftSubIndent
= subIndent
; m_flags
|= wxTEXT_ATTR_LEFT_INDENT
; }
200 void SetRightIndent(int indent
) { m_rightIndent
= indent
; m_flags
|= wxTEXT_ATTR_RIGHT_INDENT
; }
201 void SetFlags(long flags
) { m_flags
= flags
; }
204 bool HasTextColour() const { return m_colText
.Ok() && HasFlag(wxTEXT_ATTR_TEXT_COLOUR
) ; }
205 bool HasBackgroundColour() const { return m_colBack
.Ok() && HasFlag(wxTEXT_ATTR_BACKGROUND_COLOUR
) ; }
206 bool HasFont() const { return m_font
.Ok() && HasFlag(wxTEXT_ATTR_FONT
) ; }
207 bool HasAlignment() const { return (m_textAlignment
!= wxTEXT_ALIGNMENT_DEFAULT
) || ((m_flags
& wxTEXT_ATTR_ALIGNMENT
) != 0) ; }
208 bool HasTabs() const { return (m_flags
& wxTEXT_ATTR_TABS
) != 0 ; }
209 bool HasLeftIndent() const { return (m_flags
& wxTEXT_ATTR_LEFT_INDENT
) != 0 ; }
210 bool HasRightIndent() const { return (m_flags
& wxTEXT_ATTR_RIGHT_INDENT
) != 0 ; }
211 bool HasFlag(long flag
) const { return (m_flags
& flag
) != 0; }
213 const wxColour
& GetTextColour() const { return m_colText
; }
214 const wxColour
& GetBackgroundColour() const { return m_colBack
; }
215 const wxFont
& GetFont() const { return m_font
; }
216 wxTextAttrAlignment
GetAlignment() const { return m_textAlignment
; }
217 const wxArrayInt
& GetTabs() const { return m_tabs
; }
218 long GetLeftIndent() const { return m_leftIndent
; }
219 long GetLeftSubIndent() const { return m_leftSubIndent
; }
220 long GetRightIndent() const { return m_rightIndent
; }
221 long GetFlags() const { return m_flags
; }
223 // returns false if we have any attributes set, true otherwise
224 bool IsDefault() const
226 return !HasTextColour() && !HasBackgroundColour() && !HasFont() && !HasAlignment() &&
227 !HasTabs() && !HasLeftIndent() && !HasRightIndent() ;
230 // return the attribute having the valid font and colours: it uses the
231 // attributes set in attr and falls back first to attrDefault and then to
232 // the text control font/colours for those attributes which are not set
233 static wxTextAttr
Combine(const wxTextAttr
& attr
,
234 const wxTextAttr
& attrDef
,
235 const wxTextCtrlBase
*text
);
242 wxTextAttrAlignment m_textAlignment
;
243 wxArrayInt m_tabs
; // array of int: tab stops in 1/10 mm
244 int m_leftIndent
; // left indent in 1/10 mm
245 int m_leftSubIndent
; // left indent for all but the first
246 // line in a paragraph relative to the
247 // first line, in 1/10 mm
248 int m_rightIndent
; // right indent in 1/10 mm
251 // ----------------------------------------------------------------------------
252 // wxTextCtrl: a single or multiple line text zone where user can enter and
254 // ----------------------------------------------------------------------------
256 class WXDLLEXPORT wxTextCtrlBase
: public wxControl
257 #ifndef NO_TEXT_WINDOW_STREAM
258 , public wxSTD streambuf
272 virtual wxString
GetValue() const = 0;
273 virtual void SetValue(const wxString
& value
) = 0;
275 virtual wxString
GetRange(long from
, long to
) const;
277 virtual int GetLineLength(long lineNo
) const = 0;
278 virtual wxString
GetLineText(long lineNo
) const = 0;
279 virtual int GetNumberOfLines() const = 0;
281 virtual bool IsModified() const = 0;
282 virtual bool IsEditable() const = 0;
284 // more readable flag testing methods
285 bool IsSingleLine() const { return !(GetWindowStyle() & wxTE_MULTILINE
); }
286 bool IsMultiLine() const { return !IsSingleLine(); }
288 // If the return values from and to are the same, there is no selection.
289 virtual void GetSelection(long* from
, long* to
) const = 0;
291 virtual wxString
GetStringSelection() const;
297 virtual void Clear() = 0;
298 virtual void Replace(long from
, long to
, const wxString
& value
) = 0;
299 virtual void Remove(long from
, long to
) = 0;
301 // load/save the controls contents from/to the file
302 virtual bool LoadFile(const wxString
& file
);
303 virtual bool SaveFile(const wxString
& file
= wxEmptyString
);
305 // sets/clears the dirty flag
306 virtual void MarkDirty() = 0;
307 virtual void DiscardEdits() = 0;
309 // set the max number of characters which may be entered in a single line
311 virtual void SetMaxLength(unsigned long WXUNUSED(len
)) { }
313 // writing text inserts it at the current position, appending always
314 // inserts it at the end
315 virtual void WriteText(const wxString
& text
) = 0;
316 virtual void AppendText(const wxString
& text
) = 0;
318 // insert the character which would have resulted from this key event,
319 // return true if anything has been inserted
320 virtual bool EmulateKeyPress(const wxKeyEvent
& event
);
322 // text control under some platforms supports the text styles: these
323 // methods allow to apply the given text style to the given selection or to
324 // set/get the style which will be used for all appended text
325 virtual bool SetStyle(long start
, long end
, const wxTextAttr
& style
);
326 virtual bool GetStyle(long position
, wxTextAttr
& style
);
327 virtual bool SetDefaultStyle(const wxTextAttr
& style
);
328 virtual const wxTextAttr
& GetDefaultStyle() const;
330 // translate between the position (which is just an index in the text ctrl
331 // considering all its contents as a single strings) and (x, y) coordinates
332 // which represent column and line.
333 virtual long XYToPosition(long x
, long y
) const = 0;
334 virtual bool PositionToXY(long pos
, long *x
, long *y
) const = 0;
336 virtual void ShowPosition(long pos
) = 0;
338 // find the character at position given in pixels
340 // NB: pt is in device coords (not adjusted for the client area origin nor
342 virtual wxTextCtrlHitTestResult
HitTest(const wxPoint
& pt
, long *pos
) const;
343 virtual wxTextCtrlHitTestResult
HitTest(const wxPoint
& pt
,
345 wxTextCoord
*row
) const;
347 // Clipboard operations
348 virtual void Copy() = 0;
349 virtual void Cut() = 0;
350 virtual void Paste() = 0;
352 virtual bool CanCopy() const;
353 virtual bool CanCut() const;
354 virtual bool CanPaste() const;
357 virtual void Undo() = 0;
358 virtual void Redo() = 0;
360 virtual bool CanUndo() const = 0;
361 virtual bool CanRedo() const = 0;
364 virtual void SetInsertionPoint(long pos
) = 0;
365 virtual void SetInsertionPointEnd() = 0;
366 virtual long GetInsertionPoint() const = 0;
367 virtual wxTextPos
GetLastPosition() const = 0;
369 virtual void SetSelection(long from
, long to
) = 0;
370 virtual void SelectAll();
371 virtual void SetEditable(bool editable
) = 0;
373 // override streambuf method
374 #ifndef NO_TEXT_WINDOW_STREAM
376 #endif // NO_TEXT_WINDOW_STREAM
378 // stream-like insertion operators: these are always available, whether we
379 // were, or not, compiled with streambuf support
380 wxTextCtrl
& operator<<(const wxString
& s
);
381 wxTextCtrl
& operator<<(int i
);
382 wxTextCtrl
& operator<<(long i
);
383 wxTextCtrl
& operator<<(float f
);
384 wxTextCtrl
& operator<<(double d
);
385 wxTextCtrl
& operator<<(const wxChar c
);
387 // do the window-specific processing after processing the update event
388 virtual void DoUpdateWindowUI(wxUpdateUIEvent
& event
);
390 virtual bool ShouldInheritColours() const { return false; }
393 // the name of the last file loaded with LoadFile() which will be used by
394 // SaveFile() by default
397 // the text style which will be used for any new text added to the control
398 wxTextAttr m_defaultStyle
;
400 DECLARE_NO_COPY_CLASS(wxTextCtrlBase
)
403 // ----------------------------------------------------------------------------
404 // include the platform-dependent class definition
405 // ----------------------------------------------------------------------------
407 #if defined(__WXX11__)
408 #include "wx/x11/textctrl.h"
409 #elif defined(__WXUNIVERSAL__)
410 #include "wx/univ/textctrl.h"
411 #elif defined(__SMARTPHONE__) && defined(__WXWINCE__)
412 #include "wx/msw/wince/textctrlce.h"
413 #elif defined(__WXMSW__)
414 #include "wx/msw/textctrl.h"
415 #elif defined(__WXMOTIF__)
416 #include "wx/motif/textctrl.h"
417 #elif defined(__WXGTK__)
418 #include "wx/gtk/textctrl.h"
419 #elif defined(__WXMAC__)
420 #include "wx/mac/textctrl.h"
421 #elif defined(__WXCOCOA__)
422 #include "wx/cocoa/textctrl.h"
423 #elif defined(__WXPM__)
424 #include "wx/os2/textctrl.h"
427 // ----------------------------------------------------------------------------
429 // ----------------------------------------------------------------------------
431 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
433 BEGIN_DECLARE_EVENT_TYPES()
434 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_UPDATED
, 7)
435 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_ENTER
, 8)
436 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_URL
, 13)
437 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_MAXLEN
, 14)
438 END_DECLARE_EVENT_TYPES()
440 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
442 class WXDLLEXPORT wxTextUrlEvent
: public wxCommandEvent
445 wxTextUrlEvent(int winid
, const wxMouseEvent
& evtMouse
,
446 long start
, long end
)
447 : wxCommandEvent(wxEVT_COMMAND_TEXT_URL
, winid
)
448 , m_evtMouse(evtMouse
), m_start(start
), m_end(end
)
451 // get the mouse event which happend over the URL
452 const wxMouseEvent
& GetMouseEvent() const { return m_evtMouse
; }
454 // get the start of the URL
455 long GetURLStart() const { return m_start
; }
457 // get the end of the URL
458 long GetURLEnd() const { return m_end
; }
461 // the corresponding mouse event
462 wxMouseEvent m_evtMouse
;
464 // the start and end indices of the URL in the text control
469 DECLARE_DYNAMIC_CLASS_NO_COPY(wxTextUrlEvent
)
472 // for wxWin RTTI only, don't use
473 wxTextUrlEvent() : m_evtMouse(), m_start(0), m_end(0) { }
476 typedef void (wxEvtHandler::*wxTextUrlEventFunction
)(wxTextUrlEvent
&);
478 #define wxTextEventHandler(func) wxCommandEventHandler(func)
479 #define wxTextUrlEventHandler(func) \
480 (wxObjectEventFunction)wxStaticCastEvent(wxTextUrlEventFunction, &func)
482 #define wx__DECLARE_TEXTEVT(evt, id, fn) \
483 wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_ ## evt, id, wxTextEventHandler(fn))
485 #define wx__DECLARE_TEXTURLEVT(evt, id, fn) \
486 wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_ ## evt, id, wxTextUrlEventHandler(fn))
488 #define EVT_TEXT(id, fn) wx__DECLARE_TEXTEVT(UPDATED, id, fn)
489 #define EVT_TEXT_ENTER(id, fn) wx__DECLARE_TEXTEVT(ENTER, id, fn)
490 #define EVT_TEXT_URL(id, fn) wx__DECLARE_TEXTURLEVT(URL, id, fn)
491 #define EVT_TEXT_MAXLEN(id, fn) wx__DECLARE_TEXTEVT(MAXLEN, id, fn)
493 #ifndef NO_TEXT_WINDOW_STREAM
495 // ----------------------------------------------------------------------------
496 // wxStreamToTextRedirector: this class redirects all data sent to the given
497 // C++ stream to the wxTextCtrl given to its ctor during its lifetime.
498 // ----------------------------------------------------------------------------
500 class WXDLLEXPORT wxStreamToTextRedirector
503 void Init(wxTextCtrl
*text
)
505 m_sbufOld
= m_ostr
.rdbuf();
510 wxStreamToTextRedirector(wxTextCtrl
*text
)
516 wxStreamToTextRedirector(wxTextCtrl
*text
, wxSTD ostream
*ostr
)
522 ~wxStreamToTextRedirector()
524 m_ostr
.rdbuf(m_sbufOld
);
528 // the stream we're redirecting
529 wxSTD ostream
& m_ostr
;
531 // the old streambuf (before we changed it)
532 wxSTD streambuf
*m_sbufOld
;
535 #endif // !NO_TEXT_WINDOW_STREAM
537 #endif // wxUSE_TEXTCTRL
540 // _WX_TEXTCTRL_H_BASE_