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