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