]>
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_
16 #pragma interface "textctrl.h"
19 class WXDLLEXPORT wxTextCtrl
: public wxTextCtrlBase
25 wxTextCtrl() { Init(); }
26 wxTextCtrl(wxWindow
*parent
, wxWindowID id
,
27 const wxString
& value
= wxEmptyString
,
28 const wxPoint
& pos
= wxDefaultPosition
,
29 const wxSize
& size
= wxDefaultSize
,
31 const wxValidator
& validator
= wxDefaultValidator
,
32 const wxString
& name
= wxTextCtrlNameStr
)
36 Create(parent
, id
, value
, pos
, size
, style
, validator
, name
);
39 bool Create(wxWindow
*parent
, wxWindowID id
,
40 const wxString
& value
= wxEmptyString
,
41 const wxPoint
& pos
= wxDefaultPosition
,
42 const wxSize
& size
= wxDefaultSize
,
44 const wxValidator
& validator
= wxDefaultValidator
,
45 const wxString
& name
= wxTextCtrlNameStr
);
47 // implement base class pure virtuals
48 // ----------------------------------
50 virtual wxString
GetValue() const;
51 virtual void SetValue(const wxString
& value
);
53 virtual wxString
GetRange(long from
, long to
) const;
55 virtual int GetLineLength(long lineNo
) const;
56 virtual wxString
GetLineText(long lineNo
) const;
57 virtual int GetNumberOfLines() const;
59 virtual bool IsModified() const;
60 virtual bool IsEditable() const;
62 virtual void GetSelection(long* from
, long* to
) const;
69 virtual void Replace(long from
, long to
, const wxString
& value
);
70 virtual void Remove(long from
, long to
);
72 // load the controls contents from the file
73 virtual bool LoadFile(const wxString
& file
);
75 // clears the dirty flag
76 virtual void DiscardEdits();
78 virtual void SetMaxLength(unsigned long len
);
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
);
86 // apply text attribute to the range of text (only works with richedit
88 virtual bool SetStyle(long start
, long end
, const wxTextAttr
& style
);
89 #endif // wxUSE_RICHEDIT
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;
95 virtual bool PositionToXY(long pos
, long *x
, long *y
) const;
97 virtual void ShowPosition(long pos
);
99 // Clipboard operations
102 virtual void Paste();
104 virtual bool CanCopy() const;
105 virtual bool CanCut() const;
106 virtual bool CanPaste() const;
112 virtual bool CanUndo() const;
113 virtual bool CanRedo() const;
116 virtual void SetInsertionPoint(long pos
);
117 virtual void SetInsertionPointEnd();
118 virtual long GetInsertionPoint() const;
119 virtual long GetLastPosition() const;
121 virtual void SetSelection(long from
, long to
);
122 virtual void SetEditable(bool editable
);
124 // Implementation from now on
125 // --------------------------
127 virtual void Command(wxCommandEvent
& event
);
128 virtual bool MSWCommand(WXUINT param
, WXWORD id
);
129 virtual WXHBRUSH
OnCtlColor(WXHDC pDC
, WXHWND pWnd
, WXUINT nCtlColor
,
130 WXUINT message
, WXWPARAM wParam
, WXLPARAM lParam
);
132 // In WIN16, need to override normal erasing because
133 // Ctl3D doesn't use the wxWindows background colour.
135 void OnEraseBackground(wxEraseEvent
& event
);
139 virtual bool MSWOnNotify(int idCtrl
, WXLPARAM lParam
, WXLPARAM
*result
);
141 int GetRichVersion() const { return m_verRichEdit
; }
142 bool IsRich() const { return m_verRichEdit
!= 0; }
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
);
148 #endif // wxUSE_RICHEDIT
150 virtual void AdoptAttributesFromHWND();
152 virtual bool AcceptsFocus() const;
155 void OnDropFiles(wxDropFilesEvent
& event
);
156 void OnChar(wxKeyEvent
& event
); // Process 'enter' if required
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
);
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
);
171 // common part of all ctors
174 // call this to increase the size limit (will do nothing if the current
175 // limit is big enough)
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();
182 // replace the selection with the given text in the specified encoding
183 bool StreamIn(const wxString
& value
, wxFontEncoding encoding
);
184 #endif // wxUSE_RICHEDIT
186 // set the selection possibly without scrolling the caret into view
187 void DoSetSelection(long from
, long to
, bool scrollCaret
= TRUE
);
189 // get the length of the line containing the character at the given
191 long GetLengthOfLineContainingPos(long pos
) const;
193 // override some base class virtuals
194 virtual bool MSWShouldPreProcessMessage(WXMSG
* pMsg
);
195 virtual wxSize
DoGetBestSize() const;
198 // we're using RICHEDIT (and not simple EDIT) control if this field is not
199 // 0, it also gives the version of the RICHEDIT control being used (1, 2 or
202 #endif // wxUSE_RICHEDIT
205 DECLARE_EVENT_TABLE()
206 DECLARE_DYNAMIC_CLASS(wxTextCtrl
)