]>
git.saurik.com Git - wxWidgets.git/blob - include/wx/msw/textctrl.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/msw/textctrl.h
3 // Purpose: wxTextCtrl class
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_TEXTCTRL_H_
13 #define _WX_TEXTCTRL_H_
15 class WXDLLEXPORT wxTextCtrl
: public wxTextCtrlBase
21 wxTextCtrl() { Init(); }
22 wxTextCtrl(wxWindow
*parent
, wxWindowID id
,
23 const wxString
& value
= wxEmptyString
,
24 const wxPoint
& pos
= wxDefaultPosition
,
25 const wxSize
& size
= wxDefaultSize
,
27 const wxValidator
& validator
= wxDefaultValidator
,
28 const wxString
& name
= wxTextCtrlNameStr
)
32 Create(parent
, id
, value
, pos
, size
, style
, validator
, name
);
34 virtual ~wxTextCtrl();
36 bool Create(wxWindow
*parent
, wxWindowID id
,
37 const wxString
& value
= wxEmptyString
,
38 const wxPoint
& pos
= wxDefaultPosition
,
39 const wxSize
& size
= wxDefaultSize
,
41 const wxValidator
& validator
= wxDefaultValidator
,
42 const wxString
& name
= wxTextCtrlNameStr
);
44 // implement base class pure virtuals
45 // ----------------------------------
47 virtual wxString
GetValue() const;
48 virtual bool IsEmpty() const;
50 virtual wxString
GetRange(long from
, long to
) const;
52 virtual int GetLineLength(long lineNo
) const;
53 virtual wxString
GetLineText(long lineNo
) const;
54 virtual int GetNumberOfLines() const;
56 virtual bool IsModified() const;
57 virtual bool IsEditable() const;
59 virtual void GetSelection(long* from
, long* to
) const;
66 virtual void Replace(long from
, long to
, const wxString
& value
);
67 virtual void Remove(long from
, long to
);
69 // load the control's contents from the file
70 virtual bool DoLoadFile(const wxString
& file
, int fileType
);
72 // clears the dirty flag
73 virtual void MarkDirty();
74 virtual void DiscardEdits();
76 virtual void SetMaxLength(unsigned long len
);
78 // writing text inserts it at the current position, appending always
79 // inserts it at the end
80 virtual void WriteText(const wxString
& text
);
81 virtual void AppendText(const wxString
& text
);
84 virtual bool EmulateKeyPress(const wxKeyEvent
& event
);
88 // apply text attribute to the range of text (only works with richedit
90 virtual bool SetStyle(long start
, long end
, const wxTextAttr
& style
);
91 virtual bool SetDefaultStyle(const wxTextAttr
& style
);
92 virtual bool GetStyle(long position
, wxTextAttr
& style
);
93 #endif // wxUSE_RICHEDIT
95 // translate between the position (which is just an index in the text ctrl
96 // considering all its contents as a single strings) and (x, y) coordinates
97 // which represent column and line.
98 virtual long XYToPosition(long x
, long y
) const;
99 virtual bool PositionToXY(long pos
, long *x
, long *y
) const;
101 virtual void ShowPosition(long pos
);
102 virtual wxTextCtrlHitTestResult
HitTest(const wxPoint
& pt
, long *pos
) const;
103 virtual wxTextCtrlHitTestResult
HitTest(const wxPoint
& pt
,
105 wxTextCoord
*row
) const
107 return wxTextCtrlBase::HitTest(pt
, col
, row
);
110 // Clipboard operations
113 virtual void Paste();
115 virtual bool CanCopy() const;
116 virtual bool CanCut() const;
117 virtual bool CanPaste() const;
123 virtual bool CanUndo() const;
124 virtual bool CanRedo() const;
127 virtual void SetInsertionPoint(long pos
);
128 virtual void SetInsertionPointEnd();
129 virtual long GetInsertionPoint() const;
130 virtual wxTextPos
GetLastPosition() const;
132 virtual void SetSelection(long from
, long to
);
133 virtual void SetEditable(bool editable
);
135 // Caret handling (Windows only)
137 bool ShowNativeCaret(bool show
= true);
138 bool HideNativeCaret() { return ShowNativeCaret(false); }
140 // Implementation from now on
141 // --------------------------
143 virtual void SetWindowStyleFlag(long style
);
145 virtual void Command(wxCommandEvent
& event
);
146 virtual bool MSWCommand(WXUINT param
, WXWORD id
);
147 virtual WXHBRUSH
MSWControlColor(WXHDC hDC
, WXHWND hWnd
);
150 virtual bool MSWOnNotify(int idCtrl
, WXLPARAM lParam
, WXLPARAM
*result
);
152 int GetRichVersion() const { return m_verRichEdit
; }
153 bool IsRich() const { return m_verRichEdit
!= 0; }
155 // rich edit controls are not compatible with normal ones and wem ust set
156 // the colours for them otherwise
157 virtual bool SetBackgroundColour(const wxColour
& colour
);
158 virtual bool SetForegroundColour(const wxColour
& colour
);
159 #endif // wxUSE_RICHEDIT
161 #if wxUSE_INKEDIT && wxUSE_RICHEDIT
162 bool IsInkEdit() const { return m_isInkEdit
!= 0; }
164 bool IsInkEdit() const { return false; }
167 virtual void AdoptAttributesFromHWND();
169 virtual bool AcceptsFocus() const;
172 void OnDropFiles(wxDropFilesEvent
& event
);
173 void OnChar(wxKeyEvent
& event
); // Process 'enter' if required
175 void OnCut(wxCommandEvent
& event
);
176 void OnCopy(wxCommandEvent
& event
);
177 void OnPaste(wxCommandEvent
& event
);
178 void OnUndo(wxCommandEvent
& event
);
179 void OnRedo(wxCommandEvent
& event
);
180 void OnDelete(wxCommandEvent
& event
);
181 void OnSelectAll(wxCommandEvent
& event
);
183 void OnUpdateCut(wxUpdateUIEvent
& event
);
184 void OnUpdateCopy(wxUpdateUIEvent
& event
);
185 void OnUpdatePaste(wxUpdateUIEvent
& event
);
186 void OnUpdateUndo(wxUpdateUIEvent
& event
);
187 void OnUpdateRedo(wxUpdateUIEvent
& event
);
188 void OnUpdateDelete(wxUpdateUIEvent
& event
);
189 void OnUpdateSelectAll(wxUpdateUIEvent
& event
);
191 // Show a context menu for Rich Edit controls (the standard
192 // EDIT control has one already)
193 void OnContextMenu(wxContextMenuEvent
& event
);
195 // be sure the caret remains invisible if the user
196 // called HideNativeCaret() before
197 void OnSetFocus(wxFocusEvent
& event
);
199 // intercept WM_GETDLGCODE
200 virtual WXLRESULT
MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
);
202 virtual bool MSWShouldPreProcessMessage(WXMSG
* pMsg
);
203 virtual WXDWORD
MSWGetStyle(long style
, WXDWORD
*exstyle
) const;
204 virtual wxVisualAttributes
GetDefaultAttributes() const;
207 // common part of all ctors
210 virtual void DoSetValue(const wxString
&value
, int flags
= 0);
212 // return true if this control has a user-set limit on amount of text (i.e.
213 // the limit is due to a previous call to SetMaxLength() and not built in)
214 bool HasSpaceLimit(unsigned int *len
) const;
216 // call this to increase the size limit (will do nothing if the current
217 // limit is big enough)
219 // returns true if we increased the limit to allow entering more text,
220 // false if we hit the limit set by SetMaxLength() and so didn't change it
221 bool AdjustSpaceLimit();
223 #if wxUSE_RICHEDIT && (!wxUSE_UNICODE || wxUSE_UNICODE_MSLU)
224 // replace the selection or the entire control contents with the given text
225 // in the specified encoding
226 bool StreamIn(const wxString
& value
, wxFontEncoding encoding
, bool selOnly
);
228 // get the contents of the control out as text in the given encoding
229 wxString
StreamOut(wxFontEncoding encoding
, bool selOnly
= false) const;
230 #endif // wxUSE_RICHEDIT
232 // replace the contents of the selection or of the entire control with the
234 void DoWriteText(const wxString
& text
, int flags
= SetValue_SelectionOnly
);
236 // set the selection possibly without scrolling the caret into view
237 void DoSetSelection(long from
, long to
, bool scrollCaret
= true);
239 // return true if there is a non empty selection in the control
240 bool HasSelection() const;
242 // get the length of the line containing the character at the given
244 long GetLengthOfLineContainingPos(long pos
) const;
246 // send TEXT_UPDATED event, return true if it was handled, false otherwise
247 bool SendUpdateEvent();
249 virtual wxSize
DoGetBestSize() const;
252 // we're using RICHEDIT (and not simple EDIT) control if this field is not
253 // 0, it also gives the version of the RICHEDIT control being used (1, 2 or
256 #endif // wxUSE_RICHEDIT
258 // number of EN_UPDATE events sent by Windows when we change the controls
259 // text ourselves: we want this to be exactly 1
263 DECLARE_EVENT_TABLE()
264 DECLARE_DYNAMIC_CLASS_NO_COPY(wxTextCtrl
)
266 wxMenu
* m_privateContextMenu
;
268 bool m_isNativeCaretShown
;
270 #if wxUSE_INKEDIT && wxUSE_RICHEDIT