minor clean up
[wxWidgets.git] / include / wx / textctrl.h
CommitLineData
a1b82138
VZ
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
34138703
JS
12#ifndef _WX_TEXTCTRL_H_BASE_
13#define _WX_TEXTCTRL_H_BASE_
c801d85f 14
a1b82138
VZ
15// ----------------------------------------------------------------------------
16// headers
17// ----------------------------------------------------------------------------
4bc1afd5 18
bf3e0fbd
KB
19#ifdef __GNUG__
20 #pragma interface "textctrlbase.h"
4bc1afd5 21#endif
a1b82138
VZ
22
23#include "wx/defs.h"
1e6feb95
VZ
24
25#if wxUSE_TEXTCTRL
26
a1b82138
VZ
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__) || defined(_WINDLL) || defined(WXUSINGDLL) || defined(WXMAKINGDLL)
34 #define NO_TEXT_WINDOW_STREAM
35#endif
36
dd107c50
VZ
37// the streambuf which is used in the declaration of wxTextCtrlBase below is not compatible
38// with the standard-conforming implementation found in newer egcs versions
39// (that is, the libstdc++ v3 that is shipped with it)
40#if defined(__GNUC__)&&( (__GNUC__>2) ||( (__GNUC__==2)&&(__GNUC_MINOR__>97) ) )
41 #define NO_TEXT_WINDOW_STREAM
42#endif
43
a1b82138 44#ifndef NO_TEXT_WINDOW_STREAM
324dbfec 45 #if wxUSE_STD_IOSTREAM
bac507e0 46 #include "wx/ioswrap.h" // for iostream classes if we need them
a1b82138
VZ
47 #else // !wxUSE_STD_IOSTREAM
48 // can't compile this feature in if we don't use streams at all
49 #define NO_TEXT_WINDOW_STREAM
50 #endif // wxUSE_STD_IOSTREAM/!wxUSE_STD_IOSTREAM
51#endif
52
0efe5ba7
VZ
53class WXDLLEXPORT wxTextCtrl;
54
a1b82138
VZ
55// ----------------------------------------------------------------------------
56// constants
57// ----------------------------------------------------------------------------
58
59WXDLLEXPORT_DATA(extern const wxChar*) wxTextCtrlNameStr;
60WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
61
c57e3339
VZ
62// ----------------------------------------------------------------------------
63// wxTextCtrl style flags
64// ----------------------------------------------------------------------------
65
66// the flag bits 0x0001, 2, 4 and 8 are free but should be used only for the
67// things which don't make sense for a text control used by wxTextEntryDialog
68// because they would otherwise conflict with wxOK, wxCANCEL, wxCENTRE
69#define wxTE_READONLY 0x0010
70#define wxTE_MULTILINE 0x0020
71#define wxTE_PROCESS_TAB 0x0040
72
73// this style means to use RICHEDIT control and does something only under wxMSW
74// and Win32 and is silently ignored under all other platforms
75#define wxTE_RICH 0x0080
76#define wxTE_NO_VSCROLL 0x0100
77#define wxTE_AUTO_SCROLL 0x0200
78#define wxTE_PROCESS_ENTER 0x0400
79#define wxTE_PASSWORD 0x0800
80
81// automatically detect the URLs and generate the events when mouse is
82// moved/clicked over an URL
83//
84// this is for Win32 richedit controls only so far
85#define wxTE_AUTO_URL 0x1000
86
4bc1afd5
VZ
87// ----------------------------------------------------------------------------
88// wxTextAttr: a structure containing the visual attributes of a text
89// ----------------------------------------------------------------------------
90
91class WXDLLEXPORT wxTextAttr
92{
93public:
94 // ctors
95 wxTextAttr() { }
96 wxTextAttr(const wxColour& colText,
97 const wxColour& colBack = wxNullColour,
98 const wxFont& font = wxNullFont)
99 : m_colText(colText), m_colBack(colBack), m_font(font) { }
100
101 // setters
102 void SetTextColour(const wxColour& colText) { m_colText = colText; }
103 void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; }
104 void SetFont(const wxFont& font) { m_font = font; }
105
106 // accessors
107 bool HasTextColour() const { return m_colText.Ok(); }
108 bool HasBackgroundColour() const { return m_colBack.Ok(); }
109 bool HasFont() const { return m_font.Ok(); }
110
17665a2b 111 // setters
4bc1afd5
VZ
112 const wxColour& GetTextColour() const { return m_colText; }
113 const wxColour& GetBackgroundColour() const { return m_colBack; }
114 const wxFont& GetFont() const { return m_font; }
115
17665a2b
VZ
116 // returns false if we have any attributes set, true otherwise
117 bool IsDefault() const
118 {
119 return !HasTextColour() && !HasBackgroundColour() && !HasFont();
120 }
121
4bc1afd5
VZ
122private:
123 wxColour m_colText,
124 m_colBack;
125 wxFont m_font;
126};
127
a1b82138
VZ
128// ----------------------------------------------------------------------------
129// wxTextCtrl: a single or multiple line text zone where user can enter and
130// edit text
131// ----------------------------------------------------------------------------
132
133class WXDLLEXPORT wxTextCtrlBase : public wxControl
134#ifndef NO_TEXT_WINDOW_STREAM
135 , public streambuf
136#endif
137
138{
139public:
140 // creation
141 // --------
142
143 wxTextCtrlBase();
fa40e7a1 144 ~wxTextCtrlBase();
a1b82138
VZ
145
146 // accessors
147 // ---------
148
149 virtual wxString GetValue() const = 0;
150 virtual void SetValue(const wxString& value) = 0;
151
152 virtual int GetLineLength(long lineNo) const = 0;
153 virtual wxString GetLineText(long lineNo) const = 0;
154 virtual int GetNumberOfLines() const = 0;
155
156 virtual bool IsModified() const = 0;
157 virtual bool IsEditable() const = 0;
158
159 // If the return values from and to are the same, there is no selection.
160 virtual void GetSelection(long* from, long* to) const = 0;
161
162 // operations
163 // ----------
164
165 // editing
166 virtual void Clear() = 0;
167 virtual void Replace(long from, long to, const wxString& value) = 0;
168 virtual void Remove(long from, long to) = 0;
169
170 // load/save the controls contents from/to the file
171 virtual bool LoadFile(const wxString& file);
172 virtual bool SaveFile(const wxString& file = wxEmptyString);
173
174 // clears the dirty flag
175 virtual void DiscardEdits() = 0;
176
d7eee191
VZ
177 // set the max number of characters which may be entered in a single line
178 // text control
179 virtual void SetMaxLength(unsigned long WXUNUSED(len)) { }
180
a1b82138
VZ
181 // writing text inserts it at the current position, appending always
182 // inserts it at the end
183 virtual void WriteText(const wxString& text) = 0;
184 virtual void AppendText(const wxString& text) = 0;
185
4bc1afd5
VZ
186 // text control under some platforms supports the text styles: these
187 // methods allow to apply the given text style to the given selection or to
188 // set/get the style which will be used for all appended text
189 virtual bool SetStyle(long start, long end, const wxTextAttr& style);
190 virtual bool SetDefaultStyle(const wxTextAttr& style);
191 virtual const wxTextAttr& GetDefaultStyle() const;
192
a1b82138
VZ
193 // translate between the position (which is just an index in the text ctrl
194 // considering all its contents as a single strings) and (x, y) coordinates
195 // which represent column and line.
196 virtual long XYToPosition(long x, long y) const = 0;
0efe5ba7 197 virtual bool PositionToXY(long pos, long *x, long *y) const = 0;
a1b82138
VZ
198
199 virtual void ShowPosition(long pos) = 0;
200
201 // Clipboard operations
202 virtual void Copy() = 0;
203 virtual void Cut() = 0;
204 virtual void Paste() = 0;
205
1e6feb95
VZ
206 virtual bool CanCopy() const;
207 virtual bool CanCut() const;
208 virtual bool CanPaste() const;
a1b82138
VZ
209
210 // Undo/redo
211 virtual void Undo() = 0;
212 virtual void Redo() = 0;
213
214 virtual bool CanUndo() const = 0;
215 virtual bool CanRedo() const = 0;
216
217 // Insertion point
218 virtual void SetInsertionPoint(long pos) = 0;
219 virtual void SetInsertionPointEnd() = 0;
220 virtual long GetInsertionPoint() const = 0;
221 virtual long GetLastPosition() const = 0;
222
223 virtual void SetSelection(long from, long to) = 0;
1e6feb95 224 virtual void SelectAll();
a1b82138
VZ
225 virtual void SetEditable(bool editable) = 0;
226
227 // streambuf methods
228#ifndef NO_TEXT_WINDOW_STREAM
229 int overflow(int i);
230 int sync();
231 int underflow();
232#endif // NO_TEXT_WINDOW_STREAM
233
234 // stream-like insertion operators: these are always available, whether we
235 // were, or not, compiled with streambuf support
236 wxTextCtrl& operator<<(const wxString& s);
237 wxTextCtrl& operator<<(int i);
238 wxTextCtrl& operator<<(long i);
239 wxTextCtrl& operator<<(float f);
240 wxTextCtrl& operator<<(double d);
a324a7bc 241 wxTextCtrl& operator<<(const wxChar c);
a1b82138
VZ
242
243 // obsolete functions
244#if WXWIN_COMPATIBILITY
245 bool Modified() const { return IsModified(); }
246#endif
247
5bd3a2da 248protected:
a1b82138
VZ
249 // the name of the last file loaded with LoadFile() which will be used by
250 // SaveFile() by default
251 wxString m_filename;
fa40e7a1 252
4bc1afd5
VZ
253 // the text style which will be used for any new text added to the control
254 wxTextAttr m_defaultStyle;
255
fa40e7a1
SB
256private:
257#ifndef NO_TEXT_WINDOW_STREAM
258#if !wxUSE_IOSTREAMH
1e6feb95 259 char *m_streambuf;
fa40e7a1
SB
260#endif
261#endif
a1b82138
VZ
262};
263
264// ----------------------------------------------------------------------------
265// include the platform-dependent class definition
266// ----------------------------------------------------------------------------
267
1e6feb95
VZ
268#if defined(__WXUNIVERSAL__)
269 #include "wx/univ/textctrl.h"
270#elif defined(__WXMSW__)
a1b82138 271 #include "wx/msw/textctrl.h"
2049ba38 272#elif defined(__WXMOTIF__)
a1b82138 273 #include "wx/motif/textctrl.h"
2049ba38 274#elif defined(__WXGTK__)
a1b82138 275 #include "wx/gtk/textctrl.h"
b4e76e0d 276#elif defined(__WXQT__)
a1b82138 277 #include "wx/qt/textctrl.h"
34138703 278#elif defined(__WXMAC__)
a1b82138 279 #include "wx/mac/textctrl.h"
1777b9bb
DW
280#elif defined(__WXPM__)
281 #include "wx/os2/textctrl.h"
34138703 282#elif defined(__WXSTUBS__)
a1b82138 283 #include "wx/stubs/textctrl.h"
c801d85f
KB
284#endif
285
c57e3339
VZ
286// ----------------------------------------------------------------------------
287// wxTextCtrl events
288// ----------------------------------------------------------------------------
289
ad0bae85
VZ
290#if !WXWIN_COMPATIBILITY_EVENT_TYPES
291
c57e3339
VZ
292BEGIN_DECLARE_EVENT_TYPES()
293 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_UPDATED, 7)
294 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_ENTER, 8)
295 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_URL, 13)
d7eee191 296 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_MAXLEN, 14)
c57e3339
VZ
297END_DECLARE_EVENT_TYPES()
298
ad0bae85
VZ
299#endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
300
c57e3339
VZ
301class WXDLLEXPORT wxTextUrlEvent : public wxCommandEvent
302{
303public:
304 wxTextUrlEvent(int id, const wxMouseEvent& evtMouse,
305 long start, long end)
306 : wxCommandEvent(wxEVT_COMMAND_TEXT_URL, id),
307 m_evtMouse(evtMouse)
308 { m_start = start; m_end = end; }
309
310 // get the mouse event which happend over the URL
311 const wxMouseEvent& GetMouseEvent() const { return m_evtMouse; }
312
313 // get the start of the URL
314 long GetURLStart() const { return m_start; }
315
316 // get the end of the URL
317 long GetURLEnd() const { return m_end; }
318
319protected:
320 // the corresponding mouse event
321 wxMouseEvent m_evtMouse;
322
323 // the start and end indices of the URL in the text control
324 long m_start,
325 m_end;
326
327private:
328 DECLARE_DYNAMIC_CLASS(wxTextUrlEvent)
329
330public:
331 // for wxWin RTTI only, don't use
332 wxTextUrlEvent() { }
333};
334
335typedef void (wxEvtHandler::*wxTextUrlEventFunction)(wxTextUrlEvent&);
336
337#define EVT_TEXT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
338#define EVT_TEXT_ENTER(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
339#define EVT_TEXT_URL(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_URL, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxTextUrlEventFunction) & fn, (wxObject *) NULL ),
d7eee191 340#define EVT_TEXT_MAXLEN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_MAXLEN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
c57e3339 341
1e6feb95
VZ
342#endif // wxUSE_TEXTCTRL
343
c801d85f 344#endif
34138703 345 // _WX_TEXTCTRL_H_BASE_