]> git.saurik.com Git - wxWidgets.git/blame - include/wx/msw/textctrl.h
Added wchar handling for EMX (gcc on OS/2).
[wxWidgets.git] / include / wx / msw / textctrl.h
CommitLineData
2bda0e17 1/////////////////////////////////////////////////////////////////////////////
d7eee191 2// Name: wx/msw/textctrl.h
2bda0e17
KB
3// Purpose: wxTextCtrl class
4// Author: Julian Smart
5// Modified by:
6// Created: 01/02/97
7// RCS-ID: $Id$
bbcdf8bc 8// Copyright: (c) Julian Smart
5fb9fcfc 9// Licence: wxWindows licence
2bda0e17
KB
10/////////////////////////////////////////////////////////////////////////////
11
bbcdf8bc
JS
12#ifndef _WX_TEXTCTRL_H_
13#define _WX_TEXTCTRL_H_
2bda0e17
KB
14
15#ifdef __GNUG__
396bdd5a 16 #pragma interface "textctrl.h"
2bda0e17
KB
17#endif
18
a1b82138 19class WXDLLEXPORT wxTextCtrl : public wxTextCtrlBase
2bda0e17 20{
ae29de83 21public:
bfc6fde4
VZ
22 // creation
23 // --------
a1b82138 24
aac7e7fe 25 wxTextCtrl() { Init(); }
bfc6fde4 26 wxTextCtrl(wxWindow *parent, wxWindowID id,
a1b82138
VZ
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 {
aac7e7fe
VZ
34 Init();
35
a1b82138
VZ
36 Create(parent, id, value, pos, size, style, validator, name);
37 }
bfc6fde4
VZ
38
39 bool Create(wxWindow *parent, wxWindowID id,
a1b82138
VZ
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);
bfc6fde4 46
a1b82138
VZ
47 // implement base class pure virtuals
48 // ----------------------------------
4438caf4
VZ
49
50 virtual wxString GetValue() const;
bfc6fde4
VZ
51 virtual void SetValue(const wxString& value);
52
a5aa8086
VZ
53 virtual wxString GetRange(long from, long to) const;
54
bfc6fde4
VZ
55 virtual int GetLineLength(long lineNo) const;
56 virtual wxString GetLineText(long lineNo) const;
57 virtual int GetNumberOfLines() const;
58
a1b82138
VZ
59 virtual bool IsModified() const;
60 virtual bool IsEditable() const;
61
a1b82138
VZ
62 virtual void GetSelection(long* from, long* to) const;
63
bfc6fde4
VZ
64 // operations
65 // ----------
66
a1b82138
VZ
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
d7eee191
VZ
78 virtual void SetMaxLength(unsigned long len);
79
a1b82138
VZ
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
4bc1afd5
VZ
85#if wxUSE_RICHEDIT
86 // apply text attribute to the range of text (only works with richedit
87 // controls)
88 virtual bool SetStyle(long start, long end, const wxTextAttr& style);
89#endif // wxUSE_RICHEDIT
90
a1b82138
VZ
91 // translate between the position (which is just an index in the text ctrl
92 // considering all its contents as a single strings) and (x, y) coordinates
93 // which represent column and line.
94 virtual long XYToPosition(long x, long y) const;
0efe5ba7 95 virtual bool PositionToXY(long pos, long *x, long *y) const;
a1b82138
VZ
96
97 virtual void ShowPosition(long pos);
98
bfc6fde4
VZ
99 // Clipboard operations
100 virtual void Copy();
101 virtual void Cut();
102 virtual void Paste();
103
ca8b28f2
JS
104 virtual bool CanCopy() const;
105 virtual bool CanCut() const;
106 virtual bool CanPaste() const;
107
108 // Undo/redo
109 virtual void Undo();
110 virtual void Redo();
111
112 virtual bool CanUndo() const;
113 virtual bool CanRedo() const;
114
a1b82138 115 // Insertion point
bfc6fde4
VZ
116 virtual void SetInsertionPoint(long pos);
117 virtual void SetInsertionPointEnd();
a1b82138
VZ
118 virtual long GetInsertionPoint() const;
119 virtual long GetLastPosition() const;
120
bfc6fde4
VZ
121 virtual void SetSelection(long from, long to);
122 virtual void SetEditable(bool editable);
123
4438caf4
VZ
124 // Implementation from now on
125 // --------------------------
e702ff0f 126
bfc6fde4
VZ
127 virtual void Command(wxCommandEvent& event);
128 virtual bool MSWCommand(WXUINT param, WXWORD id);
f6bcfd97
BP
129 virtual WXHBRUSH OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
130 WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
131
132 // In WIN16, need to override normal erasing because
133 // Ctl3D doesn't use the wxWindows background colour.
134#ifdef __WIN16__
135 void OnEraseBackground(wxEraseEvent& event);
136#endif
396bdd5a
VZ
137
138#if wxUSE_RICHEDIT
c57e3339
VZ
139 virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
140
aac7e7fe
VZ
141 int GetRichVersion() const { return m_verRichEdit; }
142 bool IsRich() const { return m_verRichEdit != 0; }
f6bcfd97
BP
143
144 // rich edit controls are not compatible with normal ones and wem ust set
145 // the colours for them otherwise
146 virtual bool SetBackgroundColour(const wxColour& colour);
147 virtual bool SetForegroundColour(const wxColour& colour);
a1b82138 148#endif // wxUSE_RICHEDIT
396bdd5a 149
bfc6fde4 150 virtual void AdoptAttributesFromHWND();
5fb9fcfc 151
c50f1fb9
VZ
152 virtual bool AcceptsFocus() const;
153
4438caf4 154 // callbacks
4438caf4
VZ
155 void OnDropFiles(wxDropFilesEvent& event);
156 void OnChar(wxKeyEvent& event); // Process 'enter' if required
157
158 void OnCut(wxCommandEvent& event);
159 void OnCopy(wxCommandEvent& event);
160 void OnPaste(wxCommandEvent& event);
161 void OnUndo(wxCommandEvent& event);
162 void OnRedo(wxCommandEvent& event);
163
164 void OnUpdateCut(wxUpdateUIEvent& event);
165 void OnUpdateCopy(wxUpdateUIEvent& event);
166 void OnUpdatePaste(wxUpdateUIEvent& event);
167 void OnUpdateUndo(wxUpdateUIEvent& event);
168 void OnUpdateRedo(wxUpdateUIEvent& event);
169
2bda0e17 170protected:
aac7e7fe
VZ
171 // common part of all ctors
172 void Init();
173
789295bf
VZ
174 // call this to increase the size limit (will do nothing if the current
175 // limit is big enough)
d7eee191
VZ
176 //
177 // returns true if we increased the limit to allow entering more text,
178 // false if we hit the limit set by SetMaxLength() and so didn't change it
179 bool AdjustSpaceLimit();
789295bf 180
aac7e7fe 181#if wxUSE_RICHEDIT
79d26b32
VZ
182 // replace the selection or the entire control contents with the given text
183 // in the specified encoding
184 bool StreamIn(const wxString& value,
185 wxFontEncoding encoding,
186 bool selOnly);
aac7e7fe
VZ
187#endif // wxUSE_RICHEDIT
188
79d26b32
VZ
189 // replace the contents of the selection or of the entire control with the
190 // given text
191 void DoWriteText(const wxString& text, bool selectionOnly = TRUE);
192
aac7e7fe
VZ
193 // set the selection possibly without scrolling the caret into view
194 void DoSetSelection(long from, long to, bool scrollCaret = TRUE);
195
a5aa8086
VZ
196 // get the length of the line containing the character at the given
197 // position
198 long GetLengthOfLineContainingPos(long pos) const;
199
a37d422a
VZ
200 // override some base class virtuals
201 virtual bool MSWShouldPreProcessMessage(WXMSG* pMsg);
f68586e5 202 virtual wxSize DoGetBestSize() const;
bfc6fde4 203
d7eee191 204#if wxUSE_RICHEDIT
aac7e7fe
VZ
205 // we're using RICHEDIT (and not simple EDIT) control if this field is not
206 // 0, it also gives the version of the RICHEDIT control being used (1, 2 or
207 // 3 so far)
208 int m_verRichEdit;
209#endif // wxUSE_RICHEDIT
d7eee191 210
bfc6fde4
VZ
211private:
212 DECLARE_EVENT_TABLE()
a1b82138 213 DECLARE_DYNAMIC_CLASS(wxTextCtrl)
2bda0e17
KB
214};
215
216#endif
bbcdf8bc 217 // _WX_TEXTCTRL_H_