]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/textentry.h
another DMC build fix (http://thread.gmane.org/gmane.comp.lib.wxwidgets.devel/93155)
[wxWidgets.git] / include / wx / textentry.h
... / ...
CommitLineData
1///////////////////////////////////////////////////////////////////////////////
2// Name: wx/textentry.h
3// Purpose: declares wxTextEntry interface defining a simple text entry
4// Author: Vadim Zeitlin
5// Created: 2007-09-24
6// RCS-ID: $Id$
7// Copyright: (c) 2007 Vadim Zeitlin <vadim@wxwindows.org>
8// Licence: wxWindows licence
9///////////////////////////////////////////////////////////////////////////////
10
11#ifndef _WX_TEXTENTRY_H_
12#define _WX_TEXTENTRY_H_
13
14// wxTextPos is the position in the text (currently it's hardly used anywhere
15// and should probably be replaced with int anyhow)
16typedef long wxTextPos;
17
18// ----------------------------------------------------------------------------
19// wxTextEntryBase
20// ----------------------------------------------------------------------------
21
22class WXDLLIMPEXP_CORE wxTextEntryBase
23{
24public:
25 wxTextEntryBase() { m_eventsBlock = 0; }
26 virtual ~wxTextEntryBase() { }
27
28
29 // accessing the value
30 // -------------------
31
32 // SetValue() generates a text change event, ChangeValue() doesn't
33 virtual void SetValue(const wxString& value)
34 { DoSetValue(value, SetValue_SendEvent); }
35 virtual void ChangeValue(const wxString& value)
36 { DoSetValue(value, SetValue_NoEvent); }
37
38 // writing text inserts it at the current position replacing any current
39 // selection, appending always inserts it at the end and doesn't remove any
40 // existing text (but it will reset the selection if there is any)
41 virtual void WriteText(const wxString& text) = 0;
42 virtual void AppendText(const wxString& text);
43
44 virtual wxString GetValue() const = 0;
45 virtual wxString GetRange(long from, long to) const;
46 bool IsEmpty() const { return GetValue().empty(); }
47
48
49 // editing operations
50 // ------------------
51
52 virtual void Replace(long from, long to, const wxString& value);
53 virtual void Remove(long from, long to) = 0;
54 virtual void Clear() { SetValue(wxString()); }
55
56
57 // clipboard operations
58 // --------------------
59
60 virtual void Copy() = 0;
61 virtual void Cut() = 0;
62 virtual void Paste() = 0;
63
64 virtual bool CanCopy() const;
65 virtual bool CanCut() const;
66 virtual bool CanPaste() const;
67
68 // undo/redo
69 // ---------
70
71 virtual void Undo() = 0;
72 virtual void Redo() = 0;
73
74 virtual bool CanUndo() const = 0;
75 virtual bool CanRedo() const = 0;
76
77
78 // insertion point
79 // ---------------
80
81 // note that moving insertion point removes any current selection
82 virtual void SetInsertionPoint(long pos) = 0;
83 virtual void SetInsertionPointEnd() { SetInsertionPoint(-1); }
84 virtual long GetInsertionPoint() const = 0;
85 virtual long GetLastPosition() const = 0;
86
87
88 // selection
89 // ---------
90
91 virtual void SetSelection(long from, long to) = 0;
92 virtual void SelectAll() { SetSelection(0, GetLastPosition()); }
93 virtual void GetSelection(long *from, long *to) const = 0;
94 bool HasSelection() const;
95 virtual wxString GetStringSelection() const;
96
97
98 // status
99 // ------
100 virtual bool IsEditable() const = 0;
101 virtual void SetEditable(bool editable) = 0;
102
103
104 // set the max number of characters which may be entered in a single line
105 // text control
106 virtual void SetMaxLength(unsigned long WXUNUSED(len)) { }
107
108
109protected:
110 // flags for DoSetValue(): common part of SetValue() and ChangeValue() and
111 // also used to implement WriteText() in wxMSW
112 enum
113 {
114 SetValue_NoEvent = 0,
115 SetValue_SendEvent = 1,
116 SetValue_SelectionOnly = 2
117 };
118
119 virtual void DoSetValue(const wxString& value, int flags);
120
121 // class which should be used to temporarily disable text change events
122 //
123 // if suppress argument in ctor is false, nothing is done
124 class EventsSuppressor
125 {
126 public:
127 EventsSuppressor(wxTextEntryBase *text, bool suppress = true)
128 {
129 m_suppress = suppress;
130 if ( m_suppress )
131 {
132 m_text = text;
133 m_text->SuppressTextChangedEvents();
134 }
135 }
136
137 ~EventsSuppressor()
138 {
139 if ( m_suppress )
140 m_text->ResumeTextChangedEvents();
141 }
142
143 private:
144 wxTextEntryBase *m_text;
145 bool m_suppress;
146 };
147 friend class EventsSuppressor;
148
149 // return true if the events are currently not suppressed
150 bool EventsAllowed() const { return m_eventsBlock == 0; }
151
152private:
153 // suppress or resume the text changed events generation: don't use these
154 // functions directly, use EventsSuppressor class above instead
155 void SuppressTextChangedEvents()
156 {
157 if ( !m_eventsBlock++ )
158 EnableTextChangedEvents(false);
159 }
160
161 void ResumeTextChangedEvents()
162 {
163 if ( !--m_eventsBlock )
164 EnableTextChangedEvents(true);
165 }
166
167
168 // this must be overridden in the derived classes if our implementation of
169 // SetValue() or Replace() is used to disable (and enable back) generation
170 // of the text changed events
171 //
172 // initially the generation of the events is enabled
173 virtual void EnableTextChangedEvents(bool WXUNUSED(enable)) { }
174
175 // if this counter is non-null, events are blocked
176 unsigned m_eventsBlock;
177};
178
179#ifdef __WXUNIVERSAL__
180 // TODO: we need to use wxTextEntryDelegate here, but for now just prevent
181 // the GTK/MSW classes from being used in wxUniv build
182 class WXDLLIMPEXP_CORE wxTextEntry : public wxTextEntryBase
183 {
184 };
185#elif defined(__WXGTK20__)
186 #include "wx/gtk/textentry.h"
187#elif defined(__WXMSW__)
188 #include "wx/msw/textentry.h"
189#else
190 // no platform-specific implementation of wxTextEntry yet
191 class WXDLLIMPEXP_CORE wxTextEntry : public wxTextEntryBase
192 {
193 };
194#endif
195
196#endif // _WX_TEXTENTRY_H_
197