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