]> git.saurik.com Git - wxWidgets.git/blob - include/wx/msw/textctrl.h
Applied patch [ 597700 ] Fix proposal for wxJoystick under MSW
[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 #ifdef __GNUG__
16 #pragma interface "textctrl.h"
17 #endif
18
19 class WXDLLEXPORT wxTextCtrl : public wxTextCtrlBase
20 {
21 public:
22 // creation
23 // --------
24
25 wxTextCtrl() { Init(); }
26 wxTextCtrl(wxWindow *parent, wxWindowID id,
27 const wxString& value = wxEmptyString,
28 const wxPoint& pos = wxDefaultPosition,
29 const wxSize& size = wxDefaultSize,
30 long style = 0,
31 const wxValidator& validator = wxDefaultValidator,
32 const wxString& name = wxTextCtrlNameStr)
33 {
34 Init();
35
36 Create(parent, id, value, pos, size, style, validator, name);
37 }
38
39 bool Create(wxWindow *parent, wxWindowID id,
40 const wxString& value = wxEmptyString,
41 const wxPoint& pos = wxDefaultPosition,
42 const wxSize& size = wxDefaultSize,
43 long style = 0,
44 const wxValidator& validator = wxDefaultValidator,
45 const wxString& name = wxTextCtrlNameStr);
46
47 // implement base class pure virtuals
48 // ----------------------------------
49
50 virtual wxString GetValue() const;
51 virtual void SetValue(const wxString& value);
52
53 virtual wxString GetRange(long from, long to) const;
54
55 virtual int GetLineLength(long lineNo) const;
56 virtual wxString GetLineText(long lineNo) const;
57 virtual int GetNumberOfLines() const;
58
59 virtual bool IsModified() const;
60 virtual bool IsEditable() const;
61
62 virtual void GetSelection(long* from, long* to) const;
63
64 // operations
65 // ----------
66
67 // editing
68 virtual void Clear();
69 virtual void Replace(long from, long to, const wxString& value);
70 virtual void Remove(long from, long to);
71
72 // load the controls contents from the file
73 virtual bool LoadFile(const wxString& file);
74
75 // clears the dirty flag
76 virtual void DiscardEdits();
77
78 virtual void SetMaxLength(unsigned long len);
79
80 // writing text inserts it at the current position, appending always
81 // inserts it at the end
82 virtual void WriteText(const wxString& text);
83 virtual void AppendText(const wxString& text);
84
85 #ifdef __WIN32__
86 virtual bool EmulateKeyPress(const wxKeyEvent& event);
87 #endif // __WIN32__
88
89 #if wxUSE_RICHEDIT
90 // apply text attribute to the range of text (only works with richedit
91 // controls)
92 virtual bool SetStyle(long start, long end, const wxTextAttr& style);
93 virtual bool SetDefaultStyle(const wxTextAttr& style);
94 #endif // wxUSE_RICHEDIT
95
96 // translate between the position (which is just an index in the text ctrl
97 // considering all its contents as a single strings) and (x, y) coordinates
98 // which represent column and line.
99 virtual long XYToPosition(long x, long y) const;
100 virtual bool PositionToXY(long pos, long *x, long *y) const;
101
102 virtual void ShowPosition(long pos);
103
104 // Clipboard operations
105 virtual void Copy();
106 virtual void Cut();
107 virtual void Paste();
108
109 virtual bool CanCopy() const;
110 virtual bool CanCut() const;
111 virtual bool CanPaste() const;
112
113 // Undo/redo
114 virtual void Undo();
115 virtual void Redo();
116
117 virtual bool CanUndo() const;
118 virtual bool CanRedo() const;
119
120 // Insertion point
121 virtual void SetInsertionPoint(long pos);
122 virtual void SetInsertionPointEnd();
123 virtual long GetInsertionPoint() const;
124 virtual long GetLastPosition() const;
125
126 virtual void SetSelection(long from, long to);
127 virtual void SetEditable(bool editable);
128
129 // Implementation from now on
130 // --------------------------
131
132 virtual void SetWindowStyleFlag(long style);
133
134 virtual void Command(wxCommandEvent& event);
135 virtual bool MSWCommand(WXUINT param, WXWORD id);
136 virtual WXHBRUSH OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
137 WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
138
139 // In WIN16, need to override normal erasing because
140 // Ctl3D doesn't use the wxWindows background colour.
141 #ifdef __WIN16__
142 void OnEraseBackground(wxEraseEvent& event);
143 #endif
144
145 #if wxUSE_RICHEDIT
146 virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
147
148 int GetRichVersion() const { return m_verRichEdit; }
149 bool IsRich() const { return m_verRichEdit != 0; }
150
151 // rich edit controls are not compatible with normal ones and wem ust set
152 // the colours for them otherwise
153 virtual bool SetBackgroundColour(const wxColour& colour);
154 virtual bool SetForegroundColour(const wxColour& colour);
155 #endif // wxUSE_RICHEDIT
156
157 virtual void AdoptAttributesFromHWND();
158
159 virtual bool AcceptsFocus() const;
160
161 // callbacks
162 void OnDropFiles(wxDropFilesEvent& event);
163 void OnChar(wxKeyEvent& event); // Process 'enter' if required
164
165 void OnCut(wxCommandEvent& event);
166 void OnCopy(wxCommandEvent& event);
167 void OnPaste(wxCommandEvent& event);
168 void OnUndo(wxCommandEvent& event);
169 void OnRedo(wxCommandEvent& event);
170
171 void OnUpdateCut(wxUpdateUIEvent& event);
172 void OnUpdateCopy(wxUpdateUIEvent& event);
173 void OnUpdatePaste(wxUpdateUIEvent& event);
174 void OnUpdateUndo(wxUpdateUIEvent& event);
175 void OnUpdateRedo(wxUpdateUIEvent& event);
176
177 protected:
178 // common part of all ctors
179 void Init();
180
181 // intercept WM_GETDLGCODE
182 virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
183
184 // call this to increase the size limit (will do nothing if the current
185 // limit is big enough)
186 //
187 // returns true if we increased the limit to allow entering more text,
188 // false if we hit the limit set by SetMaxLength() and so didn't change it
189 bool AdjustSpaceLimit();
190
191 #if wxUSE_RICHEDIT
192 // replace the selection or the entire control contents with the given text
193 // in the specified encoding
194 bool StreamIn(const wxString& value,
195 wxFontEncoding encoding,
196 bool selOnly);
197 #endif // wxUSE_RICHEDIT
198
199 // replace the contents of the selection or of the entire control with the
200 // given text
201 void DoWriteText(const wxString& text, bool selectionOnly = TRUE);
202
203 // set the selection possibly without scrolling the caret into view
204 void DoSetSelection(long from, long to, bool scrollCaret = TRUE);
205
206 // get the length of the line containing the character at the given
207 // position
208 long GetLengthOfLineContainingPos(long pos) const;
209
210 // override some base class virtuals
211 virtual bool MSWShouldPreProcessMessage(WXMSG* pMsg);
212 virtual wxSize DoGetBestSize() const;
213
214 virtual WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
215
216 #if wxUSE_RICHEDIT
217 // we're using RICHEDIT (and not simple EDIT) control if this field is not
218 // 0, it also gives the version of the RICHEDIT control being used (1, 2 or
219 // 3 so far)
220 int m_verRichEdit;
221 #endif // wxUSE_RICHEDIT
222
223 private:
224 DECLARE_EVENT_TABLE()
225 DECLARE_DYNAMIC_CLASS(wxTextCtrl)
226 };
227
228 #endif
229 // _WX_TEXTCTRL_H_