]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/textctrl.h
fixed typo
[wxWidgets.git] / include / wx / textctrl.h
... / ...
CommitLineData
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) wxWindows 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#ifdef __GNUG__
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
29// 16-bit Borland 4.0 doesn't seem to allow multiple inheritance with wxWindow
30// and streambuf: it complains about deriving a huge class from the huge class
31// streambuf. !! Also, can't use streambuf if making or using a DLL :-(
32
33#if (defined(__BORLANDC__)) || defined(__MWERKS__) || \
34 defined(WXUSINGDLL) || defined(WXMAKINGDLL)
35 #define NO_TEXT_WINDOW_STREAM
36#endif
37
38#ifndef NO_TEXT_WINDOW_STREAM
39 #if wxUSE_STD_IOSTREAM
40 #include "wx/ioswrap.h" // for iostream classes if we need them
41 #else // !wxUSE_STD_IOSTREAM
42 // can't compile this feature in if we don't use streams at all
43 #define NO_TEXT_WINDOW_STREAM
44 #endif // wxUSE_STD_IOSTREAM/!wxUSE_STD_IOSTREAM
45#endif
46
47class WXDLLEXPORT wxTextCtrl;
48class WXDLLEXPORT wxTextCtrlBase;
49
50// ----------------------------------------------------------------------------
51// constants
52// ----------------------------------------------------------------------------
53
54WXDLLEXPORT_DATA(extern const wxChar*) wxTextCtrlNameStr;
55WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
56
57// ----------------------------------------------------------------------------
58// wxTextCtrl style flags
59// ----------------------------------------------------------------------------
60
61// the flag bits 0x0001, 2, 4 and 8 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
64#define wxTE_READONLY 0x0010
65#define wxTE_MULTILINE 0x0020
66#define wxTE_PROCESS_TAB 0x0040
67
68// this style means to use RICHEDIT control and does something only under wxMSW
69// and Win32 and is silently ignored under all other platforms
70#define wxTE_RICH 0x0080
71#define wxTE_NO_VSCROLL 0x0100
72#define wxTE_AUTO_SCROLL 0x0200
73#define wxTE_PROCESS_ENTER 0x0400
74#define wxTE_PASSWORD 0x0800
75
76// automatically detect the URLs and generate the events when mouse is
77// moved/clicked over an URL
78//
79// this is for Win32 richedit controls only so far
80#define wxTE_AUTO_URL 0x1000
81
82// by default, the Windows text control doesn't show the selection when it
83// doesn't have focus - use this style to force it to always show it
84#define wxTE_NOHIDESEL 0x2000
85
86// use wxHSCROLL to not wrap text at all, wxTE_LINEWRAP to wrap it at any
87// position and wxTE_WORDWRAP to wrap at words boundary
88#define wxTE_DONTWRAP wxHSCROLL
89#define wxTE_LINEWRAP 0x4000
90#define wxTE_WORDWRAP 0x0000 // it's just == !wxHSCROLL
91
92// force using RichEdit version 2.0 or 3.0 instead of 1.0 (default) for
93// wxTE_RICH controls - can be used together with or instead of wxTE_RICH
94#define wxTE_RICH2 0x8000
95
96// ----------------------------------------------------------------------------
97// wxTextAttr: a structure containing the visual attributes of a text
98// ----------------------------------------------------------------------------
99
100class WXDLLEXPORT wxTextAttr
101{
102public:
103 // ctors
104 wxTextAttr() { }
105 wxTextAttr(const wxColour& colText,
106 const wxColour& colBack = wxNullColour,
107 const wxFont& font = wxNullFont)
108 : m_colText(colText), m_colBack(colBack), m_font(font) { }
109
110 // setters
111 void SetTextColour(const wxColour& colText) { m_colText = colText; }
112 void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; }
113 void SetFont(const wxFont& font) { m_font = font; }
114
115 // accessors
116 bool HasTextColour() const { return m_colText.Ok(); }
117 bool HasBackgroundColour() const { return m_colBack.Ok(); }
118 bool HasFont() const { return m_font.Ok(); }
119
120 // setters
121 const wxColour& GetTextColour() const { return m_colText; }
122 const wxColour& GetBackgroundColour() const { return m_colBack; }
123 const wxFont& GetFont() const { return m_font; }
124
125 // returns false if we have any attributes set, true otherwise
126 bool IsDefault() const
127 {
128 return !HasTextColour() && !HasBackgroundColour() && !HasFont();
129 }
130
131 // return the attribute having the valid font and colours: it uses the
132 // attributes set in attr and falls back first to attrDefault and then to
133 // the text control font/colours for those attributes which are not set
134 static wxTextAttr Combine(const wxTextAttr& attr,
135 const wxTextAttr& attrDef,
136 const wxTextCtrlBase *text);
137
138private:
139 wxColour m_colText,
140 m_colBack;
141 wxFont m_font;
142};
143
144// ----------------------------------------------------------------------------
145// wxTextCtrl: a single or multiple line text zone where user can enter and
146// edit text
147// ----------------------------------------------------------------------------
148
149class WXDLLEXPORT wxTextCtrlBase : public wxControl
150#ifndef NO_TEXT_WINDOW_STREAM
151 , public wxSTD streambuf
152#endif
153
154{
155public:
156 // creation
157 // --------
158
159 wxTextCtrlBase();
160 ~wxTextCtrlBase();
161
162 // accessors
163 // ---------
164
165 virtual wxString GetValue() const = 0;
166 virtual void SetValue(const wxString& value) = 0;
167
168 virtual wxString GetRange(long from, long to) const;
169
170 virtual int GetLineLength(long lineNo) const = 0;
171 virtual wxString GetLineText(long lineNo) const = 0;
172 virtual int GetNumberOfLines() const = 0;
173
174 virtual bool IsModified() const = 0;
175 virtual bool IsEditable() const = 0;
176
177 // If the return values from and to are the same, there is no selection.
178 virtual void GetSelection(long* from, long* to) const = 0;
179
180 virtual wxString GetStringSelection() const;
181
182 // operations
183 // ----------
184
185 // editing
186 virtual void Clear() = 0;
187 virtual void Replace(long from, long to, const wxString& value) = 0;
188 virtual void Remove(long from, long to) = 0;
189
190 // load/save the controls contents from/to the file
191 virtual bool LoadFile(const wxString& file);
192 virtual bool SaveFile(const wxString& file = wxEmptyString);
193
194 // clears the dirty flag
195 virtual void DiscardEdits() = 0;
196
197 // set the max number of characters which may be entered in a single line
198 // text control
199 virtual void SetMaxLength(unsigned long WXUNUSED(len)) { }
200
201 // writing text inserts it at the current position, appending always
202 // inserts it at the end
203 virtual void WriteText(const wxString& text) = 0;
204 virtual void AppendText(const wxString& text) = 0;
205
206 // text control under some platforms supports the text styles: these
207 // methods allow to apply the given text style to the given selection or to
208 // set/get the style which will be used for all appended text
209 virtual bool SetStyle(long start, long end, const wxTextAttr& style);
210 virtual bool SetDefaultStyle(const wxTextAttr& style);
211 virtual const wxTextAttr& GetDefaultStyle() const;
212
213 // translate between the position (which is just an index in the text ctrl
214 // considering all its contents as a single strings) and (x, y) coordinates
215 // which represent column and line.
216 virtual long XYToPosition(long x, long y) const = 0;
217 virtual bool PositionToXY(long pos, long *x, long *y) const = 0;
218
219 virtual void ShowPosition(long pos) = 0;
220
221 // Clipboard operations
222 virtual void Copy() = 0;
223 virtual void Cut() = 0;
224 virtual void Paste() = 0;
225
226 virtual bool CanCopy() const;
227 virtual bool CanCut() const;
228 virtual bool CanPaste() const;
229
230 // Undo/redo
231 virtual void Undo() = 0;
232 virtual void Redo() = 0;
233
234 virtual bool CanUndo() const = 0;
235 virtual bool CanRedo() const = 0;
236
237 // Insertion point
238 virtual void SetInsertionPoint(long pos) = 0;
239 virtual void SetInsertionPointEnd() = 0;
240 virtual long GetInsertionPoint() const = 0;
241 virtual long GetLastPosition() const = 0;
242
243 virtual void SetSelection(long from, long to) = 0;
244 virtual void SelectAll();
245 virtual void SetEditable(bool editable) = 0;
246
247 // override streambuf method
248#ifndef NO_TEXT_WINDOW_STREAM
249 int overflow(int i);
250#endif // NO_TEXT_WINDOW_STREAM
251
252 // stream-like insertion operators: these are always available, whether we
253 // were, or not, compiled with streambuf support
254 wxTextCtrl& operator<<(const wxString& s);
255 wxTextCtrl& operator<<(int i);
256 wxTextCtrl& operator<<(long i);
257 wxTextCtrl& operator<<(float f);
258 wxTextCtrl& operator<<(double d);
259 wxTextCtrl& operator<<(const wxChar c);
260
261 // obsolete functions
262#if WXWIN_COMPATIBILITY
263 bool Modified() const { return IsModified(); }
264#endif
265
266protected:
267 // the name of the last file loaded with LoadFile() which will be used by
268 // SaveFile() by default
269 wxString m_filename;
270
271 // the text style which will be used for any new text added to the control
272 wxTextAttr m_defaultStyle;
273};
274
275// ----------------------------------------------------------------------------
276// include the platform-dependent class definition
277// ----------------------------------------------------------------------------
278
279#if defined(__WXX11__)
280 #include "wx/x11/textctrl.h"
281#elif defined(__WXUNIVERSAL__)
282 #include "wx/univ/textctrl.h"
283#elif defined(__WXMSW__)
284 #include "wx/msw/textctrl.h"
285#elif defined(__WXMOTIF__)
286 #include "wx/motif/textctrl.h"
287#elif defined(__WXGTK__)
288 #include "wx/gtk/textctrl.h"
289#elif defined(__WXMAC__)
290 #include "wx/mac/textctrl.h"
291#elif defined(__WXPM__)
292 #include "wx/os2/textctrl.h"
293#elif defined(__WXSTUBS__)
294 #include "wx/stubs/textctrl.h"
295#endif
296
297// ----------------------------------------------------------------------------
298// wxTextCtrl events
299// ----------------------------------------------------------------------------
300
301#if !WXWIN_COMPATIBILITY_EVENT_TYPES
302
303BEGIN_DECLARE_EVENT_TYPES()
304 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_UPDATED, 7)
305 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_ENTER, 8)
306 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_URL, 13)
307 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_MAXLEN, 14)
308END_DECLARE_EVENT_TYPES()
309
310#endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
311
312class WXDLLEXPORT wxTextUrlEvent : public wxCommandEvent
313{
314public:
315 wxTextUrlEvent(int id, const wxMouseEvent& evtMouse,
316 long start, long end)
317 : wxCommandEvent(wxEVT_COMMAND_TEXT_URL, id),
318 m_evtMouse(evtMouse)
319 { m_start = start; m_end = end; }
320
321 // get the mouse event which happend over the URL
322 const wxMouseEvent& GetMouseEvent() const { return m_evtMouse; }
323
324 // get the start of the URL
325 long GetURLStart() const { return m_start; }
326
327 // get the end of the URL
328 long GetURLEnd() const { return m_end; }
329
330protected:
331 // the corresponding mouse event
332 wxMouseEvent m_evtMouse;
333
334 // the start and end indices of the URL in the text control
335 long m_start,
336 m_end;
337
338private:
339 DECLARE_DYNAMIC_CLASS(wxTextUrlEvent)
340
341public:
342 // for wxWin RTTI only, don't use
343 wxTextUrlEvent() { }
344};
345
346typedef void (wxEvtHandler::*wxTextUrlEventFunction)(wxTextUrlEvent&);
347
348#define EVT_TEXT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
349#define EVT_TEXT_ENTER(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
350#define EVT_TEXT_URL(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_URL, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxTextUrlEventFunction) & fn, (wxObject *) NULL ),
351#define EVT_TEXT_MAXLEN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_MAXLEN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
352
353#ifndef NO_TEXT_WINDOW_STREAM
354
355// ----------------------------------------------------------------------------
356// wxStreamToTextRedirector: this class redirects all data sent to the given
357// C++ stream to the wxTextCtrl given to its ctor during its lifetime.
358// ----------------------------------------------------------------------------
359
360class WXDLLEXPORT wxStreamToTextRedirector
361{
362public:
363 wxStreamToTextRedirector(wxTextCtrl *text, wxSTD ostream *ostr = NULL)
364 : m_ostr(ostr ? *ostr : wxSTD cout)
365 {
366 m_sbufOld = m_ostr.rdbuf();
367 m_ostr.rdbuf(text);
368 }
369
370 ~wxStreamToTextRedirector()
371 {
372 m_ostr.rdbuf(m_sbufOld);
373 }
374
375private:
376 // the stream we're redirecting
377 wxSTD ostream& m_ostr;
378
379 // the old streambuf (before we changed it)
380 wxSTD streambuf *m_sbufOld;
381};
382
383#endif // !NO_TEXT_WINDOW_STREAM
384
385#endif // wxUSE_TEXTCTRL
386
387#endif
388 // _WX_TEXTCTRL_H_BASE_