Add new sample project files.

[wxWidgets.git] / interface / wx / richtext / richtextctrl.h
diff --git a/interface/wx/richtext/richtextctrl.h b/interface/wx/richtext/richtextctrl.h

index 72fc00fd8f17eaad2516f420bc03636d98051b2e..baf58d29a6456117c5ceded43263cb94a0ce3780 100644 (file)
--- a/interface/wx/richtext/richtextctrl.h
+++ b/interface/wx/richtext/richtextctrl.h
@@ -1,155 +1,163 @@
  /////////////////////////////////////////////////////////////////////////////
  /////////////////////////////////////////////////////////////////////////////
-// Name:        richtext/richtextctrl.h
-// Purpose:     interface of wxRichTextCtrl and wxRichTextEvent
-// Author:      wxWidgets team
+// Name:        wx/richtext/richtextctrl.h
+// Purpose:     A rich edit control
+// Author:      Julian Smart
+// Modified by:
+// Created:     2005-09-30
  // RCS-ID:      $Id$
  // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence
  /////////////////////////////////////////////////////////////////////////////
  
  /////////////////////////////////////////////////////////////////////////////
  
+/*
+ * Styles and flags
+ */
+
  /**
  /**
-    @class wxRichTextEvent
+    Styles
+*/
  
  
-    This is the event class for wxRichTextCtrl notifications.
+#define wxRE_READONLY          0x0010
+#define wxRE_MULTILINE         0x0020
+#define wxRE_CENTRE_CARET      0x8000
+#define wxRE_CENTER_CARET      wxRE_CENTRE_CARET
  
  
-    @beginEventTable{wxRichTextEvent}
-    @event{EVT_RICHTEXT_CHARACTER(id, func)}
-        Process a wxEVT_COMMAND_RICHTEXT_CHARACTER event, generated when the user
-        presses a character key. Valid event functions: GetFlags, GetPosition, GetCharacter.
-    @event{EVT_RICHTEXT_DELETE(id, func)}
-        Process a wxEVT_COMMAND_RICHTEXT_DELETE event, generated when the user
-        presses the backspace or delete key. Valid event functions: GetFlags, GetPosition.
-    @event{EVT_RICHTEXT_RETURN(id, func)}
-        Process a wxEVT_COMMAND_RICHTEXT_RETURN event, generated when the user
-        presses the return key. Valid event functions: GetFlags, GetPosition.
-    @event{EVT_RICHTEXT_STYLE_CHANGED(id, func)}
-        Process a wxEVT_COMMAND_RICHTEXT_STYLE_CHANGED event, generated when
-        styling has been applied to the control. Valid event functions: GetPosition, GetRange.
-    @event{EVT_RICHTEXT_STYLESHEET_CHANGED(id, func)}
-        Process a wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING event, generated
-        when the control's stylesheet has changed, for example the user added,
-        edited or deleted a style. Valid event functions: GetRange, GetPosition.
-    @event{EVT_RICHTEXT_STYLESHEET_REPLACING(id, func)}
-        Process a wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACING event, generated
-        when the control's stylesheet is about to be replaced, for example when
-        a file is loaded into the control.
-        Valid event functions: Veto, GetOldStyleSheet, GetNewStyleSheet.
-    @event{EVT_RICHTEXT_STYLESHEET_REPLACED(id, func)}
-        Process a wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACED event, generated
-        when the control's stylesheet has been replaced, for example when a file
-        is loaded into the control.
-        Valid event functions: GetOldStyleSheet, GetNewStyleSheet.
-    @event{EVT_RICHTEXT_CONTENT_INSERTED(id, func)}
-        Process a wxEVT_COMMAND_RICHTEXT_CONTENT_INSERTED event, generated when
-        content has been inserted into the control.
-        Valid event functions: GetPosition, GetRange.
-    @event{EVT_RICHTEXT_CONTENT_DELETED(id, func)}
-        Process a wxEVT_COMMAND_RICHTEXT_CONTENT_DELETED event, generated when
-        content has been deleted from the control.
-        Valid event functions: GetPosition, GetRange.
-    @event{EVT_RICHTEXT_BUFFER_RESET(id, func)}
-        Process a wxEVT_COMMAND_RICHTEXT_BUFFER_RESET event, generated when the
-        buffer has been reset by deleting all content.
-        You can use this to set a default style for the first new paragraph.
-    @endEventTable
+/**
+    Flags
+*/
  
  
-    @library{wxrichtext}
-    @category{events,richtext}
+#define wxRICHTEXT_SHIFT_DOWN  0x01
+#define wxRICHTEXT_CTRL_DOWN   0x02
+#define wxRICHTEXT_ALT_DOWN    0x04
+
+/**
+    Extra flags
  */
  */
-class wxRichTextEvent : public wxNotifyEvent
+
+// Don't draw guide lines around boxes and tables
+#define wxRICHTEXT_EX_NO_GUIDELINES 0x00000100
+
+
+/*
+    Defaults
+*/
+
+#define wxRICHTEXT_DEFAULT_OVERALL_SIZE wxSize(-1, -1)
+#define wxRICHTEXT_DEFAULT_IMAGE_SIZE wxSize(80, 80)
+#define wxRICHTEXT_DEFAULT_SPACING 3
+#define wxRICHTEXT_DEFAULT_MARGIN 3
+#define wxRICHTEXT_DEFAULT_UNFOCUSSED_BACKGROUND wxColour(175, 175, 175)
+#define wxRICHTEXT_DEFAULT_FOCUSSED_BACKGROUND wxColour(140, 140, 140)
+#define wxRICHTEXT_DEFAULT_UNSELECTED_BACKGROUND wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE)
+#define wxRICHTEXT_DEFAULT_TYPE_COLOUR wxColour(0, 0, 200)
+#define wxRICHTEXT_DEFAULT_FOCUS_RECT_COLOUR wxColour(100, 80, 80)
+#define wxRICHTEXT_DEFAULT_CARET_WIDTH 2
+// Minimum buffer size before delayed layout kicks in
+#define wxRICHTEXT_DEFAULT_DELAYED_LAYOUT_THRESHOLD 20000
+// Milliseconds before layout occurs after resize
+#define wxRICHTEXT_DEFAULT_LAYOUT_INTERVAL 50
+
+/* Identifiers
+ */
+#define wxID_RICHTEXT_PROPERTIES1   (wxID_HIGHEST + 1)
+#define wxID_RICHTEXT_PROPERTIES2   (wxID_HIGHEST + 2)
+#define wxID_RICHTEXT_PROPERTIES3   (wxID_HIGHEST + 3)
+
+/*
+    Normal selection occurs initially and as user drags within one container.
+    Common ancestor selection occurs when the user starts dragging across containers
+    that have a common ancestor, for example the cells in a table.
+ */
+
+enum wxRichTextCtrlSelectionState
  {
  {
-public:
-    /**
-        Copy constructor.
-    */
-    wxRichTextEvent(const wxRichTextEvent& event);
+    wxRichTextCtrlSelectionState_Normal,
+    wxRichTextCtrlSelectionState_CommonAncestor
+};
  
  
-    /**
-        Constructor.
+/**
+    @class wxRichTextContextMenuPropertiesInfo
  
  
-        @param commandType
-            The type of the event.
-        @param id
-            Window identifier. The value @c wxID_ANY indicates a default value.
-    */
-    wxRichTextEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
+    wxRichTextContextMenuPropertiesInfo keeps track of objects that appear in the context menu,
+    whose properties are available to be edited.
+ */
  
  
+class WXDLLIMPEXP_RICHTEXT wxRichTextContextMenuPropertiesInfo
+{
+public:
      /**
      /**
-        Clones the event.
+        Constructor.
      */
      */
-    wxEvent* Clone() const;
+    wxRichTextContextMenuPropertiesInfo() { Init(); }
+
+// Operations
  
      /**
  
      /**
-        Returns the character pressed, within a wxEVT_COMMAND_RICHTEXT_CHARACTER event.
+        Initialisation.
      */
      */
-    wxChar GetCharacter() const;
+    void Init() {}
  
      /**
  
      /**
-        Returns flags indicating modifier keys pressed.
-
-        Possible values are wxRICHTEXT_CTRL_DOWN, wxRICHTEXT_SHIFT_DOWN, and wxRICHTEXT_ALT_DOWN.
+        Adds an item.
      */
      */
-    int GetFlags() const;
+    bool AddItem(const wxString& label, wxRichTextObject* obj);
  
      /**
  
      /**
-        Returns the new style sheet.
-
-        Can be used in a wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING or
-        wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGED event handler.
+        Returns the number of menu items that were added.
      */
      */
-    wxRichTextStyleSheet* GetNewStyleSheet() const;
+    int AddMenuItems(wxMenu* menu, int startCmd = wxID_RICHTEXT_PROPERTIES1) const;
  
      /**
  
      /**
-        Returns the old style sheet.
-
-        Can be used in a wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING or
-        wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGED event handler.
+        Adds appropriate menu items for the current container and clicked on object
+        (and container's parent, if appropriate).
      */
      */
-    wxRichTextStyleSheet* GetOldStyleSheet() const;
+    int AddItems(wxRichTextObject* container, wxRichTextObject* obj);
  
      /**
  
      /**
-        Returns the buffer position at which the event occured.
+        Clears the items.
      */
      */
-    long GetPosition() const;
+    void Clear() { m_objects.Clear(); m_labels.Clear(); }
+
+// Accessors
  
      /**
  
      /**
-        Gets the range for the current operation.
+        Returns the nth label.
      */
      */
-    const wxRichTextRange& GetRange() const;
+    wxString GetLabel(int n) const { return m_labels[n]; }
  
      /**
  
      /**
-        Sets the character variable.
+        Returns the nth object.
      */
      */
-    void SetCharacter(wxChar ch);
+    wxRichTextObject* GetObject(int n) const { return m_objects[n]; }
  
      /**
  
      /**
-        Sets flags indicating modifier keys pressed.
-
-        Possible values are wxRICHTEXT_CTRL_DOWN, wxRICHTEXT_SHIFT_DOWN, and wxRICHTEXT_ALT_DOWN.
+        Returns the array of objects.
      */
      */
-    void SetFlags(int flags);
+    wxRichTextObjectPtrArray& GetObjects() { return m_objects; }
  
      /**
  
      /**
-        Sets the new style sheet variable.
+        Returns the array of objects.
      */
      */
-    void SetNewStyleSheet(wxRichTextStyleSheet* sheet);
+    const wxRichTextObjectPtrArray& GetObjects() const { return m_objects; }
  
      /**
  
      /**
-        Sets the old style sheet variable.
+        Returns the array of labels.
      */
      */
-    void SetOldStyleSheet(wxRichTextStyleSheet* sheet);
+    wxArrayString& GetLabels() { return m_labels; }
  
      /**
  
      /**
-        Sets the buffer position variable.
+        Returns the array of labels.
      */
      */
-    void SetPosition(long pos);
+    const wxArrayString& GetLabels() const { return m_labels; }
  
      /**
  
      /**
-        Sets the range variable.
+        Returns the number of items.
      */
      */
-    void SetRange(const wxRichTextRange& range);
-};
-
+    int GetCount() const { return m_objects.GetCount(); }
  
  
+    wxRichTextObjectPtrArray    m_objects;
+    wxArrayString               m_labels;
+};
  
  /**
      @class wxRichTextCtrl
  
  /**
      @class wxRichTextCtrl
@@ -159,21 +167,41 @@ public:
  
      wxRichTextCtrl sends notification events: see wxRichTextEvent.
  
  
      wxRichTextCtrl sends notification events: see wxRichTextEvent.
  
-    It also sends the standard wxTextCtrl events wxEVT_COMMAND_TEXT_ENTER and
-    wxEVT_COMMAND_TEXT_UPDATED, and wxTextUrlEvent when URL content is clicked.
+    It also sends the standard wxTextCtrl events @c wxEVT_COMMAND_TEXT_ENTER and
+    @c wxEVT_COMMAND_TEXT_UPDATED, and wxTextUrlEvent when URL content is clicked.
  
      For more information, see the @ref overview_richtextctrl.
  
  
      For more information, see the @ref overview_richtextctrl.
  
+    @beginStyleTable
+    @style{wxRE_CENTRE_CARET}
+           The control will try to keep the caret line centred vertically while editing.
+           wxRE_CENTER_CARET is a synonym for this style.
+    @style{wxRE_MULTILINE}
+           The control will be multiline (mandatory).
+    @style{wxRE_READONLY}
+           The control will not be editable.
+    @endStyleTable
+
      @library{wxrichtext}
      @category{richtext}
      @library{wxrichtext}
      @category{richtext}
-*/
-class wxRichTextCtrl
+    @appearance{richtextctrl.png}
+
+ */
+
+class WXDLLIMPEXP_RICHTEXT wxRichTextCtrl : public wxControl,
+                                            public wxTextCtrlIface,
+                                            public wxScrollHelper
  {
  {
+    DECLARE_CLASS( wxRichTextCtrl )
+    DECLARE_EVENT_TABLE()
+
  public:
  public:
+// Constructors
+
      /**
      /**
-        Default Constructor.
+        Default constructor.
      */
      */
-    wxRichTextCtrl();
+    wxRichTextCtrl( );
  
      /**
          Constructor, creating and showing a rich text control.
  
      /**
          Constructor, creating and showing a rich text control.
@@ -197,1236 +225,1454 @@ public:
  
          @see Create(), wxValidator
      */
  
          @see Create(), wxValidator
      */
-    wxRichTextCtrl(wxWindow* parent, wxWindowID id = wxID_ANY,
-                   const wxString& value = wxEmptyString,
-                   const wxPoint& pos = wxDefaultPosition,
-                   const wxSize& size = wxDefaultSize,
-                   long style = wxRE_MULTILINE,
-                   const wxValidator& validator = wxDefaultValidator,
-                   const wxString& name = wxTextCtrlNameStr);
+    wxRichTextCtrl( wxWindow* parent, wxWindowID id = -1, const wxString& value = wxEmptyString, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
+        long style = wxRE_MULTILINE, const wxValidator& validator = wxDefaultValidator, const wxString& name = wxTextCtrlNameStr);
  
      /**
          Destructor.
      */
  
      /**
          Destructor.
      */
-    virtual ~wxRichTextCtrl();
+    virtual ~wxRichTextCtrl( );
+
+// Operations
  
      /**
  
      /**
-        Adds an image to the control's buffer.
+        Creates the underlying window.
      */
      */
-    virtual wxRichTextRange AddImage(const wxImage& image);
+    bool Create( wxWindow* parent, wxWindowID id = -1, const wxString& value = wxEmptyString, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
+        long style = wxRE_MULTILINE, const wxValidator& validator = wxDefaultValidator, const wxString& name = wxTextCtrlNameStr );
  
      /**
  
      /**
-        Adds a new paragraph of text to the end of the buffer.
+        Initialises the members of the control.
      */
      */
-    virtual wxRichTextRange AddParagraph(const wxString& text);
+    void Init();
+
+// Accessors
  
      /**
  
      /**
-        Sets the insertion point to the end of the buffer and writes the text.
+        Gets the text for the given range.
+        The end point of range is specified as the last character position of
+        the span of text, plus one.
      */
      */
-    virtual void AppendText(const wxString& text);
+    virtual wxString GetRange(long from, long to) const;
  
      /**
  
      /**
-        Applies the given alignment to the selection (undoable).
-        For alignment values, see wxTextAttr.
+        Returns the length of the specified line in characters.
      */
      */
-    virtual bool ApplyAlignmentToSelection(wxTextAttrAlignment alignment);
+    virtual int GetLineLength(long lineNo) const ;
  
      /**
  
      /**
-        Apples bold to the selection (undoable).
+        Returns the text for the given line.
      */
      */
-    virtual bool ApplyBoldToSelection();
+    virtual wxString GetLineText(long lineNo) const ;
  
      /**
  
      /**
-        Applies italic to the selection (undoable).
+        Returns the number of lines in the buffer.
      */
      */
-    virtual bool ApplyItalicToSelection();
+    virtual int GetNumberOfLines() const ;
  
      /**
  
      /**
-        Applies the given style to the selection.
+        Returns @true if the buffer has been modified.
      */
      */
-    virtual bool ApplyStyle(wxRichTextStyleDefinition* def);
+    virtual bool IsModified() const ;
  
      /**
  
      /**
-        Applies the style sheet to the buffer, matching paragraph styles in the sheet
-        against named styles in the buffer.
-
-        This might be useful if the styles have changed.
-        If @a sheet is @NULL, the sheet set with SetStyleSheet() is used.
-        Currently this applies paragraph styles only.
+        Returns @true if the control is editable.
      */
      */
-    bool ApplyStyleSheet(wxRichTextStyleSheet* sheet = NULL);
+    virtual bool IsEditable() const ;
  
      /**
  
      /**
-        Applies underline to the selection (undoable).
+        Returns @true if the control is single-line.
+        Currently wxRichTextCtrl does not support single-line editing.
      */
      */
-    virtual bool ApplyUnderlineToSelection();
+    bool IsSingleLine() const { return !HasFlag(wxRE_MULTILINE); }
  
      /**
  
      /**
-        Returns @true if undo commands are being batched.
+        Returns @true if the control is multiline.
      */
      */
-    virtual bool BatchingUndo() const;
+    bool IsMultiLine() const { return !IsSingleLine(); }
  
  
+    //@{
      /**
      /**
-        Begins using alignment.
-        For alignment values, see wxTextAttr.
+        Returns the range of the current selection.
+        The end point of range is specified as the last character position of the span
+        of text, plus one.
+        If the return values @a from and @a to are the same, there is no selection.
      */
      */
-    bool BeginAlignment(wxTextAttrAlignment alignment);
+    virtual void GetSelection(long* from, long* to) const;
+    const wxRichTextSelection& GetSelection() const { return m_selection; }
+    wxRichTextSelection& GetSelection() { return m_selection; }
+    //@}
  
      /**
  
      /**
-        Starts batching undo history for commands.
+        Returns the text within the current selection range, if any.
      */
      */
-    virtual bool BeginBatchUndo(const wxString& cmdName);
+    virtual wxString GetStringSelection() const;
  
      /**
  
      /**
-        Begins using bold.
+        Gets the current filename associated with the control.
      */
      */
-    bool BeginBold();
+    wxString GetFilename() const { return m_filename; }
  
      /**
  
      /**
-        Begins using the named character style.
+        Sets the current filename.
      */
      */
-    bool BeginCharacterStyle(const wxString& characterStyle);
+    void SetFilename(const wxString& filename) { m_filename = filename; }
  
      /**
  
      /**
-        Begins using this font.
+        Sets the size of the buffer beyond which layout is delayed during resizing.
+        This optimizes sizing for large buffers. The default is 20000.
      */
      */
-    bool BeginFont(const wxFont& font);
+    void SetDelayedLayoutThreshold(long threshold) { m_delayedLayoutThreshold = threshold; }
  
      /**
  
      /**
-        Begins using the given point size.
+        Gets the size of the buffer beyond which layout is delayed during resizing.
+        This optimizes sizing for large buffers. The default is 20000.
      */
      */
-    bool BeginFontSize(int pointSize);
+    long GetDelayedLayoutThreshold() const { return m_delayedLayoutThreshold; }
  
      /**
  
      /**
-        Begins using italic.
      */
      */
-    bool BeginItalic();
+    bool GetFullLayoutRequired() const { return m_fullLayoutRequired; }
  
      /**
  
      /**
-        Begins applying a left indent and subindent in tenths of a millimetre.
-        The subindent is an offset from the left edge of the paragraph, and is
-        used for all but the first line in a paragraph. A positive value will
-        cause the first line to appear to the left of the subsequent lines, and
-        a negative value will cause the first line to be indented to the right
-        of the subsequent lines.
-
-        wxRichTextBuffer uses indentation to render a bulleted item. The
-        content of the paragraph, including the first line, starts at the
-        @a leftIndent plus the @a leftSubIndent.
-
-        @param leftIndent
-            The distance between the margin and the bullet.
-        @param leftSubIndent
-             The distance between the left edge of the bullet and the left edge
-             of the actual paragraph.
      */
      */
-    bool BeginLeftIndent(int leftIndent, int leftSubIndent = 0);
+    void SetFullLayoutRequired(bool b) { m_fullLayoutRequired = b; }
  
      /**
  
      /**
-        Begins appling line spacing. @e spacing is a multiple, where 10 means
-        single-spacing, 15 means 1.5 spacing, and 20 means double spacing.
-
-        The ::wxTextAttrLineSpacing constants are defined for convenience.
      */
      */
-    bool BeginLineSpacing(int lineSpacing);
+    wxLongLong GetFullLayoutTime() const { return m_fullLayoutTime; }
  
      /**
  
      /**
-        Begins using a specified list style.
-        Optionally, you can also pass a level and a number.
      */
      */
-    bool BeginListStyle(const wxString& listStyle, int level = 1,
-                        int number = 1);
+    void SetFullLayoutTime(wxLongLong t) { m_fullLayoutTime = t; }
  
      /**
  
      /**
-        Begins a numbered bullet.
-
-        This call will be needed for each item in the list, and the
-        application should take care of incrementing the numbering.
-
-        @a bulletNumber is a number, usually starting with 1.
-        @a leftIndent and @a leftSubIndent are values in tenths of a millimetre.
-        @a bulletStyle is a bitlist of the  ::wxTextAttrBulletStyle values.
-
-        wxRichTextBuffer uses indentation to render a bulleted item.
-        The left indent is the distance between the margin and the bullet.
-        The content of the paragraph, including the first line, starts
-        at leftMargin + leftSubIndent.
-        So the distance between the left edge of the bullet and the
-        left of the actual paragraph is leftSubIndent.
      */
      */
-    bool BeginNumberedBullet(int bulletNumber, int leftIndent,
-                             int leftSubIndent,
-                             int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_ARABIC|wxTEXT_ATTR_BULLET_STYLE_PERIOD);
+    long GetFullLayoutSavedPosition() const { return m_fullLayoutSavedPosition; }
  
      /**
  
      /**
-        Begins paragraph spacing; pass the before-paragraph and after-paragraph spacing
-        in tenths of a millimetre.
      */
      */
-    bool BeginParagraphSpacing(int before, int after);
+    void SetFullLayoutSavedPosition(long p) { m_fullLayoutSavedPosition = p; }
  
  
+    // Force any pending layout due to large buffer
      /**
      /**
-        Begins applying the named paragraph style.
      */
      */
-    bool BeginParagraphStyle(const wxString& paragraphStyle);
+    void ForceDelayedLayout();
  
      /**
  
      /**
-        Begins a right indent, specified in tenths of a millimetre.
+        Sets the text (normal) cursor.
      */
      */
-    bool BeginRightIndent(int rightIndent);
+    void SetTextCursor(const wxCursor& cursor ) { m_textCursor = cursor; }
  
      /**
  
      /**
-        Begins applying a style.
+        Returns the text (normal) cursor.
      */
      */
-    virtual bool BeginStyle(const wxTextAttr& style);
+    wxCursor GetTextCursor() const { return m_textCursor; }
  
      /**
  
      /**
-        Starts suppressing undo history for commands.
+        Sets the cursor to be used over URLs.
      */
      */
-    virtual bool BeginSuppressUndo();
+    void SetURLCursor(const wxCursor& cursor ) { m_urlCursor = cursor; }
  
      /**
  
      /**
-        Begins applying a symbol bullet, using a character from the current font.
-        See BeginNumberedBullet() for an explanation of how indentation is used
-        to render the bulleted paragraph.
+        Returns the cursor to be used over URLs.
      */
      */
-    bool BeginSymbolBullet(const wxString& symbol, int leftIndent,
-                           int leftSubIndent,
-                           int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_SYMBOL);
+    wxCursor GetURLCursor() const { return m_urlCursor; }
  
      /**
  
      /**
-        Begins using this colour.
+        Returns @true if we are showing the caret position at the start of a line
+        instead of at the end of the previous one.
      */
      */
-    bool BeginTextColour(const wxColour& colour);
+    bool GetCaretAtLineStart() const { return m_caretAtLineStart; }
  
      /**
  
      /**
-        Begins applying wxTEXT_ATTR_URL to the content.
-
-        Pass a URL and optionally, a character style to apply, since it is common
-        to mark a URL with a familiar style such as blue text with underlining.
+        Sets a flag to remember that we are showing the caret position at the start of a line
+        instead of at the end of the previous one.
      */
      */
-    bool BeginURL(const wxString& url,
-                  const wxString& characterStyle = wxEmptyString);
+    void SetCaretAtLineStart(bool atStart) { m_caretAtLineStart = atStart; }
  
      /**
  
      /**
-        Begins using underlining.
+        Returns @true if we are dragging a selection.
      */
      */
-    bool BeginUnderline();
+    bool GetDragging() const { return m_dragging; }
  
      /**
  
      /**
-        Returns @true if selected content can be copied to the clipboard.
+        Sets a flag to remember if we are dragging a selection.
      */
      */
-    virtual bool CanCopy() const;
+    void SetDragging(bool dragging) { m_dragging = dragging; }
  
      /**
  
      /**
-        Returns @true if selected content can be copied to the clipboard and deleted.
+        Returns the drag start position.
      */
      */
-    virtual bool CanCut() const;
+    const wxPoint& GetDragStart() const { return m_dragStart; }
  
      /**
  
      /**
-        Returns @true if selected content can be deleted.
+        Sets the drag start position.
      */
      */
-    virtual bool CanDeleteSelection() const;
+    void SetDragStart(const wxPoint& pt) { m_dragStart = pt; }
  
  
+#if wxRICHTEXT_BUFFERED_PAINTING
+    //@{
      /**
      /**
-        Returns @true if the clipboard content can be pasted to the buffer.
+        Returns the buffer bitmap if using buffered painting.
      */
      */
-    virtual bool CanPaste() const;
+    const wxBitmap& GetBufferBitmap() const { return m_bufferBitmap; }
+    wxBitmap& GetBufferBitmap() { return m_bufferBitmap; }
+    //@}
+#endif
  
      /**
  
      /**
-        Returns @true if there is a command in the command history that can be redone.
+        Returns the current context menu.
      */
      */
-    virtual bool CanRedo() const;
+    wxMenu* GetContextMenu() const { return m_contextMenu; }
  
      /**
  
      /**
-        Returns @true if there is a command in the command history that can be undone.
+        Sets the current context menu.
      */
      */
-    virtual bool CanUndo() const;
+    void SetContextMenu(wxMenu* menu);
  
      /**
  
      /**
-        Clears the buffer content, leaving a single empty paragraph. Cannot be undone.
+        Returns an anchor so we know how to extend the selection.
+        It's a caret position since it's between two characters.
      */
      */
-    virtual void Clear();
+    long GetSelectionAnchor() const { return m_selectionAnchor; }
  
  
-    //@{
      /**
      /**
-        Clears the list style from the given range, clearing list-related attributes
-        and applying any named paragraph style associated with each paragraph.
-
-        @a flags is a bit list of the following:
-        - wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
-
-        @see SetListStyle(), PromoteList(), NumberList().
+        Sets an anchor so we know how to extend the selection.
+        It's a caret position since it's between two characters.
      */
      */
-    bool ClearListStyle(const wxRichTextRange& range,
-                        int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
-    bool ClearListStyle(const wxRichTextRange& range,
-                        int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
-    //@}
+    void SetSelectionAnchor(long anchor) { m_selectionAnchor = anchor; }
  
      /**
  
      /**
-        Sends the event to the control.
+        Returns the anchor object if selecting multiple containers.
      */
      */
-    virtual void Command(wxCommandEvent& event);
+    wxRichTextObject* GetSelectionAnchorObject() const { return m_selectionAnchorObject; }
  
      /**
  
      /**
-        Copies the selected content (if any) to the clipboard.
+        Sets the anchor object if selecting multiple containers.
      */
      */
-    virtual void Copy();
+    void SetSelectionAnchorObject(wxRichTextObject* anchor) { m_selectionAnchorObject = anchor; }
  
  
+    //@{
      /**
      /**
-        Creates the underlying window.
+        Returns an object that stores information about context menu property item(s),
+        in order to communicate between the context menu event handler and the code
+        that responds to it. The wxRichTextContextMenuPropertiesInfo stores one
+        item for each object that could respond to a property-editing event. If
+        objects are nested, several might be editable.
      */
      */
-    bool Create(wxWindow* parent, wxWindowID id = wxID_ANY,
-                const wxString& value = wxEmptyString,
-                const wxPoint& pos = wxDefaultPosition,
-                const wxSize& size = wxDefaultSize,
-                long style = wxRE_MULTILINE,
-                const wxValidator& validator = wxDefaultValidator,
-                const wxString& name = wxTextCtrlNameStr);
+    wxRichTextContextMenuPropertiesInfo& GetContextMenuPropertiesInfo() { return m_contextMenuPropertiesInfo; }
+    const wxRichTextContextMenuPropertiesInfo& GetContextMenuPropertiesInfo() const { return m_contextMenuPropertiesInfo; }
+    //@}
  
      /**
  
      /**
-        Copies the selected content (if any) to the clipboard and deletes the selection.
-        This is undoable.
+        Returns the wxRichTextObject object that currently has the editing focus.
+        If there are no composite objects, this will be the top-level buffer.
      */
      */
-    virtual void Cut();
+    wxRichTextParagraphLayoutBox* GetFocusObject() const { return m_focusObject; }
  
      /**
  
      /**
-        Deletes the content within the given range.
+        Sets the wxRichTextObject object that currently has the editing focus.
      */
      */
-    virtual bool Delete(const wxRichTextRange& range);
+    bool SetFocusObject(wxRichTextParagraphLayoutBox* obj, bool setCaretPosition = true);
+
+// Operations
  
      /**
  
      /**
-        Deletes content if there is a selection, e.g. when pressing a key.
-        Returns the new caret position in @e newPos, or leaves it if there
-        was no action. This is undoable.
+        Invalidates the whole buffer to trigger painting later.
      */
      */
-    bool DeleteSelectedContent(long* newPos = NULL);
+    void Invalidate() { GetBuffer().Invalidate(wxRICHTEXT_ALL); }
  
      /**
  
      /**
-        Deletes the content in the selection, if any. This is undoable.
+        Clears the buffer content, leaving a single empty paragraph. Cannot be undone.
      */
      */
-    virtual void DeleteSelection();
+    virtual void Clear();
  
      /**
  
      /**
-        Sets the buffer's modified status to @false, and clears the buffer's command
-        history.
+        Replaces the content in the specified range with the string specified by
+        @a value.
      */
      */
-    virtual void DiscardEdits();
+    virtual void Replace(long from, long to, const wxString& value);
  
      /**
  
      /**
-        Currently this simply returns @c wxSize(10, 10).
+        Removes the content in the specified range.
      */
      */
-    virtual wxSize DoGetBestSize() const;
+    virtual void Remove(long from, long to);
  
  
+#ifdef DOXYGEN
      /**
      /**
-        Ends alignment.
-    */
-    bool EndAlignment();
+        Loads content into the control's buffer using the given type.
  
  
-    /**
-        Ends application of all styles in the current style stack.
-    */
-    virtual bool EndAllStyles();
+        If the specified type is wxRICHTEXT_TYPE_ANY, the type is deduced from
+        the filename extension.
  
  
-    /**
-        Ends batching undo command history.
+        This function looks for a suitable wxRichTextFileHandler object.
      */
      */
-    virtual bool EndBatchUndo();
+    bool LoadFile(const wxString& file,
+                  int type = wxRICHTEXT_TYPE_ANY);
+#endif
  
      /**
  
      /**
-        Ends using bold.
-    */
-    bool EndBold();
+        Helper function for LoadFile(). Loads content into the control's buffer using the given type.
  
  
-    /**
-        Ends application of a named character style.
+        If the specified type is wxRICHTEXT_TYPE_ANY, the type is deduced from
+        the filename extension.
+
+        This function looks for a suitable wxRichTextFileHandler object.
      */
      */
-    bool EndCharacterStyle();
+    virtual bool DoLoadFile(const wxString& file, int fileType);
  
  
+#ifdef DOXYGEN
      /**
      /**
-        Ends using a font.
+        Saves the buffer content using the given type.
+
+        If the specified type is wxRICHTEXT_TYPE_ANY, the type is deduced from
+        the filename extension.
+
+        This function looks for a suitable wxRichTextFileHandler object.
      */
      */
-    bool EndFont();
+    bool SaveFile(const wxString& file = wxEmptyString,
+                  int type = wxRICHTEXT_TYPE_ANY);
+#endif
  
      /**
  
      /**
-        Ends using a point size.
+        Helper function for SaveFile(). Saves the buffer content using the given type.
+
+        If the specified type is wxRICHTEXT_TYPE_ANY, the type is deduced from
+        the filename extension.
+
+        This function looks for a suitable wxRichTextFileHandler object.
      */
      */
-    bool EndFontSize();
+    virtual bool DoSaveFile(const wxString& file = wxEmptyString,
+                            int fileType = wxRICHTEXT_TYPE_ANY);
  
      /**
  
      /**
-        Ends using italic.
+        Sets flags that change the behaviour of loading or saving.
+
+        See the documentation for each handler class to see what flags are
+        relevant for each handler.
      */
      */
-    bool EndItalic();
+    void SetHandlerFlags(int flags) { GetBuffer().SetHandlerFlags(flags); }
  
      /**
  
      /**
-        Ends left indent.
+        Returns flags that change the behaviour of loading or saving.
+        See the documentation for each handler class to see what flags are
+        relevant for each handler.
      */
      */
-    bool EndLeftIndent();
+    int GetHandlerFlags() const { return GetBuffer().GetHandlerFlags(); }
  
      /**
  
      /**
-        Ends line spacing.
+        Marks the buffer as modified.
      */
      */
-    bool EndLineSpacing();
+    virtual void MarkDirty();
  
      /**
  
      /**
-        Ends using a specified list style.
+        Sets the buffer's modified status to @false, and clears the buffer's command
+        history.
      */
      */
-    bool EndListStyle();
+    virtual void DiscardEdits();
  
      /**
  
      /**
-        Ends application of a numbered bullet.
+        Sets the maximum number of characters that may be entered in a single line
+        text control. For compatibility only; currently does nothing.
      */
      */
-    bool EndNumberedBullet();
+    virtual void SetMaxLength(unsigned long WXUNUSED(len)) { }
  
      /**
  
      /**
-        Ends paragraph spacing.
+        Writes text at the current position.
      */
      */
-    bool EndParagraphSpacing();
+    virtual void WriteText(const wxString& text);
  
      /**
  
      /**
-        Ends application of a named character style.
+        Sets the insertion point to the end of the buffer and writes the text.
      */
      */
-    bool EndParagraphStyle();
+    virtual void AppendText(const wxString& text);
  
  
+    //@{
      /**
      /**
-        Ends right indent.
+        Gets the attributes at the given position.
+        This function gets the combined style - that is, the style you see on the
+        screen as a result of combining base style, paragraph style and character
+        style attributes.
+
+        To get the character or paragraph style alone, use GetUncombinedStyle().
+
+        @beginWxPerlOnly
+        In wxPerl this method is implemented as GetStyle(@a position)
+        returning a 2-element list (ok, attr).
+        @endWxPerlOnly
      */
      */
-    bool EndRightIndent();
+    virtual bool GetStyle(long position, wxTextAttr& style);
+    virtual bool GetStyle(long position, wxRichTextAttr& style);
+    virtual bool GetStyle(long position, wxRichTextAttr& style, wxRichTextParagraphLayoutBox* container);
+    //@}
  
  
+    //@{
      /**
      /**
-        Ends the current style.
+        Sets the attributes for the given range.
+        The end point of range is specified as the last character position of the span
+        of text, plus one.
+
+        So, for example, to set the style for a character at position 5, use the range
+        (5,6).
      */
      */
-    virtual bool EndStyle();
+    virtual bool SetStyle(long start, long end, const wxTextAttr& style);
+    virtual bool SetStyle(long start, long end, const wxRichTextAttr& style);
+    virtual bool SetStyle(const wxRichTextRange& range, const wxTextAttr& style);
+    virtual bool SetStyle(const wxRichTextRange& range, const wxRichTextAttr& style);
+    //@}
  
      /**
  
      /**
-        Ends suppressing undo command history.
+        Sets the attributes for a single object
      */
      */
-    virtual bool EndSuppressUndo();
+    virtual void SetStyle(wxRichTextObject *obj, const wxRichTextAttr& textAttr);
  
  
+    //@{
      /**
      /**
-        Ends applying a symbol bullet.
+        Gets the attributes common to the specified range.
+        Attributes that differ in value within the range will not be included
+        in @a style flags.
+
+        @beginWxPerlOnly
+        In wxPerl this method is implemented as GetStyleForRange(@a position)
+        returning a 2-element list (ok, attr).
+        @endWxPerlOnly
      */
      */
-    bool EndSymbolBullet();
+    virtual bool GetStyleForRange(const wxRichTextRange& range, wxTextAttr& style);
+    virtual bool GetStyleForRange(const wxRichTextRange& range, wxRichTextAttr& style);
+    virtual bool GetStyleForRange(const wxRichTextRange& range, wxRichTextAttr& style, wxRichTextParagraphLayoutBox* container);
+    //@}
  
      /**
  
      /**
-        Ends applying a text colour.
+        Sets the attributes for the given range, passing flags to determine how the
+        attributes are set.
+
+        The end point of range is specified as the last character position of the span
+        of text, plus one. So, for example, to set the style for a character at
+        position 5, use the range (5,6).
+
+        @a flags may contain a bit list of the following values:
+        - wxRICHTEXT_SETSTYLE_NONE: no style flag.
+        - wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this operation should be
+          undoable.
+        - wxRICHTEXT_SETSTYLE_OPTIMIZE: specifies that the style should not be applied
+          if the combined style at this point is already the style in question.
+        - wxRICHTEXT_SETSTYLE_PARAGRAPHS_ONLY: specifies that the style should only be
+          applied to paragraphs, and not the content.
+          This allows content styling to be preserved independently from that
+          of e.g. a named paragraph style.
+        - wxRICHTEXT_SETSTYLE_CHARACTERS_ONLY: specifies that the style should only be
+          applied to characters, and not the paragraph.
+          This allows content styling to be preserved independently from that
+          of e.g. a named paragraph style.
+        - wxRICHTEXT_SETSTYLE_RESET: resets (clears) the existing style before applying
+          the new style.
+        - wxRICHTEXT_SETSTYLE_REMOVE: removes the specified style. Only the style flags
+          are used in this operation.
      */
      */
-    bool EndTextColour();
+    virtual bool SetStyleEx(const wxRichTextRange& range, const wxRichTextAttr& style, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
  
  
+    //@{
      /**
      /**
-        Ends applying a URL.
+        Gets the attributes at the given position.
+        This function gets the @e uncombined style - that is, the attributes associated
+        with the paragraph or character content, and not necessarily the combined
+        attributes you see on the screen.
+        To get the combined attributes, use GetStyle().
+
+        If you specify (any) paragraph attribute in @e style's flags, this function
+        will fetch the paragraph attributes.
+        Otherwise, it will return the character attributes.
+
+        @beginWxPerlOnly
+        In wxPerl this method is implemented as GetUncombinedStyle(@a position)
+        returning a 2-element list (ok, attr).
+        @endWxPerlOnly
      */
      */
-    bool EndURL();
+    virtual bool GetUncombinedStyle(long position, wxRichTextAttr& style);
+    virtual bool GetUncombinedStyle(long position, wxRichTextAttr& style, wxRichTextParagraphLayoutBox* container);
+    //@}
  
  
+    //@{
      /**
      /**
-        End applying underlining.
+        Sets the current default style, which can be used to change how subsequently
+        inserted text is displayed.
      */
      */
-    bool EndUnderline();
+    virtual bool SetDefaultStyle(const wxTextAttr& style);
+    virtual bool SetDefaultStyle(const wxRichTextAttr& style);
+    //@}
  
      /**
  
      /**
-        Helper function for extending the selection, returning @true if the selection
-        was changed. Selections are in caret positions.
+        Returns the current default style, which can be used to change how subsequently
+        inserted text is displayed.
      */
      */
-    virtual bool ExtendSelection(long oldPosition, long newPosition, int flags);
+    virtual const wxRichTextAttr& GetDefaultStyleEx() const;
  
  
+    //virtual const wxTextAttr& GetDefaultStyle() const;
+
+    //@{
      /**
      /**
-        Helper function for finding the caret position for the next word.
-        Direction is 1 (forward) or -1 (backwards).
+        Sets the list attributes for the given range, passing flags to determine how
+        the attributes are set.
+
+        Either the style definition or the name of the style definition (in the current
+        sheet) can be passed.
+        @a flags is a bit list of the following:
+        - wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
+        - wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from
+          @a startFrom, otherwise existing attributes are used.
+        - wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used
+          as the level for all paragraphs, otherwise the current indentation will be used.
+
+        @see NumberList(), PromoteList(), ClearListStyle().
      */
      */
-    virtual long FindNextWordPosition(int direction = 1) const;
+    virtual bool SetListStyle(const wxRichTextRange& range, wxRichTextListStyleDefinition* def, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1);
+    virtual bool SetListStyle(const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1);
+    //@}
  
      /**
  
      /**
-        Call this function to prevent refresh and allow fast updates, and then Thaw() to
-        refresh the control.
+        Clears the list style from the given range, clearing list-related attributes
+        and applying any named paragraph style associated with each paragraph.
+
+        @a flags is a bit list of the following:
+        - wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
+
+        @see SetListStyle(), PromoteList(), NumberList().
      */
      */
-    void Freeze();
+    virtual bool ClearListStyle(const wxRichTextRange& range, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
  
  
+    //@{
      /**
      /**
-        Gets the basic (overall) style.
+        Numbers the paragraphs in the given range.
+        Pass flags to determine how the attributes are set.
  
  
-        This is the style of the whole buffer before further styles are applied,
-        unlike the default style, which only affects the style currently being
-        applied (for example, setting the default style to bold will cause
-        subsequently inserted text to be bold).
+        Either the style definition or the name of the style definition (in the current
+        sheet) can be passed.
+
+        @a flags is a bit list of the following:
+        - wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
+        - wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from
+          @a startFrom, otherwise existing attributes are used.
+        - wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used
+          as the level for all paragraphs, otherwise the current indentation will be used.
+
+        @see SetListStyle(), PromoteList(), ClearListStyle().
      */
      */
-    virtual const wxTextAttr& GetBasicStyle() const;
+    virtual bool NumberList(const wxRichTextRange& range, wxRichTextListStyleDefinition* def = NULL, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1);
+    virtual bool NumberList(const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1);
+    //@}
  
      //@{
      /**
  
      //@{
      /**
-        Returns the buffer associated with the control.
+        Promotes or demotes the paragraphs in the given range.
+        A positive @a promoteBy produces a smaller indent, and a negative number
+        produces a larger indent. Pass flags to determine how the attributes are set.
+        Either the style definition or the name of the style definition (in the current
+        sheet) can be passed.
+
+        @a flags is a bit list of the following:
+        - wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
+        - wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from
+          @a startFrom, otherwise existing attributes are used.
+        - wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used
+        as the level for all paragraphs, otherwise the current indentation will be used.
+
+        @see SetListStyle(), @see SetListStyle(), ClearListStyle().
      */
      */
-    const wxRichTextBuffer GetBuffer();
-    const wxRichTextBuffer&  GetBuffer();
+    virtual bool PromoteList(int promoteBy, const wxRichTextRange& range, wxRichTextListStyleDefinition* def = NULL, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int specifiedLevel = -1);
+    virtual bool PromoteList(int promoteBy, const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int specifiedLevel = -1);
      //@}
  
      /**
      //@}
  
      /**
-        Returns the current caret position.
+        Deletes the content within the given range.
      */
      */
-    long GetCaretPosition() const;
+    virtual bool Delete(const wxRichTextRange& range);
  
      /**
  
      /**
-        Returns the caret height and position for the given character position.
+        Translates from column and line number to position.
      */
      */
-    bool GetCaretPositionForIndex(long position, wxRect& rect);
+    virtual long XYToPosition(long x, long y) const;
  
      /**
  
      /**
-        Gets the command processor associated with the control's buffer.
+        Converts a text position to zero-based column and line numbers.
      */
      */
-    wxCommandProcessor* GetCommandProcessor() const;
+    virtual bool PositionToXY(long pos, long *x, long *y) const;
  
      /**
  
      /**
-        Returns the current default style, which can be used to change how subsequently
-        inserted text is displayed.
+        Scrolls the buffer so that the given position is in view.
      */
      */
-    virtual const wxTextAttr& GetDefaultStyle() const;
+    virtual void ShowPosition(long pos);
  
  
+    //@{
      /**
      /**
-        Gets the size of the buffer beyond which layout is delayed during resizing.
-        This optimizes sizing for large buffers. The default is 20000.
+        Finds the character at the given position in pixels.
+        @a pt is in device coords (not adjusted for the client area origin nor for
+        scrolling).
      */
      */
-    long GetDelayedLayoutThreshold() const;
+    virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
+    virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
+                                            wxTextCoord *col,
+                                            wxTextCoord *row) const;
+    //@}
+
+// Clipboard operations
  
      /**
  
      /**
-        Gets the current filename associated with the control.
+        Copies the selected content (if any) to the clipboard.
      */
      */
-    wxString GetFilename() const;
+    virtual void Copy();
  
      /**
  
      /**
-        Returns the first visible position in the current view.
+        Copies the selected content (if any) to the clipboard and deletes the selection.
+        This is undoable.
      */
      */
-    long GetFirstVisiblePosition() const;
+    virtual void Cut();
  
      /**
  
      /**
-        Returns flags that change the behaviour of loading or saving.
-        See the documentation for each handler class to see what flags are
-        relevant for each handler.
+        Pastes content from the clipboard to the buffer.
      */
      */
-    int GetHandlerFlags() const;
+    virtual void Paste();
  
      /**
  
      /**
-        Returns the current insertion point.
+        Deletes the content in the selection, if any. This is undoable.
      */
      */
-    virtual long GetInsertionPoint() const;
+    virtual void DeleteSelection();
  
      /**
  
      /**
-        Returns the last position in the buffer.
+        Returns @true if selected content can be copied to the clipboard.
      */
      */
-    virtual wxTextPos GetLastPosition() const;
+    virtual bool CanCopy() const;
  
      /**
  
      /**
-        Returns the length of the specified line in characters.
+        Returns @true if selected content can be copied to the clipboard and deleted.
      */
      */
-    virtual int GetLineLength(long lineNo) const;
+    virtual bool CanCut() const;
  
      /**
  
      /**
-        Returns the text for the given line.
+        Returns @true if the clipboard content can be pasted to the buffer.
      */
      */
-    virtual wxString GetLineText(long lineNo) const;
+    virtual bool CanPaste() const;
  
      /**
  
      /**
-        Transforms physical window position to logical (unscrolled) position.
+        Returns @true if selected content can be deleted.
      */
      */
-    wxPoint GetLogicalPoint(const wxPoint& ptPhysical) const;
+    virtual bool CanDeleteSelection() const;
  
      /**
  
      /**
-        Returns the number of lines in the buffer.
+        Undoes the command at the top of the command history, if there is one.
      */
      */
-    virtual int GetNumberOfLines() const;
+    virtual void Undo();
  
      /**
  
      /**
-        Transforms logical (unscrolled) position to physical window position.
+        Redoes the current command.
      */
      */
-    wxPoint GetPhysicalPoint(const wxPoint& ptLogical) const;
+    virtual void Redo();
  
      /**
  
      /**
-        Gets the text for the given range.
-        The end point of range is specified as the last character position of
-        the span of text, plus one.
+        Returns @true if there is a command in the command history that can be undone.
      */
      */
-    virtual wxString GetRange(long from, long to) const;
+    virtual bool CanUndo() const;
  
      /**
  
      /**
-        Returns the range of the current selection.
-        The end point of range is specified as the last character position of the span
-        of text, plus one.
-        If the return values @a from and @a to are the same, there is no selection.
+        Returns @true if there is a command in the command history that can be redone.
      */
      */
-    virtual void GetSelection(long* from, long* to) const;
+    virtual bool CanRedo() const;
  
      /**
  
      /**
-        Returns the selection range in character positions. -1, -1 means no selection.
+        Sets the insertion point and causes the current editing style to be taken from
+        the new position (unlike wxRichTextCtrl::SetCaretPosition).
      */
      */
-    wxRichTextRange GetSelectionRange() const;
+    virtual void SetInsertionPoint(long pos);
  
      /**
  
      /**
-        Returns the text within the current selection range, if any.
+        Sets the insertion point to the end of the text control.
      */
      */
-    virtual wxString GetStringSelection() const;
+    virtual void SetInsertionPointEnd();
  
      /**
  
      /**
-        Gets the attributes at the given position.
-        This function gets the combined style - that is, the style you see on the
-        screen as a result of combining base style, paragraph style and character
-        style attributes.
-
-        To get the character or paragraph style alone, use GetUncombinedStyle().
+        Returns the current insertion point.
      */
      */
-    virtual bool GetStyle(long position, wxTextAttr& style);
+    virtual long GetInsertionPoint() const;
  
      /**
  
      /**
-        Gets the attributes common to the specified range.
-        Attributes that differ in value within the range will not be included
-        in @a style flags.
+        Returns the last position in the buffer.
      */
      */
-    virtual bool GetStyleForRange(const wxRichTextRange& range,
-                                  wxTextAttr& style);
+    virtual wxTextPos GetLastPosition() const;
  
  
+    //@{
      /**
      /**
-        Returns the style sheet associated with the control, if any.
-        A style sheet allows named character and paragraph styles to be applied.
+        Sets the selection to the given range.
+        The end point of range is specified as the last character position of the span
+        of text, plus one.
+
+        So, for example, to set the selection for a character at position 5, use the
+        range (5,6).
      */
      */
-    wxRichTextStyleSheet* GetStyleSheet() const;
+    virtual void SetSelection(long from, long to);
+    void SetSelection(const wxRichTextSelection& sel) { m_selection = sel; }
+    //@}
  
  
-    /**
-        Gets the attributes at the given position.
-        This function gets the @e uncombined style - that is, the attributes associated
-        with the paragraph or character content, and not necessarily the combined
-        attributes you see on the screen.
-        To get the combined attributes, use GetStyle().
  
  
-        If you specify (any) paragraph attribute in @e style's flags, this function
-        will fetch the paragraph attributes.
-        Otherwise, it will return the character attributes.
+    /**
+        Selects all the text in the buffer.
      */
      */
-    virtual bool GetUncombinedStyle(long position, wxTextAttr& style);
+    virtual void SelectAll();
  
      /**
  
      /**
-        Returns the content of the entire control as a string.
+        Makes the control editable, or not.
      */
      */
-    virtual wxString GetValue() const;
+    virtual void SetEditable(bool editable);
  
      /**
  
      /**
-        Internal helper function returning the line for the visible caret position.
-        If the caret is shown at the very end of the line, it means the next character
-        is actually on the following line.
-        So this function gets the line we're expecting to find if this is the case.
+        Returns @true if there is a selection and the object containing the selection
+        was the same as the current focus object.
      */
      */
-    wxRichTextLine* GetVisibleLineForCaretPosition(long caretPosition) const;
+    virtual bool HasSelection() const;
  
      /**
  
      /**
-        Test if this whole range has character attributes of the specified kind.
-        If any of the attributes are different within the range, the test fails.
-
-        You can use this to implement, for example, bold button updating.
-        @a style must have flags indicating which attributes are of interest.
+        Returns @true if there was a selection, whether or not the current focus object
+        is the same as the selection's container object.
      */
      */
-    virtual bool HasCharacterAttributes(const wxRichTextRange& range,
-                                        const wxTextAttr& style) const;
+    virtual bool HasUnfocusedSelection() const;
  
  
+    //@{
      /**
      /**
-        Test if this whole range has paragraph attributes of the specified kind.
-        If any of the attributes are different within the range, the test fails.
-        You can use this to implement, for example, centering button updating.
-        @a style must have flags indicating which attributes are of interest.
+        Write a bitmap or image at the current insertion point.
+        Supply an optional type to use for internal and file storage of the raw data.
      */
      */
-    virtual bool HasParagraphAttributes(const wxRichTextRange& range,
-                                        const wxTextAttr& style) const;
+    virtual bool WriteImage(const wxImage& image, wxBitmapType bitmapType = wxBITMAP_TYPE_PNG,
+                            const wxRichTextAttr& textAttr = wxRichTextAttr());
+
+    virtual bool WriteImage(const wxBitmap& bitmap, wxBitmapType bitmapType = wxBITMAP_TYPE_PNG,
+                            const wxRichTextAttr& textAttr = wxRichTextAttr());
+    //@}
  
      /**
  
      /**
-        Returns @true if there is a selection.
+        Loads an image from a file and writes it at the current insertion point.
      */
      */
-    virtual bool HasSelection() const;
+    virtual bool WriteImage(const wxString& filename, wxBitmapType bitmapType,
+                            const wxRichTextAttr& textAttr = wxRichTextAttr());
  
  
-    //@{
      /**
      /**
-        Finds the character at the given position in pixels.
-        @a pt is in device coords (not adjusted for the client area origin nor for
-        scrolling).
+        Writes an image block at the current insertion point.
      */
      */
-    wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long* pos) const;
-    const wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
-                                          wxTextCoord* col,
-                                          wxTextCoord* row) const;
-    //@}
+    virtual bool WriteImage(const wxRichTextImageBlock& imageBlock,
+                            const wxRichTextAttr& textAttr = wxRichTextAttr());
  
      /**
  
      /**
-        Initialises the members of the control.
+        Write a text box at the current insertion point, returning the text box.
+        You can then call SetFocusObject() to set the focus to the new object.
      */
      */
-    void Init();
+    virtual wxRichTextBox* WriteTextBox(const wxRichTextAttr& textAttr = wxRichTextAttr());
  
      /**
  
      /**
-        Initialises the command event.
+        Write a table at the current insertion point, returning the table.
+        You can then call SetFocusObject() to set the focus to the new object.
      */
      */
-    void InitCommandEvent(wxCommandEvent& event) const;
+    virtual wxRichTextTable* WriteTable(int rows, int cols, const wxRichTextAttr& tableAttr = wxRichTextAttr(), const wxRichTextAttr& cellAttr = wxRichTextAttr());
  
      /**
  
      /**
-        Returns @true if the user has recently set the default style without moving
-        the caret, and therefore the UI needs to reflect the default style and not
-        the style at the caret.
+        Inserts a new paragraph at the current insertion point. @see LineBreak().
+    */
+    virtual bool Newline();
  
  
-        Below is an example of code that uses this function to determine whether the UI
-        should show that the current style is bold.
+    /**
+        Inserts a line break at the current insertion point.
  
  
-        @see SetAndShowDefaultStyle().
+        A line break forces wrapping within a paragraph, and can be introduced by
+        using this function, by appending the wxChar value @b  wxRichTextLineBreakChar
+        to text content, or by typing Shift-Return.
      */
      */
-    bool IsDefaultStyleShowing() const;
+    virtual bool LineBreak();
  
      /**
  
      /**
-        Returns @true if the control is editable.
+        Sets the basic (overall) style.
+
+        This is the style of the whole buffer before further styles are applied,
+        unlike the default style, which only affects the style currently being
+        applied (for example, setting the default style to bold will cause
+        subsequently inserted text to be bold).
      */
      */
-    virtual bool IsEditable() const;
+    virtual void SetBasicStyle(const wxRichTextAttr& style) { GetBuffer().SetBasicStyle(style); }
  
      /**
  
      /**
-        Returns @true if Freeze has been called without a Thaw.
+        Gets the basic (overall) style.
+
+        This is the style of the whole buffer before further styles are applied,
+        unlike the default style, which only affects the style currently being
+        applied (for example, setting the default style to bold will cause
+        subsequently inserted text to be bold).
      */
      */
-    bool IsFrozen() const;
+    virtual const wxRichTextAttr& GetBasicStyle() const { return GetBuffer().GetBasicStyle(); }
  
      /**
  
      /**
-        Returns @true if the buffer has been modified.
+        Begins applying a style.
      */
      */
-    virtual bool IsModified() const;
+    virtual bool BeginStyle(const wxRichTextAttr& style) { return GetBuffer().BeginStyle(style); }
  
      /**
  
      /**
-        Returns @true if the control is multiline.
+        Ends the current style.
      */
      */
-    bool IsMultiLine() const;
+    virtual bool EndStyle() { return GetBuffer().EndStyle(); }
  
      /**
  
      /**
-        Returns @true if the given position is visible on the screen.
+        Ends application of all styles in the current style stack.
      */
      */
-    bool IsPositionVisible(long pos) const;
+    virtual bool EndAllStyles() { return GetBuffer().EndAllStyles(); }
  
      /**
  
      /**
-        Returns @true if all of the selection is aligned according to the specified flag.
+        Begins using bold.
      */
      */
-    virtual bool IsSelectionAligned(wxTextAttrAlignment alignment);
+    bool BeginBold() { return GetBuffer().BeginBold(); }
  
      /**
  
      /**
-        Returns @true if all of the selection is bold.
+        Ends using bold.
      */
      */
-    virtual bool IsSelectionBold();
+    bool EndBold()  { return GetBuffer().EndBold(); }
  
      /**
  
      /**
-        Returns @true if all of the selection is italic.
+        Begins using italic.
      */
      */
-    virtual bool IsSelectionItalics();
+    bool BeginItalic() { return GetBuffer().BeginItalic(); }
  
      /**
  
      /**
-        Returns @true if all of the selection is underlined.
+        Ends using italic.
      */
      */
-    virtual bool IsSelectionUnderlined();
+    bool EndItalic() { return GetBuffer().EndItalic(); }
  
      /**
  
      /**
-        Returns @true if the control is single-line.
-        Currently wxRichTextCtrl does not support single-line editing.
+        Begins using underlining.
      */
      */
-    bool IsSingleLine() const;
+    bool BeginUnderline() { return GetBuffer().BeginUnderline(); }
  
      /**
  
      /**
-        Helper function implementing keyboard navigation.
+        End applying underlining.
      */
      */
-    virtual bool KeyboardNavigate(int keyCode, int flags);
+    bool EndUnderline() { return GetBuffer().EndUnderline(); }
  
      /**
  
      /**
-        Lays out the buffer, which must be done before certain operations, such as
-        setting the caret position.
-        This function should not normally be required by the application.
+        Begins using the given point size.
      */
      */
-    virtual bool LayoutContent(bool onlyVisibleRect = false);
+    bool BeginFontSize(int pointSize) { return GetBuffer().BeginFontSize(pointSize); }
  
      /**
  
      /**
-        Inserts a line break at the current insertion point.
+        Ends using a point size.
+    */
+    bool EndFontSize() { return GetBuffer().EndFontSize(); }
  
  
-        A line break forces wrapping within a paragraph, and can be introduced by
-        using this function, by appending the wxChar value @b  wxRichTextLineBreakChar
-        to text content, or by typing Shift-Return.
+    /**
+        Begins using this font.
      */
      */
-    virtual bool LineBreak();
+    bool BeginFont(const wxFont& font) { return GetBuffer().BeginFont(font); }
  
      /**
  
      /**
-        Loads content into the control's buffer using the given type.
+        Ends using a font.
+    */
+    bool EndFont() { return GetBuffer().EndFont(); }
  
  
-        If the specified type is wxRICHTEXT_TYPE_ANY, the type is deduced from
-        the filename extension.
+    /**
+        Begins using this colour.
+    */
+    bool BeginTextColour(const wxColour& colour) { return GetBuffer().BeginTextColour(colour); }
  
  
-        This function looks for a suitable wxRichTextFileHandler object.
+    /**
+        Ends applying a text colour.
      */
      */
-    bool LoadFile(const wxString& file,
-                  int type = wxRICHTEXT_TYPE_ANY);
+    bool EndTextColour() { return GetBuffer().EndTextColour(); }
  
      /**
  
      /**
-        Marks the buffer as modified.
+        Begins using alignment.
+        For alignment values, see wxTextAttr.
      */
      */
-    virtual void MarkDirty();
+    bool BeginAlignment(wxTextAttrAlignment alignment) { return GetBuffer().BeginAlignment(alignment); }
  
      /**
  
      /**
-        Move the caret to the given character position.
+        Ends alignment.
      */
      */
-    virtual bool MoveCaret(long pos, bool showAtLineStart = false);
+    bool EndAlignment() { return GetBuffer().EndAlignment(); }
  
      /**
  
      /**
-        Move the caret one visual step forward: this may mean setting a flag
-        and keeping the same position if we're going from the end of one line
-        to the start of the next, which may be the exact same caret position.
+        Begins applying a left indent and subindent in tenths of a millimetre.
+        The subindent is an offset from the left edge of the paragraph, and is
+        used for all but the first line in a paragraph. A positive value will
+        cause the first line to appear to the left of the subsequent lines, and
+        a negative value will cause the first line to be indented to the right
+        of the subsequent lines.
+
+        wxRichTextBuffer uses indentation to render a bulleted item. The
+        content of the paragraph, including the first line, starts at the
+        @a leftIndent plus the @a leftSubIndent.
+
+        @param leftIndent
+            The distance between the margin and the bullet.
+        @param leftSubIndent
+             The distance between the left edge of the bullet and the left edge
+             of the actual paragraph.
      */
      */
-    void MoveCaretBack(long oldPosition);
+    bool BeginLeftIndent(int leftIndent, int leftSubIndent = 0) { return GetBuffer().BeginLeftIndent(leftIndent, leftSubIndent); }
  
      /**
  
      /**
-        Move the caret one visual step forward: this may mean setting a flag
-        and keeping the same position if we're going from the end of one line
-        to the start of the next, which may be the exact same caret position.
+        Ends left indent.
      */
      */
-    void MoveCaretForward(long oldPosition);
+    bool EndLeftIndent() { return GetBuffer().EndLeftIndent(); }
  
      /**
  
      /**
-        Moves the caret down.
+        Begins a right indent, specified in tenths of a millimetre.
      */
      */
-    virtual bool MoveDown(int noLines = 1, int flags = 0);
+    bool BeginRightIndent(int rightIndent) { return GetBuffer().BeginRightIndent(rightIndent); }
  
      /**
  
      /**
-        Moves to the end of the buffer.
+        Ends right indent.
      */
      */
-    virtual bool MoveEnd(int flags = 0);
+    bool EndRightIndent() { return GetBuffer().EndRightIndent(); }
  
      /**
  
      /**
-        Moves to the start of the buffer.
+        Begins paragraph spacing; pass the before-paragraph and after-paragraph spacing
+        in tenths of a millimetre.
      */
      */
-    virtual bool MoveHome(int flags = 0);
+    bool BeginParagraphSpacing(int before, int after) { return GetBuffer().BeginParagraphSpacing(before, after); }
  
      /**
  
      /**
-        Moves left.
+        Ends paragraph spacing.
      */
      */
-    virtual bool MoveLeft(int noPositions = 1, int flags = 0);
+    bool EndParagraphSpacing() { return GetBuffer().EndParagraphSpacing(); }
  
      /**
  
      /**
-        Moves right.
+        Begins appling line spacing. @e spacing is a multiple, where 10 means
+        single-spacing, 15 means 1.5 spacing, and 20 means double spacing.
+
+        The ::wxTextAttrLineSpacing constants are defined for convenience.
      */
      */
-    virtual bool MoveRight(int noPositions = 1, int flags = 0);
+    bool BeginLineSpacing(int lineSpacing) { return GetBuffer().BeginLineSpacing(lineSpacing); }
  
      /**
  
      /**
-        Moves to the end of the line.
+        Ends line spacing.
      */
      */
-    virtual bool MoveToLineEnd(int flags = 0);
+    bool EndLineSpacing() { return GetBuffer().EndLineSpacing(); }
  
      /**
  
      /**
-        Moves to the start of the line.
+        Begins a numbered bullet.
+
+        This call will be needed for each item in the list, and the
+        application should take care of incrementing the numbering.
+
+        @a bulletNumber is a number, usually starting with 1.
+        @a leftIndent and @a leftSubIndent are values in tenths of a millimetre.
+        @a bulletStyle is a bitlist of the  ::wxTextAttrBulletStyle values.
+
+        wxRichTextBuffer uses indentation to render a bulleted item.
+        The left indent is the distance between the margin and the bullet.
+        The content of the paragraph, including the first line, starts
+        at leftMargin + leftSubIndent.
+        So the distance between the left edge of the bullet and the
+        left of the actual paragraph is leftSubIndent.
      */
      */
-    virtual bool MoveToLineStart(int flags = 0);
+    bool BeginNumberedBullet(int bulletNumber, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_ARABIC|wxTEXT_ATTR_BULLET_STYLE_PERIOD)
+    { return GetBuffer().BeginNumberedBullet(bulletNumber, leftIndent, leftSubIndent, bulletStyle); }
  
      /**
  
      /**
-        Moves to the end of the paragraph.
+        Ends application of a numbered bullet.
      */
      */
-    virtual bool MoveToParagraphEnd(int flags = 0);
+    bool EndNumberedBullet() { return GetBuffer().EndNumberedBullet(); }
  
      /**
  
      /**
-        Moves to the start of the paragraph.
+        Begins applying a symbol bullet, using a character from the current font.
+        See BeginNumberedBullet() for an explanation of how indentation is used
+        to render the bulleted paragraph.
      */
      */
-    virtual bool MoveToParagraphStart(int flags = 0);
+    bool BeginSymbolBullet(const wxString& symbol, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_SYMBOL)
+    { return GetBuffer().BeginSymbolBullet(symbol, leftIndent, leftSubIndent, bulletStyle); }
  
      /**
  
      /**
-        Moves up.
+        Ends applying a symbol bullet.
      */
      */
-    virtual bool MoveUp(int noLines = 1, int flags = 0);
+    bool EndSymbolBullet() { return GetBuffer().EndSymbolBullet(); }
  
      /**
  
      /**
-        Inserts a new paragraph at the current insertion point. @see LineBreak().
+        Begins applying a symbol bullet.
      */
      */
-    virtual bool Newline();
+    bool BeginStandardBullet(const wxString& bulletName, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_STANDARD)
+    { return GetBuffer().BeginStandardBullet(bulletName, leftIndent, leftSubIndent, bulletStyle); }
  
  
-    //@{
      /**
      /**
-        Numbers the paragraphs in the given range.
-        Pass flags to determine how the attributes are set.
-
-        Either the style definition or the name of the style definition (in the current
-        sheet) can be passed.
-
-        @a flags is a bit list of the following:
-        - wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
-        - wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from
-          @a startFrom, otherwise existing attributes are used.
-        - wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used
-          as the level for all paragraphs, otherwise the current indentation will be used.
-
-        @see SetListStyle(), PromoteList(), ClearListStyle().
+        Begins applying a standard bullet.
      */
      */
-    bool NumberList(const wxRichTextRange& range,
-                    const wxRichTextListStyleDefinition* style,
-                    int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO,
-                    int startFrom = -1,
-                    int listLevel = -1);
-    bool Number(const wxRichTextRange& range,
-                const wxString& styleName,
-                int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO,
-                int startFrom = -1,
-                int listLevel = -1);
-    //@}
+    bool EndStandardBullet() { return GetBuffer().EndStandardBullet(); }
  
      /**
  
      /**
-        Standard handler for the wxID_CLEAR command.
+        Begins using the named character style.
      */
      */
-    void OnClear(wxCommandEvent& event);
+    bool BeginCharacterStyle(const wxString& characterStyle) { return GetBuffer().BeginCharacterStyle(characterStyle); }
  
      /**
  
      /**
-        Shows a standard context menu with undo, redo, cut, copy, paste, clear, and
-        select all commands.
+        Ends application of a named character style.
      */
      */
-    void OnContextMenu(wxContextMenuEvent& event);
+    bool EndCharacterStyle() { return GetBuffer().EndCharacterStyle(); }
  
      /**
  
      /**
-        Standard handler for the wxID_COPY command.
+        Begins applying the named paragraph style.
      */
      */
-    void OnCopy(wxCommandEvent& event);
+    bool BeginParagraphStyle(const wxString& paragraphStyle) { return GetBuffer().BeginParagraphStyle(paragraphStyle); }
  
      /**
  
      /**
-        Standard handler for the wxID_CUT command.
+        Ends application of a named paragraph style.
      */
      */
-    void OnCut(wxCommandEvent& event);
+    bool EndParagraphStyle() { return GetBuffer().EndParagraphStyle(); }
  
      /**
  
      /**
-        Loads the first dropped file.
+        Begins using a specified list style.
+        Optionally, you can also pass a level and a number.
      */
      */
-    void OnDropFiles(wxDropFilesEvent& event);
+    bool BeginListStyle(const wxString& listStyle, int level = 1, int number = 1) { return GetBuffer().BeginListStyle(listStyle, level, number); }
  
      /**
  
      /**
-        Standard handler for the wxID_PASTE command.
+        Ends using a specified list style.
      */
      */
-    void OnPaste(wxCommandEvent& event);
+    bool EndListStyle() { return GetBuffer().EndListStyle(); }
  
      /**
  
      /**
-        Standard handler for the wxID_REDO command.
+        Begins applying wxTEXT_ATTR_URL to the content.
+
+        Pass a URL and optionally, a character style to apply, since it is common
+        to mark a URL with a familiar style such as blue text with underlining.
      */
      */
-    void OnRedo(wxCommandEvent& event);
+    bool BeginURL(const wxString& url, const wxString& characterStyle = wxEmptyString) { return GetBuffer().BeginURL(url, characterStyle); }
  
      /**
  
      /**
-        Standard handler for the wxID_SELECTALL command.
+        Ends applying a URL.
      */
      */
-    void OnSelectAll(wxCommandEvent& event);
+    bool EndURL() { return GetBuffer().EndURL(); }
  
      /**
  
      /**
-        Standard handler for the wxID_PASTE command.
+        Sets the default style to the style under the cursor.
      */
      */
-    void OnUndo(wxCommandEvent& event);
+    bool SetDefaultStyleToCursorStyle();
  
      /**
  
      /**
-        Standard update handler for the wxID_CLEAR command.
+        Cancels any selection.
      */
      */
-    void OnUpdateClear(wxUpdateUIEvent& event);
+    virtual void SelectNone();
  
      /**
  
      /**
-        Standard update handler for the wxID_COPY command.
+        Selects the word at the given character position.
      */
      */
-    void OnUpdateCopy(wxUpdateUIEvent& event);
+    virtual bool SelectWord(long position);
  
      /**
  
      /**
-        Standard update handler for the wxID_CUT command.
+        Returns the selection range in character positions. -1, -1 means no selection.
+
+        The range is in API convention, i.e. a single character selection is denoted
+        by (n, n+1)
      */
      */
-    void OnUpdateCut(wxUpdateUIEvent& event);
+    wxRichTextRange GetSelectionRange() const;
  
      /**
  
      /**
-        Standard update handler for the wxID_PASTE command.
+        Sets the selection to the given range.
+        The end point of range is specified as the last character position of the span
+        of text, plus one.
+
+        So, for example, to set the selection for a character at position 5, use the
+        range (5,6).
      */
      */
-    void OnUpdatePaste(wxUpdateUIEvent& event);
+    void SetSelectionRange(const wxRichTextRange& range);
  
      /**
  
      /**
-        Standard update handler for the wxID_REDO command.
+        Returns the selection range in character positions. -2, -2 means no selection
+        -1, -1 means select everything.
+        The range is in internal format, i.e. a single character selection is denoted
+        by (n, n)
      */
      */
-    void OnUpdateRedo(wxUpdateUIEvent& event);
+    wxRichTextRange GetInternalSelectionRange() const { return m_selection.GetRange(); }
  
      /**
  
      /**
-        Standard update handler for the wxID_SELECTALL command.
+        Sets the selection range in character positions. -2, -2 means no selection
+        -1, -1 means select everything.
+        The range is in internal format, i.e. a single character selection is denoted
+        by (n, n)
      */
      */
-    void OnUpdateSelectAll(wxUpdateUIEvent& event);
+    void SetInternalSelectionRange(const wxRichTextRange& range) { m_selection.Set(range, GetFocusObject()); }
  
      /**
  
      /**
-        Standard update handler for the wxID_UNDO command.
+        Adds a new paragraph of text to the end of the buffer.
      */
      */
-    void OnUpdateUndo(wxUpdateUIEvent& event);
+    virtual wxRichTextRange AddParagraph(const wxString& text);
  
      /**
  
      /**
-        Moves one or more pages down.
+        Adds an image to the control's buffer.
      */
      */
-    virtual bool PageDown(int noPages = 1, int flags = 0);
+    virtual wxRichTextRange AddImage(const wxImage& image);
  
      /**
  
      /**
-        Moves one or more pages up.
+        Lays out the buffer, which must be done before certain operations, such as
+        setting the caret position.
+        This function should not normally be required by the application.
      */
      */
-    virtual bool PageUp(int noPages = 1, int flags = 0);
+    virtual bool LayoutContent(bool onlyVisibleRect = false);
  
      /**
  
      /**
-        Paints the background.
+        Move the caret to the given character position.
+
+        Please note that this does not update the current editing style
+        from the new position; to do that, call wxRichTextCtrl::SetInsertionPoint instead.
      */
      */
-    virtual void PaintBackground(wxDC& dc);
+    virtual bool MoveCaret(long pos, bool showAtLineStart = false, wxRichTextParagraphLayoutBox* container = NULL);
  
      /**
  
      /**
-        Pastes content from the clipboard to the buffer.
+        Moves right.
      */
      */
-    virtual void Paste();
+    virtual bool MoveRight(int noPositions = 1, int flags = 0);
  
      /**
  
      /**
-        Internal function to position the visible caret according to the current caret
-        position.
+        Moves left.
      */
      */
-    virtual void PositionCaret();
+    virtual bool MoveLeft(int noPositions = 1, int flags = 0);
  
      /**
  
      /**
-        Converts a text position to zero-based column and line numbers.
+        Moves to the start of the paragraph.
      */
      */
-    virtual bool PositionToXY(long pos, long* x, long* y) const;
+    virtual bool MoveUp(int noLines = 1, int flags = 0);
  
  
-    //@{
      /**
      /**
-        Promotes or demotes the paragraphs in the given range.
-        A positive @a promoteBy produces a smaller indent, and a negative number
-        produces a larger indent. Pass flags to determine how the attributes are set.
-        Either the style definition or the name of the style definition (in the current
-        sheet) can be passed.
-
-        @a flags is a bit list of the following:
-        - wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
-        - wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from
-          @a startFrom, otherwise existing attributes are used.
-        - wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used
-        as the level for all paragraphs, otherwise the current indentation will be used.
-
-        @see SetListStyle(), @see SetListStyle(), ClearListStyle().
+        Moves the caret down.
      */
      */
-    bool PromoteList(int promoteBy, const wxRichTextRange& range,
-                     const wxRichTextListStyleDefinition* style,
-                     int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO,
-                     int listLevel = -1);
-    bool PromoteList(int promoteBy, const wxRichTextRange& range,
-                     const wxString& styleName,
-                     int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO,
-                     int listLevel = -1);
-    //@}
+    virtual bool MoveDown(int noLines = 1, int flags = 0);
  
      /**
  
      /**
-        Redoes the current command.
+        Moves to the end of the line.
      */
      */
-    virtual void Redo();
+    virtual bool MoveToLineEnd(int flags = 0);
  
      /**
  
      /**
-        Removes the content in the specified range.
+        Moves to the start of the line.
      */
      */
-    virtual void Remove(long from, long to);
+    virtual bool MoveToLineStart(int flags = 0);
  
      /**
  
      /**
-        Replaces the content in the specified range with the string specified by
-        @a value.
+        Moves to the end of the paragraph.
      */
      */
-    virtual void Replace(long from, long to, const wxString& value);
+    virtual bool MoveToParagraphEnd(int flags = 0);
  
      /**
  
      /**
-        Saves the buffer content using the given type.
-
-        If the specified type is wxRICHTEXT_TYPE_ANY, the type is deduced from
-        the filename extension.
-
-        This function looks for a suitable wxRichTextFileHandler object.
+        Moves to the start of the paragraph.
      */
      */
-    bool SaveFile(const wxString& file = wxEmptyString,
-                  int type = wxRICHTEXT_TYPE_ANY);
+    virtual bool MoveToParagraphStart(int flags = 0);
  
      /**
  
      /**
-        Scrolls @a position into view. This function takes a caret position.
+        Moves to the start of the buffer.
      */
      */
-    virtual bool ScrollIntoView(long position, int keyCode);
+    virtual bool MoveHome(int flags = 0);
  
      /**
  
      /**
-        Selects all the text in the buffer.
+        Moves to the end of the buffer.
      */
      */
-    virtual void SelectAll();
+    virtual bool MoveEnd(int flags = 0);
  
      /**
  
      /**
-        Cancels any selection.
+        Moves one or more pages up.
      */
      */
-    virtual void SelectNone();
+    virtual bool PageUp(int noPages = 1, int flags = 0);
  
      /**
  
      /**
-        Sets @a attr as the default style and tells the control that the UI should
-        reflect this attribute until the user moves the caret.
-
-        @see IsDefaultStyleShowing().
+        Moves one or more pages down.
      */
      */
-    void SetAndShowDefaultStyle(const wxTextAttr& attr);
+    virtual bool PageDown(int noPages = 1, int flags = 0);
  
      /**
  
      /**
-        Sets the basic (overall) style.
+        Moves a number of words to the left.
+    */
+    virtual bool WordLeft(int noPages = 1, int flags = 0);
  
  
-        This is the style of the whole buffer before further styles are applied,
-        unlike the default style, which only affects the style currently being
-        applied (for example, setting the default style to bold will cause
-        subsequently inserted text to be bold).
+    /**
+        Move a nuber of words to the right.
      */
      */
-    virtual void SetBasicStyle(const wxTextAttr& style);
+    virtual bool WordRight(int noPages = 1, int flags = 0);
  
  
+    //@{
      /**
      /**
-        The caret position is the character position just before the caret.
-        A value of -1 means the caret is at the start of the buffer.
+        Returns the buffer associated with the control.
      */
      */
-    void SetCaretPosition(long position,
-                          bool showAtLineStart = false);
+    wxRichTextBuffer& GetBuffer() { return m_buffer; }
+    const wxRichTextBuffer& GetBuffer() const { return m_buffer; }
+    //@}
  
      /**
  
      /**
-        Sets the current default style, which can be used to change how subsequently
-        inserted text is displayed.
+        Starts batching undo history for commands.
      */
      */
-    virtual bool SetDefaultStyle(const wxTextAttr& style);
+    virtual bool BeginBatchUndo(const wxString& cmdName) { return m_buffer.BeginBatchUndo(cmdName); }
  
      /**
  
      /**
-        Sets the default style to the style under the cursor.
+        Ends batching undo command history.
      */
      */
-    bool SetDefaultStyleToCursorStyle();
+    virtual bool EndBatchUndo() { return m_buffer.EndBatchUndo(); }
  
      /**
  
      /**
-        Sets the size of the buffer beyond which layout is delayed during resizing.
-        This optimizes sizing for large buffers. The default is 20000.
+        Returns @true if undo commands are being batched.
      */
      */
-    void SetDelayedLayoutThreshold(long threshold);
+    virtual bool BatchingUndo() const { return m_buffer.BatchingUndo(); }
  
      /**
  
      /**
-        Makes the control editable, or not.
+        Starts suppressing undo history for commands.
      */
      */
-    virtual void SetEditable(bool editable);
+    virtual bool BeginSuppressUndo() { return m_buffer.BeginSuppressUndo(); }
  
      /**
  
      /**
-        Sets the current filename.
+        Ends suppressing undo command history.
      */
      */
-    void SetFilename(const wxString& filename);
+    virtual bool EndSuppressUndo() { return m_buffer.EndSuppressUndo(); }
  
      /**
  
      /**
-        Sets the font, and also the basic and default attributes
-        (see wxRichTextCtrl::SetDefaultStyle).
+        Returns @true if undo history suppression is on.
      */
      */
-    virtual bool SetFont(const wxFont& font);
+    virtual bool SuppressingUndo() const { return m_buffer.SuppressingUndo(); }
  
      /**
  
      /**
-        Sets flags that change the behaviour of loading or saving.
+        Test if this whole range has character attributes of the specified kind.
+        If any of the attributes are different within the range, the test fails.
  
  
-        See the documentation for each handler class to see what flags are
-        relevant for each handler.
+        You can use this to implement, for example, bold button updating.
+        @a style must have flags indicating which attributes are of interest.
      */
      */
-    void SetHandlerFlags(int flags);
+    virtual bool HasCharacterAttributes(const wxRichTextRange& range, const wxRichTextAttr& style) const
+    {
+        return GetBuffer().HasCharacterAttributes(range.ToInternal(), style);
+    }
  
      /**
  
      /**
-        Sets the insertion point.
+        Test if this whole range has paragraph attributes of the specified kind.
+        If any of the attributes are different within the range, the test fails.
+        You can use this to implement, for example, centering button updating.
+        @a style must have flags indicating which attributes are of interest.
      */
      */
-    virtual void SetInsertionPoint(long pos);
+    virtual bool HasParagraphAttributes(const wxRichTextRange& range, const wxRichTextAttr& style) const
+    {
+        return GetBuffer().HasParagraphAttributes(range.ToInternal(), style);
+    }
  
      /**
  
      /**
-        Sets the insertion point to the end of the text control.
+        Returns @true if all of the selection is bold.
      */
      */
-    virtual void SetInsertionPointEnd();
+    virtual bool IsSelectionBold();
  
  
-    //@{
      /**
      /**
-        Sets the list attributes for the given range, passing flags to determine how
-        the attributes are set.
-
-        Either the style definition or the name of the style definition (in the current
-        sheet) can be passed.
-        @a flags is a bit list of the following:
-        - wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
-        - wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from
-          @a startFrom, otherwise existing attributes are used.
-        - wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used
-          as the level for all paragraphs, otherwise the current indentation will be used.
-
-        @see NumberList(), PromoteList(), ClearListStyle().
+        Returns @true if all of the selection is italic.
      */
      */
-    bool SetListStyle(const wxRichTextRange& range,
-                      const wxRichTextListStyleDefinition* style,
-                      int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO,
-                      int startFrom = -1,
-                      int listLevel = -1);
-    bool SetListStyle(const wxRichTextRange& range,
-                      const wxString& styleName,
-                      int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO,
-                      int startFrom = -1,
-                      int listLevel = -1);
-    //@}
+    virtual bool IsSelectionItalics();
  
      /**
  
      /**
-        Sets the selection to the given range.
-        The end point of range is specified as the last character position of the span
-        of text, plus one.
-
-        So, for example, to set the selection for a character at position 5, use the
-        range (5,6).
+        Returns @true if all of the selection is underlined.
      */
      */
-    virtual void SetSelection(long from, long to);
+    virtual bool IsSelectionUnderlined();
  
      /**
  
      /**
-        Sets the selection to the given range.
-        The end point of range is specified as the last character position of the span
-        of text, plus one.
-
-        So, for example, to set the selection for a character at position 5, use the
-        range (5,6).
+        Returns @true if all of the selection is aligned according to the specified flag.
      */
      */
-    void SetSelectionRange(const wxRichTextRange& range);
+    virtual bool IsSelectionAligned(wxTextAttrAlignment alignment);
  
  
-    //@{
      /**
      /**
-        Sets the attributes for the given range.
-        The end point of range is specified as the last character position of the span
-        of text, plus one.
-
-        So, for example, to set the style for a character at position 5, use the range
-        (5,6).
+        Apples bold to the selection (undoable).
      */
      */
-    bool SetStyle(const wxRichTextRange& range,
-                  const wxTextAttr& style);
-    bool SetStyle(long start, long end, const wxTextAttr& style);
-    //@}
+    virtual bool ApplyBoldToSelection();
  
  
-    //@{
      /**
      /**
-        Sets the attributes for the given range, passing flags to determine how the
-        attributes are set.
+        Applies italic to the selection (undoable).
+    */
+    virtual bool ApplyItalicToSelection();
  
  
-        The end point of range is specified as the last character position of the span
-        of text, plus one. So, for example, to set the style for a character at
-        position 5, use the range (5,6).
+    /**
+        Applies underline to the selection (undoable).
+    */
+    virtual bool ApplyUnderlineToSelection();
  
  
-        @a flags may contain a bit list of the following values:
-        - wxRICHTEXT_SETSTYLE_NONE: no style flag.
-        - wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this operation should be
-          undoable.
-        - wxRICHTEXT_SETSTYLE_OPTIMIZE: specifies that the style should not be applied
-          if the combined style at this point is already the style in question.
-        - wxRICHTEXT_SETSTYLE_PARAGRAPHS_ONLY: specifies that the style should only be
-          applied to paragraphs, and not the content.
-          This allows content styling to be preserved independently from that
-          of e.g. a named paragraph style.
-        - wxRICHTEXT_SETSTYLE_CHARACTERS_ONLY: specifies that the style should only be
-          applied to characters, and not the paragraph.
-          This allows content styling to be preserved independently from that
-          of e.g. a named paragraph style.
-        - wxRICHTEXT_SETSTYLE_RESET: resets (clears) the existing style before applying
-          the new style.
-        - wxRICHTEXT_SETSTYLE_REMOVE: removes the specified style. Only the style flags
-          are used in this operation.
+    /**
+        Applies the given alignment to the selection (undoable).
+        For alignment values, see wxTextAttr.
      */
      */
-    bool SetStyleEx(const wxRichTextRange& range,
-                    const wxTextAttr& style,
-                    int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
-    bool SetStyleEx(long start, long end,
-                    const wxTextAttr& style,
-                    int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
-    //@}
+    virtual bool ApplyAlignmentToSelection(wxTextAttrAlignment alignment);
+
+    /**
+        Applies the style sheet to the buffer, matching paragraph styles in the sheet
+        against named styles in the buffer.
+
+        This might be useful if the styles have changed.
+        If @a sheet is @NULL, the sheet set with SetStyleSheet() is used.
+        Currently this applies paragraph styles only.
+    */
+    virtual bool ApplyStyle(wxRichTextStyleDefinition* def);
  
      /**
          Sets the style sheet associated with the control.
          A style sheet allows named character and paragraph styles to be applied.
      */
  
      /**
          Sets the style sheet associated with the control.
          A style sheet allows named character and paragraph styles to be applied.
      */
-    void SetStyleSheet(wxRichTextStyleSheet* styleSheet);
+    void SetStyleSheet(wxRichTextStyleSheet* styleSheet) { GetBuffer().SetStyleSheet(styleSheet); }
  
      /**
  
      /**
-        Replaces existing content with the given text.
+        Returns the style sheet associated with the control, if any.
+        A style sheet allows named character and paragraph styles to be applied.
      */
      */
-    virtual void SetValue(const wxString& value);
+    wxRichTextStyleSheet* GetStyleSheet() const { return GetBuffer().GetStyleSheet(); }
+
+    /**
+        Push the style sheet to top of stack.
+    */
+    bool PushStyleSheet(wxRichTextStyleSheet* styleSheet) { return GetBuffer().PushStyleSheet(styleSheet); }
+
+    /**
+        Pops the style sheet from top of stack.
+    */
+    wxRichTextStyleSheet* PopStyleSheet() { return GetBuffer().PopStyleSheet(); }
+
+    /**
+        Applies the style sheet to the buffer, for example if the styles have changed.
+    */
+    bool ApplyStyleSheet(wxRichTextStyleSheet* styleSheet = NULL);
+
+// Command handlers
+
+    /**
+        Sends the event to the control.
+    */
+    void Command(wxCommandEvent& event);
+
+    /**
+        Loads the first dropped file.
+    */
+    void OnDropFiles(wxDropFilesEvent& event);
+
+    void OnCaptureLost(wxMouseCaptureLostEvent& event);
+    void OnSysColourChanged(wxSysColourChangedEvent& event);
+
+    /**
+        Standard handler for the wxID_CUT command.
+    */
+    void OnCut(wxCommandEvent& event);
+
+    /**
+        Standard handler for the wxID_COPY command.
+    */
+    void OnCopy(wxCommandEvent& event);
+
+    /**
+        Standard handler for the wxID_PASTE command.
+    */
+    void OnPaste(wxCommandEvent& event);
+
+    /**
+        Standard handler for the wxID_UNDO command.
+    */
+    void OnUndo(wxCommandEvent& event);
+
+    /**
+        Standard handler for the wxID_REDO command.
+    */
+    void OnRedo(wxCommandEvent& event);
+
+    /**
+        Standard handler for the wxID_SELECTALL command.
+    */
+    void OnSelectAll(wxCommandEvent& event);
+
+    /**
+        Standard handler for property commands.
+    */
+    void OnProperties(wxCommandEvent& event);
+
+    /**
+        Standard handler for the wxID_CLEAR command.
+    */
+    void OnClear(wxCommandEvent& event);
+
+    /**
+        Standard update handler for the wxID_CUT command.
+    */
+    void OnUpdateCut(wxUpdateUIEvent& event);
+
+    /**
+        Standard update handler for the wxID_COPY command.
+    */
+    void OnUpdateCopy(wxUpdateUIEvent& event);
+
+    /**
+        Standard update handler for the wxID_PASTE command.
+    */
+    void OnUpdatePaste(wxUpdateUIEvent& event);
+
+    /**
+        Standard update handler for the wxID_UNDO command.
+    */
+    void OnUpdateUndo(wxUpdateUIEvent& event);
+
+    /**
+        Standard update handler for the wxID_REDO command.
+    */
+    void OnUpdateRedo(wxUpdateUIEvent& event);
+
+    /**
+        Standard update handler for the wxID_SELECTALL command.
+    */
+    void OnUpdateSelectAll(wxUpdateUIEvent& event);
+
+    /**
+        Standard update handler for property commands.
+    */
+
+    void OnUpdateProperties(wxUpdateUIEvent& event);
+
+    /**
+        Standard update handler for the wxID_CLEAR command.
+    */
+    void OnUpdateClear(wxUpdateUIEvent& event);
+
+    /**
+        Shows a standard context menu with undo, redo, cut, copy, paste, clear, and
+        select all commands.
+    */
+    void OnContextMenu(wxContextMenuEvent& event);
+
+// Event handlers
+
+    // Painting
+    void OnPaint(wxPaintEvent& event);
+    void OnEraseBackground(wxEraseEvent& event);
+
+    // Left-click
+    void OnLeftClick(wxMouseEvent& event);
+
+    // Left-up
+    void OnLeftUp(wxMouseEvent& event);
+
+    // Motion
+    void OnMoveMouse(wxMouseEvent& event);
+
+    // Left-double-click
+    void OnLeftDClick(wxMouseEvent& event);
+
+    // Middle-click
+    void OnMiddleClick(wxMouseEvent& event);
+
+    // Right-click
+    void OnRightClick(wxMouseEvent& event);
+
+    // Key press
+    void OnChar(wxKeyEvent& event);
+
+    // Sizing
+    void OnSize(wxSizeEvent& event);
+
+    // Setting/losing focus
+    void OnSetFocus(wxFocusEvent& event);
+    void OnKillFocus(wxFocusEvent& event);
+
+    // Idle-time processing
+    void OnIdle(wxIdleEvent& event);
+
+    // Scrolling
+    void OnScroll(wxScrollWinEvent& event);
+
+    /**
+        Sets the font, and also the basic and default attributes
+        (see wxRichTextCtrl::SetDefaultStyle).
+    */
+    virtual bool SetFont(const wxFont& font);
  
      /**
          A helper function setting up scrollbars, for example after a resize.
  
      /**
          A helper function setting up scrollbars, for example after a resize.
@@ -1434,14 +1680,215 @@ public:
      virtual void SetupScrollbars(bool atTop = false);
  
      /**
      virtual void SetupScrollbars(bool atTop = false);
  
      /**
-        Scrolls the buffer so that the given position is in view.
+        Helper function implementing keyboard navigation.
      */
      */
-    virtual void ShowPosition(long pos);
+    virtual bool KeyboardNavigate(int keyCode, int flags);
  
      /**
  
      /**
-        Returns @true if undo history suppression is on.
+        Paints the background.
+    */
+    virtual void PaintBackground(wxDC& dc);
+
+    /**
+        Other user defined painting after everything else (i.e. all text) is painted.
+
+        @since 2.9.1
+    */
+    virtual void PaintAboveContent(wxDC& WXUNUSED(dc)) {}
+
+#if wxRICHTEXT_BUFFERED_PAINTING
+    /**
+        Recreates the buffer bitmap if necessary.
+    */
+    virtual bool RecreateBuffer(const wxSize& size = wxDefaultSize);
+#endif
+
+    // Write text
+    virtual void DoWriteText(const wxString& value, int flags = 0);
+
+    // Should we inherit colours?
+    virtual bool ShouldInheritColours() const { return false; }
+
+    /**
+        Internal function to position the visible caret according to the current caret
+        position.
+    */
+    virtual void PositionCaret(wxRichTextParagraphLayoutBox* container = NULL);
+
+    /**
+        Helper function for extending the selection, returning @true if the selection
+        was changed. Selections are in caret positions.
      */
      */
-    virtual bool SuppressingUndo() const;
+    virtual bool ExtendSelection(long oldPosition, long newPosition, int flags);
+
+    /**
+        Scrolls @a position into view. This function takes a caret position.
+    */
+    virtual bool ScrollIntoView(long position, int keyCode);
+
+    /**
+        Refreshes the area affected by a selection change.
+    */
+    bool RefreshForSelectionChange(const wxRichTextSelection& oldSelection, const wxRichTextSelection& newSelection);
+
+    /**
+        Sets the caret position.
+
+        The caret position is the character position just before the caret.
+        A value of -1 means the caret is at the start of the buffer.
+        Please note that this does not update the current editing style
+        from the new position or cause the actual caret to be refreshed; to do that,
+        call wxRichTextCtrl::SetInsertionPoint instead.
+    */
+    void SetCaretPosition(long position, bool showAtLineStart = false) ;
+
+    /**
+        Returns the current caret position.
+    */
+    long GetCaretPosition() const { return m_caretPosition; }
+
+    /**
+        The adjusted caret position is the character position adjusted to take
+        into account whether we're at the start of a paragraph, in which case
+        style information should be taken from the next position, not current one.
+    */
+    long GetAdjustedCaretPosition(long caretPos) const;
+
+    /**
+        Move the caret one visual step forward: this may mean setting a flag
+        and keeping the same position if we're going from the end of one line
+        to the start of the next, which may be the exact same caret position.
+    */
+    void MoveCaretForward(long oldPosition) ;
+
+    /**
+        Move the caret one visual step forward: this may mean setting a flag
+        and keeping the same position if we're going from the end of one line
+        to the start of the next, which may be the exact same caret position.
+    */
+    void MoveCaretBack(long oldPosition) ;
+
+    /**
+        Returns the caret height and position for the given character position.
+        If container is null, the current focus object will be used.
+
+        @beginWxPerlOnly
+        In wxPerl this method is implemented as
+        GetCaretPositionForIndex(@a position) returning a
+        2-element list (ok, rect).
+        @endWxPerlOnly
+    */
+    bool GetCaretPositionForIndex(long position, wxRect& rect, wxRichTextParagraphLayoutBox* container = NULL);
+
+    /**
+        Internal helper function returning the line for the visible caret position.
+        If the caret is shown at the very end of the line, it means the next character
+        is actually on the following line.
+        So this function gets the line we're expecting to find if this is the case.
+    */
+    wxRichTextLine* GetVisibleLineForCaretPosition(long caretPosition) const;
+
+    /**
+        Gets the command processor associated with the control's buffer.
+    */
+    wxCommandProcessor* GetCommandProcessor() const { return GetBuffer().GetCommandProcessor(); }
+
+    /**
+        Deletes content if there is a selection, e.g. when pressing a key.
+        Returns the new caret position in @e newPos, or leaves it if there
+        was no action. This is undoable.
+
+        @beginWxPerlOnly
+        In wxPerl this method takes no arguments and returns a 2-element
+        list (ok, newPos).
+        @endWxPerlOnly
+    */
+    bool DeleteSelectedContent(long* newPos= NULL);
+
+    /**
+        Transforms logical (unscrolled) position to physical window position.
+    */
+    wxPoint GetPhysicalPoint(const wxPoint& ptLogical) const;
+
+    /**
+        Transforms physical window position to logical (unscrolled) position.
+    */
+    wxPoint GetLogicalPoint(const wxPoint& ptPhysical) const;
+
+    /**
+        Helper function for finding the caret position for the next word.
+        Direction is 1 (forward) or -1 (backwards).
+    */
+    virtual long FindNextWordPosition(int direction = 1) const;
+
+    /**
+        Returns @true if the given position is visible on the screen.
+    */
+    bool IsPositionVisible(long pos) const;
+
+    /**
+        Returns the first visible position in the current view.
+    */
+    long GetFirstVisiblePosition() const;
+
+    /**
+        Returns the caret position since the default formatting was changed. As
+        soon as this position changes, we no longer reflect the default style
+        in the UI. A value of -2 means that we should only reflect the style of the
+        content under the caret.
+    */
+    long GetCaretPositionForDefaultStyle() const { return m_caretPositionForDefaultStyle; }
+
+    /**
+        Set the caret position for the default style that the user is selecting.
+    */
+    void SetCaretPositionForDefaultStyle(long pos) { m_caretPositionForDefaultStyle = pos; }
+
+    /**
+        Returns @true if the user has recently set the default style without moving
+        the caret, and therefore the UI needs to reflect the default style and not
+        the style at the caret.
+
+        Below is an example of code that uses this function to determine whether the UI
+        should show that the current style is bold.
+
+        @see SetAndShowDefaultStyle().
+    */
+    bool IsDefaultStyleShowing() const { return m_caretPositionForDefaultStyle != -2; }
+
+    /**
+        Sets @a attr as the default style and tells the control that the UI should
+        reflect this attribute until the user moves the caret.
+
+        @see IsDefaultStyleShowing().
+    */
+    void SetAndShowDefaultStyle(const wxRichTextAttr& attr)
+    {
+        SetDefaultStyle(attr);
+        SetCaretPositionForDefaultStyle(GetCaretPosition());
+    }
+
+    /**
+        Returns the first visible point in the window.
+    */
+    wxPoint GetFirstVisiblePoint() const;
+
+#ifdef DOXYGEN
+    /**
+        Returns the content of the entire control as a string.
+    */
+    virtual wxString GetValue() const;
+
+    /**
+        Replaces existing content with the given text.
+    */
+    virtual void SetValue(const wxString& value);
+
+    /**
+        Call this function to prevent refresh and allow fast updates, and then Thaw() to
+        refresh the control.
+    */
+    void Freeze();
  
      /**
          Call this function to end a Freeze and refresh the display.
  
      /**
          Call this function to end a Freeze and refresh the display.
@@ -1449,49 +1896,344 @@ public:
      void Thaw();
  
      /**
      void Thaw();
  
      /**
-        Undoes the command at the top of the command history, if there is one.
+        Returns @true if Freeze has been called without a Thaw.
      */
      */
-    virtual void Undo();
+    bool IsFrozen() const;
+
+#endif
+
+// Implementation
  
      /**
  
      /**
-        Moves a number of words to the left.
+        Sets up the caret for the given position and container, after a mouse click.
      */
      */
-    virtual bool WordLeft(int noWords = 1, int flags = 0);
+    bool SetCaretPositionAfterClick(wxRichTextParagraphLayoutBox* container, long position, int hitTestFlags, bool extendSelection = false);
  
      /**
  
      /**
-        Move a nuber of words to the right.
+        Find the caret position for the combination of hit-test flags and character position.
+        Returns the caret position and also an indication of where to place the caret (caretLineStart)
+        since this is ambiguous (same position used for end of line and start of next).
      */
      */
-    virtual bool WordRight(int noWords = 1, int flags = 0);
+    long FindCaretPositionForCharacterPosition(long position, int hitTestFlags, wxRichTextParagraphLayoutBox* container,
+                                                   bool& caretLineStart);
  
      /**
  
      /**
-        Loads an image from a file and writes it at the current insertion point.
+        Font names take a long time to retrieve, so cache them (on demand).
      */
      */
-    bool WriteImage(const wxString& filename, int bitmapType);
+    static const wxArrayString& GetAvailableFontNames();
  
      /**
  
      /**
-        Writes an image block at the current insertion point.
+        Clears the cache of available font names.
      */
      */
-    virtual bool WriteImage(const wxRichTextImageBlock& imageBlock);
+    static void ClearAvailableFontNames();
+
+    WX_FORWARD_TO_SCROLL_HELPER()
+
+    // implement wxTextEntry methods
+    virtual wxString DoGetValue() const;
+
+protected:
+    // implement the wxTextEntry pure virtual method
+    virtual wxWindow *GetEditableWindow() { return this; }
+
+    // margins functions
+    virtual bool DoSetMargins(const wxPoint& pt);
+    virtual wxPoint DoGetMargins() const;
+
+     // FIXME: this does not work, it allows this code to compile but will fail
+     //        during run-time
+#ifndef __WXUNIVERSAL__
+#ifdef __WXMSW__
+    virtual WXHWND GetEditHWND() const { return GetHWND(); }
+#endif
+#ifdef __WXMOTIF__
+    virtual WXWidget GetTextWidget() const { return NULL; }
+#endif
+#ifdef __WXGTK20__
+    virtual GtkEditable *GetEditable() const { return NULL; }
+    virtual GtkEntry *GetEntry() const { return NULL; }
+#endif
+#endif // !__WXUNIVERSAL__
+
+// Overrides
+protected:
  
  
-    //@{
      /**
      /**
-        Write a bitmap or image at the current insertion point.
-        Supply an optional type to use for internal and file storage of the raw data.
+        Currently this simply returns @c wxSize(10, 10).
      */
      */
-    bool WriteImage(const wxBitmap& bitmap,
-                    int bitmapType = wxBITMAP_TYPE_PNG);
-    bool WriteImage(const wxImage& image,
-                    int bitmapType = wxBITMAP_TYPE_PNG);
-    //@}
+    virtual wxSize DoGetBestSize() const ;
+
+    virtual void DoSetValue(const wxString& value, int flags = 0);
+
+    virtual void DoThaw();
+
+
+// Data members
+private:
+#if wxRICHTEXT_BUFFERED_PAINTING
+    /// Buffer bitmap
+    wxBitmap                m_bufferBitmap;
+#endif
+
+    /// Text buffer
+    wxRichTextBuffer        m_buffer;
+
+    wxMenu*                 m_contextMenu;
+
+    /// Caret position (1 less than the character position, so -1 is the
+    /// first caret position).
+    long                    m_caretPosition;
+
+    /// Caret position when the default formatting has been changed. As
+    /// soon as this position changes, we no longer reflect the default style
+    /// in the UI.
+    long                    m_caretPositionForDefaultStyle;
+
+    /// Selection range in character positions. -2, -2 means no selection.
+    wxRichTextSelection     m_selection;
  
  
+    wxRichTextCtrlSelectionState m_selectionState;
+
+    /// Anchor so we know how to extend the selection
+    /// It's a caret position since it's between two characters.
+    long                    m_selectionAnchor;
+
+    /// Anchor object if selecting multiple container objects, such as grid cells.
+    wxRichTextObject*       m_selectionAnchorObject;
+
+    /// Are we editable?
+    bool                    m_editable;
+
+    /// Are we showing the caret position at the start of a line
+    /// instead of at the end of the previous one?
+    bool                    m_caretAtLineStart;
+
+    /// Are we dragging a selection?
+    bool                    m_dragging;
+
+    /// Start position for drag
+    wxPoint                 m_dragStart;
+
+    /// Do we need full layout in idle?
+    bool                    m_fullLayoutRequired;
+    wxLongLong              m_fullLayoutTime;
+    long                    m_fullLayoutSavedPosition;
+
+    /// Threshold for doing delayed layout
+    long                    m_delayedLayoutThreshold;
+
+    /// Cursors
+    wxCursor                m_textCursor;
+    wxCursor                m_urlCursor;
+
+    static wxArrayString    sm_availableFontNames;
+
+    wxRichTextContextMenuPropertiesInfo m_contextMenuPropertiesInfo;
+
+    /// The object that currently has the editing focus
+    wxRichTextParagraphLayoutBox* m_focusObject;
+};
+
+/**
+    @class wxRichTextEvent
+
+    This is the event class for wxRichTextCtrl notifications.
+
+    @beginEventTable{wxRichTextEvent}
+    @event{EVT_RICHTEXT_LEFT_CLICK(id, func)}
+        Process a @c wxEVT_COMMAND_RICHTEXT_LEFT_CLICK event, generated when the user
+        releases the left mouse button over an object.
+    @event{EVT_RICHTEXT_RIGHT_CLICK(id, func)}
+        Process a @c wxEVT_COMMAND_RICHTEXT_RIGHT_CLICK event, generated when the user
+        releases the right mouse button over an object.
+    @event{EVT_RICHTEXT_MIDDLE_CLICK(id, func)}
+        Process a @c wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK event, generated when the user
+        releases the middle mouse button over an object.
+    @event{EVT_RICHTEXT_LEFT_DCLICK(id, func)}
+        Process a @c wxEVT_COMMAND_RICHTEXT_DLEFT_CLICK event, generated when the user
+        double-clicks an object.
+    @event{EVT_RICHTEXT_RETURN(id, func)}
+        Process a @c wxEVT_COMMAND_RICHTEXT_RETURN event, generated when the user
+        presses the return key. Valid event functions: GetFlags, GetPosition.
+    @event{EVT_RICHTEXT_CHARACTER(id, func)}
+        Process a @c wxEVT_COMMAND_RICHTEXT_CHARACTER event, generated when the user
+        presses a character key. Valid event functions: GetFlags, GetPosition, GetCharacter.
+    @event{EVT_RICHTEXT_DELETE(id, func)}
+        Process a @c wxEVT_COMMAND_RICHTEXT_DELETE event, generated when the user
+        presses the backspace or delete key. Valid event functions: GetFlags, GetPosition.
+    @event{EVT_RICHTEXT_RETURN(id, func)}
+        Process a @c wxEVT_COMMAND_RICHTEXT_RETURN event, generated when the user
+        presses the return key. Valid event functions: GetFlags, GetPosition.
+    @event{EVT_RICHTEXT_STYLE_CHANGED(id, func)}
+        Process a @c wxEVT_COMMAND_RICHTEXT_STYLE_CHANGED event, generated when
+        styling has been applied to the control. Valid event functions: GetPosition, GetRange.
+    @event{EVT_RICHTEXT_STYLESHEET_CHANGED(id, func)}
+        Process a @c wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING event, generated
+        when the control's stylesheet has changed, for example the user added,
+        edited or deleted a style. Valid event functions: GetRange, GetPosition.
+    @event{EVT_RICHTEXT_STYLESHEET_REPLACING(id, func)}
+        Process a @c wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACING event, generated
+        when the control's stylesheet is about to be replaced, for example when
+        a file is loaded into the control.
+        Valid event functions: Veto, GetOldStyleSheet, GetNewStyleSheet.
+    @event{EVT_RICHTEXT_STYLESHEET_REPLACED(id, func)}
+        Process a @c wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACED event, generated
+        when the control's stylesheet has been replaced, for example when a file
+        is loaded into the control.
+        Valid event functions: GetOldStyleSheet, GetNewStyleSheet.
+    @event{EVT_RICHTEXT_CONTENT_INSERTED(id, func)}
+        Process a @c wxEVT_COMMAND_RICHTEXT_CONTENT_INSERTED event, generated when
+        content has been inserted into the control.
+        Valid event functions: GetPosition, GetRange.
+    @event{EVT_RICHTEXT_CONTENT_DELETED(id, func)}
+        Process a @c wxEVT_COMMAND_RICHTEXT_CONTENT_DELETED event, generated when
+        content has been deleted from the control.
+        Valid event functions: GetPosition, GetRange.
+    @event{EVT_RICHTEXT_BUFFER_RESET(id, func)}
+        Process a @c wxEVT_COMMAND_RICHTEXT_BUFFER_RESET event, generated when the
+        buffer has been reset by deleting all content.
+        You can use this to set a default style for the first new paragraph.
+    @event{EVT_RICHTEXT_SELECTION_CHANGED(id, func)}
+        Process a @c wxEVT_COMMAND_RICHTEXT_SELECTION_CHANGED event, generated when the
+        selection range has changed.
+    @event{EVT_RICHTEXT_FOCUS_OBJECT_CHANGED(id, func)}
+        Process a @c wxEVT_COMMAND_RICHTEXT_FOCUS_OBJECT_CHANGED event, generated when the
+        current focus object has changed.
+    @endEventTable
+
+    @library{wxrichtext}
+    @category{events,richtext}
+*/
+
+class WXDLLIMPEXP_RICHTEXT wxRichTextEvent : public wxNotifyEvent
+{
+public:
      /**
      /**
-        Writes text at the current position.
+        Constructor.
+
+        @param commandType
+            The type of the event.
+        @param id
+            Window identifier. The value @c wxID_ANY indicates a default value.
      */
      */
-    virtual void WriteText(const wxString& text);
+    wxRichTextEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
+        : wxNotifyEvent(commandType, winid),
+        m_flags(0), m_position(-1), m_oldStyleSheet(NULL), m_newStyleSheet(NULL),
+        m_char((wxChar) 0), m_container(NULL), m_oldContainer(NULL)
+        { }
  
      /**
  
      /**
-        Translates from column and line number to position.
+        Copy constructor.
      */
      */
-    virtual long XYToPosition(long x, long y) const;
-};
+    wxRichTextEvent(const wxRichTextEvent& event)
+        : wxNotifyEvent(event),
+        m_flags(event.m_flags), m_position(-1),
+        m_oldStyleSheet(event.m_oldStyleSheet), m_newStyleSheet(event.m_newStyleSheet),
+        m_char((wxChar) 0), m_container(event.m_container), m_oldContainer(event.m_oldContainer)
+        { }
  
  
+    /**
+        Returns the buffer position at which the event occured.
+    */
+    long GetPosition() const { return m_position; }
+
+    /**
+        Sets the buffer position variable.
+    */
+    void SetPosition(long pos) { m_position = pos; }
+
+    /**
+        Returns flags indicating modifier keys pressed.
+
+        Possible values are @c wxRICHTEXT_CTRL_DOWN, @c wxRICHTEXT_SHIFT_DOWN, and @c wxRICHTEXT_ALT_DOWN.
+    */
+    int GetFlags() const { return m_flags; }
+
+    /**
+        Sets flags indicating modifier keys pressed.
+
+        Possible values are @c wxRICHTEXT_CTRL_DOWN, @c wxRICHTEXT_SHIFT_DOWN, and @c wxRICHTEXT_ALT_DOWN.
+    */
+    void SetFlags(int flags) { m_flags = flags; }
+
+    /**
+        Returns the old style sheet.
+
+        Can be used in a @c wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING or
+        @c wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGED event handler.
+    */
+    wxRichTextStyleSheet* GetOldStyleSheet() const { return m_oldStyleSheet; }
+
+    /**
+        Sets the old style sheet variable.
+    */
+    void SetOldStyleSheet(wxRichTextStyleSheet* sheet) { m_oldStyleSheet = sheet; }
+
+    /**
+        Returns the new style sheet.
+
+        Can be used in a @c wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING or
+        @c wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGED event handler.
+    */
+    wxRichTextStyleSheet* GetNewStyleSheet() const { return m_newStyleSheet; }
+
+    /**
+        Sets the new style sheet variable.
+    */
+    void SetNewStyleSheet(wxRichTextStyleSheet* sheet) { m_newStyleSheet = sheet; }
+
+    /**
+        Gets the range for the current operation.
+    */
+    const wxRichTextRange& GetRange() const { return m_range; }
+
+    /**
+        Sets the range variable.
+    */
+    void SetRange(const wxRichTextRange& range) { m_range = range; }
+
+    /**
+        Returns the character pressed, within a @c wxEVT_COMMAND_RICHTEXT_CHARACTER event.
+    */
+    wxChar GetCharacter() const { return m_char; }
+
+    /**
+        Sets the character variable.
+    */
+    void SetCharacter(wxChar ch) { m_char = ch; }
+
+    /**
+        Returns the container for which the event is relevant.
+    */
+    wxRichTextParagraphLayoutBox* GetContainer() const { return m_container; }
+
+    /**
+        Sets the container for which the event is relevant.
+    */
+    void SetContainer(wxRichTextParagraphLayoutBox* container) { m_container = container; }
+
+    /**
+        Returns the old container, for a focus change event.
+    */
+    wxRichTextParagraphLayoutBox* GetOldContainer() const { return m_oldContainer; }
+
+    /**
+        Sets the old container, for a focus change event.
+    */
+    void SetOldContainer(wxRichTextParagraphLayoutBox* container) { m_oldContainer = container; }
+
+    virtual wxEvent *Clone() const { return new wxRichTextEvent(*this); }
+
+protected:
+    int                             m_flags;
+    long                            m_position;
+    wxRichTextStyleSheet*           m_oldStyleSheet;
+    wxRichTextStyleSheet*           m_newStyleSheet;
+    wxRichTextRange                 m_range;
+    wxChar                          m_char;
+    wxRichTextParagraphLayoutBox*   m_container;
+    wxRichTextParagraphLayoutBox*   m_oldContainer;
+
+private:
+    DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxRichTextEvent)
+};