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 WXDLLIMPEXP_CORE 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 // overridden wxTextEntry methods
45 // ------------------------------
47 virtual wxString
GetValue() const;
48 virtual wxString
GetRange(long from
, long to
) const;
50 virtual bool IsEmpty() const;
52 virtual void WriteText(const wxString
& text
);
53 virtual void AppendText(const wxString
& text
);
56 virtual int GetLineLength(long lineNo
) const;
57 virtual wxString
GetLineText(long lineNo
) const;
58 virtual int GetNumberOfLines() const;
60 virtual void SetMaxLength(unsigned long len
);
62 virtual void GetSelection(long *from
, long *to
) const;
65 virtual bool CanRedo() const;
67 virtual void SetInsertionPointEnd();
68 virtual long GetInsertionPoint() const;
69 virtual wxTextPos
GetLastPosition() const;
71 // implement base class pure virtuals
72 // ----------------------------------
74 virtual bool IsModified() const;
75 virtual void MarkDirty();
76 virtual void DiscardEdits();
79 virtual bool EmulateKeyPress(const wxKeyEvent
& event
);
83 // apply text attribute to the range of text (only works with richedit
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
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;
96 virtual void ShowPosition(long pos
);
97 virtual wxTextCtrlHitTestResult
HitTest(const wxPoint
& pt
, long *pos
) const;
98 virtual wxTextCtrlHitTestResult
HitTest(const wxPoint
& pt
,
100 wxTextCoord
*row
) const
102 return wxTextCtrlBase::HitTest(pt
, col
, row
);
105 // Caret handling (Windows only)
106 bool ShowNativeCaret(bool show
= true);
107 bool HideNativeCaret() { return ShowNativeCaret(false); }
109 // Implementation from now on
110 // --------------------------
112 #if wxUSE_DRAG_AND_DROP && wxUSE_RICHEDIT
113 virtual void SetDropTarget(wxDropTarget
*dropTarget
);
114 #endif // wxUSE_DRAG_AND_DROP && wxUSE_RICHEDIT
116 virtual void SetWindowStyleFlag(long style
);
118 virtual void Command(wxCommandEvent
& event
);
119 virtual bool MSWCommand(WXUINT param
, WXWORD id
);
120 virtual WXHBRUSH
MSWControlColor(WXHDC hDC
, WXHWND hWnd
);
123 virtual bool MSWOnNotify(int idCtrl
, WXLPARAM lParam
, WXLPARAM
*result
);
125 int GetRichVersion() const { return m_verRichEdit
; }
126 bool IsRich() const { return m_verRichEdit
!= 0; }
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
);
134 bool IsRich() const { return false; }
135 #endif // wxUSE_RICHEDIT
137 #if wxUSE_INKEDIT && wxUSE_RICHEDIT
138 bool IsInkEdit() const { return m_isInkEdit
!= 0; }
140 bool IsInkEdit() const { return false; }
143 virtual void AdoptAttributesFromHWND();
145 virtual bool AcceptsFocusFromKeyboard() const;
147 // returns true if the platform should explicitly apply a theme border
148 virtual bool CanApplyThemeBorder() const;
151 void OnDropFiles(wxDropFilesEvent
& event
);
152 void OnChar(wxKeyEvent
& event
); // Process 'enter' if required
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
);
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
);
170 // Show a context menu for Rich Edit controls (the standard
171 // EDIT control has one already)
172 void OnContextMenu(wxContextMenuEvent
& event
);
174 // be sure the caret remains invisible if the user
175 // called HideNativeCaret() before
176 void OnSetFocus(wxFocusEvent
& event
);
178 // intercept WM_GETDLGCODE
179 virtual WXLRESULT
MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
);
181 virtual bool MSWShouldPreProcessMessage(WXMSG
* pMsg
);
182 virtual WXDWORD
MSWGetStyle(long style
, WXDWORD
*exstyle
) const;
185 // common part of all ctors
188 virtual bool DoLoadFile(const wxString
& file
, int fileType
);
190 // creates the control of appropriate class (plain or rich edit) with the
191 // styles corresponding to m_windowStyle
193 // this is used by ctor/Create() and when we need to recreate the control
195 bool MSWCreateText(const wxString
& value
,
199 virtual void DoSetValue(const wxString
&value
, int flags
= 0);
201 // return true if this control has a user-set limit on amount of text (i.e.
202 // the limit is due to a previous call to SetMaxLength() and not built in)
203 bool HasSpaceLimit(unsigned int *len
) const;
205 // call this to increase the size limit (will do nothing if the current
206 // limit is big enough)
208 // returns true if we increased the limit to allow entering more text,
209 // false if we hit the limit set by SetMaxLength() and so didn't change it
210 bool AdjustSpaceLimit();
212 #if wxUSE_RICHEDIT && (!wxUSE_UNICODE || wxUSE_UNICODE_MSLU)
213 // replace the selection or the entire control contents with the given text
214 // in the specified encoding
215 bool StreamIn(const wxString
& value
, wxFontEncoding encoding
, bool selOnly
);
217 // get the contents of the control out as text in the given encoding
218 wxString
StreamOut(wxFontEncoding encoding
, bool selOnly
= false) const;
219 #endif // wxUSE_RICHEDIT
221 // replace the contents of the selection or of the entire control with the
223 void DoWriteText(const wxString
& text
,
224 int flags
= SetValue_SendEvent
| SetValue_SelectionOnly
);
226 // set the selection (possibly without scrolling the caret into view)
227 void DoSetSelection(long from
, long to
, int flags
);
229 // get the length of the line containing the character at the given
231 long GetLengthOfLineContainingPos(long pos
) const;
233 // send TEXT_UPDATED event, return true if it was handled, false otherwise
234 bool SendUpdateEvent();
236 virtual wxSize
DoGetBestSize() const;
239 // we're using RICHEDIT (and not simple EDIT) control if this field is not
240 // 0, it also gives the version of the RICHEDIT control being used
241 // (although not directly: 1 is for 1.0, 2 is for either 2.0 or 3.0 as we
242 // can't nor really need to distinguish between them and 4 is for 4.1)
244 #endif // wxUSE_RICHEDIT
246 // number of EN_UPDATE events sent by Windows when we change the controls
247 // text ourselves: we want this to be exactly 1
251 virtual void EnableTextChangedEvents(bool enable
)
253 m_updatesCount
= enable
? -1 : -2;
256 // implement wxTextEntry pure virtual: it implements all the operations for
257 // the simple EDIT controls
258 virtual WXHWND
GetEditHWND() const { return m_hWnd
; }
260 void OnKeyDown(wxKeyEvent
& event
);
262 DECLARE_EVENT_TABLE()
263 DECLARE_DYNAMIC_CLASS_NO_COPY(wxTextCtrl
)
265 wxMenu
* m_privateContextMenu
;
267 bool m_isNativeCaretShown
;
269 #if wxUSE_INKEDIT && wxUSE_RICHEDIT
275 #endif // _WX_TEXTCTRL_H_