]> git.saurik.com Git - wxWidgets.git/blob - include/wx/textctrl.h
fixing 'id' objc.h collisions, listbox rewrite
[wxWidgets.git] / include / wx / textctrl.h
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: wx/textctrl.h
3 // Purpose: wxTextCtrlBase class - the interface of wxTextCtrl
4 // Author: Vadim Zeitlin
5 // Modified by:
6 // Created: 13.07.99
7 // RCS-ID: $Id$
8 // Copyright: (c) Vadim Zeitlin
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_TEXTCTRL_H_BASE_
13 #define _WX_TEXTCTRL_H_BASE_
14
15 // ----------------------------------------------------------------------------
16 // headers
17 // ----------------------------------------------------------------------------
18
19 #include "wx/defs.h"
20
21 #if wxUSE_TEXTCTRL
22
23 #include "wx/control.h" // the base class
24 #include "wx/dynarray.h" // wxArrayInt
25 #include "wx/gdicmn.h" // wxPoint
26
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 :-(
30
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
38 #else
39 #define wxHAS_TEXT_WINDOW_STREAM 0
40 #endif
41
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
45 #endif
46
47 class WXDLLEXPORT wxTextCtrl;
48 class WXDLLEXPORT wxTextCtrlBase;
49
50 // ----------------------------------------------------------------------------
51 // wxTextCtrl types
52 // ----------------------------------------------------------------------------
53
54 // wxTextPos is the position in the text
55 typedef long wxTextPos;
56
57 // wxTextCoord is the line or row number (which should have been unsigned but
58 // is long for backwards compatibility)
59 typedef long wxTextCoord;
60
61 // ----------------------------------------------------------------------------
62 // constants
63 // ----------------------------------------------------------------------------
64
65 extern WXDLLEXPORT_DATA(const wxChar) wxTextCtrlNameStr[];
66
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;
71
72 // ----------------------------------------------------------------------------
73 // wxTextCtrl style flags
74 // ----------------------------------------------------------------------------
75
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
79
80 #define wxTE_NO_VSCROLL 0x0002
81 #define wxTE_AUTO_SCROLL 0x0008
82
83 #define wxTE_READONLY 0x0010
84 #define wxTE_MULTILINE 0x0020
85 #define wxTE_PROCESS_TAB 0x0040
86
87 // alignment flags
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
92
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
96
97 #define wxTE_PROCESS_ENTER 0x0400
98 #define wxTE_PASSWORD 0x0800
99
100 // automatically detect the URLs and generate the events when mouse is
101 // moved/clicked over an URL
102 //
103 // this is for Win32 richedit and wxGTK2 multiline controls only so far
104 #define wxTE_AUTO_URL 0x1000
105
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
109
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
112 //
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
118
119 #if WXWIN_COMPATIBILITY_2_6
120 // obsolete synonym
121 #define wxTE_LINEWRAP wxTE_CHARWRAP
122 #endif // WXWIN_COMPATIBILITY_2_6
123
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
127
128 // reuse wxTE_RICH2's value for CAPEDIT control on Windows CE
129 #if defined(__SMARTPHONE__) || defined(__POCKETPC__)
130 #define wxTE_CAPITALIZE wxTE_RICH2
131 #else
132 #define wxTE_CAPITALIZE 0
133 #endif
134
135 // ----------------------------------------------------------------------------
136 // wxTextCtrl::HitTest return values
137 // ----------------------------------------------------------------------------
138
139 // the point asked is ...
140 enum wxTextCtrlHitTestResult
141 {
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]
147 };
148 // ... the character returned
149
150 // ----------------------------------------------------------------------------
151 // Types for wxTextAttr
152 // ----------------------------------------------------------------------------
153
154 // Alignment
155
156 enum wxTextAttrAlignment
157 {
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
164 };
165
166 // Flags to indicate which attributes are being applied
167
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
182
183 // ----------------------------------------------------------------------------
184 // wxTextAttr: a structure containing the visual attributes of a text
185 // ----------------------------------------------------------------------------
186
187 class WXDLLEXPORT wxTextAttr
188 {
189 public:
190 // ctors
191 wxTextAttr() { Init(); }
192 wxTextAttr(const wxColour& colText,
193 const wxColour& colBack = wxNullColour,
194 const wxFont& font = wxNullFont,
195 wxTextAttrAlignment alignment = wxTEXT_ALIGNMENT_DEFAULT);
196
197 // operations
198 void Init();
199
200 // operators
201 void operator= (const wxTextAttr& attr);
202
203 // setters
204 void SetTextColour(const wxColour& colText) { m_colText = colText; m_flags |= wxTEXT_ATTR_TEXT_COLOUR; }
205 void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; m_flags |= wxTEXT_ATTR_BACKGROUND_COLOUR; }
206 void SetFont(const wxFont& font, long flags = wxTEXT_ATTR_FONT) { m_font = font; m_flags |= flags; }
207 void SetAlignment(wxTextAttrAlignment alignment) { m_textAlignment = alignment; m_flags |= wxTEXT_ATTR_ALIGNMENT; }
208 void SetTabs(const wxArrayInt& tabs) { m_tabs = tabs; m_flags |= wxTEXT_ATTR_TABS; }
209 void SetLeftIndent(int indent, int subIndent = 0) { m_leftIndent = indent; m_leftSubIndent = subIndent; m_flags |= wxTEXT_ATTR_LEFT_INDENT; }
210 void SetRightIndent(int indent) { m_rightIndent = indent; m_flags |= wxTEXT_ATTR_RIGHT_INDENT; }
211 void SetFlags(long flags) { m_flags = flags; }
212
213 // accessors
214 bool HasTextColour() const { return m_colText.Ok() && HasFlag(wxTEXT_ATTR_TEXT_COLOUR) ; }
215 bool HasBackgroundColour() const { return m_colBack.Ok() && HasFlag(wxTEXT_ATTR_BACKGROUND_COLOUR) ; }
216 bool HasFont() const { return m_font.Ok() && HasFlag(wxTEXT_ATTR_FONT) ; }
217 bool HasAlignment() const { return (m_textAlignment != wxTEXT_ALIGNMENT_DEFAULT) || ((m_flags & wxTEXT_ATTR_ALIGNMENT) != 0) ; }
218 bool HasTabs() const { return (m_flags & wxTEXT_ATTR_TABS) != 0 ; }
219 bool HasLeftIndent() const { return (m_flags & wxTEXT_ATTR_LEFT_INDENT) != 0 ; }
220 bool HasRightIndent() const { return (m_flags & wxTEXT_ATTR_RIGHT_INDENT) != 0 ; }
221 bool HasFlag(long flag) const { return (m_flags & flag) != 0; }
222
223 const wxColour& GetTextColour() const { return m_colText; }
224 const wxColour& GetBackgroundColour() const { return m_colBack; }
225 const wxFont& GetFont() const { return m_font; }
226 wxTextAttrAlignment GetAlignment() const { return m_textAlignment; }
227 const wxArrayInt& GetTabs() const { return m_tabs; }
228 long GetLeftIndent() const { return m_leftIndent; }
229 long GetLeftSubIndent() const { return m_leftSubIndent; }
230 long GetRightIndent() const { return m_rightIndent; }
231 long GetFlags() const { return m_flags; }
232
233 // returns false if we have any attributes set, true otherwise
234 bool IsDefault() const
235 {
236 return !HasTextColour() && !HasBackgroundColour() && !HasFont() && !HasAlignment() &&
237 !HasTabs() && !HasLeftIndent() && !HasRightIndent() ;
238 }
239
240 // return the attribute having the valid font and colours: it uses the
241 // attributes set in attr and falls back first to attrDefault and then to
242 // the text control font/colours for those attributes which are not set
243 static wxTextAttr Combine(const wxTextAttr& attr,
244 const wxTextAttr& attrDef,
245 const wxTextCtrlBase *text);
246
247 private:
248 long m_flags;
249 wxColour m_colText,
250 m_colBack;
251 wxFont m_font;
252 wxTextAttrAlignment m_textAlignment;
253 wxArrayInt m_tabs; // array of int: tab stops in 1/10 mm
254 int m_leftIndent; // left indent in 1/10 mm
255 int m_leftSubIndent; // left indent for all but the first
256 // line in a paragraph relative to the
257 // first line, in 1/10 mm
258 int m_rightIndent; // right indent in 1/10 mm
259 };
260
261 // ----------------------------------------------------------------------------
262 // wxTextCtrl: a single or multiple line text zone where user can enter and
263 // edit text
264 // ----------------------------------------------------------------------------
265
266 class WXDLLEXPORT wxTextCtrlBase : public wxControl
267 #if wxHAS_TEXT_WINDOW_STREAM
268 , public wxSTD streambuf
269 #endif
270
271 {
272 public:
273 // creation
274 // --------
275
276 wxTextCtrlBase(){}
277 ~wxTextCtrlBase(){}
278
279 // accessors
280 // ---------
281
282 virtual wxString GetValue() const = 0;
283 virtual void SetValue(const wxString& value) = 0;
284
285 virtual wxString GetRange(long from, long to) const;
286
287 virtual int GetLineLength(long lineNo) const = 0;
288 virtual wxString GetLineText(long lineNo) const = 0;
289 virtual int GetNumberOfLines() const = 0;
290
291 virtual bool IsModified() const = 0;
292 virtual bool IsEditable() const = 0;
293
294 // more readable flag testing methods
295 bool IsSingleLine() const { return !HasFlag(wxTE_MULTILINE); }
296 bool IsMultiLine() const { return !IsSingleLine(); }
297
298 // If the return values from and to are the same, there is no selection.
299 virtual void GetSelection(long* from, long* to) const = 0;
300
301 virtual wxString GetStringSelection() const;
302
303 // operations
304 // ----------
305
306 // editing
307 virtual void Clear() = 0;
308 virtual void Replace(long from, long to, const wxString& value) = 0;
309 virtual void Remove(long from, long to) = 0;
310
311 // load/save the controls contents from/to the file
312 virtual bool LoadFile(const wxString& file);
313 virtual bool SaveFile(const wxString& file = wxEmptyString);
314
315 // sets/clears the dirty flag
316 virtual void MarkDirty() = 0;
317 virtual void DiscardEdits() = 0;
318
319 // set the max number of characters which may be entered in a single line
320 // text control
321 virtual void SetMaxLength(unsigned long WXUNUSED(len)) { }
322
323 // writing text inserts it at the current position, appending always
324 // inserts it at the end
325 virtual void WriteText(const wxString& text) = 0;
326 virtual void AppendText(const wxString& text) = 0;
327
328 // insert the character which would have resulted from this key event,
329 // return true if anything has been inserted
330 virtual bool EmulateKeyPress(const wxKeyEvent& event);
331
332 // text control under some platforms supports the text styles: these
333 // methods allow to apply the given text style to the given selection or to
334 // set/get the style which will be used for all appended text
335 virtual bool SetStyle(long start, long end, const wxTextAttr& style);
336 virtual bool GetStyle(long position, wxTextAttr& style);
337 virtual bool SetDefaultStyle(const wxTextAttr& style);
338 virtual const wxTextAttr& GetDefaultStyle() const;
339
340 // translate between the position (which is just an index in the text ctrl
341 // considering all its contents as a single strings) and (x, y) coordinates
342 // which represent column and line.
343 virtual long XYToPosition(long x, long y) const = 0;
344 virtual bool PositionToXY(long pos, long *x, long *y) const = 0;
345
346 virtual void ShowPosition(long pos) = 0;
347
348 // find the character at position given in pixels
349 //
350 // NB: pt is in device coords (not adjusted for the client area origin nor
351 // scrolling)
352 virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
353 virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
354 wxTextCoord *col,
355 wxTextCoord *row) const;
356
357 // Clipboard operations
358 virtual void Copy() = 0;
359 virtual void Cut() = 0;
360 virtual void Paste() = 0;
361
362 virtual bool CanCopy() const;
363 virtual bool CanCut() const;
364 virtual bool CanPaste() const;
365
366 // Undo/redo
367 virtual void Undo() = 0;
368 virtual void Redo() = 0;
369
370 virtual bool CanUndo() const = 0;
371 virtual bool CanRedo() const = 0;
372
373 // Insertion point
374 virtual void SetInsertionPoint(long pos) = 0;
375 virtual void SetInsertionPointEnd() = 0;
376 virtual long GetInsertionPoint() const = 0;
377 virtual wxTextPos GetLastPosition() const = 0;
378
379 virtual void SetSelection(long from, long to) = 0;
380 virtual void SelectAll();
381 virtual void SetEditable(bool editable) = 0;
382
383 // stream-like insertion operators: these are always available, whether we
384 // were, or not, compiled with streambuf support
385 wxTextCtrl& operator<<(const wxString& s);
386 wxTextCtrl& operator<<(int i);
387 wxTextCtrl& operator<<(long i);
388 wxTextCtrl& operator<<(float f);
389 wxTextCtrl& operator<<(double d);
390 wxTextCtrl& operator<<(const wxChar c);
391
392 // do the window-specific processing after processing the update event
393 virtual void DoUpdateWindowUI(wxUpdateUIEvent& event);
394
395 virtual bool ShouldInheritColours() const { return false; }
396
397 protected:
398 // override streambuf method
399 #if wxHAS_TEXT_WINDOW_STREAM
400 int overflow(int i);
401 #endif // wxHAS_TEXT_WINDOW_STREAM
402
403 // the name of the last file loaded with LoadFile() which will be used by
404 // SaveFile() by default
405 wxString m_filename;
406
407 // the text style which will be used for any new text added to the control
408 wxTextAttr m_defaultStyle;
409
410 DECLARE_NO_COPY_CLASS(wxTextCtrlBase)
411 };
412
413 // ----------------------------------------------------------------------------
414 // include the platform-dependent class definition
415 // ----------------------------------------------------------------------------
416
417 #if defined(__WXX11__)
418 #include "wx/x11/textctrl.h"
419 #elif defined(__WXUNIVERSAL__)
420 #include "wx/univ/textctrl.h"
421 #elif defined(__SMARTPHONE__) && defined(__WXWINCE__)
422 #include "wx/msw/wince/textctrlce.h"
423 #elif defined(__WXMSW__)
424 #include "wx/msw/textctrl.h"
425 #elif defined(__WXMOTIF__)
426 #include "wx/motif/textctrl.h"
427 #elif defined(__WXGTK20__)
428 #include "wx/gtk/textctrl.h"
429 #elif defined(__WXGTK__)
430 #include "wx/gtk1/textctrl.h"
431 #elif defined(__WXMAC__)
432 #include "wx/mac/textctrl.h"
433 #elif defined(__WXCOCOA__)
434 #include "wx/cocoa/textctrl.h"
435 #elif defined(__WXPM__)
436 #include "wx/os2/textctrl.h"
437 #endif
438
439 // ----------------------------------------------------------------------------
440 // wxTextCtrl events
441 // ----------------------------------------------------------------------------
442
443 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
444
445 BEGIN_DECLARE_EVENT_TYPES()
446 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_UPDATED, 7)
447 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_ENTER, 8)
448 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_URL, 13)
449 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_MAXLEN, 14)
450 END_DECLARE_EVENT_TYPES()
451
452 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
453
454 class WXDLLEXPORT wxTextUrlEvent : public wxCommandEvent
455 {
456 public:
457 wxTextUrlEvent(int winid, const wxMouseEvent& evtMouse,
458 long start, long end)
459 : wxCommandEvent(wxEVT_COMMAND_TEXT_URL, winid)
460 , m_evtMouse(evtMouse), m_start(start), m_end(end)
461 { }
462
463 // get the mouse event which happend over the URL
464 const wxMouseEvent& GetMouseEvent() const { return m_evtMouse; }
465
466 // get the start of the URL
467 long GetURLStart() const { return m_start; }
468
469 // get the end of the URL
470 long GetURLEnd() const { return m_end; }
471
472 protected:
473 // the corresponding mouse event
474 wxMouseEvent m_evtMouse;
475
476 // the start and end indices of the URL in the text control
477 long m_start,
478 m_end;
479
480 private:
481 DECLARE_DYNAMIC_CLASS_NO_COPY(wxTextUrlEvent)
482
483 public:
484 // for wxWin RTTI only, don't use
485 wxTextUrlEvent() : m_evtMouse(), m_start(0), m_end(0) { }
486 };
487
488 typedef void (wxEvtHandler::*wxTextUrlEventFunction)(wxTextUrlEvent&);
489
490 #define wxTextEventHandler(func) wxCommandEventHandler(func)
491 #define wxTextUrlEventHandler(func) \
492 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxTextUrlEventFunction, &func)
493
494 #define wx__DECLARE_TEXTEVT(evt, id, fn) \
495 wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_ ## evt, id, wxTextEventHandler(fn))
496
497 #define wx__DECLARE_TEXTURLEVT(evt, id, fn) \
498 wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_ ## evt, id, wxTextUrlEventHandler(fn))
499
500 #define EVT_TEXT(id, fn) wx__DECLARE_TEXTEVT(UPDATED, id, fn)
501 #define EVT_TEXT_ENTER(id, fn) wx__DECLARE_TEXTEVT(ENTER, id, fn)
502 #define EVT_TEXT_URL(id, fn) wx__DECLARE_TEXTURLEVT(URL, id, fn)
503 #define EVT_TEXT_MAXLEN(id, fn) wx__DECLARE_TEXTEVT(MAXLEN, id, fn)
504
505 #if wxHAS_TEXT_WINDOW_STREAM
506
507 // ----------------------------------------------------------------------------
508 // wxStreamToTextRedirector: this class redirects all data sent to the given
509 // C++ stream to the wxTextCtrl given to its ctor during its lifetime.
510 // ----------------------------------------------------------------------------
511
512 class WXDLLEXPORT wxStreamToTextRedirector
513 {
514 private:
515 void Init(wxTextCtrl *text)
516 {
517 m_sbufOld = m_ostr.rdbuf();
518 m_ostr.rdbuf(text);
519 }
520
521 public:
522 wxStreamToTextRedirector(wxTextCtrl *text)
523 : m_ostr(wxSTD cout)
524 {
525 Init(text);
526 }
527
528 wxStreamToTextRedirector(wxTextCtrl *text, wxSTD ostream *ostr)
529 : m_ostr(*ostr)
530 {
531 Init(text);
532 }
533
534 ~wxStreamToTextRedirector()
535 {
536 m_ostr.rdbuf(m_sbufOld);
537 }
538
539 private:
540 // the stream we're redirecting
541 wxSTD ostream& m_ostr;
542
543 // the old streambuf (before we changed it)
544 wxSTD streambuf *m_sbufOld;
545 };
546
547 #endif // wxHAS_TEXT_WINDOW_STREAM
548
549 #endif // wxUSE_TEXTCTRL
550
551 #endif
552 // _WX_TEXTCTRL_H_BASE_