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 #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
47 class WXDLLEXPORT wxTextCtrl
;
48 class WXDLLEXPORT wxTextCtrlBase
;
50 // ----------------------------------------------------------------------------
52 // ----------------------------------------------------------------------------
54 // wxTextPos is the position in the text
55 typedef long wxTextPos
;
57 // wxTextCoord is the line or row number (which should have been unsigned but
58 // is long for backwards compatibility)
59 typedef long wxTextCoord
;
61 // ----------------------------------------------------------------------------
63 // ----------------------------------------------------------------------------
65 extern WXDLLEXPORT_DATA(const wxChar
) wxTextCtrlNameStr
[];
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;
72 // ----------------------------------------------------------------------------
73 // wxTextCtrl style flags
74 // ----------------------------------------------------------------------------
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
80 #define wxTE_NO_VSCROLL 0x0002
81 #define wxTE_AUTO_SCROLL 0x0008
83 #define wxTE_READONLY 0x0010
84 #define wxTE_MULTILINE 0x0020
85 #define wxTE_PROCESS_TAB 0x0040
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
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
97 #define wxTE_PROCESS_ENTER 0x0400
98 #define wxTE_PASSWORD 0x0800
100 // automatically detect the URLs and generate the events when mouse is
101 // moved/clicked over an URL
103 // this is for Win32 richedit and wxGTK2 multiline controls only so far
104 #define wxTE_AUTO_URL 0x1000
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
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
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
119 #if WXWIN_COMPATIBILITY_2_6
121 #define wxTE_LINEWRAP wxTE_CHARWRAP
122 #endif // WXWIN_COMPATIBILITY_2_6
124 // force using RichEdit version 2.0 or 3.0 instead of 1.0 (default) for
125 // wxTE_RICH controls - can be used together with or instead of wxTE_RICH
126 #define wxTE_RICH2 0x8000
128 // reuse wxTE_RICH2's value for CAPEDIT control on Windows CE
129 #if defined(__SMARTPHONE__) || defined(__POCKETPC__)
130 #define wxTE_CAPITALIZE wxTE_RICH2
132 #define wxTE_CAPITALIZE 0
135 // ----------------------------------------------------------------------------
136 // wxTextCtrl::HitTest return values
137 // ----------------------------------------------------------------------------
139 // the point asked is ...
140 enum wxTextCtrlHitTestResult
142 wxTE_HT_UNKNOWN
= -2, // this means HitTest() is simply not implemented
143 wxTE_HT_BEFORE
, // either to the left or upper
144 wxTE_HT_ON_TEXT
, // directly on
145 wxTE_HT_BELOW
, // below [the last line]
146 wxTE_HT_BEYOND
// after [the end of line]
148 // ... the character returned
150 // ----------------------------------------------------------------------------
151 // Types for wxTextAttr
152 // ----------------------------------------------------------------------------
156 enum wxTextAttrAlignment
158 wxTEXT_ALIGNMENT_DEFAULT
,
159 wxTEXT_ALIGNMENT_LEFT
,
160 wxTEXT_ALIGNMENT_CENTRE
,
161 wxTEXT_ALIGNMENT_CENTER
= wxTEXT_ALIGNMENT_CENTRE
,
162 wxTEXT_ALIGNMENT_RIGHT
,
163 wxTEXT_ALIGNMENT_JUSTIFIED
166 // Flags to indicate which attributes are being applied
168 #define wxTEXT_ATTR_TEXT_COLOUR 0x0001
169 #define wxTEXT_ATTR_BACKGROUND_COLOUR 0x0002
170 #define wxTEXT_ATTR_FONT_FACE 0x0004
171 #define wxTEXT_ATTR_FONT_SIZE 0x0008
172 #define wxTEXT_ATTR_FONT_WEIGHT 0x0010
173 #define wxTEXT_ATTR_FONT_ITALIC 0x0020
174 #define wxTEXT_ATTR_FONT_UNDERLINE 0x0040
175 #define wxTEXT_ATTR_FONT \
176 ( wxTEXT_ATTR_FONT_FACE | wxTEXT_ATTR_FONT_SIZE | wxTEXT_ATTR_FONT_WEIGHT | \
177 wxTEXT_ATTR_FONT_ITALIC | wxTEXT_ATTR_FONT_UNDERLINE )
178 #define wxTEXT_ATTR_ALIGNMENT 0x0080
179 #define wxTEXT_ATTR_LEFT_INDENT 0x0100
180 #define wxTEXT_ATTR_RIGHT_INDENT 0x0200
181 #define wxTEXT_ATTR_TABS 0x0400
183 // ----------------------------------------------------------------------------
184 // wxTextAttr: a structure containing the visual attributes of a text
185 // ----------------------------------------------------------------------------
187 class WXDLLEXPORT wxTextAttr
191 wxTextAttr() { Init(); }
192 wxTextAttr(const wxColour
& colText
,
193 const wxColour
& colBack
= wxNullColour
,
194 const wxFont
& font
= wxNullFont
,
195 wxTextAttrAlignment alignment
= wxTEXT_ALIGNMENT_DEFAULT
);
200 // merges the attributes of the base and the overlay objects and returns
201 // the result; the parameter attributes take precedence
203 // WARNING: the order of arguments is the opposite of Combine()
204 static wxTextAttr
Merge(const wxTextAttr
& base
, const wxTextAttr
& overlay
)
206 return Combine(overlay
, base
, NULL
);
209 // merges the attributes of this object and overlay
210 void Merge(const wxTextAttr
& overlay
)
212 *this = Merge(*this, overlay
);
217 void operator= (const wxTextAttr
& attr
);
220 void SetTextColour(const wxColour
& colText
) { m_colText
= colText
; m_flags
|= wxTEXT_ATTR_TEXT_COLOUR
; }
221 void SetBackgroundColour(const wxColour
& colBack
) { m_colBack
= colBack
; m_flags
|= wxTEXT_ATTR_BACKGROUND_COLOUR
; }
222 void SetFont(const wxFont
& font
, long flags
= wxTEXT_ATTR_FONT
) { m_font
= font
; m_flags
|= flags
; }
223 void SetAlignment(wxTextAttrAlignment alignment
) { m_textAlignment
= alignment
; m_flags
|= wxTEXT_ATTR_ALIGNMENT
; }
224 void SetTabs(const wxArrayInt
& tabs
) { m_tabs
= tabs
; m_flags
|= wxTEXT_ATTR_TABS
; }
225 void SetLeftIndent(int indent
, int subIndent
= 0) { m_leftIndent
= indent
; m_leftSubIndent
= subIndent
; m_flags
|= wxTEXT_ATTR_LEFT_INDENT
; }
226 void SetRightIndent(int indent
) { m_rightIndent
= indent
; m_flags
|= wxTEXT_ATTR_RIGHT_INDENT
; }
227 void SetFlags(long flags
) { m_flags
= flags
; }
230 bool HasTextColour() const { return m_colText
.Ok() && HasFlag(wxTEXT_ATTR_TEXT_COLOUR
) ; }
231 bool HasBackgroundColour() const { return m_colBack
.Ok() && HasFlag(wxTEXT_ATTR_BACKGROUND_COLOUR
) ; }
232 bool HasFont() const { return m_font
.Ok() && HasFlag(wxTEXT_ATTR_FONT
) ; }
233 bool HasAlignment() const { return (m_textAlignment
!= wxTEXT_ALIGNMENT_DEFAULT
) || ((m_flags
& wxTEXT_ATTR_ALIGNMENT
) != 0) ; }
234 bool HasTabs() const { return (m_flags
& wxTEXT_ATTR_TABS
) != 0 ; }
235 bool HasLeftIndent() const { return (m_flags
& wxTEXT_ATTR_LEFT_INDENT
) != 0 ; }
236 bool HasRightIndent() const { return (m_flags
& wxTEXT_ATTR_RIGHT_INDENT
) != 0 ; }
237 bool HasFlag(long flag
) const { return (m_flags
& flag
) != 0; }
239 const wxColour
& GetTextColour() const { return m_colText
; }
240 const wxColour
& GetBackgroundColour() const { return m_colBack
; }
241 const wxFont
& GetFont() const { return m_font
; }
242 wxTextAttrAlignment
GetAlignment() const { return m_textAlignment
; }
243 const wxArrayInt
& GetTabs() const { return m_tabs
; }
244 long GetLeftIndent() const { return m_leftIndent
; }
245 long GetLeftSubIndent() const { return m_leftSubIndent
; }
246 long GetRightIndent() const { return m_rightIndent
; }
247 long GetFlags() const { return m_flags
; }
249 // returns false if we have any attributes set, true otherwise
250 bool IsDefault() const
252 return !HasTextColour() && !HasBackgroundColour() && !HasFont() && !HasAlignment() &&
253 !HasTabs() && !HasLeftIndent() && !HasRightIndent() ;
256 // return the attribute having the valid font and colours: it uses the
257 // attributes set in attr and falls back first to attrDefault and then to
258 // the text control font/colours for those attributes which are not set
259 static wxTextAttr
Combine(const wxTextAttr
& attr
,
260 const wxTextAttr
& attrDef
,
261 const wxTextCtrlBase
*text
);
268 wxTextAttrAlignment m_textAlignment
;
269 wxArrayInt m_tabs
; // array of int: tab stops in 1/10 mm
270 int m_leftIndent
; // left indent in 1/10 mm
271 int m_leftSubIndent
; // left indent for all but the first
272 // line in a paragraph relative to the
273 // first line, in 1/10 mm
274 int m_rightIndent
; // right indent in 1/10 mm
277 // ----------------------------------------------------------------------------
278 // wxTextCtrl: a single or multiple line text zone where user can enter and
280 // ----------------------------------------------------------------------------
282 class WXDLLEXPORT wxTextCtrlBase
: public wxControl
283 #if wxHAS_TEXT_WINDOW_STREAM
284 , public wxSTD streambuf
298 virtual wxString
GetValue() const = 0;
299 virtual void SetValue(const wxString
& value
) = 0;
301 virtual wxString
GetRange(long from
, long to
) const;
303 virtual int GetLineLength(long lineNo
) const = 0;
304 virtual wxString
GetLineText(long lineNo
) const = 0;
305 virtual int GetNumberOfLines() const = 0;
307 virtual bool IsModified() const = 0;
308 virtual bool IsEditable() const = 0;
310 // more readable flag testing methods
311 bool IsSingleLine() const { return !HasFlag(wxTE_MULTILINE
); }
312 bool IsMultiLine() const { return !IsSingleLine(); }
314 // If the return values from and to are the same, there is no selection.
315 virtual void GetSelection(long* from
, long* to
) const = 0;
317 virtual wxString
GetStringSelection() const;
323 virtual void Clear() = 0;
324 virtual void Replace(long from
, long to
, const wxString
& value
) = 0;
325 virtual void Remove(long from
, long to
) = 0;
327 // load/save the controls contents from/to the file
328 virtual bool LoadFile(const wxString
& file
);
329 virtual bool SaveFile(const wxString
& file
= wxEmptyString
);
331 // sets/clears the dirty flag
332 virtual void MarkDirty() = 0;
333 virtual void DiscardEdits() = 0;
335 // set the max number of characters which may be entered in a single line
337 virtual void SetMaxLength(unsigned long WXUNUSED(len
)) { }
339 // writing text inserts it at the current position, appending always
340 // inserts it at the end
341 virtual void WriteText(const wxString
& text
) = 0;
342 virtual void AppendText(const wxString
& text
) = 0;
344 // insert the character which would have resulted from this key event,
345 // return true if anything has been inserted
346 virtual bool EmulateKeyPress(const wxKeyEvent
& event
);
348 // text control under some platforms supports the text styles: these
349 // methods allow to apply the given text style to the given selection or to
350 // set/get the style which will be used for all appended text
351 virtual bool SetStyle(long start
, long end
, const wxTextAttr
& style
);
352 virtual bool GetStyle(long position
, wxTextAttr
& style
);
353 virtual bool SetDefaultStyle(const wxTextAttr
& style
);
354 virtual const wxTextAttr
& GetDefaultStyle() const;
356 // translate between the position (which is just an index in the text ctrl
357 // considering all its contents as a single strings) and (x, y) coordinates
358 // which represent column and line.
359 virtual long XYToPosition(long x
, long y
) const = 0;
360 virtual bool PositionToXY(long pos
, long *x
, long *y
) const = 0;
362 virtual void ShowPosition(long pos
) = 0;
364 // find the character at position given in pixels
366 // NB: pt is in device coords (not adjusted for the client area origin nor
368 virtual wxTextCtrlHitTestResult
HitTest(const wxPoint
& pt
, long *pos
) const;
369 virtual wxTextCtrlHitTestResult
HitTest(const wxPoint
& pt
,
371 wxTextCoord
*row
) const;
373 // Clipboard operations
374 virtual void Copy() = 0;
375 virtual void Cut() = 0;
376 virtual void Paste() = 0;
378 virtual bool CanCopy() const;
379 virtual bool CanCut() const;
380 virtual bool CanPaste() const;
383 virtual void Undo() = 0;
384 virtual void Redo() = 0;
386 virtual bool CanUndo() const = 0;
387 virtual bool CanRedo() const = 0;
390 virtual void SetInsertionPoint(long pos
) = 0;
391 virtual void SetInsertionPointEnd() = 0;
392 virtual long GetInsertionPoint() const = 0;
393 virtual wxTextPos
GetLastPosition() const = 0;
395 virtual void SetSelection(long from
, long to
) = 0;
396 virtual void SelectAll();
397 virtual void SetEditable(bool editable
) = 0;
399 // stream-like insertion operators: these are always available, whether we
400 // were, or not, compiled with streambuf support
401 wxTextCtrl
& operator<<(const wxString
& s
);
402 wxTextCtrl
& operator<<(int i
);
403 wxTextCtrl
& operator<<(long i
);
404 wxTextCtrl
& operator<<(float f
);
405 wxTextCtrl
& operator<<(double d
);
406 wxTextCtrl
& operator<<(const wxChar c
);
408 // do the window-specific processing after processing the update event
409 virtual void DoUpdateWindowUI(wxUpdateUIEvent
& event
);
411 virtual bool ShouldInheritColours() const { return false; }
414 // override streambuf method
415 #if wxHAS_TEXT_WINDOW_STREAM
417 #endif // wxHAS_TEXT_WINDOW_STREAM
419 // the name of the last file loaded with LoadFile() which will be used by
420 // SaveFile() by default
423 // the text style which will be used for any new text added to the control
424 wxTextAttr m_defaultStyle
;
426 DECLARE_NO_COPY_CLASS(wxTextCtrlBase
)
429 // ----------------------------------------------------------------------------
430 // include the platform-dependent class definition
431 // ----------------------------------------------------------------------------
433 #if defined(__WXX11__)
434 #include "wx/x11/textctrl.h"
435 #elif defined(__WXUNIVERSAL__)
436 #include "wx/univ/textctrl.h"
437 #elif defined(__SMARTPHONE__) && defined(__WXWINCE__)
438 #include "wx/msw/wince/textctrlce.h"
439 #elif defined(__WXMSW__)
440 #include "wx/msw/textctrl.h"
441 #elif defined(__WXMOTIF__)
442 #include "wx/motif/textctrl.h"
443 #elif defined(__WXGTK20__)
444 #include "wx/gtk/textctrl.h"
445 #elif defined(__WXGTK__)
446 #include "wx/gtk1/textctrl.h"
447 #elif defined(__WXMAC__)
448 #include "wx/mac/textctrl.h"
449 #elif defined(__WXCOCOA__)
450 #include "wx/cocoa/textctrl.h"
451 #elif defined(__WXPM__)
452 #include "wx/os2/textctrl.h"
455 // ----------------------------------------------------------------------------
457 // ----------------------------------------------------------------------------
459 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
461 BEGIN_DECLARE_EVENT_TYPES()
462 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_UPDATED
, 7)
463 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_ENTER
, 8)
464 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_URL
, 13)
465 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_MAXLEN
, 14)
466 END_DECLARE_EVENT_TYPES()
468 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
470 class WXDLLEXPORT wxTextUrlEvent
: public wxCommandEvent
473 wxTextUrlEvent(int winid
, const wxMouseEvent
& evtMouse
,
474 long start
, long end
)
475 : wxCommandEvent(wxEVT_COMMAND_TEXT_URL
, winid
)
476 , m_evtMouse(evtMouse
), m_start(start
), m_end(end
)
479 // get the mouse event which happend over the URL
480 const wxMouseEvent
& GetMouseEvent() const { return m_evtMouse
; }
482 // get the start of the URL
483 long GetURLStart() const { return m_start
; }
485 // get the end of the URL
486 long GetURLEnd() const { return m_end
; }
489 // the corresponding mouse event
490 wxMouseEvent m_evtMouse
;
492 // the start and end indices of the URL in the text control
497 DECLARE_DYNAMIC_CLASS_NO_COPY(wxTextUrlEvent
)
500 // for wxWin RTTI only, don't use
501 wxTextUrlEvent() : m_evtMouse(), m_start(0), m_end(0) { }
504 typedef void (wxEvtHandler::*wxTextUrlEventFunction
)(wxTextUrlEvent
&);
506 #define wxTextEventHandler(func) wxCommandEventHandler(func)
507 #define wxTextUrlEventHandler(func) \
508 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxTextUrlEventFunction, &func)
510 #define wx__DECLARE_TEXTEVT(evt, id, fn) \
511 wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_ ## evt, id, wxTextEventHandler(fn))
513 #define wx__DECLARE_TEXTURLEVT(evt, id, fn) \
514 wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_ ## evt, id, wxTextUrlEventHandler(fn))
516 #define EVT_TEXT(id, fn) wx__DECLARE_TEXTEVT(UPDATED, id, fn)
517 #define EVT_TEXT_ENTER(id, fn) wx__DECLARE_TEXTEVT(ENTER, id, fn)
518 #define EVT_TEXT_URL(id, fn) wx__DECLARE_TEXTURLEVT(URL, id, fn)
519 #define EVT_TEXT_MAXLEN(id, fn) wx__DECLARE_TEXTEVT(MAXLEN, id, fn)
521 #if wxHAS_TEXT_WINDOW_STREAM
523 // ----------------------------------------------------------------------------
524 // wxStreamToTextRedirector: this class redirects all data sent to the given
525 // C++ stream to the wxTextCtrl given to its ctor during its lifetime.
526 // ----------------------------------------------------------------------------
528 class WXDLLEXPORT wxStreamToTextRedirector
531 void Init(wxTextCtrl
*text
)
533 m_sbufOld
= m_ostr
.rdbuf();
538 wxStreamToTextRedirector(wxTextCtrl
*text
)
544 wxStreamToTextRedirector(wxTextCtrl
*text
, wxSTD ostream
*ostr
)
550 ~wxStreamToTextRedirector()
552 m_ostr
.rdbuf(m_sbufOld
);
556 // the stream we're redirecting
557 wxSTD ostream
& m_ostr
;
559 // the old streambuf (before we changed it)
560 wxSTD streambuf
*m_sbufOld
;
563 #endif // wxHAS_TEXT_WINDOW_STREAM
565 #endif // wxUSE_TEXTCTRL
568 // _WX_TEXTCTRL_H_BASE_