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 int GetLineLength(wxTextCoord lineNo) const;
 111     virtual wxString GetLineText(wxTextCoord lineNo) const;
 112     virtual int GetNumberOfLines() const;
 113
 114     virtual bool IsModified() const;
 115     virtual bool IsEditable() const;
 116
 117     // If the return values from and to are the same, there is no selection.
 118     virtual void GetSelection(wxTextPos* from, wxTextPos* to) const;
 119
 120     // operations
 121     // ----------
 122
 123     // editing
 124     virtual void Clear();
 125     virtual void Replace(wxTextPos from, wxTextPos to, const wxString& value);
 126     virtual void Remove(wxTextPos from, wxTextPos to);
 127
 128     // sets/clears the dirty flag
 129     virtual void MarkDirty();
 130     virtual void DiscardEdits();
 131
 132     // writing text inserts it at the current position, appending always
 133     // inserts it at the end
 134     virtual void WriteText(const wxString& text);
 135     virtual void AppendText(const wxString& text);
 136
 137     // translate between the position (which is just an index in the text ctrl
 138     // considering all its contents as a single strings) and (x, y) coordinates
 139     // which represent (logical, i.e. unwrapped) column and line.
 140     virtual wxTextPos XYToPosition(wxTextCoord x, wxTextCoord y) const;
 141     virtual bool PositionToXY(wxTextPos pos,
 142                               wxTextCoord *x, wxTextCoord *y) const;
 143
 144     // wxUniv-specific: find a screen position (in client coordinates) of the
 145     // given text position or of the caret
 146     bool PositionToLogicalXY(wxTextPos pos, wxCoord *x, wxCoord *y) const;
 147     bool PositionToDeviceXY(wxTextPos pos, wxCoord *x, wxCoord *y) const;
 148     wxPoint GetCaretPosition() const;
 149
 150     virtual void ShowPosition(wxTextPos pos);
 151
 152     // Clipboard operations
 153     virtual void Copy();
 154     virtual void Cut();
 155     virtual void Paste();
 156
 157     // Undo/redo
 158     virtual void Undo();
 159     virtual void Redo();
 160
 161     virtual bool CanUndo() const;
 162     virtual bool CanRedo() const;
 163
 164     // Insertion point
 165     virtual void SetInsertionPoint(wxTextPos pos);
 166     virtual void SetInsertionPointEnd();
 167     virtual wxTextPos GetInsertionPoint() const;
 168     virtual wxTextPos GetLastPosition() const;
 169
 170     virtual void SetSelection(wxTextPos from, wxTextPos to);
 171     virtual void SetEditable(bool editable);
 172
 173     // wxUniv-specific methods
 174     // -----------------------
 175
 176     // caret stuff
 177     virtual void ShowCaret(bool show = true);
 178     void HideCaret() { ShowCaret(false); }
 179     void CreateCaret(); // for the current font size
 180
 181     // helpers for cursor movement
 182     wxTextPos GetWordStart() const;
 183     wxTextPos GetWordEnd() const;
 184
 185     // selection helpers
 186     bool HasSelection() const
 187         { return m_selStart != -1 && m_selEnd > m_selStart; }
 188     void ClearSelection();
 189     void RemoveSelection();
 190     wxString GetSelectionText() const;
 191
 192     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
 193     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
 194                                             wxTextCoord *col,
 195                                             wxTextCoord *row) const;
 196
 197     // find the character at this position in the given line, return value as
 198     // for HitTest()
 199     //
 200     // NB: x is the logical coord (client and unscrolled)
 201     wxTextCtrlHitTestResult HitTestLine(const wxString& line,
 202                                         wxCoord x,
 203                                         wxTextCoord *colOut) const;
 204
 205     // bring the given position into view
 206     void ShowHorzPosition(wxCoord pos);
 207
 208     // scroll the window horizontally so that the first character shown is in
 209     // position pos
 210     void ScrollText(wxTextCoord col);
 211
 212     // adjust the DC for horz text control scrolling too
 213     virtual void DoPrepareDC(wxDC& dc);
 214
 215     // implementation only from now on
 216     // -------------------------------
 217
 218     // override this to take into account our scrollbar-less scrolling
 219     virtual void CalcUnscrolledPosition(int x, int y, int *xx, int *yy) const;
 220     virtual void CalcScrolledPosition(int x, int y, int *xx, int *yy) const;
 221
 222     // perform an action
 223     virtual bool PerformAction(const wxControlAction& action,
 224                                long numArg = -1,
 225                                const wxString& strArg = wxEmptyString);
 226
 227     static wxInputHandler *GetStdInputHandler(wxInputHandler *handlerDef);
 228     virtual wxInputHandler *DoGetStdInputHandler(wxInputHandler *handlerDef)
 229     {
 230         return GetStdInputHandler(handlerDef);
 231     }
 232
 233     // override these methods to handle the caret
 234     virtual bool SetFont(const wxFont &font);
 235     virtual bool Enable(bool enable = true);
 236
 237     // more readable flag testing methods
 238     bool IsPassword() const { return (GetWindowStyle() & wxTE_PASSWORD) != 0; }
 239     bool WrapLines() const
 240         { return !IsSingleLine() && !(GetWindowStyle() & wxHSCROLL); }
 241
 242     // only for wxStdTextCtrlInputHandler
 243     void RefreshSelection();
 244
 245     // override wxScrollHelper method to prevent (auto)scrolling beyond the end
 246     // of line
 247     virtual bool SendAutoScrollEvents(wxScrollWinEvent& event) const;
 248
 249     // idle processing
 250     virtual void OnInternalIdle();
 251
 252 protected:
 253     // ensure we have correct default border
 254     virtual wxBorder GetDefaultBorder() const { return wxBORDER_SUNKEN; }
 255
 256     // override base class methods
 257     virtual void DoDrawBorder(wxDC& dc, const wxRect& rect);
 258     virtual void DoDraw(wxControlRenderer *renderer);
 259
 260     // calc the size from the text extent
 261     virtual wxSize DoGetBestClientSize() const;
 262
 263     // common part of all ctors
 264     void Init();
 265
 266     // drawing
 267     // -------
 268
 269     // draw the text in the given rectangle
 270     void DoDrawTextInRect(wxDC& dc, const wxRect& rectUpdate);
 271
 272     // draw the line wrap marks in this rect
 273     void DoDrawLineWrapMarks(wxDC& dc, const wxRect& rectUpdate);
 274
 275     // line/row geometry calculations
 276     // ------------------------------
 277
 278     // get the extent (width) of the text
 279     wxCoord GetTextWidth(const wxString& text) const;
 280
 281     // get the logical text width (accounting for scrolling)
 282     wxCoord GetTotalWidth() const;
 283
 284     // get total number of rows (different from number of lines if the lines
 285     // can be wrapped)
 286     wxTextCoord GetRowCount() const;
 287
 288     // find the number of rows in this line (only if WrapLines())
 289     wxTextCoord GetRowsPerLine(wxTextCoord line) const;
 290
 291     // get the starting row of the given line
 292     wxTextCoord GetFirstRowOfLine(wxTextCoord line) const;
 293
 294     // get the row following this line
 295     wxTextCoord GetRowAfterLine(wxTextCoord line) const;
 296
 297     // refresh functions
 298     // -----------------
 299
 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;
 307
 308     // refresh the text in the given (in logical coords) rect
 309     void RefreshTextRect(const wxRect& rect, bool textOnly = true);
 310
 311     // refresh the line wrap marks for the given range of lines (inclusive)
 312     void RefreshLineWrapMarks(wxTextCoord rowFirst, wxTextCoord rowLast);
 313
 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);
 317
 318     // refresh the text in the given range (in text coords) in this line
 319     void RefreshColRange(wxTextCoord line, wxTextPos start, size_t count);
 320
 321     // refresh the text from in the given line range (inclusive)
 322     void RefreshLineRange(wxTextCoord lineFirst, wxTextCoord lineLast);
 323
 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);
 327
 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;
 331
 332     // find the row in this line where the given position (counted from the
 333     // start of line) is
 334     wxTextCoord GetRowInLine(wxTextCoord line,
 335                              wxTextCoord col,
 336                              wxTextCoord *colRowStart = NULL) const;
 337
 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;
 342
 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;
 347
 348     // update the text rect: the zone inside our client rect (its coords are
 349     // client coords) which contains the text
 350     void UpdateTextRect();
 351
 352     // calculate the last visible position
 353     void UpdateLastVisible();
 354
 355     // move caret to the given position unconditionally
 356     // (SetInsertionPoint() does nothing if the position didn't change)
 357     void DoSetInsertionPoint(wxTextPos pos);
 358
 359     // move caret to the new position without updating the display (for
 360     // internal use only)
 361     void MoveInsertionPoint(wxTextPos pos);
 362
 363     // set the caret to its initial (default) position
 364     void InitInsertionPoint();
 365
 366     // get the width of the longest line in pixels
 367     wxCoord GetMaxWidth() const;
 368
 369     // force recalculation of the max line width
 370     void RecalcMaxWidth();
 371
 372     // update the max width after the given line was modified
 373     void UpdateMaxWidth(wxTextCoord line);
 374
 375     // hit testing
 376     // -----------
 377
 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
 380     // pixels
 381     //
 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,
 385                                      wxCoord x1,
 386                                      wxCoord x2,
 387                                      wxTextCoord *row,
 388                                      wxTextCoord *colStart,
 389                                      wxTextCoord *colEnd,
 390                                      wxTextCoord *colRowStart,
 391                                      bool devCoords = true) const;
 392
 393     // HitTest() version which takes the logical text coordinates and not the
 394     // device ones
 395     wxTextCtrlHitTestResult HitTestLogical(const wxPoint& pos,
 396                                            wxTextCoord *col,
 397                                            wxTextCoord *row) const;
 398
 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
 401     //
 402     // NB: this function can only be called for controls which wrap lines
 403     bool GetLineAndRow(wxTextCoord row,
 404                        wxTextCoord *line,
 405                        wxTextCoord *rowInLine) const;
 406
 407     // get the height of one line (the same for all lines)
 408     wxCoord GetLineHeight() const
 409     {
 410         // this one should be already precalculated
 411         wxASSERT_MSG( m_heightLine != -1, _T("should have line height") );
 412
 413         return m_heightLine;
 414     }
 415
 416     // get the average char width
 417     wxCoord GetAverageWidth() const { return m_widthAvg; }
 418
 419     // recalc the line height and char width (to call when the font changes)
 420     void RecalcFontMetrics();
 421
 422     // vertical scrolling helpers
 423     // --------------------------
 424
 425     // all these functions are for multi line controls only
 426
 427     // get the number of visible lines
 428     size_t GetLinesPerPage() const;
 429
 430     // return the position above the cursor or INVALID_POS_VALUE
 431     wxTextPos GetPositionAbove();
 432
 433     // return the position below the cursor or INVALID_POS_VALUE
 434     wxTextPos GetPositionBelow();
 435
 436     // event handlers
 437     // --------------
 438     void OnChar(wxKeyEvent& event);
 439     void OnSize(wxSizeEvent& event);
 440
 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; }
 448
 449     // clipboard operations (unlike the versions without Do prefix, they have a
 450     // return code)
 451     bool DoCut();
 452     bool DoPaste();
 453
 454 private:
 455     // all these methods are for multiline text controls only
 456
 457     // update the scrollbars (only called from OnIdle)
 458     void UpdateScrollbars();
 459
 460     // get read only access to the lines of multiline control
 461     inline const wxArrayString& GetLines() const;
 462     inline size_t GetLineCount() const;
 463
 464     // replace a line (returns true if the number of rows in thel ine changed)
 465     bool ReplaceLine(wxTextCoord line, const wxString& text);
 466
 467     // remove a line
 468     void RemoveLine(wxTextCoord line);
 469
 470     // insert a line at this position
 471     void InsertLine(wxTextCoord line, const wxString& text);
 472
 473     // calculate geometry of this line
 474     void LayoutLine(wxTextCoord line, class wxWrappedLineData& lineData) const;
 475
 476     // calculate geometry of all lines until the given one
 477     void LayoutLines(wxTextCoord lineLast) const;
 478
 479     // the initially specified control size
 480     wxSize m_sizeInitial;
 481
 482     // the global control text
 483     wxString m_value;
 484
 485     // current position
 486     wxTextPos m_curPos;
 487     wxTextCoord m_curCol,
 488                 m_curRow;
 489
 490     // last position (only used by GetLastPosition())
 491     wxTextPos m_posLast;
 492
 493     // selection
 494     wxTextPos m_selAnchor,
 495               m_selStart,
 496               m_selEnd;
 497
 498     // flags
 499     bool m_isModified:1,
 500          m_isEditable:1,
 501          m_hasCaret:1;
 502
 503     // the rectangle (in client coordinates) to draw text inside
 504     wxRect m_rectText;
 505
 506     // the height of one line (cached value of GetCharHeight)
 507     wxCoord m_heightLine;
 508
 509     // and the average char width (cached value of GetCharWidth)
 510     wxCoord m_widthAvg;
 511
 512     // we have some data which depends on the kind of control (single or multi
 513     // line)
 514     union
 515     {
 516         wxTextSingleLineData *sdata;
 517         wxTextMultiLineData *mdata;
 518         wxTextWrappedData *wdata;
 519         void *data;
 520     } m_data;
 521
 522     // the object to which we delegate our undo/redo implementation
 523     wxTextCtrlCommandProcessor *m_cmdProcessor;
 524
 525     DECLARE_EVENT_TABLE()
 526     DECLARE_DYNAMIC_CLASS(wxTextCtrl)
 527
 528     friend class wxWrappedLineData;
 529 };
 530
 531 #endif // _WX_UNIV_TEXTCTRL_H_
 532