1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/univ/textctrl.h
3 // Purpose: wxTextCtrl class
4 // Author: Vadim Zeitlin
8 // Copyright: (c) 2000 SciTech Software, Inc. (www.scitechsoft.com)
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_UNIV_TEXTCTRL_H_
13 #define _WX_UNIV_TEXTCTRL_H_
15 class WXDLLIMPEXP_FWD_CORE wxCaret
;
16 class WXDLLIMPEXP_FWD_CORE wxTextCtrlCommandProcessor
;
18 #include "wx/scrolwin.h" // for wxScrollHelper
20 #include "wx/univ/inphand.h"
22 // ----------------------------------------------------------------------------
24 // ----------------------------------------------------------------------------
26 // cursor movement and also selection and delete operations
27 #define wxACTION_TEXT_GOTO wxT("goto") // to pos in numArg
28 #define wxACTION_TEXT_FIRST wxT("first") // go to pos 0
29 #define wxACTION_TEXT_LAST wxT("last") // go to last pos
30 #define wxACTION_TEXT_HOME wxT("home")
31 #define wxACTION_TEXT_END wxT("end")
32 #define wxACTION_TEXT_LEFT wxT("left")
33 #define wxACTION_TEXT_RIGHT wxT("right")
34 #define wxACTION_TEXT_UP wxT("up")
35 #define wxACTION_TEXT_DOWN wxT("down")
36 #define wxACTION_TEXT_WORD_LEFT wxT("wordleft")
37 #define wxACTION_TEXT_WORD_RIGHT wxT("wordright")
38 #define wxACTION_TEXT_PAGE_UP wxT("pageup")
39 #define wxACTION_TEXT_PAGE_DOWN wxT("pagedown")
41 // clipboard operations
42 #define wxACTION_TEXT_COPY wxT("copy")
43 #define wxACTION_TEXT_CUT wxT("cut")
44 #define wxACTION_TEXT_PASTE wxT("paste")
46 // insert text at the cursor position: the text is in strArg of PerformAction
47 #define wxACTION_TEXT_INSERT wxT("insert")
49 // if the action starts with either of these prefixes and the rest of the
50 // string is one of the movement commands, it means to select/delete text from
51 // the current cursor position to the new one
52 #define wxACTION_TEXT_PREFIX_SEL wxT("sel")
53 #define wxACTION_TEXT_PREFIX_DEL wxT("del")
56 #define wxACTION_TEXT_ANCHOR_SEL wxT("anchorsel")
57 #define wxACTION_TEXT_EXTEND_SEL wxT("extendsel")
58 #define wxACTION_TEXT_SEL_WORD wxT("wordsel")
59 #define wxACTION_TEXT_SEL_LINE wxT("linesel")
62 #define wxACTION_TEXT_UNDO wxT("undo")
63 #define wxACTION_TEXT_REDO wxT("redo")
65 // ----------------------------------------------------------------------------
67 // ----------------------------------------------------------------------------
69 class WXDLLIMPEXP_CORE wxTextCtrl
: public wxTextCtrlBase
,
76 wxTextCtrl() : wxScrollHelper(this) { Init(); }
78 wxTextCtrl(wxWindow
*parent
,
80 const wxString
& value
= wxEmptyString
,
81 const wxPoint
& pos
= wxDefaultPosition
,
82 const wxSize
& size
= wxDefaultSize
,
84 const wxValidator
& validator
= wxDefaultValidator
,
85 const wxString
& name
= wxTextCtrlNameStr
)
86 : wxScrollHelper(this)
90 Create(parent
, id
, value
, pos
, size
, style
, validator
, name
);
93 bool Create(wxWindow
*parent
,
95 const wxString
& value
= wxEmptyString
,
96 const wxPoint
& pos
= wxDefaultPosition
,
97 const wxSize
& size
= wxDefaultSize
,
99 const wxValidator
& validator
= wxDefaultValidator
,
100 const wxString
& name
= wxTextCtrlNameStr
);
102 virtual ~wxTextCtrl() wxNOEXCEPT
;
104 // implement base class pure virtuals
105 // ----------------------------------
107 virtual int GetLineLength(wxTextCoord lineNo
) const;
108 virtual wxString
GetLineText(wxTextCoord lineNo
) const;
109 virtual int GetNumberOfLines() const;
111 virtual bool IsModified() const;
112 virtual bool IsEditable() const;
114 // If the return values from and to are the same, there is no selection.
115 virtual void GetSelection(wxTextPos
* from
, wxTextPos
* to
) const;
121 virtual void Clear();
122 virtual void Replace(wxTextPos from
, wxTextPos to
, const wxString
& value
);
123 virtual void Remove(wxTextPos from
, wxTextPos to
);
125 // sets/clears the dirty flag
126 virtual void MarkDirty();
127 virtual void DiscardEdits();
129 // writing text inserts it at the current position, appending always
130 // inserts it at the end
131 virtual void WriteText(const wxString
& text
);
132 virtual void AppendText(const wxString
& text
);
134 // translate between the position (which is just an index in the text ctrl
135 // considering all its contents as a single strings) and (x, y) coordinates
136 // which represent (logical, i.e. unwrapped) column and line.
137 virtual wxTextPos
XYToPosition(wxTextCoord x
, wxTextCoord y
) const;
138 virtual bool PositionToXY(wxTextPos pos
,
139 wxTextCoord
*x
, wxTextCoord
*y
) const;
141 // wxUniv-specific: find a screen position (in client coordinates) of the
142 // given text position or of the caret
143 bool PositionToLogicalXY(wxTextPos pos
, wxCoord
*x
, wxCoord
*y
) const;
144 bool PositionToDeviceXY(wxTextPos pos
, wxCoord
*x
, wxCoord
*y
) const;
145 wxPoint
GetCaretPosition() const;
147 virtual void ShowPosition(wxTextPos pos
);
149 // Clipboard operations
152 virtual void Paste();
158 virtual bool CanUndo() const;
159 virtual bool CanRedo() const;
162 virtual void SetInsertionPoint(wxTextPos pos
);
163 virtual void SetInsertionPointEnd();
164 virtual wxTextPos
GetInsertionPoint() const;
165 virtual wxTextPos
GetLastPosition() const;
167 virtual void SetSelection(wxTextPos from
, wxTextPos to
);
168 virtual void SetEditable(bool editable
);
170 // wxUniv-specific methods
171 // -----------------------
174 virtual void ShowCaret(bool show
= true);
175 void HideCaret() { ShowCaret(false); }
176 void CreateCaret(); // for the current font size
178 // helpers for cursor movement
179 wxTextPos
GetWordStart() const;
180 wxTextPos
GetWordEnd() const;
183 bool HasSelection() const
184 { return m_selStart
!= -1 && m_selEnd
> m_selStart
; }
185 void ClearSelection();
186 void RemoveSelection();
187 wxString
GetSelectionText() const;
189 virtual wxTextCtrlHitTestResult
HitTest(const wxPoint
& pt
, long *pos
) const;
190 virtual wxTextCtrlHitTestResult
HitTest(const wxPoint
& pt
,
192 wxTextCoord
*row
) const;
194 // find the character at this position in the given line, return value as
197 // NB: x is the logical coord (client and unscrolled)
198 wxTextCtrlHitTestResult
HitTestLine(const wxString
& line
,
200 wxTextCoord
*colOut
) const;
202 // bring the given position into view
203 void ShowHorzPosition(wxCoord pos
);
205 // scroll the window horizontally so that the first character shown is in
207 void ScrollText(wxTextCoord col
);
209 // adjust the DC for horz text control scrolling too
210 virtual void DoPrepareDC(wxDC
& dc
);
212 // implementation only from now on
213 // -------------------------------
215 // override this to take into account our scrollbar-less scrolling
216 virtual void CalcUnscrolledPosition(int x
, int y
, int *xx
, int *yy
) const;
217 virtual void CalcScrolledPosition(int x
, int y
, int *xx
, int *yy
) const;
220 virtual bool PerformAction(const wxControlAction
& action
,
222 const wxString
& strArg
= wxEmptyString
);
224 static wxInputHandler
*GetStdInputHandler(wxInputHandler
*handlerDef
);
225 virtual wxInputHandler
*DoGetStdInputHandler(wxInputHandler
*handlerDef
)
227 return GetStdInputHandler(handlerDef
);
230 // override these methods to handle the caret
231 virtual bool SetFont(const wxFont
&font
);
232 virtual bool Enable(bool enable
= true);
234 // more readable flag testing methods
235 bool IsPassword() const { return HasFlag(wxTE_PASSWORD
); }
236 bool WrapLines() const { return m_wrapLines
; }
238 // only for wxStdTextCtrlInputHandler
239 void RefreshSelection();
241 // override wxScrollHelper method to prevent (auto)scrolling beyond the end
243 virtual bool SendAutoScrollEvents(wxScrollWinEvent
& event
) const;
246 virtual void OnInternalIdle();
249 // ensure we have correct default border
250 virtual wxBorder
GetDefaultBorder() const { return wxBORDER_SUNKEN
; }
252 // override base class methods
253 virtual void DoDrawBorder(wxDC
& dc
, const wxRect
& rect
);
254 virtual void DoDraw(wxControlRenderer
*renderer
);
256 // calc the size from the text extent
257 virtual wxSize
DoGetBestClientSize() const;
259 // implements Set/ChangeValue()
260 virtual void DoSetValue(const wxString
& value
, int flags
= 0);
261 virtual wxString
DoGetValue() const;
263 // common part of all ctors
269 // draw the text in the given rectangle
270 void DoDrawTextInRect(wxDC
& dc
, const wxRect
& rectUpdate
);
272 // draw the line wrap marks in this rect
273 void DoDrawLineWrapMarks(wxDC
& dc
, const wxRect
& rectUpdate
);
275 // line/row geometry calculations
276 // ------------------------------
278 // get the extent (width) of the text
279 wxCoord
GetTextWidth(const wxString
& text
) const;
281 // get the logical text width (accounting for scrolling)
282 wxCoord
GetTotalWidth() const;
284 // get total number of rows (different from number of lines if the lines
286 wxTextCoord
GetRowCount() const;
288 // find the number of rows in this line (only if WrapLines())
289 wxTextCoord
GetRowsPerLine(wxTextCoord line
) const;
291 // get the starting row of the given line
292 wxTextCoord
GetFirstRowOfLine(wxTextCoord line
) const;
294 // get the row following this line
295 wxTextCoord
GetRowAfterLine(wxTextCoord line
) const;
300 // the text area is the part of the window in which the text can be
301 // displayed, i.e. part of it inside the margins and the real text area is
302 // the area in which the text *is* currently displayed: for example, in the
303 // multiline control case the text area can have extra space at the bottom
304 // which is not tall enough for another line and which is then not included
305 // into the real text area
306 wxRect
GetRealTextArea() const;
308 // refresh the text in the given (in logical coords) rect
309 void RefreshTextRect(const wxRect
& rect
, bool textOnly
= true);
311 // refresh the line wrap marks for the given range of lines (inclusive)
312 void RefreshLineWrapMarks(wxTextCoord rowFirst
, wxTextCoord rowLast
);
314 // refresh the text in the given range (in logical coords) of this line, if
315 // width is 0, refresh to the end of line
316 void RefreshPixelRange(wxTextCoord line
, wxCoord start
, wxCoord width
);
318 // refresh the text in the given range (in text coords) in this line
319 void RefreshColRange(wxTextCoord line
, wxTextPos start
, size_t count
);
321 // refresh the text from in the given line range (inclusive)
322 void RefreshLineRange(wxTextCoord lineFirst
, wxTextCoord lineLast
);
324 // refresh the text in the given range which can span multiple lines
325 // (this method accepts arguments in any order)
326 void RefreshTextRange(wxTextPos start
, wxTextPos end
);
328 // get the text to show: either the text itself or the text replaced with
329 // starts for wxTE_PASSWORD control
330 wxString
GetTextToShow(const wxString
& text
) const;
332 // find the row in this line where the given position (counted from the
334 wxTextCoord
GetRowInLine(wxTextCoord line
,
336 wxTextCoord
*colRowStart
= NULL
) const;
338 // find the number of characters of a line before it wraps
339 // (and optionally also the real width of the line)
340 size_t GetPartOfWrappedLine(const wxChar
* text
,
341 wxCoord
*widthReal
= NULL
) const;
343 // get the start and end of the selection for this line: if the line is
344 // outside the selection, both will be -1 and false will be returned
345 bool GetSelectedPartOfLine(wxTextCoord line
,
346 wxTextPos
*start
, wxTextPos
*end
) const;
348 // update the text rect: the zone inside our client rect (its coords are
349 // client coords) which contains the text
350 void UpdateTextRect();
352 // calculate the last visible position
353 void UpdateLastVisible();
355 // move caret to the given position unconditionally
356 // (SetInsertionPoint() does nothing if the position didn't change)
357 void DoSetInsertionPoint(wxTextPos pos
);
359 // move caret to the new position without updating the display (for
360 // internal use only)
361 void MoveInsertionPoint(wxTextPos pos
);
363 // set the caret to its initial (default) position
364 void InitInsertionPoint();
366 // get the width of the longest line in pixels
367 wxCoord
GetMaxWidth() const;
369 // force recalculation of the max line width
370 void RecalcMaxWidth();
372 // update the max width after the given line was modified
373 void UpdateMaxWidth(wxTextCoord line
);
378 // HitTest2() is more efficient than 2 consecutive HitTest()s with the same
379 // line (i.e. y) and it also returns the offset of the starting position in
382 // as the last hack, this function accepts either logical or device (by
383 // default) coords depending on devCoords flag
384 wxTextCtrlHitTestResult
HitTest2(wxCoord y
,
388 wxTextCoord
*colStart
,
390 wxTextCoord
*colRowStart
,
391 bool devCoords
= true) const;
393 // HitTest() version which takes the logical text coordinates and not the
395 wxTextCtrlHitTestResult
HitTestLogical(const wxPoint
& pos
,
397 wxTextCoord
*row
) const;
399 // get the line and the row in this line corresponding to the given row,
400 // return true if ok and false if row is out of range
402 // NB: this function can only be called for controls which wrap lines
403 bool GetLineAndRow(wxTextCoord row
,
405 wxTextCoord
*rowInLine
) const;
407 // get the height of one line (the same for all lines)
408 wxCoord
GetLineHeight() const
410 // this one should be already precalculated
411 wxASSERT_MSG( m_heightLine
!= -1, wxT("should have line height") );
416 // get the average char width
417 wxCoord
GetAverageWidth() const { return m_widthAvg
; }
419 // recalc the line height and char width (to call when the font changes)
420 void RecalcFontMetrics();
422 // vertical scrolling helpers
423 // --------------------------
425 // all these functions are for multi line controls only
427 // get the number of visible lines
428 size_t GetLinesPerPage() const;
430 // return the position above the cursor or INVALID_POS_VALUE
431 wxTextPos
GetPositionAbove();
433 // return the position below the cursor or INVALID_POS_VALUE
434 wxTextPos
GetPositionBelow();
438 void OnChar(wxKeyEvent
& event
);
439 void OnSize(wxSizeEvent
& event
);
441 // return the struct containing control-type dependent data
442 struct wxTextSingleLineData
& SData() { return *m_data
.sdata
; }
443 struct wxTextMultiLineData
& MData() { return *m_data
.mdata
; }
444 struct wxTextWrappedData
& WData() { return *m_data
.wdata
; }
445 const wxTextSingleLineData
& SData() const { return *m_data
.sdata
; }
446 const wxTextMultiLineData
& MData() const { return *m_data
.mdata
; }
447 const wxTextWrappedData
& WData() const { return *m_data
.wdata
; }
449 // clipboard operations (unlike the versions without Do prefix, they have a
455 // all these methods are for multiline text controls only
457 // update the scrollbars (only called from OnIdle)
458 void UpdateScrollbars();
460 // get read only access to the lines of multiline control
461 inline const wxArrayString
& GetLines() const;
462 inline size_t GetLineCount() const;
464 // replace a line (returns true if the number of rows in thel ine changed)
465 bool ReplaceLine(wxTextCoord line
, const wxString
& text
);
468 void RemoveLine(wxTextCoord line
);
470 // insert a line at this position
471 void InsertLine(wxTextCoord line
, const wxString
& text
);
473 // calculate geometry of this line
474 void LayoutLine(wxTextCoord line
, class wxWrappedLineData
& lineData
) const;
476 // calculate geometry of all lines until the given one
477 void LayoutLines(wxTextCoord lineLast
) const;
479 // the initially specified control size
480 wxSize m_sizeInitial
;
482 // the global control text
487 wxTextCoord m_curCol
,
490 // last position (only used by GetLastPosition())
494 wxTextPos m_selAnchor
,
502 m_wrapLines
:1; // can't be changed after creation
504 // the rectangle (in client coordinates) to draw text inside
507 // the height of one line (cached value of GetCharHeight)
508 wxCoord m_heightLine
;
510 // and the average char width (cached value of GetCharWidth)
513 // we have some data which depends on the kind of control (single or multi
517 wxTextSingleLineData
*sdata
;
518 wxTextMultiLineData
*mdata
;
519 wxTextWrappedData
*wdata
;
523 // the object to which we delegate our undo/redo implementation
524 wxTextCtrlCommandProcessor
*m_cmdProcessor
;
526 DECLARE_EVENT_TABLE()
527 DECLARE_DYNAMIC_CLASS(wxTextCtrl
)
529 friend class wxWrappedLineData
;
532 #endif // _WX_UNIV_TEXTCTRL_H_