include/wx/univ/textctrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/univ/textctrl.h
   3 // Purpose:     wxTextCtrl class
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     15.09.00
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2000 SciTech Software, Inc. (www.scitechsoft.com)
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_UNIV_TEXTCTRL_H_
  13 #define _WX_UNIV_TEXTCTRL_H_
  14
  15 class WXDLLEXPORT wxCaret;
  16 class WXDLLEXPORT wxTextCtrlCommandProcessor;
  17
  18 #include "wx/scrolwin.h"    // for wxScrollHelper
  19
  20 #include "wx/univ/inphand.h"
  21
  22 // ----------------------------------------------------------------------------
  23 // wxTextCtrl actions
  24 // ----------------------------------------------------------------------------
  25
  26 // cursor movement and also selection and delete operations
  27 #define wxACTION_TEXT_GOTO          _T("goto")  // to pos in numArg
  28 #define wxACTION_TEXT_FIRST         _T("first") // go to pos 0
  29 #define wxACTION_TEXT_LAST          _T("last")  // go to last pos
  30 #define wxACTION_TEXT_HOME          _T("home")
  31 #define wxACTION_TEXT_END           _T("end")
  32 #define wxACTION_TEXT_LEFT          _T("left")
  33 #define wxACTION_TEXT_RIGHT         _T("right")
  34 #define wxACTION_TEXT_UP            _T("up")
  35 #define wxACTION_TEXT_DOWN          _T("down")
  36 #define wxACTION_TEXT_WORD_LEFT     _T("wordleft")
  37 #define wxACTION_TEXT_WORD_RIGHT    _T("wordright")
  38 #define wxACTION_TEXT_PAGE_UP       _T("pageup")
  39 #define wxACTION_TEXT_PAGE_DOWN     _T("pagedown")
  40
  41 // clipboard operations
  42 #define wxACTION_TEXT_COPY          _T("copy")
  43 #define wxACTION_TEXT_CUT           _T("cut")
  44 #define wxACTION_TEXT_PASTE         _T("paste")
  45
  46 // insert text at the cursor position: the text is in strArg of PerformAction
  47 #define wxACTION_TEXT_INSERT        _T("insert")
  48
  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    _T("sel")
  53 #define wxACTION_TEXT_PREFIX_DEL    _T("del")
  54
  55 // mouse selection
  56 #define wxACTION_TEXT_ANCHOR_SEL    _T("anchorsel")
  57 #define wxACTION_TEXT_EXTEND_SEL    _T("extendsel")
  58 #define wxACTION_TEXT_SEL_WORD      _T("wordsel")
  59 #define wxACTION_TEXT_SEL_LINE      _T("linesel")
  60
  61 // undo or redo
  62 #define wxACTION_TEXT_UNDO          _T("undo")
  63 #define wxACTION_TEXT_REDO          _T("redo")
  64
  65 // ----------------------------------------------------------------------------
  66 // wxTextCtrl
  67 // ----------------------------------------------------------------------------
  68
  69 class WXDLLEXPORT wxTextCtrl : public wxTextCtrlBase,
  70                                public wxScrollHelper
  71 {
  72 public:
  73     // creation
  74     // --------
  75
  76     wxTextCtrl() : wxScrollHelper(this) { Init(); }
  77
  78     wxTextCtrl(wxWindow *parent,
  79                wxWindowID id,
  80                const wxString& value = wxEmptyString,
  81                const wxPoint& pos = wxDefaultPosition,
  82                const wxSize& size = wxDefaultSize,
  83                long style = 0,
  84                const wxValidator& validator = wxDefaultValidator,
  85                const wxString& name = wxTextCtrlNameStr)
  86         : wxScrollHelper(this)
  87     {
  88         Init();
  89
  90         Create(parent, id, value, pos, size, style, validator, name);
  91     }
  92
  93     bool Create(wxWindow *parent,
  94                 wxWindowID id,
  95                 const wxString& value = wxEmptyString,
  96                 const wxPoint& pos = wxDefaultPosition,
  97                 const wxSize& size = wxDefaultSize,
  98                 long style = 0,
  99                 const wxValidator& validator = wxDefaultValidator,
 100                 const wxString& name = wxTextCtrlNameStr);
 101
 102     virtual ~wxTextCtrl();
 103
 104     // implement base class pure virtuals
 105     // ----------------------------------
 106
 107     virtual wxString GetValue() const;
 108     virtual void SetValue(const wxString& value);
 109
 110     virtual void ChangeValue(const wxString &value);
 111
 112     virtual int GetLineLength(wxTextCoord lineNo) const;
 113     virtual wxString GetLineText(wxTextCoord lineNo) const;
 114     virtual int GetNumberOfLines() const;
 115
 116     virtual bool IsModified() const;
 117     virtual bool IsEditable() const;
 118
 119     // If the return values from and to are the same, there is no selection.
 120     virtual void GetSelection(wxTextPos* from, wxTextPos* to) const;
 121
 122     // operations
 123     // ----------
 124
 125     // editing
 126     virtual void Clear();
 127     virtual void Replace(wxTextPos from, wxTextPos to, const wxString& value);
 128     virtual void Remove(wxTextPos from, wxTextPos to);
 129
 130     // sets/clears the dirty flag
 131     virtual void MarkDirty();
 132     virtual void DiscardEdits();
 133
 134     // writing text inserts it at the current position, appending always
 135     // inserts it at the end
 136     virtual void WriteText(const wxString& text);
 137     virtual void AppendText(const wxString& text);
 138
 139     // translate between the position (which is just an index in the text ctrl
 140     // considering all its contents as a single strings) and (x, y) coordinates
 141     // which represent (logical, i.e. unwrapped) column and line.
 142     virtual wxTextPos XYToPosition(wxTextCoord x, wxTextCoord y) const;
 143     virtual bool PositionToXY(wxTextPos pos,
 144                               wxTextCoord *x, wxTextCoord *y) const;
 145
 146     // wxUniv-specific: find a screen position (in client coordinates) of the
 147     // given text position or of the caret
 148     bool PositionToLogicalXY(wxTextPos pos, wxCoord *x, wxCoord *y) const;
 149     bool PositionToDeviceXY(wxTextPos pos, wxCoord *x, wxCoord *y) const;
 150     wxPoint GetCaretPosition() const;
 151
 152     virtual void ShowPosition(wxTextPos pos);
 153
 154     // Clipboard operations
 155     virtual void Copy();
 156     virtual void Cut();
 157     virtual void Paste();
 158
 159     // Undo/redo
 160     virtual void Undo();
 161     virtual void Redo();
 162
 163     virtual bool CanUndo() const;
 164     virtual bool CanRedo() const;
 165
 166     // Insertion point
 167     virtual void SetInsertionPoint(wxTextPos pos);
 168     virtual void SetInsertionPointEnd();
 169     virtual wxTextPos GetInsertionPoint() const;
 170     virtual wxTextPos GetLastPosition() const;
 171
 172     virtual void SetSelection(wxTextPos from, wxTextPos to);
 173     virtual void SetEditable(bool editable);
 174
 175     // wxUniv-specific methods
 176     // -----------------------
 177
 178     // caret stuff
 179     virtual void ShowCaret(bool show = true);
 180     void HideCaret() { ShowCaret(false); }
 181     void CreateCaret(); // for the current font size
 182
 183     // helpers for cursor movement
 184     wxTextPos GetWordStart() const;
 185     wxTextPos GetWordEnd() const;
 186
 187     // selection helpers
 188     bool HasSelection() const
 189         { return m_selStart != -1 && m_selEnd > m_selStart; }
 190     void ClearSelection();
 191     void RemoveSelection();
 192     wxString GetSelectionText() const;
 193
 194     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
 195     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
 196                                             wxTextCoord *col,
 197                                             wxTextCoord *row) const;
 198
 199     // find the character at this position in the given line, return value as
 200     // for HitTest()
 201     //
 202     // NB: x is the logical coord (client and unscrolled)
 203     wxTextCtrlHitTestResult HitTestLine(const wxString& line,
 204                                         wxCoord x,
 205                                         wxTextCoord *colOut) const;
 206
 207     // bring the given position into view
 208     void ShowHorzPosition(wxCoord pos);
 209
 210     // scroll the window horizontally so that the first character shown is in
 211     // position pos
 212     void ScrollText(wxTextCoord col);
 213
 214     // adjust the DC for horz text control scrolling too
 215     virtual void DoPrepareDC(wxDC& dc);
 216
 217     // implementation only from now on
 218     // -------------------------------
 219
 220     // override this to take into account our scrollbar-less scrolling
 221     virtual void CalcUnscrolledPosition(int x, int y, int *xx, int *yy) const;
 222     virtual void CalcScrolledPosition(int x, int y, int *xx, int *yy) const;
 223
 224     // perform an action
 225     virtual bool PerformAction(const wxControlAction& action,
 226                                long numArg = -1,
 227                                const wxString& strArg = wxEmptyString);
 228
 229     static wxInputHandler *GetStdInputHandler(wxInputHandler *handlerDef);
 230     virtual wxInputHandler *DoGetStdInputHandler(wxInputHandler *handlerDef)
 231     {
 232         return GetStdInputHandler(handlerDef);
 233     }
 234
 235     // override these methods to handle the caret
 236     virtual bool SetFont(const wxFont &font);
 237     virtual bool Enable(bool enable = true);
 238
 239     // more readable flag testing methods
 240     bool IsPassword() const { return (GetWindowStyle() & wxTE_PASSWORD) != 0; }
 241     bool WrapLines() const
 242         { return !IsSingleLine() && !(GetWindowStyle() & wxHSCROLL); }
 243
 244     // only for wxStdTextCtrlInputHandler
 245     void RefreshSelection();
 246
 247     // override wxScrollHelper method to prevent (auto)scrolling beyond the end
 248     // of line
 249     virtual bool SendAutoScrollEvents(wxScrollWinEvent& event) const;
 250
 251     // idle processing
 252     virtual void OnInternalIdle();
 253
 254 protected:
 255     // ensure we have correct default border
 256     virtual wxBorder GetDefaultBorder() const { return wxBORDER_SUNKEN; }
 257
 258     // override base class methods
 259     virtual void DoDrawBorder(wxDC& dc, const wxRect& rect);
 260     virtual void DoDraw(wxControlRenderer *renderer);
 261
 262     // calc the size from the text extent
 263     virtual wxSize DoGetBestClientSize() const;
 264
 265     // common part of all ctors
 266     void Init();
 267
 268     // drawing
 269     // -------
 270
 271     // draw the text in the given rectangle
 272     void DoDrawTextInRect(wxDC& dc, const wxRect& rectUpdate);
 273
 274     // draw the line wrap marks in this rect
 275     void DoDrawLineWrapMarks(wxDC& dc, const wxRect& rectUpdate);
 276
 277     // line/row geometry calculations
 278     // ------------------------------
 279
 280     // get the extent (width) of the text
 281     wxCoord GetTextWidth(const wxString& text) const;
 282
 283     // get the logical text width (accounting for scrolling)
 284     wxCoord GetTotalWidth() const;
 285
 286     // get total number of rows (different from number of lines if the lines
 287     // can be wrapped)
 288     wxTextCoord GetRowCount() const;
 289
 290     // find the number of rows in this line (only if WrapLines())
 291     wxTextCoord GetRowsPerLine(wxTextCoord line) const;
 292
 293     // get the starting row of the given line
 294     wxTextCoord GetFirstRowOfLine(wxTextCoord line) const;
 295
 296     // get the row following this line
 297     wxTextCoord GetRowAfterLine(wxTextCoord line) const;
 298
 299     // refresh functions
 300     // -----------------
 301
 302     // the text area is the part of the window in which the text can be
 303     // displayed, i.e. part of it inside the margins and the real text area is
 304     // the area in which the text *is* currently displayed: for example, in the
 305     // multiline control case the text area can have extra space at the bottom
 306     // which is not tall enough for another line and which is then not included
 307     // into the real text area
 308     wxRect GetRealTextArea() const;
 309
 310     // refresh the text in the given (in logical coords) rect
 311     void RefreshTextRect(const wxRect& rect, bool textOnly = true);
 312
 313     // refresh the line wrap marks for the given range of lines (inclusive)
 314     void RefreshLineWrapMarks(wxTextCoord rowFirst, wxTextCoord rowLast);
 315
 316     // refresh the text in the given range (in logical coords) of this line, if
 317     // width is 0, refresh to the end of line
 318     void RefreshPixelRange(wxTextCoord line, wxCoord start, wxCoord width);
 319
 320     // refresh the text in the given range (in text coords) in this line
 321     void RefreshColRange(wxTextCoord line, wxTextPos start, size_t count);
 322
 323     // refresh the text from in the given line range (inclusive)
 324     void RefreshLineRange(wxTextCoord lineFirst, wxTextCoord lineLast);
 325
 326     // refresh the text in the given range which can span multiple lines
 327     // (this method accepts arguments in any order)
 328     void RefreshTextRange(wxTextPos start, wxTextPos end);
 329
 330     // get the text to show: either the text itself or the text replaced with
 331     // starts for wxTE_PASSWORD control
 332     wxString GetTextToShow(const wxString& text) const;
 333
 334     // find the row in this line where the given position (counted from the
 335     // start of line) is
 336     wxTextCoord GetRowInLine(wxTextCoord line,
 337                              wxTextCoord col,
 338                              wxTextCoord *colRowStart = NULL) const;
 339
 340     // find the number of characters of a line before it wraps
 341     // (and optionally also the real width of the line)
 342     size_t GetPartOfWrappedLine(const wxChar* text,
 343                                 wxCoord *widthReal = NULL) const;
 344
 345     // get the start and end of the selection for this line: if the line is
 346     // outside the selection, both will be -1 and false will be returned
 347     bool GetSelectedPartOfLine(wxTextCoord line,
 348                                wxTextPos *start, wxTextPos *end) const;
 349
 350     // update the text rect: the zone inside our client rect (its coords are
 351     // client coords) which contains the text
 352     void UpdateTextRect();
 353
 354     // calculate the last visible position
 355     void UpdateLastVisible();
 356
 357     // move caret to the given position unconditionally
 358     // (SetInsertionPoint() does nothing if the position didn't change)
 359     void DoSetInsertionPoint(wxTextPos pos);
 360
 361     // move caret to the new position without updating the display (for
 362     // internal use only)
 363     void MoveInsertionPoint(wxTextPos pos);
 364
 365     // set the caret to its initial (default) position
 366     void InitInsertionPoint();
 367
 368     // get the width of the longest line in pixels
 369     wxCoord GetMaxWidth() const;
 370
 371     // force recalculation of the max line width
 372     void RecalcMaxWidth();
 373
 374     // update the max width after the given line was modified
 375     void UpdateMaxWidth(wxTextCoord line);
 376
 377     // hit testing
 378     // -----------
 379
 380     // HitTest2() is more efficient than 2 consecutive HitTest()s with the same
 381     // line (i.e. y) and it also returns the offset of the starting position in
 382     // pixels
 383     //
 384     // as the last hack, this function accepts either logical or device (by
 385     // default) coords depending on devCoords flag
 386     wxTextCtrlHitTestResult HitTest2(wxCoord y,
 387                                      wxCoord x1,
 388                                      wxCoord x2,
 389                                      wxTextCoord *row,
 390                                      wxTextCoord *colStart,
 391                                      wxTextCoord *colEnd,
 392                                      wxTextCoord *colRowStart,
 393                                      bool devCoords = true) const;
 394
 395     // HitTest() version which takes the logical text coordinates and not the
 396     // device ones
 397     wxTextCtrlHitTestResult HitTestLogical(const wxPoint& pos,
 398                                            wxTextCoord *col,
 399                                            wxTextCoord *row) const;
 400
 401     // get the line and the row in this line corresponding to the given row,
 402     // return true if ok and false if row is out of range
 403     //
 404     // NB: this function can only be called for controls which wrap lines
 405     bool GetLineAndRow(wxTextCoord row,
 406                        wxTextCoord *line,
 407                        wxTextCoord *rowInLine) const;
 408
 409     // get the height of one line (the same for all lines)
 410     wxCoord GetLineHeight() const
 411     {
 412         // this one should be already precalculated
 413         wxASSERT_MSG( m_heightLine != -1, _T("should have line height") );
 414
 415         return m_heightLine;
 416     }
 417
 418     // get the average char width
 419     wxCoord GetAverageWidth() const { return m_widthAvg; }
 420
 421     // recalc the line height and char width (to call when the font changes)
 422     void RecalcFontMetrics();
 423
 424     // vertical scrolling helpers
 425     // --------------------------
 426
 427     // all these functions are for multi line controls only
 428
 429     // get the number of visible lines
 430     size_t GetLinesPerPage() const;
 431
 432     // return the position above the cursor or INVALID_POS_VALUE
 433     wxTextPos GetPositionAbove();
 434
 435     // return the position below the cursor or INVALID_POS_VALUE
 436     wxTextPos GetPositionBelow();
 437
 438     // event handlers
 439     // --------------
 440     void OnChar(wxKeyEvent& event);
 441     void OnSize(wxSizeEvent& event);
 442
 443     // return the struct containing control-type dependent data
 444     struct wxTextSingleLineData& SData() { return *m_data.sdata; }
 445     struct wxTextMultiLineData& MData() { return *m_data.mdata; }
 446     struct wxTextWrappedData& WData() { return *m_data.wdata; }
 447     const wxTextSingleLineData& SData() const { return *m_data.sdata; }
 448     const wxTextMultiLineData& MData() const { return *m_data.mdata; }
 449     const wxTextWrappedData& WData() const { return *m_data.wdata; }
 450
 451     // clipboard operations (unlike the versions without Do prefix, they have a
 452     // return code)
 453     bool DoCut();
 454     bool DoPaste();
 455
 456 private:
 457     // all these methods are for multiline text controls only
 458
 459     // update the scrollbars (only called from OnIdle)
 460     void UpdateScrollbars();
 461
 462     // get read only access to the lines of multiline control
 463     inline const wxArrayString& GetLines() const;
 464     inline size_t GetLineCount() const;
 465
 466     // replace a line (returns true if the number of rows in thel ine changed)
 467     bool ReplaceLine(wxTextCoord line, const wxString& text);
 468
 469     // remove a line
 470     void RemoveLine(wxTextCoord line);
 471
 472     // insert a line at this position
 473     void InsertLine(wxTextCoord line, const wxString& text);
 474
 475     // calculate geometry of this line
 476     void LayoutLine(wxTextCoord line, class wxWrappedLineData& lineData) const;
 477
 478     // calculate geometry of all lines until the given one
 479     void LayoutLines(wxTextCoord lineLast) const;
 480
 481     // the initially specified control size
 482     wxSize m_sizeInitial;
 483
 484     // the global control text
 485     wxString m_value;
 486
 487     // current position
 488     wxTextPos m_curPos;
 489     wxTextCoord m_curCol,
 490                 m_curRow;
 491
 492     // last position (only used by GetLastPosition())
 493     wxTextPos m_posLast;
 494
 495     // selection
 496     wxTextPos m_selAnchor,
 497               m_selStart,
 498               m_selEnd;
 499
 500     // flags
 501     bool m_isModified:1,
 502          m_isEditable:1,
 503          m_hasCaret:1;
 504
 505     // the rectangle (in client coordinates) to draw text inside
 506     wxRect m_rectText;
 507
 508     // the height of one line (cached value of GetCharHeight)
 509     wxCoord m_heightLine;
 510
 511     // and the average char width (cached value of GetCharWidth)
 512     wxCoord m_widthAvg;
 513
 514     // we have some data which depends on the kind of control (single or multi
 515     // line)
 516     union
 517     {
 518         wxTextSingleLineData *sdata;
 519         wxTextMultiLineData *mdata;
 520         wxTextWrappedData *wdata;
 521         void *data;
 522     } m_data;
 523
 524     // the object to which we delegate our undo/redo implementation
 525     wxTextCtrlCommandProcessor *m_cmdProcessor;
 526
 527     DECLARE_EVENT_TABLE()
 528     DECLARE_DYNAMIC_CLASS(wxTextCtrl)
 529
 530     friend class wxWrappedLineData;
 531 };
 532
 533 #endif // _WX_UNIV_TEXTCTRL_H_
 534