include/wx/richtext/richtextctrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/richtext/richtextctrl.h
   3 // Purpose:     A rich edit control
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     2005-09-30
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_RICHTEXTCTRL_H_
  13 #define _WX_RICHTEXTCTRL_H_
  14
  15 #include "wx/richtext/richtextbuffer.h"
  16
  17 #if wxUSE_RICHTEXT
  18
  19 #include "wx/scrolwin.h"
  20 #include "wx/caret.h"
  21
  22 #include "wx/textctrl.h"
  23
  24 #if !defined(__WXGTK__) && !defined(__WXMAC__)
  25 #define wxRICHTEXT_BUFFERED_PAINTING 1
  26 #else
  27 #define wxRICHTEXT_BUFFERED_PAINTING 0
  28 #endif
  29
  30 class WXDLLIMPEXP_RICHTEXT wxRichTextStyleDefinition;
  31
  32 /*!
  33  * Styles and flags
  34  */
  35
  36 /* Styles
  37  */
  38
  39 #define wxRE_READONLY          0x0010
  40 #define wxRE_MULTILINE         0x0020
  41
  42 /* Flags
  43  */
  44
  45 #define wxRICHTEXT_SHIFT_DOWN  0x01
  46 #define wxRICHTEXT_CTRL_DOWN   0x02
  47 #define wxRICHTEXT_ALT_DOWN    0x04
  48
  49 /* Defaults
  50  */
  51
  52 #define wxRICHTEXT_DEFAULT_OVERALL_SIZE wxSize(-1, -1)
  53 #define wxRICHTEXT_DEFAULT_IMAGE_SIZE wxSize(80, 80)
  54 #define wxRICHTEXT_DEFAULT_SPACING 3
  55 #define wxRICHTEXT_DEFAULT_MARGIN 3
  56 #define wxRICHTEXT_DEFAULT_UNFOCUSSED_BACKGROUND wxColour(175, 175, 175)
  57 #define wxRICHTEXT_DEFAULT_FOCUSSED_BACKGROUND wxColour(140, 140, 140)
  58 #define wxRICHTEXT_DEFAULT_UNSELECTED_BACKGROUND wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE)
  59 #define wxRICHTEXT_DEFAULT_TYPE_COLOUR wxColour(0, 0, 200)
  60 #define wxRICHTEXT_DEFAULT_FOCUS_RECT_COLOUR wxColour(100, 80, 80)
  61 #define wxRICHTEXT_DEFAULT_CARET_WIDTH 2
  62 // Minimum buffer size before delayed layout kicks in
  63 #define wxRICHTEXT_DEFAULT_DELAYED_LAYOUT_THRESHOLD 20000
  64 // Milliseconds before layout occurs after resize
  65 #define wxRICHTEXT_DEFAULT_LAYOUT_INTERVAL 50
  66
  67 /*!
  68  * Forward declarations
  69  */
  70
  71 /*!
  72  * wxRichTextItem class declaration
  73  */
  74
  75 // Drawing styles/states
  76 #define wxRICHTEXT_SELECTED    0x01
  77 #define wxRICHTEXT_TAGGED      0x02
  78 // The control is focussed
  79 #define wxRICHTEXT_FOCUSSED    0x04
  80 // The item itself has the focus
  81 #define wxRICHTEXT_IS_FOCUS    0x08
  82
  83 /*!
  84  * wxRichTextCtrl class declaration
  85  */
  86
  87 class WXDLLIMPEXP_RICHTEXT wxRichTextCtrl : public wxTextCtrlBase,
  88                                             public wxScrollHelper
  89 {
  90     DECLARE_CLASS( wxRichTextCtrl )
  91     DECLARE_EVENT_TABLE()
  92
  93 public:
  94 // Constructors
  95
  96     wxRichTextCtrl( );
  97     wxRichTextCtrl( wxWindow* parent, wxWindowID id = -1, const wxString& value = wxEmptyString, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
  98         long style = wxRE_MULTILINE );
  99     virtual ~wxRichTextCtrl( );
 100
 101 // Operations
 102
 103     /// Creation
 104     bool Create( wxWindow* parent, wxWindowID id = -1, const wxString& value = wxEmptyString, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
 105         long style = wxRE_MULTILINE );
 106
 107     /// Member initialisation
 108     void Init();
 109
 110 ///// wxTextCtrl compatibility
 111
 112 // Accessors
 113
 114     virtual wxString GetValue() const;
 115
 116     virtual wxString GetRange(long from, long to) const;
 117
 118     virtual int GetLineLength(long lineNo) const ;
 119     virtual wxString GetLineText(long lineNo) const ;
 120     virtual int GetNumberOfLines() const ;
 121
 122     virtual bool IsModified() const ;
 123     virtual bool IsEditable() const ;
 124
 125     // more readable flag testing methods
 126     bool IsSingleLine() const { return !HasFlag(wxRE_MULTILINE); }
 127     bool IsMultiLine() const { return !IsSingleLine(); }
 128
 129     // If the return values from and to are the same, there is no selection.
 130     virtual void GetSelection(long* from, long* to) const;
 131
 132     virtual wxString GetStringSelection() const;
 133
 134     /// Get filename
 135     wxString GetFilename() const { return m_filename; }
 136
 137     /// Set filename
 138     void SetFilename(const wxString& filename) { m_filename = filename; }
 139
 140     /// Set the threshold in character positions for doing layout optimization during sizing
 141     void SetDelayedLayoutThreshold(long threshold) { m_delayedLayoutThreshold = threshold; }
 142
 143     /// Get the threshold in character positions for doing layout optimization during sizing
 144     long GetDelayedLayoutThreshold() const { return m_delayedLayoutThreshold; }
 145
 146 // Operations
 147
 148     // editing
 149     virtual void Clear();
 150     virtual void Replace(long from, long to, const wxString& value);
 151     virtual void Remove(long from, long to);
 152
 153     // load/save the controls contents from/to the file
 154     virtual bool DoLoadFile(const wxString& file, int fileType);
 155     virtual bool DoSaveFile(const wxString& file = wxEmptyString, int fileType = wxRICHTEXT_TYPE_ANY);
 156
 157     // sets/clears the dirty flag
 158     virtual void MarkDirty();
 159     virtual void DiscardEdits();
 160
 161     // set the max number of characters which may be entered in a single line
 162     // text control
 163     virtual void SetMaxLength(unsigned long WXUNUSED(len)) { }
 164
 165     // writing text inserts it at the current position, appending always
 166     // inserts it at the end
 167     virtual void WriteText(const wxString& text);
 168     virtual void AppendText(const wxString& text);
 169
 170     // text control under some platforms supports the text styles: these
 171     // methods allow to apply the given text style to the given selection or to
 172     // set/get the style which will be used for all appended text
 173     virtual bool SetStyle(long start, long end, const wxTextAttr& style);
 174     virtual bool SetStyle(long start, long end, const wxTextAttrEx& style);
 175     virtual bool SetStyle(const wxRichTextRange& range, const wxRichTextAttr& style);
 176     virtual bool GetStyle(long position, wxTextAttr& style);
 177     virtual bool GetStyle(long position, wxTextAttrEx& style);
 178     virtual bool GetStyle(long position, wxRichTextAttr& style);
 179
 180     // extended style setting operation with flags including:
 181     // wxRICHTEXT_SETSTYLE_WITH_UNDO, wxRICHTEXT_SETSTYLE_OPTIMIZE, wxRICHTEXT_SETSTYLE_PARAGRAPHS_ONLY, wxRICHTEXT_SETSTYLE_CHARACTERS_ONLY
 182     // see richtextbuffer.h for more details.
 183     virtual bool SetStyleEx(long start, long end, const wxTextAttrEx& style, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
 184     virtual bool SetStyleEx(const wxRichTextRange& range, const wxTextAttrEx& style, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
 185     virtual bool SetStyleEx(const wxRichTextRange& range, const wxRichTextAttr& style, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
 186
 187     /// Get the content (uncombined) attributes for this position.
 188     virtual bool GetUncombinedStyle(long position, wxTextAttr& style);
 189     virtual bool GetUncombinedStyle(long position, wxTextAttrEx& style);
 190     virtual bool GetUncombinedStyle(long position, wxRichTextAttr& style);
 191
 192     virtual bool SetDefaultStyle(const wxTextAttrEx& style);
 193     virtual bool SetDefaultStyle(const wxTextAttr& style);
 194
 195     // TODO: change to GetDefaultStyle if we merge wxTextAttr and wxTextAttrEx
 196     virtual const wxTextAttrEx& GetDefaultStyleEx() const;
 197     virtual const wxTextAttr& GetDefaultStyle() const;
 198
 199     // translate between the position (which is just an index in the text ctrl
 200     // considering all its contents as a single strings) and (x, y) coordinates
 201     // which represent column and line.
 202     virtual long XYToPosition(long x, long y) const;
 203     virtual bool PositionToXY(long pos, long *x, long *y) const;
 204
 205     virtual void ShowPosition(long pos);
 206
 207     // find the character at position given in pixels
 208     //
 209     // NB: pt is in device coords (not adjusted for the client area origin nor
 210     //     scrolling)
 211     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
 212     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
 213                                             wxTextCoord *col,
 214                                             wxTextCoord *row) const;
 215
 216     // Clipboard operations
 217     virtual void Copy();
 218     virtual void Cut();
 219     virtual void Paste();
 220     virtual void DeleteSelection();
 221
 222     virtual bool CanCopy() const;
 223     virtual bool CanCut() const;
 224     virtual bool CanPaste() const;
 225     virtual bool CanDeleteSelection() const;
 226
 227     // Undo/redo
 228     virtual void Undo();
 229     virtual void Redo();
 230
 231     virtual bool CanUndo() const;
 232     virtual bool CanRedo() const;
 233
 234     // Insertion point
 235     virtual void SetInsertionPoint(long pos);
 236     virtual void SetInsertionPointEnd();
 237     virtual long GetInsertionPoint() const;
 238     virtual wxTextPos GetLastPosition() const;
 239
 240     virtual void SetSelection(long from, long to);
 241     virtual void SelectAll();
 242     virtual void SetEditable(bool editable);
 243
 244     /// Call Freeze to prevent refresh
 245     virtual void Freeze();
 246
 247     /// Call Thaw to refresh
 248     virtual void Thaw();
 249
 250     /// Call Thaw to refresh
 251     virtual bool IsFrozen() const { return m_freezeCount > 0; }
 252
 253     virtual bool HasSelection() const;
 254
 255 ///// Functionality specific to wxRichTextCtrl
 256
 257     /// Write an image at the current insertion point. Supply optional type to use
 258     /// for internal and file storage of the raw data.
 259     virtual bool WriteImage(const wxImage& image, int bitmapType = wxBITMAP_TYPE_PNG);
 260
 261     /// Write a bitmap at the current insertion point. Supply optional type to use
 262     /// for internal and file storage of the raw data.
 263     virtual bool WriteImage(const wxBitmap& bitmap, int bitmapType = wxBITMAP_TYPE_PNG);
 264
 265     /// Load an image from file and write at the current insertion point.
 266     virtual bool WriteImage(const wxString& filename, int bitmapType);
 267
 268     /// Write an image block at the current insertion point.
 269     virtual bool WriteImage(const wxRichTextImageBlock& imageBlock);
 270
 271     /// Insert a newline (actually paragraph) at the current insertion point.
 272     virtual bool Newline();
 273
 274     /// Set basic (overall) style
 275     virtual void SetBasicStyle(const wxTextAttrEx& style) { GetBuffer().SetBasicStyle(style); }
 276     virtual void SetBasicStyle(const wxRichTextAttr& style) { GetBuffer().SetBasicStyle(style); }
 277
 278     /// Get basic (overall) style
 279     virtual const wxTextAttrEx& GetBasicStyle() const { return GetBuffer().GetBasicStyle(); }
 280
 281     /// Begin using a style
 282     virtual bool BeginStyle(const wxTextAttrEx& style) { return GetBuffer().BeginStyle(style); }
 283
 284     /// End the style
 285     virtual bool EndStyle() { return GetBuffer().EndStyle(); }
 286
 287     /// End all styles
 288     virtual bool EndAllStyles() { return GetBuffer().EndAllStyles(); }
 289
 290     /// Begin using bold
 291     bool BeginBold() { return GetBuffer().BeginBold(); }
 292
 293     /// End using bold
 294     bool EndBold()  { return GetBuffer().EndBold(); }
 295
 296     /// Begin using italic
 297     bool BeginItalic() { return GetBuffer().BeginItalic(); }
 298
 299     /// End using italic
 300     bool EndItalic() { return GetBuffer().EndItalic(); }
 301
 302     /// Begin using underline
 303     bool BeginUnderline() { return GetBuffer().BeginUnderline(); }
 304
 305     /// End using underline
 306     bool EndUnderline() { return GetBuffer().EndUnderline(); }
 307
 308     /// Begin using point size
 309     bool BeginFontSize(int pointSize) { return GetBuffer().BeginFontSize(pointSize); }
 310
 311     /// End using point size
 312     bool EndFontSize() { return GetBuffer().EndFontSize(); }
 313
 314     /// Begin using this font
 315     bool BeginFont(const wxFont& font) { return GetBuffer().BeginFont(font); }
 316
 317     /// End using a font
 318     bool EndFont() { return GetBuffer().EndFont(); }
 319
 320     /// Begin using this colour
 321     bool BeginTextColour(const wxColour& colour) { return GetBuffer().BeginTextColour(colour); }
 322
 323     /// End using a colour
 324     bool EndTextColour() { return GetBuffer().EndTextColour(); }
 325
 326     /// Begin using alignment
 327     bool BeginAlignment(wxTextAttrAlignment alignment) { return GetBuffer().BeginAlignment(alignment); }
 328
 329     /// End alignment
 330     bool EndAlignment() { return GetBuffer().EndAlignment(); }
 331
 332     /// Begin left indent
 333     bool BeginLeftIndent(int leftIndent, int leftSubIndent = 0) { return GetBuffer().BeginLeftIndent(leftIndent, leftSubIndent); }
 334
 335     /// End left indent
 336     bool EndLeftIndent() { return GetBuffer().EndLeftIndent(); }
 337
 338     /// Begin right indent
 339     bool BeginRightIndent(int rightIndent) { return GetBuffer().BeginRightIndent(rightIndent); }
 340
 341     /// End right indent
 342     bool EndRightIndent() { return GetBuffer().EndRightIndent(); }
 343
 344     /// Begin paragraph spacing
 345     bool BeginParagraphSpacing(int before, int after) { return GetBuffer().BeginParagraphSpacing(before, after); }
 346
 347     /// End paragraph spacing
 348     bool EndParagraphSpacing() { return GetBuffer().EndParagraphSpacing(); }
 349
 350     /// Begin line spacing
 351     bool BeginLineSpacing(int lineSpacing) { return GetBuffer().BeginLineSpacing(lineSpacing); }
 352
 353     /// End line spacing
 354     bool EndLineSpacing() { return GetBuffer().EndLineSpacing(); }
 355
 356     /// Begin numbered bullet
 357     bool BeginNumberedBullet(int bulletNumber, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_ARABIC|wxTEXT_ATTR_BULLET_STYLE_PERIOD)
 358     { return GetBuffer().BeginNumberedBullet(bulletNumber, leftIndent, leftSubIndent, bulletStyle); }
 359
 360     /// End numbered bullet
 361     bool EndNumberedBullet() { return GetBuffer().EndNumberedBullet(); }
 362
 363     /// Begin symbol bullet
 364     bool BeginSymbolBullet(wxChar symbol, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_SYMBOL)
 365     { return GetBuffer().BeginSymbolBullet(symbol, leftIndent, leftSubIndent, bulletStyle); }
 366
 367     /// End symbol bullet
 368     bool EndSymbolBullet() { return GetBuffer().EndSymbolBullet(); }
 369
 370     /// Begin named character style
 371     bool BeginCharacterStyle(const wxString& characterStyle) { return GetBuffer().BeginCharacterStyle(characterStyle); }
 372
 373     /// End named character style
 374     bool EndCharacterStyle() { return GetBuffer().EndCharacterStyle(); }
 375
 376     /// Begin named paragraph style
 377     bool BeginParagraphStyle(const wxString& paragraphStyle) { return GetBuffer().BeginParagraphStyle(paragraphStyle); }
 378
 379     /// End named character style
 380     bool EndParagraphStyle() { return GetBuffer().EndParagraphStyle(); }
 381
 382     /// Sets the default style to the style under the cursor
 383     bool SetDefaultStyleToCursorStyle();
 384
 385     /// Clear the selection
 386     virtual void SelectNone();
 387
 388     /// Select the word at the given character position
 389     virtual bool SelectWord(long position);
 390
 391     /// Get/set the selection range in character positions. -1, -1 means no selection.
 392     /// The range is in API convention, i.e. a single character selection is denoted
 393     /// by (n, n+1)
 394     wxRichTextRange GetSelectionRange() const;
 395     void SetSelectionRange(const wxRichTextRange& range);
 396
 397     /// Get/set the selection range in character positions. -1, -1 means no selection.
 398     /// The range is in internal format, i.e. a single character selection is denoted
 399     /// by (n, n)
 400     const wxRichTextRange& GetInternalSelectionRange() const { return m_selectionRange; }
 401     void SetInternalSelectionRange(const wxRichTextRange& range) { m_selectionRange = range; }
 402
 403     /// Add a new paragraph of text to the end of the buffer
 404     virtual wxRichTextRange AddParagraph(const wxString& text);
 405
 406     /// Add an image
 407     virtual wxRichTextRange AddImage(const wxImage& image);
 408
 409     /// Layout the buffer: which we must do before certain operations, such as
 410     /// setting the caret position.
 411     virtual bool LayoutContent(bool onlyVisibleRect = false);
 412
 413     /// Move the caret to the given character position
 414     virtual bool MoveCaret(long pos, bool showAtLineStart = false);
 415
 416     /// Move right
 417     virtual bool MoveRight(int noPositions = 1, int flags = 0);
 418
 419     /// Move left
 420     virtual bool MoveLeft(int noPositions = 1, int flags = 0);
 421
 422     /// Move up
 423     virtual bool MoveUp(int noLines = 1, int flags = 0);
 424
 425     /// Move up
 426     virtual bool MoveDown(int noLines = 1, int flags = 0);
 427
 428     /// Move to the end of the line
 429     virtual bool MoveToLineEnd(int flags = 0);
 430
 431     /// Move to the start of the line
 432     virtual bool MoveToLineStart(int flags = 0);
 433
 434     /// Move to the end of the paragraph
 435     virtual bool MoveToParagraphEnd(int flags = 0);
 436
 437     /// Move to the start of the paragraph
 438     virtual bool MoveToParagraphStart(int flags = 0);
 439
 440     /// Move to the start of the buffer
 441     virtual bool MoveHome(int flags = 0);
 442
 443     /// Move to the end of the buffer
 444     virtual bool MoveEnd(int flags = 0);
 445
 446     /// Move n pages up
 447     virtual bool PageUp(int noPages = 1, int flags = 0);
 448
 449     /// Move n pages down
 450     virtual bool PageDown(int noPages = 1, int flags = 0);
 451
 452     /// Move n words left
 453     virtual bool WordLeft(int noPages = 1, int flags = 0);
 454
 455     /// Move n words right
 456     virtual bool WordRight(int noPages = 1, int flags = 0);
 457
 458     /// Returns the buffer associated with the control.
 459     wxRichTextBuffer& GetBuffer() { return m_buffer; }
 460     const wxRichTextBuffer& GetBuffer() const { return m_buffer; }
 461
 462     /// Start batching undo history for commands.
 463     virtual bool BeginBatchUndo(const wxString& cmdName) { return m_buffer.BeginBatchUndo(cmdName); }
 464
 465     /// End batching undo history for commands.
 466     virtual bool EndBatchUndo() { return m_buffer.EndBatchUndo(); }
 467
 468     /// Are we batching undo history for commands?
 469     virtual bool BatchingUndo() const { return m_buffer.BatchingUndo(); }
 470
 471     /// Start suppressing undo history for commands.
 472     virtual bool BeginSuppressUndo() { return m_buffer.BeginSuppressUndo(); }
 473
 474     /// End suppressing undo history for commands.
 475     virtual bool EndSuppressUndo() { return m_buffer.EndSuppressUndo(); }
 476
 477     /// Are we suppressing undo history for commands?
 478     virtual bool SuppressingUndo() const { return m_buffer.SuppressingUndo(); }
 479
 480     /// Test if this whole range has character attributes of the specified kind. If any
 481     /// of the attributes are different within the range, the test fails. You
 482     /// can use this to implement, for example, bold button updating. style must have
 483     /// flags indicating which attributes are of interest.
 484     virtual bool HasCharacterAttributes(const wxRichTextRange& range, const wxTextAttrEx& style) const
 485     {
 486         return GetBuffer().HasCharacterAttributes(range, style);
 487     }
 488     virtual bool HasCharacterAttributes(const wxRichTextRange& range, const wxRichTextAttr& style) const
 489     {
 490         return GetBuffer().HasCharacterAttributes(range, style);
 491     }
 492
 493     /// Test if this whole range has paragraph attributes of the specified kind. If any
 494     /// of the attributes are different within the range, the test fails. You
 495     /// can use this to implement, for example, centering button updating. style must have
 496     /// flags indicating which attributes are of interest.
 497     virtual bool HasParagraphAttributes(const wxRichTextRange& range, const wxTextAttrEx& style) const
 498     {
 499         return GetBuffer().HasParagraphAttributes(range, style);
 500     }
 501     virtual bool HasParagraphAttributes(const wxRichTextRange& range, const wxRichTextAttr& style) const
 502     {
 503         return GetBuffer().HasParagraphAttributes(range, style);
 504     }
 505
 506     /// Is all of the selection bold?
 507     virtual bool IsSelectionBold();
 508
 509     /// Is all of the selection italics?
 510     virtual bool IsSelectionItalics();
 511
 512     /// Is all of the selection underlined?
 513     virtual bool IsSelectionUnderlined();
 514
 515     /// Is all of the selection aligned according to the specified flag?
 516     virtual bool IsSelectionAligned(wxTextAttrAlignment alignment);
 517
 518     /// Apply bold to the selection
 519     virtual bool ApplyBoldToSelection();
 520
 521     /// Apply italic to the selection
 522     virtual bool ApplyItalicToSelection();
 523
 524     /// Apply underline to the selection
 525     virtual bool ApplyUnderlineToSelection();
 526
 527     /// Apply alignment to the selection
 528     virtual bool ApplyAlignmentToSelection(wxTextAttrAlignment alignment);
 529
 530     /// Apply a named style to the selection
 531     virtual bool ApplyStyle(wxRichTextStyleDefinition* def);
 532
 533     /// Set style sheet, if any.
 534     void SetStyleSheet(wxRichTextStyleSheet* styleSheet) { GetBuffer().SetStyleSheet(styleSheet); }
 535     wxRichTextStyleSheet* GetStyleSheet() const { return GetBuffer().GetStyleSheet(); }
 536
 537     /// Apply the style sheet to the buffer, for example if the styles have changed.
 538     bool ApplyStyleSheet(wxRichTextStyleSheet* styleSheet = NULL);
 539
 540 // Command handlers
 541
 542     void Command(wxCommandEvent& event);
 543     void OnDropFiles(wxDropFilesEvent& event);
 544
 545     void OnCut(wxCommandEvent& event);
 546     void OnCopy(wxCommandEvent& event);
 547     void OnPaste(wxCommandEvent& event);
 548     void OnUndo(wxCommandEvent& event);
 549     void OnRedo(wxCommandEvent& event);
 550     void OnSelectAll(wxCommandEvent& event);
 551     void OnClear(wxCommandEvent& event);
 552
 553     void OnUpdateCut(wxUpdateUIEvent& event);
 554     void OnUpdateCopy(wxUpdateUIEvent& event);
 555     void OnUpdatePaste(wxUpdateUIEvent& event);
 556     void OnUpdateUndo(wxUpdateUIEvent& event);
 557     void OnUpdateRedo(wxUpdateUIEvent& event);
 558     void OnUpdateSelectAll(wxUpdateUIEvent& event);
 559     void OnUpdateClear(wxUpdateUIEvent& event);
 560
 561     // Show a context menu for Rich Edit controls (the standard
 562     // EDIT control has one already)
 563     void OnContextMenu(wxContextMenuEvent& event);
 564
 565 // Event handlers
 566
 567     /// Painting
 568     void OnPaint(wxPaintEvent& event);
 569     void OnEraseBackground(wxEraseEvent& event);
 570
 571     /// Left-click
 572     void OnLeftClick(wxMouseEvent& event);
 573
 574     /// Left-up
 575     void OnLeftUp(wxMouseEvent& event);
 576
 577     /// Motion
 578     void OnMoveMouse(wxMouseEvent& event);
 579
 580     /// Left-double-click
 581     void OnLeftDClick(wxMouseEvent& event);
 582
 583     /// Middle-click
 584     void OnMiddleClick(wxMouseEvent& event);
 585
 586     /// Right-click
 587     void OnRightClick(wxMouseEvent& event);
 588
 589     /// Key press
 590     void OnChar(wxKeyEvent& event);
 591
 592     /// Sizing
 593     void OnSize(wxSizeEvent& event);
 594
 595     /// Setting/losing focus
 596     void OnSetFocus(wxFocusEvent& event);
 597     void OnKillFocus(wxFocusEvent& event);
 598
 599     /// Idle-time processing
 600     void OnIdle(wxIdleEvent& event);
 601
 602     /// Scrolling
 603     void OnScroll(wxScrollWinEvent& event);
 604
 605     /// Set font, and also default attributes
 606     virtual bool SetFont(const wxFont& font);
 607
 608     /// Set up scrollbars, e.g. after a resize
 609     virtual void SetupScrollbars(bool atTop = false);
 610
 611     /// Keyboard navigation
 612     virtual bool KeyboardNavigate(int keyCode, int flags);
 613
 614     /// Paint the background
 615     virtual void PaintBackground(wxDC& dc);
 616
 617 #if wxRICHTEXT_BUFFERED_PAINTING
 618     /// Recreate buffer bitmap if necessary
 619     virtual bool RecreateBuffer(const wxSize& size = wxDefaultSize);
 620 #endif
 621
 622     /// Set the selection
 623     virtual void DoSetSelection(long from, long to, bool scrollCaret = true);
 624
 625     /// Write text
 626     virtual void DoWriteText(const wxString& value, int flags = 0);
 627
 628     /// Should we inherit colours?
 629     virtual bool ShouldInheritColours() const { return false; }
 630
 631     /// Position the caret
 632     virtual void PositionCaret();
 633
 634     /// Extend the selection, returning true if the selection was
 635     /// changed. Selections are in caret positions.
 636     virtual bool ExtendSelection(long oldPosition, long newPosition, int flags);
 637
 638     /// Scroll into view. This takes a _caret_ position.
 639     virtual bool ScrollIntoView(long position, int keyCode);
 640
 641     /// The caret position is the character position just before the caret.
 642     /// A value of -1 means the caret is at the start of the buffer.
 643     void SetCaretPosition(long position, bool showAtLineStart = false) ;
 644     long GetCaretPosition() const { return m_caretPosition; }
 645
 646     /// The adjusted caret position is the character position adjusted to take
 647     /// into account whether we're at the start of a paragraph, in which case
 648     /// style information should be taken from the next position, not current one.
 649     long GetAdjustedCaretPosition(long caretPos) const;
 650
 651     /// Move caret one visual step forward: this may mean setting a flag
 652     /// and keeping the same position if we're going from the end of one line
 653     /// to the start of the next, which may be the exact same caret position.
 654     void MoveCaretForward(long oldPosition) ;
 655
 656     /// Move caret one visual step forward: this may mean setting a flag
 657     /// and keeping the same position if we're going from the end of one line
 658     /// to the start of the next, which may be the exact same caret position.
 659     void MoveCaretBack(long oldPosition) ;
 660
 661     /// Get the caret height and position for the given character position
 662     bool GetCaretPositionForIndex(long position, wxRect& rect);
 663
 664     /// Gets the line for the visible caret position. If the caret is
 665     /// shown at the very end of the line, it means the next character is actually
 666     /// on the following line. So let's get the line we're expecting to find
 667     /// if this is the case.
 668     wxRichTextLine* GetVisibleLineForCaretPosition(long caretPosition) const;
 669
 670     /// Gets the command processor
 671     wxCommandProcessor* GetCommandProcessor() const { return GetBuffer().GetCommandProcessor(); }
 672
 673     /// Delete content if there is a selection, e.g. when pressing a key.
 674     /// Returns the new caret position in newPos, or leaves it if there
 675     /// was no action.
 676     bool DeleteSelectedContent(long* newPos= NULL);
 677
 678     /// Transform logical to physical
 679     wxPoint GetPhysicalPoint(const wxPoint& ptLogical) const;
 680
 681     /// Transform physical to logical
 682     wxPoint GetLogicalPoint(const wxPoint& ptPhysical) const;
 683
 684     /// Finds the caret position for the next word. Direction
 685     /// is 1 (forward) or -1 (backwards).
 686     virtual long FindNextWordPosition(int direction = 1) const;
 687
 688     /// Is the given position visible on the screen?
 689     bool IsPositionVisible(long pos) const;
 690
 691     /// Returns the first visible position in the current view
 692     long GetFirstVisiblePosition() const;
 693
 694     /// Returns the caret position since the default formatting was changed. As
 695     /// soon as this position changes, we no longer reflect the default style
 696     /// in the UI. A value of -2 means that we should only reflect the style of the
 697     /// content under the caret.
 698     long GetCaretPositionForDefaultStyle() const { return m_caretPositionForDefaultStyle; }
 699
 700     /// Set the caret position for the default style that the user is selecting.
 701     void SetCaretPositionForDefaultStyle(long pos) { m_caretPositionForDefaultStyle = pos; }
 702
 703     /// Should the UI reflect the default style chosen by the user, rather than the style under
 704     /// the caret?
 705     bool IsDefaultStyleShowing() const { return m_caretPositionForDefaultStyle != -2; }
 706
 707     /// Convenience function that tells the control to start reflecting the default
 708     /// style, since the user is changing it.
 709     void SetAndShowDefaultStyle(const wxRichTextAttr& attr)
 710     {
 711         SetDefaultStyle(attr);
 712         SetCaretPositionForDefaultStyle(GetCaretPosition());
 713     }
 714
 715 // Implementation
 716
 717      WX_FORWARD_TO_SCROLL_HELPER()
 718
 719 // Overrides
 720 protected:
 721
 722     virtual wxSize DoGetBestSize() const ;
 723
 724     virtual void DoSetValue(const wxString& value, int flags = 0);
 725
 726
 727 // Data members
 728 private:
 729
 730     /// Allows nested Freeze/Thaw
 731     int                     m_freezeCount;
 732
 733 #if wxRICHTEXT_BUFFERED_PAINTING
 734     /// Buffer bitmap
 735     wxBitmap                m_bufferBitmap;
 736 #endif
 737
 738     /// Text buffer
 739     wxRichTextBuffer        m_buffer;
 740
 741     wxMenu*                 m_contextMenu;
 742
 743     /// Caret position (1 less than the character position, so -1 is the
 744     /// first caret position).
 745     long                    m_caretPosition;
 746
 747     /// Caret position when the default formatting has been changed. As
 748     /// soon as this position changes, we no longer reflect the default style
 749     /// in the UI.
 750     long                    m_caretPositionForDefaultStyle;
 751
 752     /// Selection range in character positions. -2, -2 means no selection.
 753     wxRichTextRange         m_selectionRange;
 754
 755     /// Anchor so we know how to extend the selection
 756     /// It's a caret position since it's between two characters.
 757     long                    m_selectionAnchor;
 758
 759     /// Are we editable?
 760     bool                    m_editable;
 761
 762     /// Are we showing the caret position at the start of a line
 763     /// instead of at the end of the previous one?
 764     bool                    m_caretAtLineStart;
 765
 766     /// Are we dragging a selection?
 767     bool                    m_dragging;
 768
 769     /// Start position for drag
 770     wxPoint                 m_dragStart;
 771
 772     /// Do we need full layout in idle?
 773     bool                    m_fullLayoutRequired;
 774     wxLongLong              m_fullLayoutTime;
 775     long                    m_fullLayoutSavedPosition;
 776
 777     /// Threshold for doing delayed layout
 778     long                    m_delayedLayoutThreshold;
 779 };
 780
 781 /*!
 782  * wxRichTextEvent - the event class for wxRichTextCtrl notifications
 783  */
 784
 785 class WXDLLIMPEXP_RICHTEXT wxRichTextEvent : public wxNotifyEvent
 786 {
 787 public:
 788     wxRichTextEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
 789         : wxNotifyEvent(commandType, winid),
 790         m_itemIndex(-1), m_flags(0)
 791         { }
 792
 793     wxRichTextEvent(const wxRichTextEvent& event)
 794         : wxNotifyEvent(event),
 795         m_itemIndex(event.m_itemIndex), m_flags(event.m_flags)
 796         { }
 797
 798     int GetIndex() const { return m_itemIndex; }
 799     void SetIndex(int n) { m_itemIndex = n; }
 800
 801     int GetFlags() const { return m_flags; }
 802     void SetFlags(int flags) { m_flags = flags; }
 803
 804     virtual wxEvent *Clone() const { return new wxRichTextEvent(*this); }
 805
 806 protected:
 807     int                 m_itemIndex;
 808     int                 m_flags;
 809
 810 private:
 811     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxRichTextEvent)
 812 };
 813
 814 /*!
 815  * wxRichTextCtrl event macros
 816  */
 817
 818 BEGIN_DECLARE_EVENT_TYPES()
 819     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_ITEM_SELECTED, 2600)
 820     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_ITEM_DESELECTED, 2601)
 821     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_LEFT_CLICK, 2602)
 822     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_RIGHT_CLICK, 2603)
 823     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK, 2604)
 824     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_LEFT_DCLICK, 2605)
 825     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_RETURN, 2606)
 826 END_DECLARE_EVENT_TYPES()
 827
 828 typedef void (wxEvtHandler::*wxRichTextEventFunction)(wxRichTextEvent&);
 829
 830 #define EVT_RICHTEXT_ITEM_SELECTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_ITEM_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxRichTextEventFunction, & fn ), NULL ),
 831 #define EVT_RICHTEXT_ITEM_DESELECTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_ITEM_DESELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxRichTextEventFunction, & fn ), NULL ),
 832 #define EVT_RICHTEXT_LEFT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_LEFT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxRichTextEventFunction, & fn ), NULL ),
 833 #define EVT_RICHTEXT_RIGHT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxRichTextEventFunction, & fn ), NULL ),
 834 #define EVT_RICHTEXT_MIDDLE_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxRichTextEventFunction, & fn ), NULL ),
 835 #define EVT_RICHTEXT_LEFT_DCLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_LEFT_DCLICK, id, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxRichTextEventFunction, & fn ), NULL ),
 836 #define EVT_RICHTEXT_RETURN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_RETURN, id, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxRichTextEventFunction, & fn ), NULL ),
 837
 838 #endif
 839     // wxUSE_RICHTEXT
 840
 841 #endif
 842     // _WX_RICHTEXTCTRL_H_
 843