interface/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 /*
  13  * Styles and flags
  14  */
  15
  16 /**
  17     Styles
  18 */
  19
  20 #define wxRE_READONLY          0x0010
  21 #define wxRE_MULTILINE         0x0020
  22 #define wxRE_CENTRE_CARET      0x8000
  23 #define wxRE_CENTER_CARET      wxRE_CENTRE_CARET
  24
  25 /**
  26     Flags
  27 */
  28
  29 #define wxRICHTEXT_SHIFT_DOWN  0x01
  30 #define wxRICHTEXT_CTRL_DOWN   0x02
  31 #define wxRICHTEXT_ALT_DOWN    0x04
  32
  33 /**
  34     Extra flags
  35 */
  36
  37 // Don't draw guide lines around boxes and tables
  38 #define wxRICHTEXT_EX_NO_GUIDELINES 0x00000100
  39
  40
  41 /*
  42     Defaults
  43 */
  44
  45 #define wxRICHTEXT_DEFAULT_OVERALL_SIZE wxSize(-1, -1)
  46 #define wxRICHTEXT_DEFAULT_IMAGE_SIZE wxSize(80, 80)
  47 #define wxRICHTEXT_DEFAULT_SPACING 3
  48 #define wxRICHTEXT_DEFAULT_MARGIN 3
  49 #define wxRICHTEXT_DEFAULT_UNFOCUSSED_BACKGROUND wxColour(175, 175, 175)
  50 #define wxRICHTEXT_DEFAULT_FOCUSSED_BACKGROUND wxColour(140, 140, 140)
  51 #define wxRICHTEXT_DEFAULT_UNSELECTED_BACKGROUND wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE)
  52 #define wxRICHTEXT_DEFAULT_TYPE_COLOUR wxColour(0, 0, 200)
  53 #define wxRICHTEXT_DEFAULT_FOCUS_RECT_COLOUR wxColour(100, 80, 80)
  54 #define wxRICHTEXT_DEFAULT_CARET_WIDTH 2
  55 // Minimum buffer size before delayed layout kicks in
  56 #define wxRICHTEXT_DEFAULT_DELAYED_LAYOUT_THRESHOLD 20000
  57 // Milliseconds before layout occurs after resize
  58 #define wxRICHTEXT_DEFAULT_LAYOUT_INTERVAL 50
  59
  60 /* Identifiers
  61  */
  62 #define wxID_RICHTEXT_PROPERTIES1   (wxID_HIGHEST + 1)
  63 #define wxID_RICHTEXT_PROPERTIES2   (wxID_HIGHEST + 2)
  64 #define wxID_RICHTEXT_PROPERTIES3   (wxID_HIGHEST + 3)
  65
  66 /*
  67     Normal selection occurs initially and as user drags within one container.
  68     Common ancestor selection occurs when the user starts dragging across containers
  69     that have a common ancestor, for example the cells in a table.
  70  */
  71
  72 enum wxRichTextCtrlSelectionState
  73 {
  74     wxRichTextCtrlSelectionState_Normal,
  75     wxRichTextCtrlSelectionState_CommonAncestor
  76 };
  77
  78 /**
  79     @class wxRichTextContextMenuPropertiesInfo
  80
  81     wxRichTextContextMenuPropertiesInfo keeps track of objects that appear in the context menu,
  82     whose properties are available to be edited.
  83  */
  84
  85 class WXDLLIMPEXP_RICHTEXT wxRichTextContextMenuPropertiesInfo
  86 {
  87 public:
  88     /**
  89         Constructor.
  90     */
  91     wxRichTextContextMenuPropertiesInfo() { Init(); }
  92
  93 // Operations
  94
  95     /**
  96         Initialisation.
  97     */
  98     void Init() {}
  99
 100     /**
 101         Adds an item.
 102     */
 103     bool AddItem(const wxString& label, wxRichTextObject* obj);
 104
 105     /**
 106         Returns the number of menu items that were added.
 107     */
 108     int AddMenuItems(wxMenu* menu, int startCmd = wxID_RICHTEXT_PROPERTIES1) const;
 109
 110     /**
 111         Adds appropriate menu items for the current container and clicked on object
 112         (and container's parent, if appropriate).
 113     */
 114     int AddItems(wxRichTextObject* container, wxRichTextObject* obj);
 115
 116     /**
 117         Clears the items.
 118     */
 119     void Clear() { m_objects.Clear(); m_labels.Clear(); }
 120
 121 // Accessors
 122
 123     /**
 124         Returns the nth label.
 125     */
 126     wxString GetLabel(int n) const { return m_labels[n]; }
 127
 128     /**
 129         Returns the nth object.
 130     */
 131     wxRichTextObject* GetObject(int n) const { return m_objects[n]; }
 132
 133     /**
 134         Returns the array of objects.
 135     */
 136     wxRichTextObjectPtrArray& GetObjects() { return m_objects; }
 137
 138     /**
 139         Returns the array of objects.
 140     */
 141     const wxRichTextObjectPtrArray& GetObjects() const { return m_objects; }
 142
 143     /**
 144         Returns the array of labels.
 145     */
 146     wxArrayString& GetLabels() { return m_labels; }
 147
 148     /**
 149         Returns the array of labels.
 150     */
 151     const wxArrayString& GetLabels() const { return m_labels; }
 152
 153     /**
 154         Returns the number of items.
 155     */
 156     int GetCount() const { return m_objects.GetCount(); }
 157
 158     wxRichTextObjectPtrArray    m_objects;
 159     wxArrayString               m_labels;
 160 };
 161
 162 /**
 163     @class wxRichTextCtrl
 164
 165     wxRichTextCtrl provides a generic, ground-up implementation of a text control
 166     capable of showing multiple styles and images.
 167
 168     wxRichTextCtrl sends notification events: see wxRichTextEvent.
 169
 170     It also sends the standard wxTextCtrl events @c wxEVT_COMMAND_TEXT_ENTER and
 171     @c wxEVT_COMMAND_TEXT_UPDATED, and wxTextUrlEvent when URL content is clicked.
 172
 173     For more information, see the @ref overview_richtextctrl.
 174
 175     @beginStyleTable
 176     @style{wxRE_CENTRE_CARET}
 177            The control will try to keep the caret line centred vertically while editing.
 178            wxRE_CENTER_CARET is a synonym for this style.
 179     @style{wxRE_MULTILINE}
 180            The control will be multiline (mandatory).
 181     @style{wxRE_READONLY}
 182            The control will not be editable.
 183     @endStyleTable
 184
 185     @library{wxrichtext}
 186     @category{richtext}
 187     @appearance{richtextctrl.png}
 188
 189  */
 190
 191 class WXDLLIMPEXP_RICHTEXT wxRichTextCtrl : public wxControl,
 192                                             public wxTextCtrlIface,
 193                                             public wxScrollHelper
 194 {
 195     DECLARE_CLASS( wxRichTextCtrl )
 196     DECLARE_EVENT_TABLE()
 197
 198 public:
 199 // Constructors
 200
 201     /**
 202         Default constructor.
 203     */
 204     wxRichTextCtrl( );
 205
 206     /**
 207         Constructor, creating and showing a rich text control.
 208
 209         @param parent
 210             Parent window. Must not be @NULL.
 211         @param id
 212             Window identifier. The value @c wxID_ANY indicates a default value.
 213         @param value
 214             Default string.
 215         @param pos
 216             Window position.
 217         @param size
 218             Window size.
 219         @param style
 220             Window style.
 221         @param validator
 222             Window validator.
 223         @param name
 224             Window name.
 225
 226         @see Create(), wxValidator
 227     */
 228     wxRichTextCtrl( wxWindow* parent, wxWindowID id = -1, const wxString& value = wxEmptyString, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
 229         long style = wxRE_MULTILINE, const wxValidator& validator = wxDefaultValidator, const wxString& name = wxTextCtrlNameStr);
 230
 231     /**
 232         Destructor.
 233     */
 234     virtual ~wxRichTextCtrl( );
 235
 236 // Operations
 237
 238     /**
 239         Creates the underlying window.
 240     */
 241     bool Create( wxWindow* parent, wxWindowID id = -1, const wxString& value = wxEmptyString, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
 242         long style = wxRE_MULTILINE, const wxValidator& validator = wxDefaultValidator, const wxString& name = wxTextCtrlNameStr );
 243
 244     /**
 245         Initialises the members of the control.
 246     */
 247     void Init();
 248
 249 // Accessors
 250
 251     /**
 252         Gets the text for the given range.
 253         The end point of range is specified as the last character position of
 254         the span of text, plus one.
 255     */
 256     virtual wxString GetRange(long from, long to) const;
 257
 258     /**
 259         Returns the length of the specified line in characters.
 260     */
 261     virtual int GetLineLength(long lineNo) const ;
 262
 263     /**
 264         Returns the text for the given line.
 265     */
 266     virtual wxString GetLineText(long lineNo) const ;
 267
 268     /**
 269         Returns the number of lines in the buffer.
 270     */
 271     virtual int GetNumberOfLines() const ;
 272
 273     /**
 274         Returns @true if the buffer has been modified.
 275     */
 276     virtual bool IsModified() const ;
 277
 278     /**
 279         Returns @true if the control is editable.
 280     */
 281     virtual bool IsEditable() const ;
 282
 283     /**
 284         Returns @true if the control is single-line.
 285         Currently wxRichTextCtrl does not support single-line editing.
 286     */
 287     bool IsSingleLine() const { return !HasFlag(wxRE_MULTILINE); }
 288
 289     /**
 290         Returns @true if the control is multiline.
 291     */
 292     bool IsMultiLine() const { return !IsSingleLine(); }
 293
 294     //@{
 295     /**
 296         Returns the range of the current selection.
 297         The end point of range is specified as the last character position of the span
 298         of text, plus one.
 299         If the return values @a from and @a to are the same, there is no selection.
 300     */
 301     virtual void GetSelection(long* from, long* to) const;
 302     const wxRichTextSelection& GetSelection() const { return m_selection; }
 303     wxRichTextSelection& GetSelection() { return m_selection; }
 304     //@}
 305
 306     /**
 307         Returns the text within the current selection range, if any.
 308     */
 309     virtual wxString GetStringSelection() const;
 310
 311     /**
 312         Gets the current filename associated with the control.
 313     */
 314     wxString GetFilename() const { return m_filename; }
 315
 316     /**
 317         Sets the current filename.
 318     */
 319     void SetFilename(const wxString& filename) { m_filename = filename; }
 320
 321     /**
 322         Sets the size of the buffer beyond which layout is delayed during resizing.
 323         This optimizes sizing for large buffers. The default is 20000.
 324     */
 325     void SetDelayedLayoutThreshold(long threshold) { m_delayedLayoutThreshold = threshold; }
 326
 327     /**
 328         Gets the size of the buffer beyond which layout is delayed during resizing.
 329         This optimizes sizing for large buffers. The default is 20000.
 330     */
 331     long GetDelayedLayoutThreshold() const { return m_delayedLayoutThreshold; }
 332
 333     /**
 334     */
 335     bool GetFullLayoutRequired() const { return m_fullLayoutRequired; }
 336
 337     /**
 338     */
 339     void SetFullLayoutRequired(bool b) { m_fullLayoutRequired = b; }
 340
 341     /**
 342     */
 343     wxLongLong GetFullLayoutTime() const { return m_fullLayoutTime; }
 344
 345     /**
 346     */
 347     void SetFullLayoutTime(wxLongLong t) { m_fullLayoutTime = t; }
 348
 349     /**
 350     */
 351     long GetFullLayoutSavedPosition() const { return m_fullLayoutSavedPosition; }
 352
 353     /**
 354     */
 355     void SetFullLayoutSavedPosition(long p) { m_fullLayoutSavedPosition = p; }
 356
 357     // Force any pending layout due to large buffer
 358     /**
 359     */
 360     void ForceDelayedLayout();
 361
 362     /**
 363         Sets the text (normal) cursor.
 364     */
 365     void SetTextCursor(const wxCursor& cursor ) { m_textCursor = cursor; }
 366
 367     /**
 368         Returns the text (normal) cursor.
 369     */
 370     wxCursor GetTextCursor() const { return m_textCursor; }
 371
 372     /**
 373         Sets the cursor to be used over URLs.
 374     */
 375     void SetURLCursor(const wxCursor& cursor ) { m_urlCursor = cursor; }
 376
 377     /**
 378         Returns the cursor to be used over URLs.
 379     */
 380     wxCursor GetURLCursor() const { return m_urlCursor; }
 381
 382     /**
 383         Returns @true if we are showing the caret position at the start of a line
 384         instead of at the end of the previous one.
 385     */
 386     bool GetCaretAtLineStart() const { return m_caretAtLineStart; }
 387
 388     /**
 389         Sets a flag to remember that we are showing the caret position at the start of a line
 390         instead of at the end of the previous one.
 391     */
 392     void SetCaretAtLineStart(bool atStart) { m_caretAtLineStart = atStart; }
 393
 394     /**
 395         Returns @true if we are extending a selection.
 396     */
 397     bool GetDragging() const { return m_dragging; }
 398
 399     /**
 400         Sets a flag to remember if we are extending a selection.
 401     */
 402     void SetDragging(bool dragging) { m_dragging = dragging; }
 403
 404     /**
 405         Are we trying to start Drag'n'Drop?
 406     */
 407     bool GetPreDrag() const { return m_preDrag; }
 408
 409     /**
 410         Set if we're trying to start Drag'n'Drop
 411     */
 412     void SetPreDrag(bool pd) { m_preDrag = pd; }
 413
 414     /**
 415         Get the possible Drag'n'Drop start point
 416     */
 417     const wxPoint GetDragStartPoint() const { return m_dragStartPoint; }
 418
 419     /**
 420         Set the possible Drag'n'Drop start point
 421     */
 422     void SetDragStartPoint(wxPoint sp) { m_dragStartPoint = sp; }
 423
 424     /**
 425         Get the possible Drag'n'Drop start time
 426     */
 427     const wxDateTime GetDragStartTime() const { return m_dragStartTime; }
 428
 429     /**
 430         Set the possible Drag'n'Drop start time
 431     */
 432     void SetDragStartTime(wxDateTime st) { m_dragStartTime = st; }
 433
 434 #if wxRICHTEXT_BUFFERED_PAINTING
 435     //@{
 436     /**
 437         Returns the buffer bitmap if using buffered painting.
 438     */
 439     const wxBitmap& GetBufferBitmap() const { return m_bufferBitmap; }
 440     wxBitmap& GetBufferBitmap() { return m_bufferBitmap; }
 441     //@}
 442 #endif
 443
 444     /**
 445         Returns the current context menu.
 446     */
 447     wxMenu* GetContextMenu() const { return m_contextMenu; }
 448
 449     /**
 450         Sets the current context menu.
 451     */
 452     void SetContextMenu(wxMenu* menu);
 453
 454     /**
 455         Returns an anchor so we know how to extend the selection.
 456         It's a caret position since it's between two characters.
 457     */
 458     long GetSelectionAnchor() const { return m_selectionAnchor; }
 459
 460     /**
 461         Sets an anchor so we know how to extend the selection.
 462         It's a caret position since it's between two characters.
 463     */
 464     void SetSelectionAnchor(long anchor) { m_selectionAnchor = anchor; }
 465
 466     /**
 467         Returns the anchor object if selecting multiple containers.
 468     */
 469     wxRichTextObject* GetSelectionAnchorObject() const { return m_selectionAnchorObject; }
 470
 471     /**
 472         Sets the anchor object if selecting multiple containers.
 473     */
 474     void SetSelectionAnchorObject(wxRichTextObject* anchor) { m_selectionAnchorObject = anchor; }
 475
 476     //@{
 477     /**
 478         Returns an object that stores information about context menu property item(s),
 479         in order to communicate between the context menu event handler and the code
 480         that responds to it. The wxRichTextContextMenuPropertiesInfo stores one
 481         item for each object that could respond to a property-editing event. If
 482         objects are nested, several might be editable.
 483     */
 484     wxRichTextContextMenuPropertiesInfo& GetContextMenuPropertiesInfo() { return m_contextMenuPropertiesInfo; }
 485     const wxRichTextContextMenuPropertiesInfo& GetContextMenuPropertiesInfo() const { return m_contextMenuPropertiesInfo; }
 486     //@}
 487
 488     /**
 489         Returns the wxRichTextObject object that currently has the editing focus.
 490         If there are no composite objects, this will be the top-level buffer.
 491     */
 492     wxRichTextParagraphLayoutBox* GetFocusObject() const { return m_focusObject; }
 493
 494     /**
 495         Setter for m_focusObject.
 496     */
 497     void StoreFocusObject(wxRichTextParagraphLayoutBox* obj);
 498
 499     /**
 500         Sets the wxRichTextObject object that currently has the editing focus.
 501         @param setCaretPosition
 502             Optionally set the caret position.
 503     */
 504     bool SetFocusObject(wxRichTextParagraphLayoutBox* obj, bool setCaretPosition = true);
 505
 506 // Operations
 507
 508     /**
 509         Invalidates the whole buffer to trigger painting later.
 510     */
 511     void Invalidate() { GetBuffer().Invalidate(wxRICHTEXT_ALL); }
 512
 513     /**
 514         Clears the buffer content, leaving a single empty paragraph. Cannot be undone.
 515     */
 516     virtual void Clear();
 517
 518     /**
 519         Replaces the content in the specified range with the string specified by
 520         @a value.
 521     */
 522     virtual void Replace(long from, long to, const wxString& value);
 523
 524     /**
 525         Removes the content in the specified range.
 526     */
 527     virtual void Remove(long from, long to);
 528
 529 #ifdef DOXYGEN
 530     /**
 531         Loads content into the control's buffer using the given type.
 532
 533         If the specified type is wxRICHTEXT_TYPE_ANY, the type is deduced from
 534         the filename extension.
 535
 536         This function looks for a suitable wxRichTextFileHandler object.
 537     */
 538     bool LoadFile(const wxString& file,
 539                   int type = wxRICHTEXT_TYPE_ANY);
 540 #endif
 541
 542     /**
 543         Helper function for LoadFile(). Loads content into the control's buffer using the given type.
 544
 545         If the specified type is wxRICHTEXT_TYPE_ANY, the type is deduced from
 546         the filename extension.
 547
 548         This function looks for a suitable wxRichTextFileHandler object.
 549     */
 550     virtual bool DoLoadFile(const wxString& file, int fileType);
 551
 552 #ifdef DOXYGEN
 553     /**
 554         Saves the buffer content using the given type.
 555
 556         If the specified type is wxRICHTEXT_TYPE_ANY, the type is deduced from
 557         the filename extension.
 558
 559         This function looks for a suitable wxRichTextFileHandler object.
 560     */
 561     bool SaveFile(const wxString& file = wxEmptyString,
 562                   int type = wxRICHTEXT_TYPE_ANY);
 563 #endif
 564
 565     /**
 566         Helper function for SaveFile(). Saves the buffer content using the given type.
 567
 568         If the specified type is wxRICHTEXT_TYPE_ANY, the type is deduced from
 569         the filename extension.
 570
 571         This function looks for a suitable wxRichTextFileHandler object.
 572     */
 573     virtual bool DoSaveFile(const wxString& file = wxEmptyString,
 574                             int fileType = wxRICHTEXT_TYPE_ANY);
 575
 576     /**
 577         Sets flags that change the behaviour of loading or saving.
 578
 579         See the documentation for each handler class to see what flags are
 580         relevant for each handler.
 581     */
 582     void SetHandlerFlags(int flags) { GetBuffer().SetHandlerFlags(flags); }
 583
 584     /**
 585         Returns flags that change the behaviour of loading or saving.
 586         See the documentation for each handler class to see what flags are
 587         relevant for each handler.
 588     */
 589     int GetHandlerFlags() const { return GetBuffer().GetHandlerFlags(); }
 590
 591     /**
 592         Marks the buffer as modified.
 593     */
 594     virtual void MarkDirty();
 595
 596     /**
 597         Sets the buffer's modified status to @false, and clears the buffer's command
 598         history.
 599     */
 600     virtual void DiscardEdits();
 601
 602     /**
 603         Sets the maximum number of characters that may be entered in a single line
 604         text control. For compatibility only; currently does nothing.
 605     */
 606     virtual void SetMaxLength(unsigned long WXUNUSED(len)) { }
 607
 608     /**
 609         Writes text at the current position.
 610     */
 611     virtual void WriteText(const wxString& text);
 612
 613     /**
 614         Sets the insertion point to the end of the buffer and writes the text.
 615     */
 616     virtual void AppendText(const wxString& text);
 617
 618     //@{
 619     /**
 620         Gets the attributes at the given position.
 621         This function gets the combined style - that is, the style you see on the
 622         screen as a result of combining base style, paragraph style and character
 623         style attributes.
 624
 625         To get the character or paragraph style alone, use GetUncombinedStyle().
 626
 627         @beginWxPerlOnly
 628         In wxPerl this method is implemented as GetStyle(@a position)
 629         returning a 2-element list (ok, attr).
 630         @endWxPerlOnly
 631     */
 632     virtual bool GetStyle(long position, wxTextAttr& style);
 633     virtual bool GetStyle(long position, wxRichTextAttr& style);
 634     virtual bool GetStyle(long position, wxRichTextAttr& style, wxRichTextParagraphLayoutBox* container);
 635     //@}
 636
 637     //@{
 638     /**
 639         Sets the attributes for the given range.
 640         The end point of range is specified as the last character position of the span
 641         of text, plus one.
 642
 643         So, for example, to set the style for a character at position 5, use the range
 644         (5,6).
 645     */
 646     virtual bool SetStyle(long start, long end, const wxTextAttr& style);
 647     virtual bool SetStyle(long start, long end, const wxRichTextAttr& style);
 648     virtual bool SetStyle(const wxRichTextRange& range, const wxTextAttr& style);
 649     virtual bool SetStyle(const wxRichTextRange& range, const wxRichTextAttr& style);
 650     //@}
 651
 652     /**
 653         Sets the attributes for a single object
 654     */
 655     virtual void SetStyle(wxRichTextObject *obj, const wxRichTextAttr& textAttr);
 656
 657     //@{
 658     /**
 659         Gets the attributes common to the specified range.
 660         Attributes that differ in value within the range will not be included
 661         in @a style flags.
 662
 663         @beginWxPerlOnly
 664         In wxPerl this method is implemented as GetStyleForRange(@a position)
 665         returning a 2-element list (ok, attr).
 666         @endWxPerlOnly
 667     */
 668     virtual bool GetStyleForRange(const wxRichTextRange& range, wxTextAttr& style);
 669     virtual bool GetStyleForRange(const wxRichTextRange& range, wxRichTextAttr& style);
 670     virtual bool GetStyleForRange(const wxRichTextRange& range, wxRichTextAttr& style, wxRichTextParagraphLayoutBox* container);
 671     //@}
 672
 673     /**
 674         Sets the attributes for the given range, passing flags to determine how the
 675         attributes are set.
 676
 677         The end point of range is specified as the last character position of the span
 678         of text, plus one. So, for example, to set the style for a character at
 679         position 5, use the range (5,6).
 680
 681         @a flags may contain a bit list of the following values:
 682         - wxRICHTEXT_SETSTYLE_NONE: no style flag.
 683         - wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this operation should be
 684           undoable.
 685         - wxRICHTEXT_SETSTYLE_OPTIMIZE: specifies that the style should not be applied
 686           if the combined style at this point is already the style in question.
 687         - wxRICHTEXT_SETSTYLE_PARAGRAPHS_ONLY: specifies that the style should only be
 688           applied to paragraphs, and not the content.
 689           This allows content styling to be preserved independently from that
 690           of e.g. a named paragraph style.
 691         - wxRICHTEXT_SETSTYLE_CHARACTERS_ONLY: specifies that the style should only be
 692           applied to characters, and not the paragraph.
 693           This allows content styling to be preserved independently from that
 694           of e.g. a named paragraph style.
 695         - wxRICHTEXT_SETSTYLE_RESET: resets (clears) the existing style before applying
 696           the new style.
 697         - wxRICHTEXT_SETSTYLE_REMOVE: removes the specified style. Only the style flags
 698           are used in this operation.
 699     */
 700     virtual bool SetStyleEx(const wxRichTextRange& range, const wxRichTextAttr& style, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
 701
 702     //@{
 703     /**
 704         Gets the attributes at the given position.
 705         This function gets the @e uncombined style - that is, the attributes associated
 706         with the paragraph or character content, and not necessarily the combined
 707         attributes you see on the screen.
 708         To get the combined attributes, use GetStyle().
 709
 710         If you specify (any) paragraph attribute in @e style's flags, this function
 711         will fetch the paragraph attributes.
 712         Otherwise, it will return the character attributes.
 713
 714         @beginWxPerlOnly
 715         In wxPerl this method is implemented as GetUncombinedStyle(@a position)
 716         returning a 2-element list (ok, attr).
 717         @endWxPerlOnly
 718     */
 719     virtual bool GetUncombinedStyle(long position, wxRichTextAttr& style);
 720     virtual bool GetUncombinedStyle(long position, wxRichTextAttr& style, wxRichTextParagraphLayoutBox* container);
 721     //@}
 722
 723     //@{
 724     /**
 725         Sets the current default style, which can be used to change how subsequently
 726         inserted text is displayed.
 727     */
 728     virtual bool SetDefaultStyle(const wxTextAttr& style);
 729     virtual bool SetDefaultStyle(const wxRichTextAttr& style);
 730     //@}
 731
 732     /**
 733         Returns the current default style, which can be used to change how subsequently
 734         inserted text is displayed.
 735     */
 736     virtual const wxRichTextAttr& GetDefaultStyleEx() const;
 737
 738     //virtual const wxTextAttr& GetDefaultStyle() const;
 739
 740     //@{
 741     /**
 742         Sets the list attributes for the given range, passing flags to determine how
 743         the attributes are set.
 744
 745         Either the style definition or the name of the style definition (in the current
 746         sheet) can be passed.
 747         @a flags is a bit list of the following:
 748         - wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
 749         - wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from
 750           @a startFrom, otherwise existing attributes are used.
 751         - wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used
 752           as the level for all paragraphs, otherwise the current indentation will be used.
 753
 754         @see NumberList(), PromoteList(), ClearListStyle().
 755     */
 756     virtual bool SetListStyle(const wxRichTextRange& range, wxRichTextListStyleDefinition* def, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1);
 757     virtual bool SetListStyle(const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1);
 758     //@}
 759
 760     /**
 761         Clears the list style from the given range, clearing list-related attributes
 762         and applying any named paragraph style associated with each paragraph.
 763
 764         @a flags is a bit list of the following:
 765         - wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
 766
 767         @see SetListStyle(), PromoteList(), NumberList().
 768     */
 769     virtual bool ClearListStyle(const wxRichTextRange& range, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
 770
 771     //@{
 772     /**
 773         Numbers the paragraphs in the given range.
 774         Pass flags to determine how the attributes are set.
 775
 776         Either the style definition or the name of the style definition (in the current
 777         sheet) can be passed.
 778
 779         @a flags is a bit list of the following:
 780         - wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
 781         - wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from
 782           @a startFrom, otherwise existing attributes are used.
 783         - wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used
 784           as the level for all paragraphs, otherwise the current indentation will be used.
 785
 786         @see SetListStyle(), PromoteList(), ClearListStyle().
 787     */
 788     virtual bool NumberList(const wxRichTextRange& range, wxRichTextListStyleDefinition* def = NULL, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1);
 789     virtual bool NumberList(const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1);
 790     //@}
 791
 792     //@{
 793     /**
 794         Promotes or demotes the paragraphs in the given range.
 795         A positive @a promoteBy produces a smaller indent, and a negative number
 796         produces a larger indent. Pass flags to determine how the attributes are set.
 797         Either the style definition or the name of the style definition (in the current
 798         sheet) can be passed.
 799
 800         @a flags is a bit list of the following:
 801         - wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
 802         - wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from
 803           @a startFrom, otherwise existing attributes are used.
 804         - wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used
 805         as the level for all paragraphs, otherwise the current indentation will be used.
 806
 807         @see SetListStyle(), @see SetListStyle(), ClearListStyle().
 808     */
 809     virtual bool PromoteList(int promoteBy, const wxRichTextRange& range, wxRichTextListStyleDefinition* def = NULL, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int specifiedLevel = -1);
 810     virtual bool PromoteList(int promoteBy, const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int specifiedLevel = -1);
 811     //@}
 812
 813     /**
 814         Deletes the content within the given range.
 815     */
 816     virtual bool Delete(const wxRichTextRange& range);
 817
 818     /**
 819         Translates from column and line number to position.
 820     */
 821     virtual long XYToPosition(long x, long y) const;
 822
 823     /**
 824         Converts a text position to zero-based column and line numbers.
 825     */
 826     virtual bool PositionToXY(long pos, long *x, long *y) const;
 827
 828     /**
 829         Scrolls the buffer so that the given position is in view.
 830     */
 831     virtual void ShowPosition(long pos);
 832
 833     //@{
 834     /**
 835         Finds the character at the given position in pixels.
 836         @a pt is in device coords (not adjusted for the client area origin nor for
 837         scrolling).
 838     */
 839     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
 840     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
 841                                             wxTextCoord *col,
 842                                             wxTextCoord *row) const;
 843
 844     /**
 845         Finds the container at the given point, which is assumed to be in client coordinates.
 846     */
 847     wxRichTextParagraphLayoutBox* FindContainerAtPoint(const wxPoint pt, long& position, int& hit, wxRichTextObject* hitObj, int flags = 0);
 848     //@}
 849
 850 // Clipboard operations
 851
 852     /**
 853         Copies the selected content (if any) to the clipboard.
 854     */
 855     virtual void Copy();
 856
 857     /**
 858         Copies the selected content (if any) to the clipboard and deletes the selection.
 859         This is undoable.
 860     */
 861     virtual void Cut();
 862
 863     /**
 864         Pastes content from the clipboard to the buffer.
 865     */
 866     virtual void Paste();
 867
 868     /**
 869         Deletes the content in the selection, if any. This is undoable.
 870     */
 871     virtual void DeleteSelection();
 872
 873     /**
 874         Returns @true if selected content can be copied to the clipboard.
 875     */
 876     virtual bool CanCopy() const;
 877
 878     /**
 879         Returns @true if selected content can be copied to the clipboard and deleted.
 880     */
 881     virtual bool CanCut() const;
 882
 883     /**
 884         Returns @true if the clipboard content can be pasted to the buffer.
 885     */
 886     virtual bool CanPaste() const;
 887
 888     /**
 889         Returns @true if selected content can be deleted.
 890     */
 891     virtual bool CanDeleteSelection() const;
 892
 893     /**
 894         Undoes the command at the top of the command history, if there is one.
 895     */
 896     virtual void Undo();
 897
 898     /**
 899         Redoes the current command.
 900     */
 901     virtual void Redo();
 902
 903     /**
 904         Returns @true if there is a command in the command history that can be undone.
 905     */
 906     virtual bool CanUndo() const;
 907
 908     /**
 909         Returns @true if there is a command in the command history that can be redone.
 910     */
 911     virtual bool CanRedo() const;
 912
 913     /**
 914         Sets the insertion point and causes the current editing style to be taken from
 915         the new position (unlike wxRichTextCtrl::SetCaretPosition).
 916     */
 917     virtual void SetInsertionPoint(long pos);
 918
 919     /**
 920         Sets the insertion point to the end of the text control.
 921     */
 922     virtual void SetInsertionPointEnd();
 923
 924     /**
 925         Returns the current insertion point.
 926     */
 927     virtual long GetInsertionPoint() const;
 928
 929     /**
 930         Returns the last position in the buffer.
 931     */
 932     virtual wxTextPos GetLastPosition() const;
 933
 934     //@{
 935     /**
 936         Sets the selection to the given range.
 937         The end point of range is specified as the last character position of the span
 938         of text, plus one.
 939
 940         So, for example, to set the selection for a character at position 5, use the
 941         range (5,6).
 942     */
 943     virtual void SetSelection(long from, long to);
 944     void SetSelection(const wxRichTextSelection& sel) { m_selection = sel; }
 945     //@}
 946
 947
 948     /**
 949         Selects all the text in the buffer.
 950     */
 951     virtual void SelectAll();
 952
 953     /**
 954         Makes the control editable, or not.
 955     */
 956     virtual void SetEditable(bool editable);
 957
 958     /**
 959         Returns @true if there is a selection and the object containing the selection
 960         was the same as the current focus object.
 961     */
 962     virtual bool HasSelection() const;
 963
 964     /**
 965         Returns @true if there was a selection, whether or not the current focus object
 966         is the same as the selection's container object.
 967     */
 968     virtual bool HasUnfocusedSelection() const;
 969
 970     //@{
 971     /**
 972         Write a bitmap or image at the current insertion point.
 973         Supply an optional type to use for internal and file storage of the raw data.
 974     */
 975     virtual bool WriteImage(const wxImage& image, wxBitmapType bitmapType = wxBITMAP_TYPE_PNG,
 976                             const wxRichTextAttr& textAttr = wxRichTextAttr());
 977
 978     virtual bool WriteImage(const wxBitmap& bitmap, wxBitmapType bitmapType = wxBITMAP_TYPE_PNG,
 979                             const wxRichTextAttr& textAttr = wxRichTextAttr());
 980     //@}
 981
 982     /**
 983         Loads an image from a file and writes it at the current insertion point.
 984     */
 985     virtual bool WriteImage(const wxString& filename, wxBitmapType bitmapType,
 986                             const wxRichTextAttr& textAttr = wxRichTextAttr());
 987
 988     /**
 989         Writes an image block at the current insertion point.
 990     */
 991     virtual bool WriteImage(const wxRichTextImageBlock& imageBlock,
 992                             const wxRichTextAttr& textAttr = wxRichTextAttr());
 993
 994     /**
 995         Write a text box at the current insertion point, returning the text box.
 996         You can then call SetFocusObject() to set the focus to the new object.
 997     */
 998     virtual wxRichTextBox* WriteTextBox(const wxRichTextAttr& textAttr = wxRichTextAttr());
 999
1000     /**
1001         Write a table at the current insertion point, returning the table.
1002         You can then call SetFocusObject() to set the focus to the new object.
1003     */
1004     virtual wxRichTextTable* WriteTable(int rows, int cols, const wxRichTextAttr& tableAttr = wxRichTextAttr(), const wxRichTextAttr& cellAttr = wxRichTextAttr());
1005
1006     /**
1007         Inserts a new paragraph at the current insertion point. @see LineBreak().
1008     */
1009     virtual bool Newline();
1010
1011     /**
1012         Inserts a line break at the current insertion point.
1013
1014         A line break forces wrapping within a paragraph, and can be introduced by
1015         using this function, by appending the wxChar value @b  wxRichTextLineBreakChar
1016         to text content, or by typing Shift-Return.
1017     */
1018     virtual bool LineBreak();
1019
1020     /**
1021         Sets the basic (overall) style.
1022
1023         This is the style of the whole buffer before further styles are applied,
1024         unlike the default style, which only affects the style currently being
1025         applied (for example, setting the default style to bold will cause
1026         subsequently inserted text to be bold).
1027     */
1028     virtual void SetBasicStyle(const wxRichTextAttr& style) { GetBuffer().SetBasicStyle(style); }
1029
1030     /**
1031         Gets the basic (overall) style.
1032
1033         This is the style of the whole buffer before further styles are applied,
1034         unlike the default style, which only affects the style currently being
1035         applied (for example, setting the default style to bold will cause
1036         subsequently inserted text to be bold).
1037     */
1038     virtual const wxRichTextAttr& GetBasicStyle() const { return GetBuffer().GetBasicStyle(); }
1039
1040     /**
1041         Begins applying a style.
1042     */
1043     virtual bool BeginStyle(const wxRichTextAttr& style) { return GetBuffer().BeginStyle(style); }
1044
1045     /**
1046         Ends the current style.
1047     */
1048     virtual bool EndStyle() { return GetBuffer().EndStyle(); }
1049
1050     /**
1051         Ends application of all styles in the current style stack.
1052     */
1053     virtual bool EndAllStyles() { return GetBuffer().EndAllStyles(); }
1054
1055     /**
1056         Begins using bold.
1057     */
1058     bool BeginBold() { return GetBuffer().BeginBold(); }
1059
1060     /**
1061         Ends using bold.
1062     */
1063     bool EndBold()  { return GetBuffer().EndBold(); }
1064
1065     /**
1066         Begins using italic.
1067     */
1068     bool BeginItalic() { return GetBuffer().BeginItalic(); }
1069
1070     /**
1071         Ends using italic.
1072     */
1073     bool EndItalic() { return GetBuffer().EndItalic(); }
1074
1075     /**
1076         Begins using underlining.
1077     */
1078     bool BeginUnderline() { return GetBuffer().BeginUnderline(); }
1079
1080     /**
1081         End applying underlining.
1082     */
1083     bool EndUnderline() { return GetBuffer().EndUnderline(); }
1084
1085     /**
1086         Begins using the given point size.
1087     */
1088     bool BeginFontSize(int pointSize) { return GetBuffer().BeginFontSize(pointSize); }
1089
1090     /**
1091         Ends using a point size.
1092     */
1093     bool EndFontSize() { return GetBuffer().EndFontSize(); }
1094
1095     /**
1096         Begins using this font.
1097     */
1098     bool BeginFont(const wxFont& font) { return GetBuffer().BeginFont(font); }
1099
1100     /**
1101         Ends using a font.
1102     */
1103     bool EndFont() { return GetBuffer().EndFont(); }
1104
1105     /**
1106         Begins using this colour.
1107     */
1108     bool BeginTextColour(const wxColour& colour) { return GetBuffer().BeginTextColour(colour); }
1109
1110     /**
1111         Ends applying a text colour.
1112     */
1113     bool EndTextColour() { return GetBuffer().EndTextColour(); }
1114
1115     /**
1116         Begins using alignment.
1117         For alignment values, see wxTextAttr.
1118     */
1119     bool BeginAlignment(wxTextAttrAlignment alignment) { return GetBuffer().BeginAlignment(alignment); }
1120
1121     /**
1122         Ends alignment.
1123     */
1124     bool EndAlignment() { return GetBuffer().EndAlignment(); }
1125
1126     /**
1127         Begins applying a left indent and subindent in tenths of a millimetre.
1128         The subindent is an offset from the left edge of the paragraph, and is
1129         used for all but the first line in a paragraph. A positive value will
1130         cause the first line to appear to the left of the subsequent lines, and
1131         a negative value will cause the first line to be indented to the right
1132         of the subsequent lines.
1133
1134         wxRichTextBuffer uses indentation to render a bulleted item. The
1135         content of the paragraph, including the first line, starts at the
1136         @a leftIndent plus the @a leftSubIndent.
1137
1138         @param leftIndent
1139             The distance between the margin and the bullet.
1140         @param leftSubIndent
1141              The distance between the left edge of the bullet and the left edge
1142              of the actual paragraph.
1143     */
1144     bool BeginLeftIndent(int leftIndent, int leftSubIndent = 0) { return GetBuffer().BeginLeftIndent(leftIndent, leftSubIndent); }
1145
1146     /**
1147         Ends left indent.
1148     */
1149     bool EndLeftIndent() { return GetBuffer().EndLeftIndent(); }
1150
1151     /**
1152         Begins a right indent, specified in tenths of a millimetre.
1153     */
1154     bool BeginRightIndent(int rightIndent) { return GetBuffer().BeginRightIndent(rightIndent); }
1155
1156     /**
1157         Ends right indent.
1158     */
1159     bool EndRightIndent() { return GetBuffer().EndRightIndent(); }
1160
1161     /**
1162         Begins paragraph spacing; pass the before-paragraph and after-paragraph spacing
1163         in tenths of a millimetre.
1164     */
1165     bool BeginParagraphSpacing(int before, int after) { return GetBuffer().BeginParagraphSpacing(before, after); }
1166
1167     /**
1168         Ends paragraph spacing.
1169     */
1170     bool EndParagraphSpacing() { return GetBuffer().EndParagraphSpacing(); }
1171
1172     /**
1173         Begins appling line spacing. @e spacing is a multiple, where 10 means
1174         single-spacing, 15 means 1.5 spacing, and 20 means double spacing.
1175
1176         The ::wxTextAttrLineSpacing constants are defined for convenience.
1177     */
1178     bool BeginLineSpacing(int lineSpacing) { return GetBuffer().BeginLineSpacing(lineSpacing); }
1179
1180     /**
1181         Ends line spacing.
1182     */
1183     bool EndLineSpacing() { return GetBuffer().EndLineSpacing(); }
1184
1185     /**
1186         Begins a numbered bullet.
1187
1188         This call will be needed for each item in the list, and the
1189         application should take care of incrementing the numbering.
1190
1191         @a bulletNumber is a number, usually starting with 1.
1192         @a leftIndent and @a leftSubIndent are values in tenths of a millimetre.
1193         @a bulletStyle is a bitlist of the  ::wxTextAttrBulletStyle values.
1194
1195         wxRichTextBuffer uses indentation to render a bulleted item.
1196         The left indent is the distance between the margin and the bullet.
1197         The content of the paragraph, including the first line, starts
1198         at leftMargin + leftSubIndent.
1199         So the distance between the left edge of the bullet and the
1200         left of the actual paragraph is leftSubIndent.
1201     */
1202     bool BeginNumberedBullet(int bulletNumber, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_ARABIC|wxTEXT_ATTR_BULLET_STYLE_PERIOD)
1203     { return GetBuffer().BeginNumberedBullet(bulletNumber, leftIndent, leftSubIndent, bulletStyle); }
1204
1205     /**
1206         Ends application of a numbered bullet.
1207     */
1208     bool EndNumberedBullet() { return GetBuffer().EndNumberedBullet(); }
1209
1210     /**
1211         Begins applying a symbol bullet, using a character from the current font.
1212         See BeginNumberedBullet() for an explanation of how indentation is used
1213         to render the bulleted paragraph.
1214     */
1215     bool BeginSymbolBullet(const wxString& symbol, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_SYMBOL)
1216     { return GetBuffer().BeginSymbolBullet(symbol, leftIndent, leftSubIndent, bulletStyle); }
1217
1218     /**
1219         Ends applying a symbol bullet.
1220     */
1221     bool EndSymbolBullet() { return GetBuffer().EndSymbolBullet(); }
1222
1223     /**
1224         Begins applying a symbol bullet.
1225     */
1226     bool BeginStandardBullet(const wxString& bulletName, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_STANDARD)
1227     { return GetBuffer().BeginStandardBullet(bulletName, leftIndent, leftSubIndent, bulletStyle); }
1228
1229     /**
1230         Begins applying a standard bullet.
1231     */
1232     bool EndStandardBullet() { return GetBuffer().EndStandardBullet(); }
1233
1234     /**
1235         Begins using the named character style.
1236     */
1237     bool BeginCharacterStyle(const wxString& characterStyle) { return GetBuffer().BeginCharacterStyle(characterStyle); }
1238
1239     /**
1240         Ends application of a named character style.
1241     */
1242     bool EndCharacterStyle() { return GetBuffer().EndCharacterStyle(); }
1243
1244     /**
1245         Begins applying the named paragraph style.
1246     */
1247     bool BeginParagraphStyle(const wxString& paragraphStyle) { return GetBuffer().BeginParagraphStyle(paragraphStyle); }
1248
1249     /**
1250         Ends application of a named paragraph style.
1251     */
1252     bool EndParagraphStyle() { return GetBuffer().EndParagraphStyle(); }
1253
1254     /**
1255         Begins using a specified list style.
1256         Optionally, you can also pass a level and a number.
1257     */
1258     bool BeginListStyle(const wxString& listStyle, int level = 1, int number = 1) { return GetBuffer().BeginListStyle(listStyle, level, number); }
1259
1260     /**
1261         Ends using a specified list style.
1262     */
1263     bool EndListStyle() { return GetBuffer().EndListStyle(); }
1264
1265     /**
1266         Begins applying wxTEXT_ATTR_URL to the content.
1267
1268         Pass a URL and optionally, a character style to apply, since it is common
1269         to mark a URL with a familiar style such as blue text with underlining.
1270     */
1271     bool BeginURL(const wxString& url, const wxString& characterStyle = wxEmptyString) { return GetBuffer().BeginURL(url, characterStyle); }
1272
1273     /**
1274         Ends applying a URL.
1275     */
1276     bool EndURL() { return GetBuffer().EndURL(); }
1277
1278     /**
1279         Sets the default style to the style under the cursor.
1280     */
1281     bool SetDefaultStyleToCursorStyle();
1282
1283     /**
1284         Cancels any selection.
1285     */
1286     virtual void SelectNone();
1287
1288     /**
1289         Selects the word at the given character position.
1290     */
1291     virtual bool SelectWord(long position);
1292
1293     /**
1294         Returns the selection range in character positions. -1, -1 means no selection.
1295
1296         The range is in API convention, i.e. a single character selection is denoted
1297         by (n, n+1)
1298     */
1299     wxRichTextRange GetSelectionRange() const;
1300
1301     /**
1302         Sets the selection to the given range.
1303         The end point of range is specified as the last character position of the span
1304         of text, plus one.
1305
1306         So, for example, to set the selection for a character at position 5, use the
1307         range (5,6).
1308     */
1309     void SetSelectionRange(const wxRichTextRange& range);
1310
1311     /**
1312         Returns the selection range in character positions. -2, -2 means no selection
1313         -1, -1 means select everything.
1314         The range is in internal format, i.e. a single character selection is denoted
1315         by (n, n)
1316     */
1317     wxRichTextRange GetInternalSelectionRange() const { return m_selection.GetRange(); }
1318
1319     /**
1320         Sets the selection range in character positions. -2, -2 means no selection
1321         -1, -1 means select everything.
1322         The range is in internal format, i.e. a single character selection is denoted
1323         by (n, n)
1324     */
1325     void SetInternalSelectionRange(const wxRichTextRange& range) { m_selection.Set(range, GetFocusObject()); }
1326
1327     /**
1328         Adds a new paragraph of text to the end of the buffer.
1329     */
1330     virtual wxRichTextRange AddParagraph(const wxString& text);
1331
1332     /**
1333         Adds an image to the control's buffer.
1334     */
1335     virtual wxRichTextRange AddImage(const wxImage& image);
1336
1337     /**
1338         Lays out the buffer, which must be done before certain operations, such as
1339         setting the caret position.
1340         This function should not normally be required by the application.
1341     */
1342     virtual bool LayoutContent(bool onlyVisibleRect = false);
1343
1344     /**
1345         Move the caret to the given character position.
1346
1347         Please note that this does not update the current editing style
1348         from the new position; to do that, call wxRichTextCtrl::SetInsertionPoint instead.
1349     */
1350     virtual bool MoveCaret(long pos, bool showAtLineStart = false, wxRichTextParagraphLayoutBox* container = NULL);
1351
1352     /**
1353         Moves right.
1354     */
1355     virtual bool MoveRight(int noPositions = 1, int flags = 0);
1356
1357     /**
1358         Moves left.
1359     */
1360     virtual bool MoveLeft(int noPositions = 1, int flags = 0);
1361
1362     /**
1363         Moves to the start of the paragraph.
1364     */
1365     virtual bool MoveUp(int noLines = 1, int flags = 0);
1366
1367     /**
1368         Moves the caret down.
1369     */
1370     virtual bool MoveDown(int noLines = 1, int flags = 0);
1371
1372     /**
1373         Moves to the end of the line.
1374     */
1375     virtual bool MoveToLineEnd(int flags = 0);
1376
1377     /**
1378         Moves to the start of the line.
1379     */
1380     virtual bool MoveToLineStart(int flags = 0);
1381
1382     /**
1383         Moves to the end of the paragraph.
1384     */
1385     virtual bool MoveToParagraphEnd(int flags = 0);
1386
1387     /**
1388         Moves to the start of the paragraph.
1389     */
1390     virtual bool MoveToParagraphStart(int flags = 0);
1391
1392     /**
1393         Moves to the start of the buffer.
1394     */
1395     virtual bool MoveHome(int flags = 0);
1396
1397     /**
1398         Moves to the end of the buffer.
1399     */
1400     virtual bool MoveEnd(int flags = 0);
1401
1402     /**
1403         Moves one or more pages up.
1404     */
1405     virtual bool PageUp(int noPages = 1, int flags = 0);
1406
1407     /**
1408         Moves one or more pages down.
1409     */
1410     virtual bool PageDown(int noPages = 1, int flags = 0);
1411
1412     /**
1413         Moves a number of words to the left.
1414     */
1415     virtual bool WordLeft(int noPages = 1, int flags = 0);
1416
1417     /**
1418         Move a nuber of words to the right.
1419     */
1420     virtual bool WordRight(int noPages = 1, int flags = 0);
1421
1422     //@{
1423     /**
1424         Returns the buffer associated with the control.
1425     */
1426     wxRichTextBuffer& GetBuffer() { return m_buffer; }
1427     const wxRichTextBuffer& GetBuffer() const { return m_buffer; }
1428     //@}
1429
1430     /**
1431         Starts batching undo history for commands.
1432     */
1433     virtual bool BeginBatchUndo(const wxString& cmdName) { return m_buffer.BeginBatchUndo(cmdName); }
1434
1435     /**
1436         Ends batching undo command history.
1437     */
1438     virtual bool EndBatchUndo() { return m_buffer.EndBatchUndo(); }
1439
1440     /**
1441         Returns @true if undo commands are being batched.
1442     */
1443     virtual bool BatchingUndo() const { return m_buffer.BatchingUndo(); }
1444
1445     /**
1446         Starts suppressing undo history for commands.
1447     */
1448     virtual bool BeginSuppressUndo() { return m_buffer.BeginSuppressUndo(); }
1449
1450     /**
1451         Ends suppressing undo command history.
1452     */
1453     virtual bool EndSuppressUndo() { return m_buffer.EndSuppressUndo(); }
1454
1455     /**
1456         Returns @true if undo history suppression is on.
1457     */
1458     virtual bool SuppressingUndo() const { return m_buffer.SuppressingUndo(); }
1459
1460     /**
1461         Test if this whole range has character attributes of the specified kind.
1462         If any of the attributes are different within the range, the test fails.
1463
1464         You can use this to implement, for example, bold button updating.
1465         @a style must have flags indicating which attributes are of interest.
1466     */
1467     virtual bool HasCharacterAttributes(const wxRichTextRange& range, const wxRichTextAttr& style) const
1468     {
1469         return GetBuffer().HasCharacterAttributes(range.ToInternal(), style);
1470     }
1471
1472     /**
1473         Test if this whole range has paragraph attributes of the specified kind.
1474         If any of the attributes are different within the range, the test fails.
1475         You can use this to implement, for example, centering button updating.
1476         @a style must have flags indicating which attributes are of interest.
1477     */
1478     virtual bool HasParagraphAttributes(const wxRichTextRange& range, const wxRichTextAttr& style) const
1479     {
1480         return GetBuffer().HasParagraphAttributes(range.ToInternal(), style);
1481     }
1482
1483     /**
1484         Returns @true if all of the selection, or the content at the caret position, is bold.
1485     */
1486     virtual bool IsSelectionBold();
1487
1488     /**
1489         Returns @true if all of the selection, or the content at the caret position, is italic.
1490     */
1491     virtual bool IsSelectionItalics();
1492
1493     /**
1494         Returns @true if all of the selection, or the content at the caret position, is underlined.
1495     */
1496     virtual bool IsSelectionUnderlined();
1497
1498     /**
1499         Returns @true if all of the selection, or the content at the current caret position, has the supplied wxTextAttrEffects flag(s).
1500     */
1501     virtual bool DoesSelectionHaveTextEffectFlag(int flag);
1502
1503     /**
1504         Returns @true if all of the selection is aligned according to the specified flag.
1505     */
1506     virtual bool IsSelectionAligned(wxTextAttrAlignment alignment);
1507
1508     /**
1509         Apples bold to the selection or the default style (undoable).
1510     */
1511     virtual bool ApplyBoldToSelection();
1512
1513     /**
1514         Applies italic to the selection or the default style (undoable).
1515     */
1516     virtual bool ApplyItalicToSelection();
1517
1518     /**
1519         Applies underline to the selection or the default style (undoable).
1520     */
1521     virtual bool ApplyUnderlineToSelection();
1522
1523     /**
1524         Applies one or more wxTextAttrEffects flags to the selection (undoable).
1525         If there is no selection, it is applied to the default style.
1526     */
1527     virtual bool ApplyTextEffectToSelection(int flags);
1528
1529     /**
1530         Applies the given alignment to the selection or the default style (undoable).
1531         For alignment values, see wxTextAttr.
1532     */
1533     virtual bool ApplyAlignmentToSelection(wxTextAttrAlignment alignment);
1534
1535     /**
1536         Applies the style sheet to the buffer, matching paragraph styles in the sheet
1537         against named styles in the buffer.
1538
1539         This might be useful if the styles have changed.
1540         If @a sheet is @NULL, the sheet set with SetStyleSheet() is used.
1541         Currently this applies paragraph styles only.
1542     */
1543     virtual bool ApplyStyle(wxRichTextStyleDefinition* def);
1544
1545     /**
1546         Sets the style sheet associated with the control.
1547         A style sheet allows named character and paragraph styles to be applied.
1548     */
1549     void SetStyleSheet(wxRichTextStyleSheet* styleSheet) { GetBuffer().SetStyleSheet(styleSheet); }
1550
1551     /**
1552         Returns the style sheet associated with the control, if any.
1553         A style sheet allows named character and paragraph styles to be applied.
1554     */
1555     wxRichTextStyleSheet* GetStyleSheet() const { return GetBuffer().GetStyleSheet(); }
1556
1557     /**
1558         Push the style sheet to top of stack.
1559     */
1560     bool PushStyleSheet(wxRichTextStyleSheet* styleSheet) { return GetBuffer().PushStyleSheet(styleSheet); }
1561
1562     /**
1563         Pops the style sheet from top of stack.
1564     */
1565     wxRichTextStyleSheet* PopStyleSheet() { return GetBuffer().PopStyleSheet(); }
1566
1567     /**
1568         Applies the style sheet to the buffer, for example if the styles have changed.
1569     */
1570     bool ApplyStyleSheet(wxRichTextStyleSheet* styleSheet = NULL);
1571
1572     /**
1573         Shows the given context menu, optionally adding appropriate property-editing commands for the current position in the object hierarchy.
1574     */
1575     virtual bool ShowContextMenu(wxMenu* menu, const wxPoint& pt, bool addPropertyCommands);
1576
1577     /**
1578         Prepares the context menu, optionally adding appropriate property-editing commands.
1579         Returns the number of property commands added.
1580     */
1581     virtual int PrepareContextMenu(wxMenu* menu, const wxPoint& pt, bool addPropertyCommands);
1582
1583 // Command handlers
1584
1585     /**
1586         Sends the event to the control.
1587     */
1588     void Command(wxCommandEvent& event);
1589
1590     /**
1591         Loads the first dropped file.
1592     */
1593     void OnDropFiles(wxDropFilesEvent& event);
1594
1595     void OnCaptureLost(wxMouseCaptureLostEvent& event);
1596     void OnSysColourChanged(wxSysColourChangedEvent& event);
1597
1598     /**
1599         Standard handler for the wxID_CUT command.
1600     */
1601     void OnCut(wxCommandEvent& event);
1602
1603     /**
1604         Standard handler for the wxID_COPY command.
1605     */
1606     void OnCopy(wxCommandEvent& event);
1607
1608     /**
1609         Standard handler for the wxID_PASTE command.
1610     */
1611     void OnPaste(wxCommandEvent& event);
1612
1613     /**
1614         Standard handler for the wxID_UNDO command.
1615     */
1616     void OnUndo(wxCommandEvent& event);
1617
1618     /**
1619         Standard handler for the wxID_REDO command.
1620     */
1621     void OnRedo(wxCommandEvent& event);
1622
1623     /**
1624         Standard handler for the wxID_SELECTALL command.
1625     */
1626     void OnSelectAll(wxCommandEvent& event);
1627
1628     /**
1629         Standard handler for property commands.
1630     */
1631     void OnProperties(wxCommandEvent& event);
1632
1633     /**
1634         Standard handler for the wxID_CLEAR command.
1635     */
1636     void OnClear(wxCommandEvent& event);
1637
1638     /**
1639         Standard update handler for the wxID_CUT command.
1640     */
1641     void OnUpdateCut(wxUpdateUIEvent& event);
1642
1643     /**
1644         Standard update handler for the wxID_COPY command.
1645     */
1646     void OnUpdateCopy(wxUpdateUIEvent& event);
1647
1648     /**
1649         Standard update handler for the wxID_PASTE command.
1650     */
1651     void OnUpdatePaste(wxUpdateUIEvent& event);
1652
1653     /**
1654         Standard update handler for the wxID_UNDO command.
1655     */
1656     void OnUpdateUndo(wxUpdateUIEvent& event);
1657
1658     /**
1659         Standard update handler for the wxID_REDO command.
1660     */
1661     void OnUpdateRedo(wxUpdateUIEvent& event);
1662
1663     /**
1664         Standard update handler for the wxID_SELECTALL command.
1665     */
1666     void OnUpdateSelectAll(wxUpdateUIEvent& event);
1667
1668     /**
1669         Standard update handler for property commands.
1670     */
1671
1672     void OnUpdateProperties(wxUpdateUIEvent& event);
1673
1674     /**
1675         Standard update handler for the wxID_CLEAR command.
1676     */
1677     void OnUpdateClear(wxUpdateUIEvent& event);
1678
1679     /**
1680         Shows a standard context menu with undo, redo, cut, copy, paste, clear, and
1681         select all commands.
1682     */
1683     void OnContextMenu(wxContextMenuEvent& event);
1684
1685 // Event handlers
1686
1687     // Painting
1688     void OnPaint(wxPaintEvent& event);
1689     void OnEraseBackground(wxEraseEvent& event);
1690
1691     // Left-click
1692     void OnLeftClick(wxMouseEvent& event);
1693
1694     // Left-up
1695     void OnLeftUp(wxMouseEvent& event);
1696
1697     // Motion
1698     void OnMoveMouse(wxMouseEvent& event);
1699
1700     // Left-double-click
1701     void OnLeftDClick(wxMouseEvent& event);
1702
1703     // Middle-click
1704     void OnMiddleClick(wxMouseEvent& event);
1705
1706     // Right-click
1707     void OnRightClick(wxMouseEvent& event);
1708
1709     // Key press
1710     void OnChar(wxKeyEvent& event);
1711
1712     // Sizing
1713     void OnSize(wxSizeEvent& event);
1714
1715     // Setting/losing focus
1716     void OnSetFocus(wxFocusEvent& event);
1717     void OnKillFocus(wxFocusEvent& event);
1718
1719     // Idle-time processing
1720     void OnIdle(wxIdleEvent& event);
1721
1722     // Scrolling
1723     void OnScroll(wxScrollWinEvent& event);
1724
1725     /**
1726         Sets the font, and also the basic and default attributes
1727         (see wxRichTextCtrl::SetDefaultStyle).
1728     */
1729     virtual bool SetFont(const wxFont& font);
1730
1731     /**
1732         A helper function setting up scrollbars, for example after a resize.
1733     */
1734     virtual void SetupScrollbars(bool atTop = false);
1735
1736     /**
1737         Helper function implementing keyboard navigation.
1738     */
1739     virtual bool KeyboardNavigate(int keyCode, int flags);
1740
1741     /**
1742         Paints the background.
1743     */
1744     virtual void PaintBackground(wxDC& dc);
1745
1746     /**
1747         Other user defined painting after everything else (i.e. all text) is painted.
1748
1749         @since 2.9.1
1750     */
1751     virtual void PaintAboveContent(wxDC& WXUNUSED(dc)) {}
1752
1753 #if wxRICHTEXT_BUFFERED_PAINTING
1754     /**
1755         Recreates the buffer bitmap if necessary.
1756     */
1757     virtual bool RecreateBuffer(const wxSize& size = wxDefaultSize);
1758 #endif
1759
1760     // Write text
1761     virtual void DoWriteText(const wxString& value, int flags = 0);
1762
1763     // Should we inherit colours?
1764     virtual bool ShouldInheritColours() const { return false; }
1765
1766     /**
1767         Internal function to position the visible caret according to the current caret
1768         position.
1769     */
1770     virtual void PositionCaret(wxRichTextParagraphLayoutBox* container = NULL);
1771
1772     /**
1773         Helper function for extending the selection, returning @true if the selection
1774         was changed. Selections are in caret positions.
1775     */
1776     virtual bool ExtendSelection(long oldPosition, long newPosition, int flags);
1777
1778     /**
1779         Scrolls @a position into view. This function takes a caret position.
1780     */
1781     virtual bool ScrollIntoView(long position, int keyCode);
1782
1783     /**
1784         Refreshes the area affected by a selection change.
1785     */
1786     bool RefreshForSelectionChange(const wxRichTextSelection& oldSelection, const wxRichTextSelection& newSelection);
1787
1788     /**
1789         Sets the caret position.
1790
1791         The caret position is the character position just before the caret.
1792         A value of -1 means the caret is at the start of the buffer.
1793         Please note that this does not update the current editing style
1794         from the new position or cause the actual caret to be refreshed; to do that,
1795         call wxRichTextCtrl::SetInsertionPoint instead.
1796     */
1797     void SetCaretPosition(long position, bool showAtLineStart = false) ;
1798
1799     /**
1800         Returns the current caret position.
1801     */
1802     long GetCaretPosition() const { return m_caretPosition; }
1803
1804     /**
1805         The adjusted caret position is the character position adjusted to take
1806         into account whether we're at the start of a paragraph, in which case
1807         style information should be taken from the next position, not current one.
1808     */
1809     long GetAdjustedCaretPosition(long caretPos) const;
1810
1811     /**
1812         Move the caret one visual step forward: this may mean setting a flag
1813         and keeping the same position if we're going from the end of one line
1814         to the start of the next, which may be the exact same caret position.
1815     */
1816     void MoveCaretForward(long oldPosition) ;
1817
1818     /**
1819         Move the caret one visual step forward: this may mean setting a flag
1820         and keeping the same position if we're going from the end of one line
1821         to the start of the next, which may be the exact same caret position.
1822     */
1823     void MoveCaretBack(long oldPosition) ;
1824
1825     /**
1826         Returns the caret height and position for the given character position.
1827         If container is null, the current focus object will be used.
1828
1829         @beginWxPerlOnly
1830         In wxPerl this method is implemented as
1831         GetCaretPositionForIndex(@a position) returning a
1832         2-element list (ok, rect).
1833         @endWxPerlOnly
1834     */
1835     bool GetCaretPositionForIndex(long position, wxRect& rect, wxRichTextParagraphLayoutBox* container = NULL);
1836
1837     /**
1838         Internal helper function returning the line for the visible caret position.
1839         If the caret is shown at the very end of the line, it means the next character
1840         is actually on the following line.
1841         So this function gets the line we're expecting to find if this is the case.
1842     */
1843     wxRichTextLine* GetVisibleLineForCaretPosition(long caretPosition) const;
1844
1845     /**
1846         Gets the command processor associated with the control's buffer.
1847     */
1848     wxCommandProcessor* GetCommandProcessor() const { return GetBuffer().GetCommandProcessor(); }
1849
1850     /**
1851         Deletes content if there is a selection, e.g. when pressing a key.
1852         Returns the new caret position in @e newPos, or leaves it if there
1853         was no action. This is undoable.
1854
1855         @beginWxPerlOnly
1856         In wxPerl this method takes no arguments and returns a 2-element
1857         list (ok, newPos).
1858         @endWxPerlOnly
1859     */
1860     bool DeleteSelectedContent(long* newPos= NULL);
1861
1862     /**
1863         Transforms logical (unscrolled) position to physical window position.
1864     */
1865     wxPoint GetPhysicalPoint(const wxPoint& ptLogical) const;
1866
1867     /**
1868         Transforms physical window position to logical (unscrolled) position.
1869     */
1870     wxPoint GetLogicalPoint(const wxPoint& ptPhysical) const;
1871
1872     /**
1873         Helper function for finding the caret position for the next word.
1874         Direction is 1 (forward) or -1 (backwards).
1875     */
1876     virtual long FindNextWordPosition(int direction = 1) const;
1877
1878     /**
1879         Returns @true if the given position is visible on the screen.
1880     */
1881     bool IsPositionVisible(long pos) const;
1882
1883     /**
1884         Returns the first visible position in the current view.
1885     */
1886     long GetFirstVisiblePosition() const;
1887
1888     /**
1889         Returns the caret position since the default formatting was changed. As
1890         soon as this position changes, we no longer reflect the default style
1891         in the UI. A value of -2 means that we should only reflect the style of the
1892         content under the caret.
1893     */
1894     long GetCaretPositionForDefaultStyle() const { return m_caretPositionForDefaultStyle; }
1895
1896     /**
1897         Set the caret position for the default style that the user is selecting.
1898     */
1899     void SetCaretPositionForDefaultStyle(long pos) { m_caretPositionForDefaultStyle = pos; }
1900
1901     /**
1902         Returns @true if the user has recently set the default style without moving
1903         the caret, and therefore the UI needs to reflect the default style and not
1904         the style at the caret.
1905
1906         Below is an example of code that uses this function to determine whether the UI
1907         should show that the current style is bold.
1908
1909         @see SetAndShowDefaultStyle().
1910     */
1911     bool IsDefaultStyleShowing() const { return m_caretPositionForDefaultStyle != -2; }
1912
1913     /**
1914         Sets @a attr as the default style and tells the control that the UI should
1915         reflect this attribute until the user moves the caret.
1916
1917         @see IsDefaultStyleShowing().
1918     */
1919     void SetAndShowDefaultStyle(const wxRichTextAttr& attr)
1920     {
1921         SetDefaultStyle(attr);
1922         SetCaretPositionForDefaultStyle(GetCaretPosition());
1923     }
1924
1925     /**
1926         Returns the first visible point in the window.
1927     */
1928     wxPoint GetFirstVisiblePoint() const;
1929
1930 #ifdef DOXYGEN
1931     /**
1932         Returns the content of the entire control as a string.
1933     */
1934     virtual wxString GetValue() const;
1935
1936     /**
1937         Replaces existing content with the given text.
1938     */
1939     virtual void SetValue(const wxString& value);
1940
1941     /**
1942         Call this function to prevent refresh and allow fast updates, and then Thaw() to
1943         refresh the control.
1944     */
1945     void Freeze();
1946
1947     /**
1948         Call this function to end a Freeze and refresh the display.
1949     */
1950     void Thaw();
1951
1952     /**
1953         Returns @true if Freeze has been called without a Thaw.
1954     */
1955     bool IsFrozen() const;
1956
1957 #endif
1958
1959 // Implementation
1960
1961     /**
1962         Sets up the caret for the given position and container, after a mouse click.
1963     */
1964     bool SetCaretPositionAfterClick(wxRichTextParagraphLayoutBox* container, long position, int hitTestFlags, bool extendSelection = false);
1965
1966     /**
1967         Find the caret position for the combination of hit-test flags and character position.
1968         Returns the caret position and also an indication of where to place the caret (caretLineStart)
1969         since this is ambiguous (same position used for end of line and start of next).
1970     */
1971     long FindCaretPositionForCharacterPosition(long position, int hitTestFlags, wxRichTextParagraphLayoutBox* container,
1972                                                    bool& caretLineStart);
1973
1974     /**
1975         Font names take a long time to retrieve, so cache them (on demand).
1976     */
1977     static const wxArrayString& GetAvailableFontNames();
1978
1979     /**
1980         Clears the cache of available font names.
1981     */
1982     static void ClearAvailableFontNames();
1983
1984     WX_FORWARD_TO_SCROLL_HELPER()
1985
1986     // implement wxTextEntry methods
1987     virtual wxString DoGetValue() const;
1988
1989 protected:
1990     // implement the wxTextEntry pure virtual method
1991     virtual wxWindow *GetEditableWindow() { return this; }
1992
1993     // margins functions
1994     virtual bool DoSetMargins(const wxPoint& pt);
1995     virtual wxPoint DoGetMargins() const;
1996
1997      // FIXME: this does not work, it allows this code to compile but will fail
1998      //        during run-time
1999 #ifndef __WXUNIVERSAL__
2000 #ifdef __WXMSW__
2001     virtual WXHWND GetEditHWND() const { return GetHWND(); }
2002 #endif
2003 #ifdef __WXMOTIF__
2004     virtual WXWidget GetTextWidget() const { return NULL; }
2005 #endif
2006 #ifdef __WXGTK20__
2007     virtual GtkEditable *GetEditable() const { return NULL; }
2008     virtual GtkEntry *GetEntry() const { return NULL; }
2009 #endif
2010 #endif // !__WXUNIVERSAL__
2011
2012 // Overrides
2013 protected:
2014
2015     /**
2016         Currently this simply returns @c wxSize(10, 10).
2017     */
2018     virtual wxSize DoGetBestSize() const ;
2019
2020     virtual void DoSetValue(const wxString& value, int flags = 0);
2021
2022     virtual void DoThaw();
2023
2024
2025 // Data members
2026 protected:
2027 #if wxRICHTEXT_BUFFERED_PAINTING
2028     /// Buffer bitmap
2029     wxBitmap                m_bufferBitmap;
2030 #endif
2031
2032     /// Text buffer
2033     wxRichTextBuffer        m_buffer;
2034
2035     wxMenu*                 m_contextMenu;
2036
2037     /// Caret position (1 less than the character position, so -1 is the
2038     /// first caret position).
2039     long                    m_caretPosition;
2040
2041     /// Caret position when the default formatting has been changed. As
2042     /// soon as this position changes, we no longer reflect the default style
2043     /// in the UI.
2044     long                    m_caretPositionForDefaultStyle;
2045
2046     /// Selection range in character positions. -2, -2 means no selection.
2047     wxRichTextSelection     m_selection;
2048
2049     wxRichTextCtrlSelectionState m_selectionState;
2050
2051     /// Anchor so we know how to extend the selection
2052     /// It's a caret position since it's between two characters.
2053     long                    m_selectionAnchor;
2054
2055     /// Anchor object if selecting multiple container objects, such as grid cells.
2056     wxRichTextObject*       m_selectionAnchorObject;
2057
2058     /// Are we editable?
2059     bool                    m_editable;
2060
2061     /// Are we showing the caret position at the start of a line
2062     /// instead of at the end of the previous one?
2063     bool                    m_caretAtLineStart;
2064
2065     /// Are we dragging a selection?
2066     bool                    m_dragging;
2067
2068     /// Do we need full layout in idle?
2069     bool                    m_fullLayoutRequired;
2070     wxLongLong              m_fullLayoutTime;
2071     long                    m_fullLayoutSavedPosition;
2072
2073     /// Threshold for doing delayed layout
2074     long                    m_delayedLayoutThreshold;
2075
2076     /// Cursors
2077     wxCursor                m_textCursor;
2078     wxCursor                m_urlCursor;
2079
2080     static wxArrayString    sm_availableFontNames;
2081
2082     wxRichTextContextMenuPropertiesInfo m_contextMenuPropertiesInfo;
2083
2084     /// The object that currently has the editing focus
2085     wxRichTextParagraphLayoutBox* m_focusObject;
2086 };
2087
2088 /**
2089     @class wxRichTextEvent
2090
2091     This is the event class for wxRichTextCtrl notifications.
2092
2093     @beginEventTable{wxRichTextEvent}
2094     @event{EVT_RICHTEXT_LEFT_CLICK(id, func)}
2095         Process a @c wxEVT_COMMAND_RICHTEXT_LEFT_CLICK event, generated when the user
2096         releases the left mouse button over an object.
2097     @event{EVT_RICHTEXT_RIGHT_CLICK(id, func)}
2098         Process a @c wxEVT_COMMAND_RICHTEXT_RIGHT_CLICK event, generated when the user
2099         releases the right mouse button over an object.
2100     @event{EVT_RICHTEXT_MIDDLE_CLICK(id, func)}
2101         Process a @c wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK event, generated when the user
2102         releases the middle mouse button over an object.
2103     @event{EVT_RICHTEXT_LEFT_DCLICK(id, func)}
2104         Process a @c wxEVT_COMMAND_RICHTEXT_LEFT_DCLICK event, generated when the user
2105         double-clicks an object.
2106     @event{EVT_RICHTEXT_RETURN(id, func)}
2107         Process a @c wxEVT_COMMAND_RICHTEXT_RETURN event, generated when the user
2108         presses the return key. Valid event functions: GetFlags, GetPosition.
2109     @event{EVT_RICHTEXT_CHARACTER(id, func)}
2110         Process a @c wxEVT_COMMAND_RICHTEXT_CHARACTER event, generated when the user
2111         presses a character key. Valid event functions: GetFlags, GetPosition, GetCharacter.
2112     @event{EVT_RICHTEXT_DELETE(id, func)}
2113         Process a @c wxEVT_COMMAND_RICHTEXT_DELETE event, generated when the user
2114         presses the backspace or delete key. Valid event functions: GetFlags, GetPosition.
2115     @event{EVT_RICHTEXT_RETURN(id, func)}
2116         Process a @c wxEVT_COMMAND_RICHTEXT_RETURN event, generated when the user
2117         presses the return key. Valid event functions: GetFlags, GetPosition.
2118     @event{EVT_RICHTEXT_STYLE_CHANGED(id, func)}
2119         Process a @c wxEVT_COMMAND_RICHTEXT_STYLE_CHANGED event, generated when
2120         styling has been applied to the control. Valid event functions: GetPosition, GetRange.
2121     @event{EVT_RICHTEXT_STYLESHEET_CHANGED(id, func)}
2122         Process a @c wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING event, generated
2123         when the control's stylesheet has changed, for example the user added,
2124         edited or deleted a style. Valid event functions: GetRange, GetPosition.
2125     @event{EVT_RICHTEXT_STYLESHEET_REPLACING(id, func)}
2126         Process a @c wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACING event, generated
2127         when the control's stylesheet is about to be replaced, for example when
2128         a file is loaded into the control.
2129         Valid event functions: Veto, GetOldStyleSheet, GetNewStyleSheet.
2130     @event{EVT_RICHTEXT_STYLESHEET_REPLACED(id, func)}
2131         Process a @c wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACED event, generated
2132         when the control's stylesheet has been replaced, for example when a file
2133         is loaded into the control.
2134         Valid event functions: GetOldStyleSheet, GetNewStyleSheet.
2135     @event{EVT_RICHTEXT_CONTENT_INSERTED(id, func)}
2136         Process a @c wxEVT_COMMAND_RICHTEXT_CONTENT_INSERTED event, generated when
2137         content has been inserted into the control.
2138         Valid event functions: GetPosition, GetRange.
2139     @event{EVT_RICHTEXT_CONTENT_DELETED(id, func)}
2140         Process a @c wxEVT_COMMAND_RICHTEXT_CONTENT_DELETED event, generated when
2141         content has been deleted from the control.
2142         Valid event functions: GetPosition, GetRange.
2143     @event{EVT_RICHTEXT_BUFFER_RESET(id, func)}
2144         Process a @c wxEVT_COMMAND_RICHTEXT_BUFFER_RESET event, generated when the
2145         buffer has been reset by deleting all content.
2146         You can use this to set a default style for the first new paragraph.
2147     @event{EVT_RICHTEXT_SELECTION_CHANGED(id, func)}
2148         Process a @c wxEVT_COMMAND_RICHTEXT_SELECTION_CHANGED event, generated when the
2149         selection range has changed.
2150     @event{EVT_RICHTEXT_FOCUS_OBJECT_CHANGED(id, func)}
2151         Process a @c wxEVT_COMMAND_RICHTEXT_FOCUS_OBJECT_CHANGED event, generated when the
2152         current focus object has changed.
2153     @endEventTable
2154
2155     @library{wxrichtext}
2156     @category{events,richtext}
2157 */
2158
2159 class WXDLLIMPEXP_RICHTEXT wxRichTextEvent : public wxNotifyEvent
2160 {
2161 public:
2162     /**
2163         Constructor.
2164
2165         @param commandType
2166             The type of the event.
2167         @param id
2168             Window identifier. The value @c wxID_ANY indicates a default value.
2169     */
2170     wxRichTextEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
2171         : wxNotifyEvent(commandType, winid),
2172         m_flags(0), m_position(-1), m_oldStyleSheet(NULL), m_newStyleSheet(NULL),
2173         m_char((wxChar) 0), m_container(NULL), m_oldContainer(NULL)
2174         { }
2175
2176     /**
2177         Copy constructor.
2178     */
2179     wxRichTextEvent(const wxRichTextEvent& event)
2180         : wxNotifyEvent(event),
2181         m_flags(event.m_flags), m_position(-1),
2182         m_oldStyleSheet(event.m_oldStyleSheet), m_newStyleSheet(event.m_newStyleSheet),
2183         m_char((wxChar) 0), m_container(event.m_container), m_oldContainer(event.m_oldContainer)
2184         { }
2185
2186     /**
2187         Returns the buffer position at which the event occured.
2188     */
2189     long GetPosition() const { return m_position; }
2190
2191     /**
2192         Sets the buffer position variable.
2193     */
2194     void SetPosition(long pos) { m_position = pos; }
2195
2196     /**
2197         Returns flags indicating modifier keys pressed.
2198
2199         Possible values are @c wxRICHTEXT_CTRL_DOWN, @c wxRICHTEXT_SHIFT_DOWN, and @c wxRICHTEXT_ALT_DOWN.
2200     */
2201     int GetFlags() const { return m_flags; }
2202
2203     /**
2204         Sets flags indicating modifier keys pressed.
2205
2206         Possible values are @c wxRICHTEXT_CTRL_DOWN, @c wxRICHTEXT_SHIFT_DOWN, and @c wxRICHTEXT_ALT_DOWN.
2207     */
2208     void SetFlags(int flags) { m_flags = flags; }
2209
2210     /**
2211         Returns the old style sheet.
2212
2213         Can be used in a @c wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING or
2214         @c wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGED event handler.
2215     */
2216     wxRichTextStyleSheet* GetOldStyleSheet() const { return m_oldStyleSheet; }
2217
2218     /**
2219         Sets the old style sheet variable.
2220     */
2221     void SetOldStyleSheet(wxRichTextStyleSheet* sheet) { m_oldStyleSheet = sheet; }
2222
2223     /**
2224         Returns the new style sheet.
2225
2226         Can be used in a @c wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING or
2227         @c wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGED event handler.
2228     */
2229     wxRichTextStyleSheet* GetNewStyleSheet() const { return m_newStyleSheet; }
2230
2231     /**
2232         Sets the new style sheet variable.
2233     */
2234     void SetNewStyleSheet(wxRichTextStyleSheet* sheet) { m_newStyleSheet = sheet; }
2235
2236     /**
2237         Gets the range for the current operation.
2238     */
2239     const wxRichTextRange& GetRange() const { return m_range; }
2240
2241     /**
2242         Sets the range variable.
2243     */
2244     void SetRange(const wxRichTextRange& range) { m_range = range; }
2245
2246     /**
2247         Returns the character pressed, within a @c wxEVT_COMMAND_RICHTEXT_CHARACTER event.
2248     */
2249     wxChar GetCharacter() const { return m_char; }
2250
2251     /**
2252         Sets the character variable.
2253     */
2254     void SetCharacter(wxChar ch) { m_char = ch; }
2255
2256     /**
2257         Returns the container for which the event is relevant.
2258     */
2259     wxRichTextParagraphLayoutBox* GetContainer() const { return m_container; }
2260
2261     /**
2262         Sets the container for which the event is relevant.
2263     */
2264     void SetContainer(wxRichTextParagraphLayoutBox* container) { m_container = container; }
2265
2266     /**
2267         Returns the old container, for a focus change event.
2268     */
2269     wxRichTextParagraphLayoutBox* GetOldContainer() const { return m_oldContainer; }
2270
2271     /**
2272         Sets the old container, for a focus change event.
2273     */
2274     void SetOldContainer(wxRichTextParagraphLayoutBox* container) { m_oldContainer = container; }
2275
2276     virtual wxEvent *Clone() const { return new wxRichTextEvent(*this); }
2277
2278 protected:
2279     int                             m_flags;
2280     long                            m_position;
2281     wxRichTextStyleSheet*           m_oldStyleSheet;
2282     wxRichTextStyleSheet*           m_newStyleSheet;
2283     wxRichTextRange                 m_range;
2284     wxChar                          m_char;
2285     wxRichTextParagraphLayoutBox*   m_container;
2286     wxRichTextParagraphLayoutBox*   m_oldContainer;
2287
2288 private:
2289     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxRichTextEvent)
2290 };