]> git.saurik.com Git - wxWidgets.git/blob - include/wx/textctrl.h
added stub of GetEscapeId()
[wxWidgets.git] / include / wx / textctrl.h
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: 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 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
20 #pragma interface "textctrlbase.h"
21 #endif
22
23 #include "wx/defs.h"
24
25 #if wxUSE_TEXTCTRL
26
27 #include "wx/control.h" // the base class
28 #include "wx/dynarray.h" // wxArrayInt
29 #include "wx/gdicmn.h" // wxPoint
30
31 // Open Watcom 1.3 does allow only ios::rdbuf() while
32 // we want something with streambuf parameter
33 // Also, can't use streambuf if making or using a DLL :-(
34
35 #if defined(__WATCOMC__) || \
36 defined(__MWERKS__) || \
37 (defined(__WINDOWS__) && (defined(WXUSINGDLL) || defined(WXMAKINGDLL)))
38 #define wxHAS_TEXT_WINDOW_STREAM 0
39 #elif wxUSE_STD_IOSTREAM
40 #include "wx/ioswrap.h"
41 #define wxHAS_TEXT_WINDOW_STREAM 1
42 #else
43 #define wxHAS_TEXT_WINDOW_STREAM 0
44 #endif
45
46 #if WXWIN_COMPATIBILITY_2_4 && !wxHAS_TEXT_WINDOW_STREAM
47 // define old flag if one could use it somewhere
48 #define NO_TEXT_WINDOW_STREAM
49 #endif
50
51 class WXDLLEXPORT wxTextCtrl;
52 class WXDLLEXPORT wxTextCtrlBase;
53
54 // ----------------------------------------------------------------------------
55 // wxTextCtrl types
56 // ----------------------------------------------------------------------------
57
58 // wxTextPos is the position in the text
59 typedef long wxTextPos;
60
61 // wxTextCoord is the line or row number (which should have been unsigned but
62 // is long for backwards compatibility)
63 typedef long wxTextCoord;
64
65 // ----------------------------------------------------------------------------
66 // constants
67 // ----------------------------------------------------------------------------
68
69 extern WXDLLEXPORT_DATA(const wxChar*) wxTextCtrlNameStr;
70
71 // this is intentionally not enum to avoid warning fixes with
72 // typecasting from enum type to wxTextCoord
73 const wxTextCoord wxOutOfRangeTextCoord = -1;
74 const wxTextCoord wxInvalidTextCoord = -2;
75
76 // ----------------------------------------------------------------------------
77 // wxTextCtrl style flags
78 // ----------------------------------------------------------------------------
79
80 // the flag bit 0x0001 s free but should be used only for the things which
81 // don't make sense for a text control used by wxTextEntryDialog because they
82 // would otherwise conflict with wxOK, wxCANCEL, wxCENTRE
83
84 #define wxTE_NO_VSCROLL 0x0002
85 #define wxTE_AUTO_SCROLL 0x0008
86
87 #define wxTE_READONLY 0x0010
88 #define wxTE_MULTILINE 0x0020
89 #define wxTE_PROCESS_TAB 0x0040
90
91 // alignment flags
92 #define wxTE_LEFT 0x0000 // 0x0000
93 #define wxTE_CENTER wxALIGN_CENTER_HORIZONTAL // 0x0100
94 #define wxTE_RIGHT wxALIGN_RIGHT // 0x0200
95 #define wxTE_CENTRE wxTE_CENTER
96
97 // this style means to use RICHEDIT control and does something only under wxMSW
98 // and Win32 and is silently ignored under all other platforms
99 #define wxTE_RICH 0x0080
100
101 #define wxTE_PROCESS_ENTER 0x0400
102 #define wxTE_PASSWORD 0x0800
103
104 // automatically detect the URLs and generate the events when mouse is
105 // moved/clicked over an URL
106 //
107 // this is for Win32 richedit and wxGTK2 multiline controls only so far
108 #define wxTE_AUTO_URL 0x1000
109
110 // by default, the Windows text control doesn't show the selection when it
111 // doesn't have focus - use this style to force it to always show it
112 #define wxTE_NOHIDESEL 0x2000
113
114 // use wxHSCROLL to not wrap text at all, wxTE_CHARWRAP to wrap it at any
115 // position and wxTE_WORDWRAP to wrap at words boundary
116 //
117 // if no wrapping style is given at all, the control wraps at word boundary
118 #define wxTE_DONTWRAP wxHSCROLL
119 #define wxTE_CHARWRAP 0x4000 // wrap at any position
120 #define wxTE_WORDWRAP 0x0001 // wrap only at words boundaries
121 #define wxTE_BESTWRAP 0x0000 // this is the default
122
123 // obsolete synonym
124 #define wxTE_LINEWRAP wxTE_CHARWRAP
125
126 // force using RichEdit version 2.0 or 3.0 instead of 1.0 (default) for
127 // wxTE_RICH controls - can be used together with or instead of wxTE_RICH
128 #define wxTE_RICH2 0x8000
129
130 // reuse wxTE_RICH2's value for CAPEDIT control on Windows CE
131 #if defined(__SMARTPHONE__) || defined(__POCKETPC__)
132 #define wxTE_CAPITALIZE wxTE_RICH2
133 #else
134 #define wxTE_CAPITALIZE 0
135 #endif
136
137 // ----------------------------------------------------------------------------
138 // wxTextCtrl::HitTest return values
139 // ----------------------------------------------------------------------------
140
141 // the point asked is ...
142 enum wxTextCtrlHitTestResult
143 {
144 wxTE_HT_UNKNOWN = -2, // this means HitTest() is simply not implemented
145 wxTE_HT_BEFORE, // either to the left or upper
146 wxTE_HT_ON_TEXT, // directly on
147 wxTE_HT_BELOW, // below [the last line]
148 wxTE_HT_BEYOND // after [the end of line]
149 };
150 // ... the character returned
151
152 // ----------------------------------------------------------------------------
153 // Types for wxTextAttr
154 // ----------------------------------------------------------------------------
155
156 // Alignment
157
158 enum wxTextAttrAlignment
159 {
160 wxTEXT_ALIGNMENT_DEFAULT,
161 wxTEXT_ALIGNMENT_LEFT,
162 wxTEXT_ALIGNMENT_CENTRE,
163 wxTEXT_ALIGNMENT_CENTER = wxTEXT_ALIGNMENT_CENTRE,
164 wxTEXT_ALIGNMENT_RIGHT,
165 wxTEXT_ALIGNMENT_JUSTIFIED
166 };
167
168 // Flags to indicate which attributes are being applied
169
170 #define wxTEXT_ATTR_TEXT_COLOUR 0x0001
171 #define wxTEXT_ATTR_BACKGROUND_COLOUR 0x0002
172 #define wxTEXT_ATTR_FONT_FACE 0x0004
173 #define wxTEXT_ATTR_FONT_SIZE 0x0008
174 #define wxTEXT_ATTR_FONT_WEIGHT 0x0010
175 #define wxTEXT_ATTR_FONT_ITALIC 0x0020
176 #define wxTEXT_ATTR_FONT_UNDERLINE 0x0040
177 #define wxTEXT_ATTR_FONT \
178 ( wxTEXT_ATTR_FONT_FACE | wxTEXT_ATTR_FONT_SIZE | wxTEXT_ATTR_FONT_WEIGHT | \
179 wxTEXT_ATTR_FONT_ITALIC | wxTEXT_ATTR_FONT_UNDERLINE )
180 #define wxTEXT_ATTR_ALIGNMENT 0x0080
181 #define wxTEXT_ATTR_LEFT_INDENT 0x0100
182 #define wxTEXT_ATTR_RIGHT_INDENT 0x0200
183 #define wxTEXT_ATTR_TABS 0x0400
184
185 // ----------------------------------------------------------------------------
186 // wxTextAttr: a structure containing the visual attributes of a text
187 // ----------------------------------------------------------------------------
188
189 class WXDLLEXPORT wxTextAttr
190 {
191 public:
192 // ctors
193 wxTextAttr() { Init(); }
194 wxTextAttr(const wxColour& colText,
195 const wxColour& colBack = wxNullColour,
196 const wxFont& font = wxNullFont,
197 wxTextAttrAlignment alignment = wxTEXT_ALIGNMENT_DEFAULT);
198
199 // operations
200 void Init();
201
202 // operators
203 void operator= (const wxTextAttr& attr);
204
205 // setters
206 void SetTextColour(const wxColour& colText) { m_colText = colText; m_flags |= wxTEXT_ATTR_TEXT_COLOUR; }
207 void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; m_flags |= wxTEXT_ATTR_BACKGROUND_COLOUR; }
208 void SetFont(const wxFont& font, long flags = wxTEXT_ATTR_FONT) { m_font = font; m_flags |= flags; }
209 void SetAlignment(wxTextAttrAlignment alignment) { m_textAlignment = alignment; m_flags |= wxTEXT_ATTR_ALIGNMENT; }
210 void SetTabs(const wxArrayInt& tabs) { m_tabs = tabs; m_flags |= wxTEXT_ATTR_TABS; }
211 void SetLeftIndent(int indent, int subIndent = 0) { m_leftIndent = indent; m_leftSubIndent = subIndent; m_flags |= wxTEXT_ATTR_LEFT_INDENT; }
212 void SetRightIndent(int indent) { m_rightIndent = indent; m_flags |= wxTEXT_ATTR_RIGHT_INDENT; }
213 void SetFlags(long flags) { m_flags = flags; }
214
215 // accessors
216 bool HasTextColour() const { return m_colText.Ok() && HasFlag(wxTEXT_ATTR_TEXT_COLOUR) ; }
217 bool HasBackgroundColour() const { return m_colBack.Ok() && HasFlag(wxTEXT_ATTR_BACKGROUND_COLOUR) ; }
218 bool HasFont() const { return m_font.Ok() && HasFlag(wxTEXT_ATTR_FONT) ; }
219 bool HasAlignment() const { return (m_textAlignment != wxTEXT_ALIGNMENT_DEFAULT) || ((m_flags & wxTEXT_ATTR_ALIGNMENT) != 0) ; }
220 bool HasTabs() const { return (m_flags & wxTEXT_ATTR_TABS) != 0 ; }
221 bool HasLeftIndent() const { return (m_flags & wxTEXT_ATTR_LEFT_INDENT) != 0 ; }
222 bool HasRightIndent() const { return (m_flags & wxTEXT_ATTR_RIGHT_INDENT) != 0 ; }
223 bool HasFlag(long flag) const { return (m_flags & flag) != 0; }
224
225 const wxColour& GetTextColour() const { return m_colText; }
226 const wxColour& GetBackgroundColour() const { return m_colBack; }
227 const wxFont& GetFont() const { return m_font; }
228 wxTextAttrAlignment GetAlignment() const { return m_textAlignment; }
229 const wxArrayInt& GetTabs() const { return m_tabs; }
230 long GetLeftIndent() const { return m_leftIndent; }
231 long GetLeftSubIndent() const { return m_leftSubIndent; }
232 long GetRightIndent() const { return m_rightIndent; }
233 long GetFlags() const { return m_flags; }
234
235 // returns false if we have any attributes set, true otherwise
236 bool IsDefault() const
237 {
238 return !HasTextColour() && !HasBackgroundColour() && !HasFont() && !HasAlignment() &&
239 !HasTabs() && !HasLeftIndent() && !HasRightIndent() ;
240 }
241
242 // return the attribute having the valid font and colours: it uses the
243 // attributes set in attr and falls back first to attrDefault and then to
244 // the text control font/colours for those attributes which are not set
245 static wxTextAttr Combine(const wxTextAttr& attr,
246 const wxTextAttr& attrDef,
247 const wxTextCtrlBase *text);
248
249 private:
250 long m_flags;
251 wxColour m_colText,
252 m_colBack;
253 wxFont m_font;
254 wxTextAttrAlignment m_textAlignment;
255 wxArrayInt m_tabs; // array of int: tab stops in 1/10 mm
256 int m_leftIndent; // left indent in 1/10 mm
257 int m_leftSubIndent; // left indent for all but the first
258 // line in a paragraph relative to the
259 // first line, in 1/10 mm
260 int m_rightIndent; // right indent in 1/10 mm
261 };
262
263 // ----------------------------------------------------------------------------
264 // wxTextCtrl: a single or multiple line text zone where user can enter and
265 // edit text
266 // ----------------------------------------------------------------------------
267
268 class WXDLLEXPORT wxTextCtrlBase : public wxControl
269 #if wxHAS_TEXT_WINDOW_STREAM
270 , public wxSTD streambuf
271 #endif
272
273 {
274 public:
275 // creation
276 // --------
277
278 wxTextCtrlBase(){}
279 ~wxTextCtrlBase(){}
280
281 // accessors
282 // ---------
283
284 virtual wxString GetValue() const = 0;
285 virtual void SetValue(const wxString& value) = 0;
286
287 virtual wxString GetRange(long from, long to) const;
288
289 virtual int GetLineLength(long lineNo) const = 0;
290 virtual wxString GetLineText(long lineNo) const = 0;
291 virtual int GetNumberOfLines() const = 0;
292
293 virtual bool IsModified() const = 0;
294 virtual bool IsEditable() const = 0;
295
296 // more readable flag testing methods
297 bool IsSingleLine() const { return !HasFlag(wxTE_MULTILINE); }
298 bool IsMultiLine() const { return !IsSingleLine(); }
299
300 // If the return values from and to are the same, there is no selection.
301 virtual void GetSelection(long* from, long* to) const = 0;
302
303 virtual wxString GetStringSelection() const;
304
305 // operations
306 // ----------
307
308 // editing
309 virtual void Clear() = 0;
310 virtual void Replace(long from, long to, const wxString& value) = 0;
311 virtual void Remove(long from, long to) = 0;
312
313 // load/save the controls contents from/to the file
314 virtual bool LoadFile(const wxString& file);
315 virtual bool SaveFile(const wxString& file = wxEmptyString);
316
317 // sets/clears the dirty flag
318 virtual void MarkDirty() = 0;
319 virtual void DiscardEdits() = 0;
320
321 // set the max number of characters which may be entered in a single line
322 // text control
323 virtual void SetMaxLength(unsigned long WXUNUSED(len)) { }
324
325 // writing text inserts it at the current position, appending always
326 // inserts it at the end
327 virtual void WriteText(const wxString& text) = 0;
328 virtual void AppendText(const wxString& text) = 0;
329
330 // insert the character which would have resulted from this key event,
331 // return true if anything has been inserted
332 virtual bool EmulateKeyPress(const wxKeyEvent& event);
333
334 // text control under some platforms supports the text styles: these
335 // methods allow to apply the given text style to the given selection or to
336 // set/get the style which will be used for all appended text
337 virtual bool SetStyle(long start, long end, const wxTextAttr& style);
338 virtual bool GetStyle(long position, wxTextAttr& style);
339 virtual bool SetDefaultStyle(const wxTextAttr& style);
340 virtual const wxTextAttr& GetDefaultStyle() const;
341
342 // translate between the position (which is just an index in the text ctrl
343 // considering all its contents as a single strings) and (x, y) coordinates
344 // which represent column and line.
345 virtual long XYToPosition(long x, long y) const = 0;
346 virtual bool PositionToXY(long pos, long *x, long *y) const = 0;
347
348 virtual void ShowPosition(long pos) = 0;
349
350 // find the character at position given in pixels
351 //
352 // NB: pt is in device coords (not adjusted for the client area origin nor
353 // scrolling)
354 virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
355 virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
356 wxTextCoord *col,
357 wxTextCoord *row) const;
358
359 // Clipboard operations
360 virtual void Copy() = 0;
361 virtual void Cut() = 0;
362 virtual void Paste() = 0;
363
364 virtual bool CanCopy() const;
365 virtual bool CanCut() const;
366 virtual bool CanPaste() const;
367
368 // Undo/redo
369 virtual void Undo() = 0;
370 virtual void Redo() = 0;
371
372 virtual bool CanUndo() const = 0;
373 virtual bool CanRedo() const = 0;
374
375 // Insertion point
376 virtual void SetInsertionPoint(long pos) = 0;
377 virtual void SetInsertionPointEnd() = 0;
378 virtual long GetInsertionPoint() const = 0;
379 virtual wxTextPos GetLastPosition() const = 0;
380
381 virtual void SetSelection(long from, long to) = 0;
382 virtual void SelectAll();
383 virtual void SetEditable(bool editable) = 0;
384
385 // override streambuf method
386 #if wxHAS_TEXT_WINDOW_STREAM
387 int overflow(int i);
388 #endif // wxHAS_TEXT_WINDOW_STREAM
389
390 // stream-like insertion operators: these are always available, whether we
391 // were, or not, compiled with streambuf support
392 wxTextCtrl& operator<<(const wxString& s);
393 wxTextCtrl& operator<<(int i);
394 wxTextCtrl& operator<<(long i);
395 wxTextCtrl& operator<<(float f);
396 wxTextCtrl& operator<<(double d);
397 wxTextCtrl& operator<<(const wxChar c);
398
399 // do the window-specific processing after processing the update event
400 virtual void DoUpdateWindowUI(wxUpdateUIEvent& event);
401
402 virtual bool ShouldInheritColours() const { return false; }
403
404 protected:
405 // the name of the last file loaded with LoadFile() which will be used by
406 // SaveFile() by default
407 wxString m_filename;
408
409 // the text style which will be used for any new text added to the control
410 wxTextAttr m_defaultStyle;
411
412 DECLARE_NO_COPY_CLASS(wxTextCtrlBase)
413 };
414
415 // ----------------------------------------------------------------------------
416 // include the platform-dependent class definition
417 // ----------------------------------------------------------------------------
418
419 #if defined(__WXX11__)
420 #include "wx/x11/textctrl.h"
421 #elif defined(__WXUNIVERSAL__)
422 #include "wx/univ/textctrl.h"
423 #elif defined(__SMARTPHONE__) && defined(__WXWINCE__)
424 #include "wx/msw/wince/textctrlce.h"
425 #elif defined(__WXMSW__)
426 #include "wx/msw/textctrl.h"
427 #elif defined(__WXMOTIF__)
428 #include "wx/motif/textctrl.h"
429 #elif defined(__WXGTK__)
430 #include "wx/gtk/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_