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/textentry.h" // single-line text entry interface
25 #include "wx/dynarray.h" // wxArrayInt
26 #include "wx/gdicmn.h" // wxPoint
28 // Open Watcom 1.3 does allow only ios::rdbuf() while
29 // we want something with streambuf parameter
30 // Also, can't use streambuf if making or using a DLL :-(
32 #if defined(__WATCOMC__) || \
33 defined(__MWERKS__) || \
34 (defined(__WINDOWS__) && (defined(WXUSINGDLL) || defined(WXMAKINGDLL)))
35 #define wxHAS_TEXT_WINDOW_STREAM 0
36 #elif wxUSE_STD_IOSTREAM
37 #include "wx/ioswrap.h"
38 #define wxHAS_TEXT_WINDOW_STREAM 1
40 #define wxHAS_TEXT_WINDOW_STREAM 0
43 class WXDLLIMPEXP_FWD_CORE wxTextCtrl
;
44 class WXDLLIMPEXP_FWD_CORE wxTextCtrlBase
;
46 // ----------------------------------------------------------------------------
48 // ----------------------------------------------------------------------------
50 // wxTextCoord is the line or row number (which should have been unsigned but
51 // is long for backwards compatibility)
52 typedef long wxTextCoord
;
54 // ----------------------------------------------------------------------------
56 // ----------------------------------------------------------------------------
58 extern WXDLLEXPORT_DATA(const wxChar
) wxTextCtrlNameStr
[];
60 // this is intentionally not enum to avoid warning fixes with
61 // typecasting from enum type to wxTextCoord
62 const wxTextCoord wxOutOfRangeTextCoord
= -1;
63 const wxTextCoord wxInvalidTextCoord
= -2;
65 // ----------------------------------------------------------------------------
66 // wxTextCtrl style flags
67 // ----------------------------------------------------------------------------
69 #define wxTE_NO_VSCROLL 0x0002
70 #define wxTE_AUTO_SCROLL 0x0008
72 #define wxTE_READONLY 0x0010
73 #define wxTE_MULTILINE 0x0020
74 #define wxTE_PROCESS_TAB 0x0040
77 #define wxTE_LEFT 0x0000 // 0x0000
78 #define wxTE_CENTER wxALIGN_CENTER_HORIZONTAL // 0x0100
79 #define wxTE_RIGHT wxALIGN_RIGHT // 0x0200
80 #define wxTE_CENTRE wxTE_CENTER
82 // this style means to use RICHEDIT control and does something only under wxMSW
83 // and Win32 and is silently ignored under all other platforms
84 #define wxTE_RICH 0x0080
86 #define wxTE_PROCESS_ENTER 0x0400
87 #define wxTE_PASSWORD 0x0800
89 // automatically detect the URLs and generate the events when mouse is
90 // moved/clicked over an URL
92 // this is for Win32 richedit and wxGTK2 multiline controls only so far
93 #define wxTE_AUTO_URL 0x1000
95 // by default, the Windows text control doesn't show the selection when it
96 // doesn't have focus - use this style to force it to always show it
97 #define wxTE_NOHIDESEL 0x2000
99 // use wxHSCROLL to not wrap text at all, wxTE_CHARWRAP to wrap it at any
100 // position and wxTE_WORDWRAP to wrap at words boundary
102 // if no wrapping style is given at all, the control wraps at word boundary
103 #define wxTE_DONTWRAP wxHSCROLL
104 #define wxTE_CHARWRAP 0x4000 // wrap at any position
105 #define wxTE_WORDWRAP 0x0001 // wrap only at words boundaries
106 #define wxTE_BESTWRAP 0x0000 // this is the default
108 #if WXWIN_COMPATIBILITY_2_6
110 #define wxTE_LINEWRAP wxTE_CHARWRAP
111 #endif // WXWIN_COMPATIBILITY_2_6
113 // force using RichEdit version 2.0 or 3.0 instead of 1.0 (default) for
114 // wxTE_RICH controls - can be used together with or instead of wxTE_RICH
115 #define wxTE_RICH2 0x8000
117 // reuse wxTE_RICH2's value for CAPEDIT control on Windows CE
118 #if defined(__SMARTPHONE__) || defined(__POCKETPC__)
119 #define wxTE_CAPITALIZE wxTE_RICH2
121 #define wxTE_CAPITALIZE 0
124 // ----------------------------------------------------------------------------
125 // wxTextCtrl file types
126 // ----------------------------------------------------------------------------
128 #define wxTEXT_TYPE_ANY 0
130 // ----------------------------------------------------------------------------
131 // wxTextCtrl::HitTest return values
132 // ----------------------------------------------------------------------------
134 // the point asked is ...
135 enum wxTextCtrlHitTestResult
137 wxTE_HT_UNKNOWN
= -2, // this means HitTest() is simply not implemented
138 wxTE_HT_BEFORE
, // either to the left or upper
139 wxTE_HT_ON_TEXT
, // directly on
140 wxTE_HT_BELOW
, // below [the last line]
141 wxTE_HT_BEYOND
// after [the end of line]
143 // ... the character returned
145 // ----------------------------------------------------------------------------
146 // Types for wxTextAttr
147 // ----------------------------------------------------------------------------
151 enum wxTextAttrAlignment
153 wxTEXT_ALIGNMENT_DEFAULT
,
154 wxTEXT_ALIGNMENT_LEFT
,
155 wxTEXT_ALIGNMENT_CENTRE
,
156 wxTEXT_ALIGNMENT_CENTER
= wxTEXT_ALIGNMENT_CENTRE
,
157 wxTEXT_ALIGNMENT_RIGHT
,
158 wxTEXT_ALIGNMENT_JUSTIFIED
161 // Flags to indicate which attributes are being applied
163 #define wxTEXT_ATTR_TEXT_COLOUR 0x0001
164 #define wxTEXT_ATTR_BACKGROUND_COLOUR 0x0002
165 #define wxTEXT_ATTR_FONT_FACE 0x0004
166 #define wxTEXT_ATTR_FONT_SIZE 0x0008
167 #define wxTEXT_ATTR_FONT_WEIGHT 0x0010
168 #define wxTEXT_ATTR_FONT_ITALIC 0x0020
169 #define wxTEXT_ATTR_FONT_UNDERLINE 0x0040
170 #define wxTEXT_ATTR_FONT \
171 ( wxTEXT_ATTR_FONT_FACE | wxTEXT_ATTR_FONT_SIZE | wxTEXT_ATTR_FONT_WEIGHT | \
172 wxTEXT_ATTR_FONT_ITALIC | wxTEXT_ATTR_FONT_UNDERLINE )
173 #define wxTEXT_ATTR_ALIGNMENT 0x0080
174 #define wxTEXT_ATTR_LEFT_INDENT 0x0100
175 #define wxTEXT_ATTR_RIGHT_INDENT 0x0200
176 #define wxTEXT_ATTR_TABS 0x0400
178 // ----------------------------------------------------------------------------
179 // wxTextAttr: a structure containing the visual attributes of a text
180 // ----------------------------------------------------------------------------
182 class WXDLLEXPORT wxTextAttr
186 wxTextAttr() { Init(); }
187 wxTextAttr(const wxColour
& colText
,
188 const wxColour
& colBack
= wxNullColour
,
189 const wxFont
& font
= wxNullFont
,
190 wxTextAttrAlignment alignment
= wxTEXT_ALIGNMENT_DEFAULT
);
195 // merges the attributes of the base and the overlay objects and returns
196 // the result; the parameter attributes take precedence
198 // WARNING: the order of arguments is the opposite of Combine()
199 static wxTextAttr
Merge(const wxTextAttr
& base
, const wxTextAttr
& overlay
)
201 return Combine(overlay
, base
, NULL
);
204 // merges the attributes of this object and overlay
205 void Merge(const wxTextAttr
& overlay
)
207 *this = Merge(*this, overlay
);
212 void operator= (const wxTextAttr
& attr
);
215 void SetTextColour(const wxColour
& colText
) { m_colText
= colText
; m_flags
|= wxTEXT_ATTR_TEXT_COLOUR
; }
216 void SetBackgroundColour(const wxColour
& colBack
) { m_colBack
= colBack
; m_flags
|= wxTEXT_ATTR_BACKGROUND_COLOUR
; }
217 void SetFont(const wxFont
& font
, long flags
= wxTEXT_ATTR_FONT
) { m_font
= font
; m_flags
|= flags
; }
218 void SetAlignment(wxTextAttrAlignment alignment
) { m_textAlignment
= alignment
; m_flags
|= wxTEXT_ATTR_ALIGNMENT
; }
219 void SetTabs(const wxArrayInt
& tabs
) { m_tabs
= tabs
; m_flags
|= wxTEXT_ATTR_TABS
; }
220 void SetLeftIndent(int indent
, int subIndent
= 0) { m_leftIndent
= indent
; m_leftSubIndent
= subIndent
; m_flags
|= wxTEXT_ATTR_LEFT_INDENT
; }
221 void SetRightIndent(int indent
) { m_rightIndent
= indent
; m_flags
|= wxTEXT_ATTR_RIGHT_INDENT
; }
222 void SetFlags(long flags
) { m_flags
= flags
; }
225 bool HasTextColour() const { return m_colText
.Ok() && HasFlag(wxTEXT_ATTR_TEXT_COLOUR
) ; }
226 bool HasBackgroundColour() const { return m_colBack
.Ok() && HasFlag(wxTEXT_ATTR_BACKGROUND_COLOUR
) ; }
227 bool HasFont() const { return m_font
.Ok() && HasFlag(wxTEXT_ATTR_FONT
) ; }
228 bool HasAlignment() const { return (m_textAlignment
!= wxTEXT_ALIGNMENT_DEFAULT
) || ((m_flags
& wxTEXT_ATTR_ALIGNMENT
) != 0) ; }
229 bool HasTabs() const { return (m_flags
& wxTEXT_ATTR_TABS
) != 0 ; }
230 bool HasLeftIndent() const { return (m_flags
& wxTEXT_ATTR_LEFT_INDENT
) != 0 ; }
231 bool HasRightIndent() const { return (m_flags
& wxTEXT_ATTR_RIGHT_INDENT
) != 0 ; }
232 bool HasFlag(long flag
) const { return (m_flags
& flag
) != 0; }
234 const wxColour
& GetTextColour() const { return m_colText
; }
235 const wxColour
& GetBackgroundColour() const { return m_colBack
; }
236 const wxFont
& GetFont() const { return m_font
; }
237 wxTextAttrAlignment
GetAlignment() const { return m_textAlignment
; }
238 const wxArrayInt
& GetTabs() const { return m_tabs
; }
239 long GetLeftIndent() const { return m_leftIndent
; }
240 long GetLeftSubIndent() const { return m_leftSubIndent
; }
241 long GetRightIndent() const { return m_rightIndent
; }
242 long GetFlags() const { return m_flags
; }
244 // returns false if we have any attributes set, true otherwise
245 bool IsDefault() const
247 return !HasTextColour() && !HasBackgroundColour() && !HasFont() && !HasAlignment() &&
248 !HasTabs() && !HasLeftIndent() && !HasRightIndent() ;
251 // return the attribute having the valid font and colours: it uses the
252 // attributes set in attr and falls back first to attrDefault and then to
253 // the text control font/colours for those attributes which are not set
254 static wxTextAttr
Combine(const wxTextAttr
& attr
,
255 const wxTextAttr
& attrDef
,
256 const wxTextCtrlBase
*text
);
263 wxTextAttrAlignment m_textAlignment
;
264 wxArrayInt m_tabs
; // array of int: tab stops in 1/10 mm
265 int m_leftIndent
; // left indent in 1/10 mm
266 int m_leftSubIndent
; // left indent for all but the first
267 // line in a paragraph relative to the
268 // first line, in 1/10 mm
269 int m_rightIndent
; // right indent in 1/10 mm
272 // ----------------------------------------------------------------------------
273 // wxTextAreaBase: multiline text control specific methods
274 // ----------------------------------------------------------------------------
276 class WXDLLIMPEXP_CORE wxTextAreaBase
280 virtual ~wxTextAreaBase() { }
285 virtual int GetLineLength(long lineNo
) const = 0;
286 virtual wxString
GetLineText(long lineNo
) const = 0;
287 virtual int GetNumberOfLines() const = 0;
293 bool LoadFile(const wxString
& file
, int fileType
= wxTEXT_TYPE_ANY
)
294 { return DoLoadFile(file
, fileType
); }
295 bool SaveFile(const wxString
& file
= wxEmptyString
,
296 int fileType
= wxTEXT_TYPE_ANY
);
298 // dirty flag handling
299 // -------------------
301 virtual bool IsModified() const = 0;
302 virtual void MarkDirty() = 0;
303 virtual void DiscardEdits() = 0;
304 void SetModified(bool modified
)
316 // text control under some platforms supports the text styles: these
317 // methods allow to apply the given text style to the given selection or to
318 // set/get the style which will be used for all appended text
319 virtual bool SetStyle(long start
, long end
, const wxTextAttr
& style
) = 0;
320 virtual bool GetStyle(long position
, wxTextAttr
& style
) = 0;
321 virtual bool SetDefaultStyle(const wxTextAttr
& style
) = 0;
322 virtual const wxTextAttr
& GetDefaultStyle() const { return m_defaultStyle
; }
325 // coordinates translation
326 // -----------------------
328 // translate between the position (which is just an index in the text ctrl
329 // considering all its contents as a single strings) and (x, y) coordinates
330 // which represent column and line.
331 virtual long XYToPosition(long x
, long y
) const = 0;
332 virtual bool PositionToXY(long pos
, long *x
, long *y
) const = 0;
334 virtual void ShowPosition(long pos
) = 0;
336 // find the character at position given in pixels
338 // NB: pt is in device coords (not adjusted for the client area origin nor
340 virtual wxTextCtrlHitTestResult
HitTest(const wxPoint
& pt
, long *pos
) const;
341 virtual wxTextCtrlHitTestResult
HitTest(const wxPoint
& pt
,
343 wxTextCoord
*row
) const;
346 // implementation of loading/saving
347 virtual bool DoLoadFile(const wxString
& file
, int fileType
) = 0;
348 virtual bool DoSaveFile(const wxString
& file
, int fileType
) = 0;
351 // the name of the last file loaded with LoadFile() which will be used by
352 // SaveFile() by default
355 // the text style which will be used for any new text added to the control
356 wxTextAttr m_defaultStyle
;
359 DECLARE_NO_COPY_CLASS(wxTextAreaBase
)
362 // this class defines wxTextCtrl interface, wxTextCtrlBase actually implements
363 // too much things because it derives from wxTextEntry and not wxTextEntryBase
364 // and so any classes which "look like" wxTextCtrl (such as wxRichTextCtrl)
365 // but don't need the (native) implementation bits from wxTextEntry should
366 // actually derive from this one and not wxTextCtrlBase
367 class WXDLLIMPEXP_CORE wxTextCtrlIface
: public wxTextAreaBase
,
368 public wxTextEntryBase
371 wxTextCtrlIface() { }
374 DECLARE_NO_COPY_CLASS(wxTextCtrlIface
)
377 // ----------------------------------------------------------------------------
378 // wxTextCtrl: a single or multiple line text zone where user can edit text
379 // ----------------------------------------------------------------------------
381 class WXDLLEXPORT wxTextCtrlBase
: public wxControl
,
382 #if wxHAS_TEXT_WINDOW_STREAM
383 public wxSTD streambuf
,
385 public wxTextAreaBase
,
393 virtual ~wxTextCtrlBase() { }
396 // more readable flag testing methods
397 bool IsSingleLine() const { return !HasFlag(wxTE_MULTILINE
); }
398 bool IsMultiLine() const { return !IsSingleLine(); }
400 // stream-like insertion operators: these are always available, whether we
401 // were, or not, compiled with streambuf support
402 wxTextCtrl
& operator<<(const wxString
& s
);
403 wxTextCtrl
& operator<<(int i
);
404 wxTextCtrl
& operator<<(long i
);
405 wxTextCtrl
& operator<<(float f
);
406 wxTextCtrl
& operator<<(double d
);
407 wxTextCtrl
& operator<<(const wxChar c
);
409 // insert the character which would have resulted from this key event,
410 // return true if anything has been inserted
411 virtual bool EmulateKeyPress(const wxKeyEvent
& event
);
414 // generate the wxEVT_COMMAND_TEXT_UPDATED event, like SetValue() does and
415 // return true if the event was processed
416 static bool SendTextUpdatedEvent(wxWindow
*win
);
417 bool SendTextUpdatedEvent() { return SendTextUpdatedEvent(this); }
419 // do the window-specific processing after processing the update event
420 virtual void DoUpdateWindowUI(wxUpdateUIEvent
& event
);
422 virtual bool ShouldInheritColours() const { return false; }
424 // work around the problem with having HitTest() both in wxControl and
425 // wxTextAreaBase base classes
426 virtual wxTextCtrlHitTestResult
HitTest(const wxPoint
& pt
, long *pos
) const
428 return wxTextAreaBase::HitTest(pt
, pos
);
431 virtual wxTextCtrlHitTestResult
HitTest(const wxPoint
& pt
,
433 wxTextCoord
*row
) const
435 return wxTextAreaBase::HitTest(pt
, col
, row
);
438 // we provide stubs for these functions as not all platforms have styles
439 // support, but we really should leave them pure virtual here
440 virtual bool SetStyle(long start
, long end
, const wxTextAttr
& style
);
441 virtual bool GetStyle(long position
, wxTextAttr
& style
);
442 virtual bool SetDefaultStyle(const wxTextAttr
& style
);
445 // override streambuf method
446 #if wxHAS_TEXT_WINDOW_STREAM
448 #endif // wxHAS_TEXT_WINDOW_STREAM
450 virtual bool DoLoadFile(const wxString
& file
, int fileType
);
451 virtual bool DoSaveFile(const wxString
& file
, int fileType
);
454 DECLARE_NO_COPY_CLASS(wxTextCtrlBase
)
455 DECLARE_ABSTRACT_CLASS(wxTextCtrlBase
)
458 // ----------------------------------------------------------------------------
459 // include the platform-dependent class definition
460 // ----------------------------------------------------------------------------
462 #if defined(__WXX11__)
463 #include "wx/x11/textctrl.h"
464 #elif defined(__WXUNIVERSAL__)
465 #include "wx/univ/textctrl.h"
466 #elif defined(__SMARTPHONE__) && defined(__WXWINCE__)
467 #include "wx/msw/wince/textctrlce.h"
468 #elif defined(__WXMSW__)
469 #include "wx/msw/textctrl.h"
470 #elif defined(__WXMOTIF__)
471 #include "wx/motif/textctrl.h"
472 #elif defined(__WXGTK20__)
473 #include "wx/gtk/textctrl.h"
474 #elif defined(__WXGTK__)
475 #include "wx/gtk1/textctrl.h"
476 #elif defined(__WXMAC__)
477 #include "wx/mac/textctrl.h"
478 #elif defined(__WXCOCOA__)
479 #include "wx/cocoa/textctrl.h"
480 #elif defined(__WXPM__)
481 #include "wx/os2/textctrl.h"
484 // ----------------------------------------------------------------------------
486 // ----------------------------------------------------------------------------
488 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
490 BEGIN_DECLARE_EVENT_TYPES()
491 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_UPDATED
, 7)
492 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_ENTER
, 8)
493 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_URL
, 13)
494 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_MAXLEN
, 14)
495 END_DECLARE_EVENT_TYPES()
497 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
499 class WXDLLEXPORT wxTextUrlEvent
: public wxCommandEvent
502 wxTextUrlEvent(int winid
, const wxMouseEvent
& evtMouse
,
503 long start
, long end
)
504 : wxCommandEvent(wxEVT_COMMAND_TEXT_URL
, winid
)
505 , m_evtMouse(evtMouse
), m_start(start
), m_end(end
)
508 // get the mouse event which happend over the URL
509 const wxMouseEvent
& GetMouseEvent() const { return m_evtMouse
; }
511 // get the start of the URL
512 long GetURLStart() const { return m_start
; }
514 // get the end of the URL
515 long GetURLEnd() const { return m_end
; }
518 // the corresponding mouse event
519 wxMouseEvent m_evtMouse
;
521 // the start and end indices of the URL in the text control
526 DECLARE_DYNAMIC_CLASS_NO_COPY(wxTextUrlEvent
)
529 // for wxWin RTTI only, don't use
530 wxTextUrlEvent() : m_evtMouse(), m_start(0), m_end(0) { }
533 typedef void (wxEvtHandler::*wxTextUrlEventFunction
)(wxTextUrlEvent
&);
535 #define wxTextEventHandler(func) wxCommandEventHandler(func)
536 #define wxTextUrlEventHandler(func) \
537 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxTextUrlEventFunction, &func)
539 #define wx__DECLARE_TEXTEVT(evt, id, fn) \
540 wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_ ## evt, id, wxTextEventHandler(fn))
542 #define wx__DECLARE_TEXTURLEVT(evt, id, fn) \
543 wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_ ## evt, id, wxTextUrlEventHandler(fn))
545 #define EVT_TEXT(id, fn) wx__DECLARE_TEXTEVT(UPDATED, id, fn)
546 #define EVT_TEXT_ENTER(id, fn) wx__DECLARE_TEXTEVT(ENTER, id, fn)
547 #define EVT_TEXT_URL(id, fn) wx__DECLARE_TEXTURLEVT(URL, id, fn)
548 #define EVT_TEXT_MAXLEN(id, fn) wx__DECLARE_TEXTEVT(MAXLEN, id, fn)
550 #if wxHAS_TEXT_WINDOW_STREAM
552 // ----------------------------------------------------------------------------
553 // wxStreamToTextRedirector: this class redirects all data sent to the given
554 // C++ stream to the wxTextCtrl given to its ctor during its lifetime.
555 // ----------------------------------------------------------------------------
557 class WXDLLEXPORT wxStreamToTextRedirector
560 void Init(wxTextCtrl
*text
)
562 m_sbufOld
= m_ostr
.rdbuf();
567 wxStreamToTextRedirector(wxTextCtrl
*text
)
573 wxStreamToTextRedirector(wxTextCtrl
*text
, wxSTD ostream
*ostr
)
579 ~wxStreamToTextRedirector()
581 m_ostr
.rdbuf(m_sbufOld
);
585 // the stream we're redirecting
586 wxSTD ostream
& m_ostr
;
588 // the old streambuf (before we changed it)
589 wxSTD streambuf
*m_sbufOld
;
592 #endif // wxHAS_TEXT_WINDOW_STREAM
594 #endif // wxUSE_TEXTCTRL
597 // _WX_TEXTCTRL_H_BASE_