]> git.saurik.com Git - wxWidgets.git/blob - include/wx/msw/textctrl.h
Fix wrong return value in the changes of r73365.
[wxWidgets.git] / include / wx / msw / textctrl.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/msw/textctrl.h
3 // Purpose: wxTextCtrl class
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 01/02/97
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_TEXTCTRL_H_
13 #define _WX_TEXTCTRL_H_
14
15 class WXDLLIMPEXP_CORE wxTextCtrl : public wxTextCtrlBase
16 {
17 public:
18 // creation
19 // --------
20
21 wxTextCtrl() { Init(); }
22 wxTextCtrl(wxWindow *parent, wxWindowID id,
23 const wxString& value = wxEmptyString,
24 const wxPoint& pos = wxDefaultPosition,
25 const wxSize& size = wxDefaultSize,
26 long style = 0,
27 const wxValidator& validator = wxDefaultValidator,
28 const wxString& name = wxTextCtrlNameStr)
29 {
30 Init();
31
32 Create(parent, id, value, pos, size, style, validator, name);
33 }
34 virtual ~wxTextCtrl();
35
36 bool Create(wxWindow *parent, wxWindowID id,
37 const wxString& value = wxEmptyString,
38 const wxPoint& pos = wxDefaultPosition,
39 const wxSize& size = wxDefaultSize,
40 long style = 0,
41 const wxValidator& validator = wxDefaultValidator,
42 const wxString& name = wxTextCtrlNameStr);
43
44 // overridden wxTextEntry methods
45 // ------------------------------
46
47 virtual wxString GetValue() const;
48 virtual wxString GetRange(long from, long to) const;
49
50 virtual bool IsEmpty() const;
51
52 virtual void WriteText(const wxString& text);
53 virtual void AppendText(const wxString& text);
54 virtual void Clear();
55
56 virtual int GetLineLength(long lineNo) const;
57 virtual wxString GetLineText(long lineNo) const;
58 virtual int GetNumberOfLines() const;
59
60 virtual void SetMaxLength(unsigned long len);
61
62 virtual void GetSelection(long *from, long *to) const;
63
64 virtual void Redo();
65 virtual bool CanRedo() const;
66
67 virtual void SetInsertionPointEnd();
68 virtual long GetInsertionPoint() const;
69 virtual wxTextPos GetLastPosition() const;
70
71 // implement base class pure virtuals
72 // ----------------------------------
73
74 virtual bool IsModified() const;
75 virtual void MarkDirty();
76 virtual void DiscardEdits();
77
78 #ifdef __WIN32__
79 virtual bool EmulateKeyPress(const wxKeyEvent& event);
80 #endif // __WIN32__
81
82 #if wxUSE_RICHEDIT
83 // apply text attribute to the range of text (only works with richedit
84 // controls)
85 virtual bool SetStyle(long start, long end, const wxTextAttr& style);
86 virtual bool SetDefaultStyle(const wxTextAttr& style);
87 virtual bool GetStyle(long position, wxTextAttr& style);
88 #endif // wxUSE_RICHEDIT
89
90 // translate between the position (which is just an index in the text ctrl
91 // considering all its contents as a single strings) and (x, y) coordinates
92 // which represent column and line.
93 virtual long XYToPosition(long x, long y) const;
94 virtual bool PositionToXY(long pos, long *x, long *y) const;
95
96 virtual void ShowPosition(long pos);
97 virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
98 virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
99 wxTextCoord *col,
100 wxTextCoord *row) const
101 {
102 return wxTextCtrlBase::HitTest(pt, col, row);
103 }
104
105 // Caret handling (Windows only)
106 bool ShowNativeCaret(bool show = true);
107 bool HideNativeCaret() { return ShowNativeCaret(false); }
108
109 // Implementation from now on
110 // --------------------------
111
112 #if wxUSE_DRAG_AND_DROP && wxUSE_RICHEDIT
113 virtual void SetDropTarget(wxDropTarget *dropTarget);
114 #endif // wxUSE_DRAG_AND_DROP && wxUSE_RICHEDIT
115
116 virtual void SetWindowStyleFlag(long style);
117
118 virtual void Command(wxCommandEvent& event);
119 virtual bool MSWCommand(WXUINT param, WXWORD id);
120 virtual WXHBRUSH MSWControlColor(WXHDC hDC, WXHWND hWnd);
121
122 #if wxUSE_RICHEDIT
123 virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
124
125 int GetRichVersion() const { return m_verRichEdit; }
126 bool IsRich() const { return m_verRichEdit != 0; }
127
128 // rich edit controls are not compatible with normal ones and we must set
129 // the colours and font for them otherwise
130 virtual bool SetBackgroundColour(const wxColour& colour);
131 virtual bool SetForegroundColour(const wxColour& colour);
132 virtual bool SetFont(const wxFont& font);
133 #else
134 bool IsRich() const { return false; }
135 #endif // wxUSE_RICHEDIT
136
137 #if wxUSE_INKEDIT && wxUSE_RICHEDIT
138 bool IsInkEdit() const { return m_isInkEdit != 0; }
139 #else
140 bool IsInkEdit() const { return false; }
141 #endif
142
143 virtual void AdoptAttributesFromHWND();
144
145 virtual bool AcceptsFocusFromKeyboard() const;
146
147 // returns true if the platform should explicitly apply a theme border
148 virtual bool CanApplyThemeBorder() const;
149
150 // callbacks
151 void OnDropFiles(wxDropFilesEvent& event);
152 void OnChar(wxKeyEvent& event); // Process 'enter' if required
153
154 void OnCut(wxCommandEvent& event);
155 void OnCopy(wxCommandEvent& event);
156 void OnPaste(wxCommandEvent& event);
157 void OnUndo(wxCommandEvent& event);
158 void OnRedo(wxCommandEvent& event);
159 void OnDelete(wxCommandEvent& event);
160 void OnSelectAll(wxCommandEvent& event);
161
162 void OnUpdateCut(wxUpdateUIEvent& event);
163 void OnUpdateCopy(wxUpdateUIEvent& event);
164 void OnUpdatePaste(wxUpdateUIEvent& event);
165 void OnUpdateUndo(wxUpdateUIEvent& event);
166 void OnUpdateRedo(wxUpdateUIEvent& event);
167 void OnUpdateDelete(wxUpdateUIEvent& event);
168 void OnUpdateSelectAll(wxUpdateUIEvent& event);
169
170 // Show a context menu for Rich Edit controls (the standard
171 // EDIT control has one already)
172 void OnContextMenu(wxContextMenuEvent& event);
173
174 // be sure the caret remains invisible if the user
175 // called HideNativeCaret() before
176 void OnSetFocus(wxFocusEvent& event);
177
178 // intercept WM_GETDLGCODE
179 virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
180
181 virtual bool MSWShouldPreProcessMessage(WXMSG* pMsg);
182 virtual WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
183
184 protected:
185 // common part of all ctors
186 void Init();
187
188 virtual bool DoLoadFile(const wxString& file, int fileType);
189
190 // creates the control of appropriate class (plain or rich edit) with the
191 // styles corresponding to m_windowStyle
192 //
193 // this is used by ctor/Create() and when we need to recreate the control
194 // later
195 bool MSWCreateText(const wxString& value,
196 const wxPoint& pos,
197 const wxSize& size);
198
199 virtual void DoSetValue(const wxString &value, int flags = 0);
200
201 virtual wxPoint DoPositionToCoords(long pos) const;
202
203 // return true if this control has a user-set limit on amount of text (i.e.
204 // the limit is due to a previous call to SetMaxLength() and not built in)
205 bool HasSpaceLimit(unsigned int *len) const;
206
207 // call this to increase the size limit (will do nothing if the current
208 // limit is big enough)
209 //
210 // returns true if we increased the limit to allow entering more text,
211 // false if we hit the limit set by SetMaxLength() and so didn't change it
212 bool AdjustSpaceLimit();
213
214 #if wxUSE_RICHEDIT && (!wxUSE_UNICODE || wxUSE_UNICODE_MSLU)
215 // replace the selection or the entire control contents with the given text
216 // in the specified encoding
217 bool StreamIn(const wxString& value, wxFontEncoding encoding, bool selOnly);
218
219 // get the contents of the control out as text in the given encoding
220 wxString StreamOut(wxFontEncoding encoding, bool selOnly = false) const;
221 #endif // wxUSE_RICHEDIT
222
223 // replace the contents of the selection or of the entire control with the
224 // given text
225 void DoWriteText(const wxString& text,
226 int flags = SetValue_SendEvent | SetValue_SelectionOnly);
227
228 // set the selection (possibly without scrolling the caret into view)
229 void DoSetSelection(long from, long to, int flags);
230
231 // get the length of the line containing the character at the given
232 // position
233 long GetLengthOfLineContainingPos(long pos) const;
234
235 // send TEXT_UPDATED event, return true if it was handled, false otherwise
236 bool SendUpdateEvent();
237
238 virtual wxSize DoGetBestSize() const;
239 virtual wxSize DoGetSizeFromTextSize(int xlen, int ylen = -1) const;
240
241 #if wxUSE_RICHEDIT
242 // Apply the character-related parts of wxTextAttr to the given selection
243 // or the entire control if start == end == -1.
244 //
245 // This function is private and should only be called for rich edit
246 // controls and with (from, to) already in correct order, i.e. from <= to.
247 bool MSWSetCharFormat(const wxTextAttr& attr, long from = -1, long to = -1);
248
249 // Same as above for paragraph-related parts of wxTextAttr. Note that this
250 // can only be applied to the selection as RichEdit doesn't support setting
251 // the paragraph styles globally.
252 bool MSWSetParaFormat(const wxTextAttr& attr, long from, long to);
253
254
255 // we're using RICHEDIT (and not simple EDIT) control if this field is not
256 // 0, it also gives the version of the RICHEDIT control being used
257 // (although not directly: 1 is for 1.0, 2 is for either 2.0 or 3.0 as we
258 // can't nor really need to distinguish between them and 4 is for 4.1)
259 int m_verRichEdit;
260 #endif // wxUSE_RICHEDIT
261
262 // number of EN_UPDATE events sent by Windows when we change the controls
263 // text ourselves: we want this to be exactly 1
264 int m_updatesCount;
265
266 private:
267 virtual void EnableTextChangedEvents(bool enable)
268 {
269 m_updatesCount = enable ? -1 : -2;
270 }
271
272 // implement wxTextEntry pure virtual: it implements all the operations for
273 // the simple EDIT controls
274 virtual WXHWND GetEditHWND() const { return m_hWnd; }
275
276 void OnKeyDown(wxKeyEvent& event);
277
278 DECLARE_EVENT_TABLE()
279 DECLARE_DYNAMIC_CLASS_NO_COPY(wxTextCtrl)
280
281 wxMenu* m_privateContextMenu;
282
283 bool m_isNativeCaretShown;
284
285 #if wxUSE_INKEDIT && wxUSE_RICHEDIT
286 int m_isInkEdit;
287 #endif
288
289 };
290
291 #endif // _WX_TEXTCTRL_H_