1 ///////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxTextCtrlBase class - the interface of wxTextCtrl
4 // Author: Vadim Zeitlin
8 // Copyright: (c) wxWindows 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"
30 // 16-bit Borland 4.0 doesn't seem to allow multiple inheritance with wxWindow
31 // and streambuf: it complains about deriving a huge class from the huge class
32 // streambuf. !! Also, can't use streambuf if making or using a DLL :-(
34 #if (defined(__BORLANDC__)) || defined(__MWERKS__) || \
35 defined(WXUSINGDLL) || defined(WXMAKINGDLL)
36 #define NO_TEXT_WINDOW_STREAM
39 #ifndef NO_TEXT_WINDOW_STREAM
40 #if wxUSE_STD_IOSTREAM
41 #include "wx/ioswrap.h" // derivation: we need the full decls.
42 #else // !wxUSE_STD_IOSTREAM
43 // can't compile this feature in if we don't use streams at all
44 #define NO_TEXT_WINDOW_STREAM
45 #endif // wxUSE_STD_IOSTREAM/!wxUSE_STD_IOSTREAM
48 class WXDLLEXPORT wxTextCtrl
;
49 class WXDLLEXPORT wxTextCtrlBase
;
51 // ----------------------------------------------------------------------------
53 // ----------------------------------------------------------------------------
55 WXDLLEXPORT_DATA(extern const wxChar
*) wxTextCtrlNameStr
;
57 // ----------------------------------------------------------------------------
58 // wxTextCtrl style flags
59 // ----------------------------------------------------------------------------
61 // the flag bits 0x0001, and 0x0004 are free but should be used only for the
62 // things which don't make sense for a text control used by wxTextEntryDialog
63 // because they would otherwise conflict with wxOK, wxCANCEL, wxCENTRE
65 #define wxTE_NO_VSCROLL 0x0002
66 #define wxTE_AUTO_SCROLL 0x0008
68 #define wxTE_READONLY 0x0010
69 #define wxTE_MULTILINE 0x0020
70 #define wxTE_PROCESS_TAB 0x0040
73 #define wxTE_LEFT 0x0000 // 0x0000
74 #define wxTE_CENTER wxALIGN_CENTER_HORIZONTAL // 0x0100
75 #define wxTE_RIGHT wxALIGN_RIGHT // 0x0200
76 #define wxTE_CENTRE wxTE_CENTER
78 // this style means to use RICHEDIT control and does something only under wxMSW
79 // and Win32 and is silently ignored under all other platforms
80 #define wxTE_RICH 0x0080
82 #define wxTE_PROCESS_ENTER 0x0400
83 #define wxTE_PASSWORD 0x0800
85 // automatically detect the URLs and generate the events when mouse is
86 // moved/clicked over an URL
88 // this is for Win32 richedit controls only so far
89 #define wxTE_AUTO_URL 0x1000
91 // by default, the Windows text control doesn't show the selection when it
92 // doesn't have focus - use this style to force it to always show it
93 #define wxTE_NOHIDESEL 0x2000
95 // use wxHSCROLL to not wrap text at all, wxTE_LINEWRAP to wrap it at any
96 // position and wxTE_WORDWRAP to wrap at words boundary
97 #define wxTE_DONTWRAP wxHSCROLL
98 #define wxTE_LINEWRAP 0x4000
99 #define wxTE_WORDWRAP 0x0000 // it's just == !wxHSCROLL
101 // force using RichEdit version 2.0 or 3.0 instead of 1.0 (default) for
102 // wxTE_RICH controls - can be used together with or instead of wxTE_RICH
103 #define wxTE_RICH2 0x8000
105 // ----------------------------------------------------------------------------
106 // Types for wxTextAttr
107 // ----------------------------------------------------------------------------
111 enum wxTextAttrAlignment
113 wxTEXT_ALIGNMENT_DEFAULT
,
114 wxTEXT_ALIGNMENT_LEFT
,
115 wxTEXT_ALIGNMENT_CENTRE
,
116 wxTEXT_ALIGNMENT_CENTER
= wxTEXT_ALIGNMENT_CENTRE
,
117 wxTEXT_ALIGNMENT_RIGHT
,
118 wxTEXT_ALIGNMENT_JUSTIFIED
121 // Flags to indicate which attributes are being applied
123 #define wxTEXT_ATTR_TEXT_COLOUR 0x0001
124 #define wxTEXT_ATTR_BACKGROUND_COLOUR 0x0002
125 #define wxTEXT_ATTR_FONT_FACE 0x0004
126 #define wxTEXT_ATTR_FONT_SIZE 0x0008
127 #define wxTEXT_ATTR_FONT_WEIGHT 0x0010
128 #define wxTEXT_ATTR_FONT_ITALIC 0x0020
129 #define wxTEXT_ATTR_FONT_UNDERLINE 0x0040
130 #define wxTEXT_ATTR_FONT \
131 wxTEXT_ATTR_FONT_FACE | wxTEXT_ATTR_FONT_SIZE | wxTEXT_ATTR_FONT_WEIGHT | wxTEXT_ATTR_FONT_ITALIC | wxTEXT_ATTR_FONT_UNDERLINE
132 #define wxTEXT_ATTR_ALIGNMENT 0x0080
133 #define wxTEXT_ATTR_LEFT_INDENT 0x0100
134 #define wxTEXT_ATTR_RIGHT_INDENT 0x0200
135 #define wxTEXT_ATTR_TABS 0x0400
137 // ----------------------------------------------------------------------------
138 // wxTextAttr: a structure containing the visual attributes of a text
139 // ----------------------------------------------------------------------------
141 class WXDLLEXPORT wxTextAttr
145 wxTextAttr() { Init(); }
146 wxTextAttr(const wxColour
& colText
,
147 const wxColour
& colBack
= wxNullColour
,
148 const wxFont
& font
= wxNullFont
,
149 wxTextAttrAlignment alignment
= wxTEXT_ALIGNMENT_DEFAULT
);
155 void operator= (const wxTextAttr
& attr
);
158 void SetTextColour(const wxColour
& colText
) { m_colText
= colText
; m_flags
|= wxTEXT_ATTR_TEXT_COLOUR
; }
159 void SetBackgroundColour(const wxColour
& colBack
) { m_colBack
= colBack
; m_flags
|= wxTEXT_ATTR_BACKGROUND_COLOUR
; }
160 void SetFont(const wxFont
& font
, long flags
= wxTEXT_ATTR_FONT
) { m_font
= font
; m_flags
|= flags
; }
161 void SetAlignment(wxTextAttrAlignment alignment
) { m_textAlignment
= alignment
; m_flags
|= wxTEXT_ATTR_ALIGNMENT
; }
162 void SetTabs(const wxArrayInt
& tabs
) { m_tabs
= tabs
; m_flags
|= wxTEXT_ATTR_TABS
; }
163 void SetLeftIndent(int indent
) { m_leftIndent
= indent
; m_flags
|= wxTEXT_ATTR_LEFT_INDENT
; }
164 void SetRightIndent(int indent
) { m_rightIndent
= indent
; m_flags
|= wxTEXT_ATTR_RIGHT_INDENT
; }
165 void SetFlags(long flags
) { m_flags
= flags
; }
168 bool HasTextColour() const { return m_colText
.Ok() && HasFlag(wxTEXT_ATTR_TEXT_COLOUR
) ; }
169 bool HasBackgroundColour() const { return m_colBack
.Ok() && HasFlag(wxTEXT_ATTR_BACKGROUND_COLOUR
) ; }
170 bool HasFont() const { return m_font
.Ok() && HasFlag(wxTEXT_ATTR_FONT
) ; }
171 bool HasAlignment() const { return (m_textAlignment
!= wxTEXT_ALIGNMENT_DEFAULT
) || ((m_flags
& wxTEXT_ATTR_ALIGNMENT
) != 0) ; }
172 bool HasTabs() const { return (m_flags
& wxTEXT_ATTR_TABS
) != 0 ; }
173 bool HasLeftIndent() const { return (m_flags
& wxTEXT_ATTR_LEFT_INDENT
) != 0 ; }
174 bool HasRightIndent() const { return (m_flags
& wxTEXT_ATTR_RIGHT_INDENT
) != 0 ; }
175 bool HasFlag(long flag
) const { return (m_flags
& flag
) != 0; }
177 const wxColour
& GetTextColour() const { return m_colText
; }
178 const wxColour
& GetBackgroundColour() const { return m_colBack
; }
179 const wxFont
& GetFont() const { return m_font
; }
180 wxTextAttrAlignment
GetAlignment() const { return m_textAlignment
; }
181 const wxArrayInt
& GetTabs() const { return m_tabs
; }
182 long GetLeftIndent() const { return m_leftIndent
; }
183 long GetRightIndent() const { return m_rightIndent
; }
184 long GetFlags() const { return m_flags
; }
186 // returns false if we have any attributes set, true otherwise
187 bool IsDefault() const
189 return !HasTextColour() && !HasBackgroundColour() && !HasFont() && !HasAlignment() &&
190 !HasTabs() && !HasLeftIndent() && !HasRightIndent() ;
193 // return the attribute having the valid font and colours: it uses the
194 // attributes set in attr and falls back first to attrDefault and then to
195 // the text control font/colours for those attributes which are not set
196 static wxTextAttr
Combine(const wxTextAttr
& attr
,
197 const wxTextAttr
& attrDef
,
198 const wxTextCtrlBase
*text
);
205 wxTextAttrAlignment m_textAlignment
;
206 wxArrayInt m_tabs
; // array of int: tab stops in 1/10 mm
207 int m_leftIndent
; // left indent in 1/10 mm
208 int m_rightIndent
; // right indent in 1/10 mm
211 // ----------------------------------------------------------------------------
212 // wxTextCtrl: a single or multiple line text zone where user can enter and
214 // ----------------------------------------------------------------------------
216 class WXDLLEXPORT wxTextCtrlBase
: public wxControl
217 #ifndef NO_TEXT_WINDOW_STREAM
218 , public wxSTD streambuf
232 virtual wxString
GetValue() const = 0;
233 virtual void SetValue(const wxString
& value
) = 0;
235 virtual wxString
GetRange(long from
, long to
) const;
237 virtual int GetLineLength(long lineNo
) const = 0;
238 virtual wxString
GetLineText(long lineNo
) const = 0;
239 virtual int GetNumberOfLines() const = 0;
241 virtual bool IsModified() const = 0;
242 virtual bool IsEditable() const = 0;
244 // more readable flag testing methods
245 bool IsSingleLine() const { return !(GetWindowStyle() & wxTE_MULTILINE
); }
246 bool IsMultiLine() const { return !IsSingleLine(); }
248 // If the return values from and to are the same, there is no selection.
249 virtual void GetSelection(long* from
, long* to
) const = 0;
251 virtual wxString
GetStringSelection() const;
257 virtual void Clear() = 0;
258 virtual void Replace(long from
, long to
, const wxString
& value
) = 0;
259 virtual void Remove(long from
, long to
) = 0;
261 // load/save the controls contents from/to the file
262 virtual bool LoadFile(const wxString
& file
);
263 virtual bool SaveFile(const wxString
& file
= wxEmptyString
);
265 // sets/clears the dirty flag
266 virtual void MarkDirty() = 0;
267 virtual void DiscardEdits() = 0;
269 // set the max number of characters which may be entered in a single line
271 virtual void SetMaxLength(unsigned long WXUNUSED(len
)) { }
273 // writing text inserts it at the current position, appending always
274 // inserts it at the end
275 virtual void WriteText(const wxString
& text
) = 0;
276 virtual void AppendText(const wxString
& text
) = 0;
278 // insert the character which would have resulted from this key event,
279 // return TRUE if anything has been inserted
280 virtual bool EmulateKeyPress(const wxKeyEvent
& event
);
282 // text control under some platforms supports the text styles: these
283 // methods allow to apply the given text style to the given selection or to
284 // set/get the style which will be used for all appended text
285 virtual bool SetStyle(long start
, long end
, const wxTextAttr
& style
);
286 virtual bool GetStyle(long position
, wxTextAttr
& style
);
287 virtual bool SetDefaultStyle(const wxTextAttr
& style
);
288 virtual const wxTextAttr
& GetDefaultStyle() const;
290 // translate between the position (which is just an index in the text ctrl
291 // considering all its contents as a single strings) and (x, y) coordinates
292 // which represent column and line.
293 virtual long XYToPosition(long x
, long y
) const = 0;
294 virtual bool PositionToXY(long pos
, long *x
, long *y
) const = 0;
296 virtual void ShowPosition(long pos
) = 0;
298 // Clipboard operations
299 virtual void Copy() = 0;
300 virtual void Cut() = 0;
301 virtual void Paste() = 0;
303 virtual bool CanCopy() const;
304 virtual bool CanCut() const;
305 virtual bool CanPaste() const;
308 virtual void Undo() = 0;
309 virtual void Redo() = 0;
311 virtual bool CanUndo() const = 0;
312 virtual bool CanRedo() const = 0;
315 virtual void SetInsertionPoint(long pos
) = 0;
316 virtual void SetInsertionPointEnd() = 0;
317 virtual long GetInsertionPoint() const = 0;
318 virtual long GetLastPosition() const = 0;
320 virtual void SetSelection(long from
, long to
) = 0;
321 virtual void SelectAll();
322 virtual void SetEditable(bool editable
) = 0;
324 // override streambuf method
325 #ifndef NO_TEXT_WINDOW_STREAM
327 #endif // NO_TEXT_WINDOW_STREAM
329 // stream-like insertion operators: these are always available, whether we
330 // were, or not, compiled with streambuf support
331 wxTextCtrl
& operator<<(const wxString
& s
);
332 wxTextCtrl
& operator<<(int i
);
333 wxTextCtrl
& operator<<(long i
);
334 wxTextCtrl
& operator<<(float f
);
335 wxTextCtrl
& operator<<(double d
);
336 wxTextCtrl
& operator<<(const wxChar c
);
338 // do the window-specific processing after processing the update event
339 virtual void DoUpdateWindowUI(wxUpdateUIEvent
& event
) ;
342 // the name of the last file loaded with LoadFile() which will be used by
343 // SaveFile() by default
346 // the text style which will be used for any new text added to the control
347 wxTextAttr m_defaultStyle
;
349 DECLARE_NO_COPY_CLASS(wxTextCtrlBase
)
352 // ----------------------------------------------------------------------------
353 // include the platform-dependent class definition
354 // ----------------------------------------------------------------------------
356 #if defined(__WXX11__)
357 #include "wx/x11/textctrl.h"
358 #elif defined(__WXUNIVERSAL__)
359 #include "wx/univ/textctrl.h"
360 #elif defined(__WXMSW__)
361 #include "wx/msw/textctrl.h"
362 #elif defined(__WXMOTIF__)
363 #include "wx/motif/textctrl.h"
364 #elif defined(__WXGTK__)
365 #include "wx/gtk/textctrl.h"
366 #elif defined(__WXMAC__)
367 #include "wx/mac/textctrl.h"
368 #elif defined(__WXCOCOA__)
369 #include "wx/cocoa/textctrl.h"
370 #elif defined(__WXPM__)
371 #include "wx/os2/textctrl.h"
374 // ----------------------------------------------------------------------------
376 // ----------------------------------------------------------------------------
378 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
380 BEGIN_DECLARE_EVENT_TYPES()
381 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_UPDATED
, 7)
382 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_ENTER
, 8)
383 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_URL
, 13)
384 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_MAXLEN
, 14)
385 END_DECLARE_EVENT_TYPES()
387 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
389 class WXDLLEXPORT wxTextUrlEvent
: public wxCommandEvent
392 wxTextUrlEvent(int winid
, const wxMouseEvent
& evtMouse
,
393 long start
, long end
)
394 : wxCommandEvent(wxEVT_COMMAND_TEXT_URL
, winid
)
395 , m_evtMouse(evtMouse
), m_start(start
), m_end(end
)
398 // get the mouse event which happend over the URL
399 const wxMouseEvent
& GetMouseEvent() const { return m_evtMouse
; }
401 // get the start of the URL
402 long GetURLStart() const { return m_start
; }
404 // get the end of the URL
405 long GetURLEnd() const { return m_end
; }
408 // the corresponding mouse event
409 wxMouseEvent m_evtMouse
;
411 // the start and end indices of the URL in the text control
416 DECLARE_DYNAMIC_CLASS_NO_COPY(wxTextUrlEvent
)
419 // for wxWin RTTI only, don't use
420 wxTextUrlEvent() : m_evtMouse(), m_start(0), m_end(0) { }
423 typedef void (wxEvtHandler
::*wxTextUrlEventFunction
)(wxTextUrlEvent
&);
425 #define EVT_TEXT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
426 #define EVT_TEXT_ENTER(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
427 #define EVT_TEXT_URL(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_URL, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxTextUrlEventFunction) & fn, (wxObject *) NULL ),
428 #define EVT_TEXT_MAXLEN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_MAXLEN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
430 #ifndef NO_TEXT_WINDOW_STREAM
432 // ----------------------------------------------------------------------------
433 // wxStreamToTextRedirector: this class redirects all data sent to the given
434 // C++ stream to the wxTextCtrl given to its ctor during its lifetime.
435 // ----------------------------------------------------------------------------
437 class WXDLLEXPORT wxStreamToTextRedirector
442 m_sbufOld
= m_ostr
.rdbuf();
447 wxStreamToTextRedirector(wxTextCtrl
*text
)
453 wxStreamToTextRedirector(wxTextCtrl
*text
, wxSTD ostream
*ostr
)
459 ~wxStreamToTextRedirector()
461 m_ostr
.rdbuf(m_sbufOld
);
465 // the stream we're redirecting
466 wxSTD ostream
& m_ostr
;
468 // the old streambuf (before we changed it)
469 wxSTD streambuf
*m_sbufOld
;
472 #endif // !NO_TEXT_WINDOW_STREAM
474 #endif // wxUSE_TEXTCTRL
477 // _WX_TEXTCTRL_H_BASE_