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 and wxGTK2 multiline 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 // reuse wxTE_RICH2's value for CAPEDIT control on Windows CE
127 #if defined(__SMARTPHONE__) || defined(__POCKETPC__)
128 #define wxTE_CAPITALIZE wxTE_RICH2
130 #define wxTE_CAPITALIZE 0
133 // ----------------------------------------------------------------------------
134 // wxTextCtrl::HitTest return values
135 // ----------------------------------------------------------------------------
137 // the point asked is ...
138 enum wxTextCtrlHitTestResult
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]
146 // ... the character returned
148 // ----------------------------------------------------------------------------
149 // Types for wxTextAttr
150 // ----------------------------------------------------------------------------
154 enum wxTextAttrAlignment
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
164 // Flags to indicate which attributes are being applied
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 | 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
);
198 void operator= (const wxTextAttr
& attr
);
201 void SetTextColour(const wxColour
& colText
) { m_colText
= colText
; m_flags
|= wxTEXT_ATTR_TEXT_COLOUR
; }
202 void SetBackgroundColour(const wxColour
& colBack
) { m_colBack
= colBack
; m_flags
|= wxTEXT_ATTR_BACKGROUND_COLOUR
; }
203 void SetFont(const wxFont
& font
, long flags
= wxTEXT_ATTR_FONT
) { m_font
= font
; m_flags
|= flags
; }
204 void SetAlignment(wxTextAttrAlignment alignment
) { m_textAlignment
= alignment
; m_flags
|= wxTEXT_ATTR_ALIGNMENT
; }
205 void SetTabs(const wxArrayInt
& tabs
) { m_tabs
= tabs
; m_flags
|= wxTEXT_ATTR_TABS
; }
206 void SetLeftIndent(int indent
, int subIndent
= 0) { m_leftIndent
= indent
; m_leftSubIndent
= subIndent
; m_flags
|= wxTEXT_ATTR_LEFT_INDENT
; }
207 void SetRightIndent(int indent
) { m_rightIndent
= indent
; m_flags
|= wxTEXT_ATTR_RIGHT_INDENT
; }
208 void SetFlags(long flags
) { m_flags
= flags
; }
211 bool HasTextColour() const { return m_colText
.Ok() && HasFlag(wxTEXT_ATTR_TEXT_COLOUR
) ; }
212 bool HasBackgroundColour() const { return m_colBack
.Ok() && HasFlag(wxTEXT_ATTR_BACKGROUND_COLOUR
) ; }
213 bool HasFont() const { return m_font
.Ok() && HasFlag(wxTEXT_ATTR_FONT
) ; }
214 bool HasAlignment() const { return (m_textAlignment
!= wxTEXT_ALIGNMENT_DEFAULT
) || ((m_flags
& wxTEXT_ATTR_ALIGNMENT
) != 0) ; }
215 bool HasTabs() const { return (m_flags
& wxTEXT_ATTR_TABS
) != 0 ; }
216 bool HasLeftIndent() const { return (m_flags
& wxTEXT_ATTR_LEFT_INDENT
) != 0 ; }
217 bool HasRightIndent() const { return (m_flags
& wxTEXT_ATTR_RIGHT_INDENT
) != 0 ; }
218 bool HasFlag(long flag
) const { return (m_flags
& flag
) != 0; }
220 const wxColour
& GetTextColour() const { return m_colText
; }
221 const wxColour
& GetBackgroundColour() const { return m_colBack
; }
222 const wxFont
& GetFont() const { return m_font
; }
223 wxTextAttrAlignment
GetAlignment() const { return m_textAlignment
; }
224 const wxArrayInt
& GetTabs() const { return m_tabs
; }
225 long GetLeftIndent() const { return m_leftIndent
; }
226 long GetLeftSubIndent() const { return m_leftSubIndent
; }
227 long GetRightIndent() const { return m_rightIndent
; }
228 long GetFlags() const { return m_flags
; }
230 // returns false if we have any attributes set, true otherwise
231 bool IsDefault() const
233 return !HasTextColour() && !HasBackgroundColour() && !HasFont() && !HasAlignment() &&
234 !HasTabs() && !HasLeftIndent() && !HasRightIndent() ;
237 // return the attribute having the valid font and colours: it uses the
238 // attributes set in attr and falls back first to attrDefault and then to
239 // the text control font/colours for those attributes which are not set
240 static wxTextAttr
Combine(const wxTextAttr
& attr
,
241 const wxTextAttr
& attrDef
,
242 const wxTextCtrlBase
*text
);
249 wxTextAttrAlignment m_textAlignment
;
250 wxArrayInt m_tabs
; // array of int: tab stops in 1/10 mm
251 int m_leftIndent
; // left indent in 1/10 mm
252 int m_leftSubIndent
; // left indent for all but the first
253 // line in a paragraph relative to the
254 // first line, in 1/10 mm
255 int m_rightIndent
; // right indent in 1/10 mm
258 // ----------------------------------------------------------------------------
259 // wxTextCtrl: a single or multiple line text zone where user can enter and
261 // ----------------------------------------------------------------------------
263 class WXDLLEXPORT wxTextCtrlBase
: public wxControl
264 #ifndef NO_TEXT_WINDOW_STREAM
265 , public wxSTD streambuf
279 virtual wxString
GetValue() const = 0;
280 virtual void SetValue(const wxString
& value
) = 0;
282 virtual wxString
GetRange(long from
, long to
) const;
284 virtual int GetLineLength(long lineNo
) const = 0;
285 virtual wxString
GetLineText(long lineNo
) const = 0;
286 virtual int GetNumberOfLines() const = 0;
288 virtual bool IsModified() const = 0;
289 virtual bool IsEditable() const = 0;
291 // more readable flag testing methods
292 bool IsSingleLine() const { return !HasFlag(wxTE_MULTILINE
); }
293 bool IsMultiLine() const { return !IsSingleLine(); }
295 // If the return values from and to are the same, there is no selection.
296 virtual void GetSelection(long* from
, long* to
) const = 0;
298 virtual wxString
GetStringSelection() const;
304 virtual void Clear() = 0;
305 virtual void Replace(long from
, long to
, const wxString
& value
) = 0;
306 virtual void Remove(long from
, long to
) = 0;
308 // load/save the controls contents from/to the file
309 virtual bool LoadFile(const wxString
& file
);
310 virtual bool SaveFile(const wxString
& file
= wxEmptyString
);
312 // sets/clears the dirty flag
313 virtual void MarkDirty() = 0;
314 virtual void DiscardEdits() = 0;
316 // set the max number of characters which may be entered in a single line
318 virtual void SetMaxLength(unsigned long WXUNUSED(len
)) { }
320 // writing text inserts it at the current position, appending always
321 // inserts it at the end
322 virtual void WriteText(const wxString
& text
) = 0;
323 virtual void AppendText(const wxString
& text
) = 0;
325 // insert the character which would have resulted from this key event,
326 // return true if anything has been inserted
327 virtual bool EmulateKeyPress(const wxKeyEvent
& event
);
329 // text control under some platforms supports the text styles: these
330 // methods allow to apply the given text style to the given selection or to
331 // set/get the style which will be used for all appended text
332 virtual bool SetStyle(long start
, long end
, const wxTextAttr
& style
);
333 virtual bool GetStyle(long position
, wxTextAttr
& style
);
334 virtual bool SetDefaultStyle(const wxTextAttr
& style
);
335 virtual const wxTextAttr
& GetDefaultStyle() const;
337 // translate between the position (which is just an index in the text ctrl
338 // considering all its contents as a single strings) and (x, y) coordinates
339 // which represent column and line.
340 virtual long XYToPosition(long x
, long y
) const = 0;
341 virtual bool PositionToXY(long pos
, long *x
, long *y
) const = 0;
343 virtual void ShowPosition(long pos
) = 0;
345 // find the character at position given in pixels
347 // NB: pt is in device coords (not adjusted for the client area origin nor
349 virtual wxTextCtrlHitTestResult
HitTest(const wxPoint
& pt
, long *pos
) const;
350 virtual wxTextCtrlHitTestResult
HitTest(const wxPoint
& pt
,
352 wxTextCoord
*row
) const;
354 // Clipboard operations
355 virtual void Copy() = 0;
356 virtual void Cut() = 0;
357 virtual void Paste() = 0;
359 virtual bool CanCopy() const;
360 virtual bool CanCut() const;
361 virtual bool CanPaste() const;
364 virtual void Undo() = 0;
365 virtual void Redo() = 0;
367 virtual bool CanUndo() const = 0;
368 virtual bool CanRedo() const = 0;
371 virtual void SetInsertionPoint(long pos
) = 0;
372 virtual void SetInsertionPointEnd() = 0;
373 virtual long GetInsertionPoint() const = 0;
374 virtual wxTextPos
GetLastPosition() const = 0;
376 virtual void SetSelection(long from
, long to
) = 0;
377 virtual void SelectAll();
378 virtual void SetEditable(bool editable
) = 0;
380 // override streambuf method
381 #ifndef NO_TEXT_WINDOW_STREAM
383 #endif // NO_TEXT_WINDOW_STREAM
385 // stream-like insertion operators: these are always available, whether we
386 // were, or not, compiled with streambuf support
387 wxTextCtrl
& operator<<(const wxString
& s
);
388 wxTextCtrl
& operator<<(int i
);
389 wxTextCtrl
& operator<<(long i
);
390 wxTextCtrl
& operator<<(float f
);
391 wxTextCtrl
& operator<<(double d
);
392 wxTextCtrl
& operator<<(const wxChar c
);
394 // do the window-specific processing after processing the update event
395 virtual void DoUpdateWindowUI(wxUpdateUIEvent
& event
);
397 virtual bool ShouldInheritColours() const { return false; }
400 // the name of the last file loaded with LoadFile() which will be used by
401 // SaveFile() by default
404 // the text style which will be used for any new text added to the control
405 wxTextAttr m_defaultStyle
;
407 DECLARE_NO_COPY_CLASS(wxTextCtrlBase
)
410 // ----------------------------------------------------------------------------
411 // include the platform-dependent class definition
412 // ----------------------------------------------------------------------------
414 #if defined(__WXX11__)
415 #include "wx/x11/textctrl.h"
416 #elif defined(__WXUNIVERSAL__)
417 #include "wx/univ/textctrl.h"
418 #elif defined(__SMARTPHONE__) && defined(__WXWINCE__)
419 #include "wx/msw/wince/textctrlce.h"
420 #elif defined(__WXMSW__)
421 #include "wx/msw/textctrl.h"
422 #elif defined(__WXMOTIF__)
423 #include "wx/motif/textctrl.h"
424 #elif defined(__WXGTK__)
425 #include "wx/gtk/textctrl.h"
426 #elif defined(__WXMAC__)
427 #include "wx/mac/textctrl.h"
428 #elif defined(__WXCOCOA__)
429 #include "wx/cocoa/textctrl.h"
430 #elif defined(__WXPM__)
431 #include "wx/os2/textctrl.h"
434 // ----------------------------------------------------------------------------
436 // ----------------------------------------------------------------------------
438 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
440 BEGIN_DECLARE_EVENT_TYPES()
441 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_UPDATED
, 7)
442 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_ENTER
, 8)
443 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_URL
, 13)
444 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_MAXLEN
, 14)
445 END_DECLARE_EVENT_TYPES()
447 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
449 class WXDLLEXPORT wxTextUrlEvent
: public wxCommandEvent
452 wxTextUrlEvent(int winid
, const wxMouseEvent
& evtMouse
,
453 long start
, long end
)
454 : wxCommandEvent(wxEVT_COMMAND_TEXT_URL
, winid
)
455 , m_evtMouse(evtMouse
), m_start(start
), m_end(end
)
458 // get the mouse event which happend over the URL
459 const wxMouseEvent
& GetMouseEvent() const { return m_evtMouse
; }
461 // get the start of the URL
462 long GetURLStart() const { return m_start
; }
464 // get the end of the URL
465 long GetURLEnd() const { return m_end
; }
468 // the corresponding mouse event
469 wxMouseEvent m_evtMouse
;
471 // the start and end indices of the URL in the text control
476 DECLARE_DYNAMIC_CLASS_NO_COPY(wxTextUrlEvent
)
479 // for wxWin RTTI only, don't use
480 wxTextUrlEvent() : m_evtMouse(), m_start(0), m_end(0) { }
483 typedef void (wxEvtHandler::*wxTextUrlEventFunction
)(wxTextUrlEvent
&);
485 #define wxTextEventHandler(func) wxCommandEventHandler(func)
486 #define wxTextUrlEventHandler(func) \
487 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxTextUrlEventFunction, &func)
489 #define wx__DECLARE_TEXTEVT(evt, id, fn) \
490 wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_ ## evt, id, wxTextEventHandler(fn))
492 #define wx__DECLARE_TEXTURLEVT(evt, id, fn) \
493 wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_ ## evt, id, wxTextUrlEventHandler(fn))
495 #define EVT_TEXT(id, fn) wx__DECLARE_TEXTEVT(UPDATED, id, fn)
496 #define EVT_TEXT_ENTER(id, fn) wx__DECLARE_TEXTEVT(ENTER, id, fn)
497 #define EVT_TEXT_URL(id, fn) wx__DECLARE_TEXTURLEVT(URL, id, fn)
498 #define EVT_TEXT_MAXLEN(id, fn) wx__DECLARE_TEXTEVT(MAXLEN, id, fn)
500 #ifndef NO_TEXT_WINDOW_STREAM
502 // ----------------------------------------------------------------------------
503 // wxStreamToTextRedirector: this class redirects all data sent to the given
504 // C++ stream to the wxTextCtrl given to its ctor during its lifetime.
505 // ----------------------------------------------------------------------------
507 class WXDLLEXPORT wxStreamToTextRedirector
510 void Init(wxTextCtrl
*text
)
512 m_sbufOld
= m_ostr
.rdbuf();
517 wxStreamToTextRedirector(wxTextCtrl
*text
)
523 wxStreamToTextRedirector(wxTextCtrl
*text
, wxSTD ostream
*ostr
)
529 ~wxStreamToTextRedirector()
531 m_ostr
.rdbuf(m_sbufOld
);
535 // the stream we're redirecting
536 wxSTD ostream
& m_ostr
;
538 // the old streambuf (before we changed it)
539 wxSTD streambuf
*m_sbufOld
;
542 #endif // !NO_TEXT_WINDOW_STREAM
544 #endif // wxUSE_TEXTCTRL
547 // _WX_TEXTCTRL_H_BASE_