Remove some wxT()'s in the docs

[wxWidgets.git] / include / wx / richtext / richtextbuffer.h

diff --git a/include/wx/richtext/richtextbuffer.h b/include/wx/richtext/richtextbuffer.h
index 1a644eac9adf98947c22303fb676cd3126d41ea0..761ed468a4a5e00d496cc1f392321a8df51a096c 100644 (file)
--- a/include/wx/richtext/richtextbuffer.h
+++ b/include/wx/richtext/richtextbuffer.h
@@ -66,6 +66,7 @@
 #include "wx/cmdproc.h"
 #include "wx/txtstrm.h"
 #include "wx/variant.h"
 #include "wx/cmdproc.h"
 #include "wx/txtstrm.h"
 #include "wx/variant.h"

+#include "wx/position.h"

 
 #if wxUSE_DATAOBJ
 #include "wx/dataobj.h"
 
 #if wxUSE_DATAOBJ
 #include "wx/dataobj.h"


@@ -125,6 +126,7 @@ enum wxRichTextFileType
 class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextCtrl;
 class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextObject;
 class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextImage;
 class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextCtrl;
 class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextObject;
 class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextImage;

+class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextPlainText;

 class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextCacheObject;
 class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextObjectList;
 class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextLine;
 class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextCacheObject;
 class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextObjectList;
 class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextLine;


@@ -1543,9 +1545,16 @@ public:
     */
     void SetTextBoxAttr(const wxTextBoxAttr& attr) { m_textBoxAttr = attr; }
 
     */
     void SetTextBoxAttr(const wxTextBoxAttr& attr) { m_textBoxAttr = attr; }
 

+    /**
+        Returns @true if no attributes are set.
+    */
+    bool IsDefault() const { return (GetFlags() == 0) && m_textBoxAttr.IsDefault(); }
+

     wxTextBoxAttr    m_textBoxAttr;
 };
 
     wxTextBoxAttr    m_textBoxAttr;
 };
 

+WX_DECLARE_USER_EXPORTED_OBJARRAY(wxRichTextAttr, wxRichTextAttrArray, WXDLLIMPEXP_RICHTEXT);
+

 WX_DECLARE_USER_EXPORTED_OBJARRAY(wxVariant, wxRichTextVariantArray, WXDLLIMPEXP_RICHTEXT);
 
 /**
 WX_DECLARE_USER_EXPORTED_OBJARRAY(wxVariant, wxRichTextVariantArray, WXDLLIMPEXP_RICHTEXT);
 
 /**


@@ -2106,9 +2115,9 @@ public:
         Pass the buffer to the context so the context can retrieve information
         such as virtual attributes.
     */
         Pass the buffer to the context so the context can retrieve information
         such as virtual attributes.
     */

-    wxRichTextDrawingContext(wxRichTextBuffer* buffer) { Init(); m_buffer = buffer; }
+    wxRichTextDrawingContext(wxRichTextBuffer* buffer);

 
 

-    void Init() { m_buffer = NULL; }
+    void Init() { m_buffer = NULL; m_enableVirtualAttributes = true; }

 
     /**
         Does this object have virtual attributes?
 
     /**
         Does this object have virtual attributes?


@@ -2129,7 +2138,45 @@ public:
     */
     bool ApplyVirtualAttributes(wxRichTextAttr& attr, wxRichTextObject* obj) const;
 
     */
     bool ApplyVirtualAttributes(wxRichTextAttr& attr, wxRichTextObject* obj) const;
 

+    /**
+        Gets the count for mixed virtual attributes for individual positions within the object.
+        For example, individual characters within a text object may require special highlighting.
+    */
+    int GetVirtualSubobjectAttributesCount(wxRichTextObject* obj) const;
+
+    /**
+        Gets the mixed virtual attributes for individual positions within the object.
+        For example, individual characters within a text object may require special highlighting.
+        The function is passed the count returned by GetVirtualSubobjectAttributesCount.
+    */
+    int GetVirtualSubobjectAttributes(wxRichTextObject* obj, wxArrayInt& positions, wxRichTextAttrArray& attributes) const;
+
+    /**
+        Do we have virtual text for this object? Virtual text allows an application
+        to replace characters in an object for editing and display purposes, for example
+        for highlighting special characters.
+    */
+    bool HasVirtualText(const wxRichTextPlainText* obj) const;
+
+    /**
+        Gets the virtual text for this object.
+    */
+    bool GetVirtualText(const wxRichTextPlainText* obj, wxString& text) const;
+
+    /**
+        Enables virtual attribute processing.
+    */
+
+    void EnableVirtualAttributes(bool b) { m_enableVirtualAttributes = b; }
+
+    /**
+        Returns @true if virtual attribute processing is enabled.
+    */
+
+    bool GetVirtualAttributesEnabled() const { return m_enableVirtualAttributes; }
+

     wxRichTextBuffer*   m_buffer;
     wxRichTextBuffer*   m_buffer;

+    bool                m_enableVirtualAttributes;

 };
 
 /**
 };
 
 /**


@@ -2206,7 +2253,7 @@ public:
         is invalid for this object.
     */
 
         is invalid for this object.
     */
 

-    virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, wxRichTextDrawingContext& context, int flags, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const  = 0;
+    virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, wxRichTextDrawingContext& context, int flags, const wxPoint& position = wxPoint(0,0), const wxSize& parentSize = wxDefaultSize, wxArrayInt* partialExtents = NULL) const  = 0;

 
     /**
         Do a split from @a pos, returning an object containing the second part, and setting
 
     /**
         Do a split from @a pos, returning an object containing the second part, and setting


@@ -2252,13 +2299,26 @@ public:
     /**
         Returns @true if this object can merge itself with the given one.
     */
     /**
         Returns @true if this object can merge itself with the given one.
     */

-    virtual bool CanMerge(wxRichTextObject* WXUNUSED(object)) const { return false; }
+    virtual bool CanMerge(wxRichTextObject* WXUNUSED(object), wxRichTextDrawingContext& WXUNUSED(context)) const { return false; }

 
     /**
         Returns @true if this object merged itself with the given one.
         The calling code will then delete the given object.
     */
 
     /**
         Returns @true if this object merged itself with the given one.
         The calling code will then delete the given object.
     */

-    virtual bool Merge(wxRichTextObject* WXUNUSED(object)) { return false; }
+    virtual bool Merge(wxRichTextObject* WXUNUSED(object), wxRichTextDrawingContext& WXUNUSED(context)) { return false; }
+
+    /**
+        JACS
+        Returns @true if this object can potentially be split, by virtue of having
+        different virtual attributes for individual sub-objects.
+    */
+    virtual bool CanSplit(wxRichTextDrawingContext& WXUNUSED(context)) const { return false; }
+
+    /**
+        Returns the final object in the split objects if this object was split due to differences between sub-object virtual attributes.
+        Returns itself if it was not split.
+    */
+    virtual wxRichTextObject* Split(wxRichTextDrawingContext& WXUNUSED(context)) { return this; }

 
     /**
         Dump object data to the given output stream for debugging.
 
     /**
         Dump object data to the given output stream for debugging.


@@ -2734,7 +2794,7 @@ public:
 
     virtual wxString GetTextForRange(const wxRichTextRange& range) const;
 
 
     virtual wxString GetTextForRange(const wxRichTextRange& range) const;
 

-    virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, wxRichTextDrawingContext& context, int flags, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const;
+    virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, wxRichTextDrawingContext& context, int flags, const wxPoint& position = wxPoint(0,0), const wxSize& parentSize = wxDefaultSize, wxArrayInt* partialExtents = NULL) const;

 
     virtual void Dump(wxTextOutputStream& stream);
 
 
     virtual void Dump(wxTextOutputStream& stream);
 


@@ -2811,7 +2871,7 @@ public:
     /**
         Recursively merges all pieces that can be merged.
     */
     /**
         Recursively merges all pieces that can be merged.
     */

-    bool Defragment(const wxRichTextRange& range = wxRICHTEXT_ALL);
+    bool Defragment(wxRichTextDrawingContext& context, const wxRichTextRange& range = wxRICHTEXT_ALL);

 
     /**
         Moves the object recursively, by adding the offset from old to new.
 
     /**
         Moves the object recursively, by adding the offset from old to new.


@@ -2851,7 +2911,7 @@ public:
 
     virtual bool Layout(wxDC& dc, wxRichTextDrawingContext& context, const wxRect& rect, const wxRect& parentRect, int style);
 
 
     virtual bool Layout(wxDC& dc, wxRichTextDrawingContext& context, const wxRect& rect, const wxRect& parentRect, int style);
 

-    virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, wxRichTextDrawingContext& context, int flags, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const;
+    virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, wxRichTextDrawingContext& context, int flags, const wxPoint& position = wxPoint(0,0), const wxSize& parentSize = wxDefaultSize, wxArrayInt* partialExtents = NULL) const;

 
     virtual bool DeleteRange(const wxRichTextRange& range);
 
 
     virtual bool DeleteRange(const wxRichTextRange& range);
 


@@ -3539,7 +3599,7 @@ public:
 
     virtual bool Layout(wxDC& dc, wxRichTextDrawingContext& context, const wxRect& rect, const wxRect& parentRect, int style);
 
 
     virtual bool Layout(wxDC& dc, wxRichTextDrawingContext& context, const wxRect& rect, const wxRect& parentRect, int style);
 

-    virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, wxRichTextDrawingContext& context, int flags, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const;
+    virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, wxRichTextDrawingContext& context, int flags, const wxPoint& position = wxPoint(0,0), const wxSize& parentSize = wxDefaultSize, wxArrayInt* partialExtents = NULL) const;

 
     virtual wxString GetXMLNodeName() const { return wxT("field"); }
 
 
     virtual wxString GetXMLNodeName() const { return wxT("field"); }
 


@@ -3613,7 +3673,9 @@ public:
     /**
         Copy constructor.
     */
     /**
         Copy constructor.
     */

-    wxRichTextFieldType(const wxRichTextFieldType& fieldType) { Copy(fieldType); }
+    wxRichTextFieldType(const wxRichTextFieldType& fieldType)
+        : wxObject(fieldType)
+    { Copy(fieldType); }

 
     void Copy(const wxRichTextFieldType& fieldType) { m_name = fieldType.m_name; }
 
 
     void Copy(const wxRichTextFieldType& fieldType) { m_name = fieldType.m_name; }
 


@@ -3635,7 +3697,7 @@ public:
         Returns the object size for the given range. Returns @false if the range
         is invalid for this object.
     */
         Returns the object size for the given range. Returns @false if the range
         is invalid for this object.
     */

-    virtual bool GetRangeSize(wxRichTextField* obj, const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, wxRichTextDrawingContext& context, int flags, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const = 0;
+    virtual bool GetRangeSize(wxRichTextField* obj, const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, wxRichTextDrawingContext& context, int flags, const wxPoint& position = wxPoint(0,0), const wxSize& parentSize = wxDefaultSize, wxArrayInt* partialExtents = NULL) const = 0;

 
     /**
         Returns @true if we can edit the object's properties via a GUI.
 
     /**
         Returns @true if we can edit the object's properties via a GUI.


@@ -3766,7 +3828,9 @@ public:
         The copy constructor.
 
     */
         The copy constructor.
 
     */

-    wxRichTextFieldTypeStandard(const wxRichTextFieldTypeStandard& field) { Copy(field); }
+    wxRichTextFieldTypeStandard(const wxRichTextFieldTypeStandard& field)
+        : wxRichTextFieldType(field)
+    { Copy(field); }

 
     /**
         Initialises the object.
 
     /**
         Initialises the object.


@@ -3801,7 +3865,7 @@ public:
         Returns the object size for the given range. Returns @false if the range
         is invalid for this object.
     */
         Returns the object size for the given range. Returns @false if the range
         is invalid for this object.
     */

-    virtual bool GetRangeSize(wxRichTextField* obj, const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, wxRichTextDrawingContext& context, int flags, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const;
+    virtual bool GetRangeSize(wxRichTextField* obj, const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, wxRichTextDrawingContext& context, int flags, const wxPoint& position = wxPoint(0,0), const wxSize& parentSize = wxDefaultSize, wxArrayInt* partialExtents = NULL) const;

 
     /**
         Get the size of the field, given the label, font size, and so on.
 
     /**
         Get the size of the field, given the label, font size, and so on.


@@ -4108,7 +4172,7 @@ public:
 
     virtual bool Layout(wxDC& dc, wxRichTextDrawingContext& context, const wxRect& rect, const wxRect& parentRect, int style);
 
 
     virtual bool Layout(wxDC& dc, wxRichTextDrawingContext& context, const wxRect& rect, const wxRect& parentRect, int style);
 

-    virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, wxRichTextDrawingContext& context, int flags, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const;
+    virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, wxRichTextDrawingContext& context, int flags, const wxPoint& position = wxPoint(0,0), const wxSize& parentSize = wxDefaultSize, wxArrayInt* partialExtents = NULL) const;

 
     virtual bool FindPosition(wxDC& dc, wxRichTextDrawingContext& context, long index, wxPoint& pt, int* height, bool forceLineStart);
 
 
     virtual bool FindPosition(wxDC& dc, wxRichTextDrawingContext& context, long index, wxPoint& pt, int* height, bool forceLineStart);
 


@@ -4233,7 +4297,7 @@ public:
     /**
         Lays out the floating objects.
     */
     /**
         Lays out the floating objects.
     */

-    void LayoutFloat(wxDC& dc, wxRichTextDrawingContext& context, const wxRect& rect, int style, wxRichTextFloatCollector* floatCollector);
+    void LayoutFloat(wxDC& dc, wxRichTextDrawingContext& context, const wxRect& rect, const wxRect& parentRect, int style, wxRichTextFloatCollector* floatCollector);

 
 protected:
 
 
 protected:
 


@@ -4279,7 +4343,7 @@ public:
 
     virtual bool Layout(wxDC& dc, wxRichTextDrawingContext& context, const wxRect& rect, const wxRect& parentRect, int style);
 
 
     virtual bool Layout(wxDC& dc, wxRichTextDrawingContext& context, const wxRect& rect, const wxRect& parentRect, int style);
 

-    virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, wxRichTextDrawingContext& context, int flags, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const;
+    virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, wxRichTextDrawingContext& context, int flags, const wxPoint& position = wxPoint(0,0), const wxSize& parentSize = wxDefaultSize, wxArrayInt* partialExtents = NULL) const;

 
     virtual wxString GetTextForRange(const wxRichTextRange& range) const;
 
 
     virtual wxString GetTextForRange(const wxRichTextRange& range) const;
 


@@ -4291,12 +4355,16 @@ public:
 
     virtual bool IsEmpty() const { return m_text.empty(); }
 
 
     virtual bool IsEmpty() const { return m_text.empty(); }
 

-    virtual bool CanMerge(wxRichTextObject* object) const;
+    virtual bool CanMerge(wxRichTextObject* object, wxRichTextDrawingContext& context) const;

 
 

-    virtual bool Merge(wxRichTextObject* object);
+    virtual bool Merge(wxRichTextObject* object, wxRichTextDrawingContext& context);

 
     virtual void Dump(wxTextOutputStream& stream);
 
 
     virtual void Dump(wxTextOutputStream& stream);
 

+    virtual bool CanSplit(wxRichTextDrawingContext& context) const;
+
+    virtual wxRichTextObject* Split(wxRichTextDrawingContext& context);
+

     /**
         Get the first position from pos that has a line break character.
     */
     /**
         Get the first position from pos that has a line break character.
     */


@@ -4549,6 +4617,11 @@ public:
     */
     wxRichTextImage(const wxRichTextImage& obj): wxRichTextObject(obj) { Copy(obj); }
 
     */
     wxRichTextImage(const wxRichTextImage& obj): wxRichTextObject(obj) { Copy(obj); }
 

+    /**
+        Destructor.
+    */
+    ~wxRichTextImage();
+

     /**
         Initialisation.
     */
     /**
         Initialisation.
     */


@@ -4560,7 +4633,7 @@ public:
 
     virtual bool Layout(wxDC& dc, wxRichTextDrawingContext& context, const wxRect& rect, const wxRect& parentRect, int style);
 
 
     virtual bool Layout(wxDC& dc, wxRichTextDrawingContext& context, const wxRect& rect, const wxRect& parentRect, int style);
 

-    virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, wxRichTextDrawingContext& context, int flags, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const;
+    virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, wxRichTextDrawingContext& context, int flags, const wxPoint& position = wxPoint(0,0), const wxSize& parentSize = wxDefaultSize, wxArrayInt* partialExtents = NULL) const;

 
     /**
         Returns the 'natural' size for this object - the image size.
 
     /**
         Returns the 'natural' size for this object - the image size.


@@ -4631,7 +4704,7 @@ public:
     /**
         Creates a cached image at the required size.
     */
     /**
         Creates a cached image at the required size.
     */

-    virtual bool LoadImageCache(wxDC& dc, bool resetCache = false);
+    virtual bool LoadImageCache(wxDC& dc, bool resetCache = false, const wxSize& parentSize = wxDefaultSize);

 
     /**
         Gets the original image size.
 
     /**
         Gets the original image size.


@@ -5372,6 +5445,19 @@ public:
     */
     void SetScale(double scale) { m_scale = scale; }
 
     */
     void SetScale(double scale) { m_scale = scale; }
 

+    /**
+        Sets the floating layout mode. Pass @false to speed up editing by not performing
+        floating layout. This setting affects all buffers.
+
+    */
+    static void SetFloatingLayoutMode(bool mode) { sm_floatingLayoutMode = mode; }
+
+    /**
+        Returns the floating layout mode. The default is @true, where objects
+        are laid out according to their floating status.
+    */
+    static bool GetFloatingLayoutMode() { return sm_floatingLayoutMode; }
+

 protected:
 
     /// Command processor
 protected:
 
     /// Command processor


@@ -5425,6 +5511,9 @@ protected:
     /// Factor to multiply by character height to get a reasonable bullet size
     static float            sm_bulletProportion;
 
     /// Factor to multiply by character height to get a reasonable bullet size
     static float            sm_bulletProportion;
 

+    /// Floating layout mode, @true by default
+    static bool             sm_floatingLayoutMode;
+

     /// Scaling factor in use: needed to calculate correct dimensions when printing
     double                  m_scale;
 
     /// Scaling factor in use: needed to calculate correct dimensions when printing
     double                  m_scale;
 


@@ -5489,7 +5578,7 @@ protected:
  */
 
 WX_DEFINE_ARRAY_PTR(wxRichTextObject*, wxRichTextObjectPtrArray);
  */
 
 WX_DEFINE_ARRAY_PTR(wxRichTextObject*, wxRichTextObjectPtrArray);

-WX_DECLARE_OBJARRAY(wxRichTextObjectPtrArray, wxRichTextObjectPtrArrayArray);
+WX_DECLARE_USER_EXPORTED_OBJARRAY(wxRichTextObjectPtrArray, wxRichTextObjectPtrArrayArray, WXDLLIMPEXP_RICHTEXT);

 
 class WXDLLIMPEXP_RICHTEXT wxRichTextTable: public wxRichTextBox
 {
 
 class WXDLLIMPEXP_RICHTEXT wxRichTextTable: public wxRichTextBox
 {


@@ -5518,7 +5607,7 @@ public:
 
     virtual bool Layout(wxDC& dc, wxRichTextDrawingContext& context, const wxRect& rect, const wxRect& parentRect, int style);
 
 
     virtual bool Layout(wxDC& dc, wxRichTextDrawingContext& context, const wxRect& rect, const wxRect& parentRect, int style);
 

-    virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, wxRichTextDrawingContext& context, int flags, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const;
+    virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, wxRichTextDrawingContext& context, int flags, const wxPoint& position = wxPoint(0,0), const wxSize& parentSize = wxDefaultSize, wxArrayInt* partialExtents = NULL) const;

 
     virtual bool DeleteRange(const wxRichTextRange& range);
 
 
     virtual bool DeleteRange(const wxRichTextRange& range);
 


@@ -5595,6 +5684,11 @@ public:
     */
     virtual bool GetCellRowColumnPosition(long pos, int& row, int& col) const;
 
     */
     virtual bool GetCellRowColumnPosition(long pos, int& row, int& col) const;
 

+    /**
+        Returns the coordinates of the cell with keyboard focus, or (-1,-1) if none.
+    */    
+    virtual wxPosition GetFocusedCell() const;
+

 // Operations
 
     /**
 // Operations
 
     /**


@@ -5873,6 +5967,12 @@ public:
     */
     wxRichTextObject* GetObject() const { return m_object; }
 
     */
     wxRichTextObject* GetObject() const { return m_object; }
 

+    /**
+        Stores the object to replace the one at the position defined by the container address
+        without making an address for it (cf SetObject() and MakeObject()).
+    */
+    void StoreObject(wxRichTextObject* obj) { m_object = obj; }
+

     /**
         Sets the object to replace the one at the position defined by the container address
         and the action's range start position.
     /**
         Sets the object to replace the one at the position defined by the container address
         and the action's range start position.


@@ -6234,6 +6334,31 @@ public:
     */
     virtual bool GetVirtualAttributes(wxRichTextAttr& attr, wxRichTextObject* obj) const = 0;
 
     */
     virtual bool GetVirtualAttributes(wxRichTextAttr& attr, wxRichTextObject* obj) const = 0;
 

+    /**
+        Gets the count for mixed virtual attributes for individual positions within the object.
+        For example, individual characters within a text object may require special highlighting.
+    */
+    virtual int GetVirtualSubobjectAttributesCount(wxRichTextObject* obj) const = 0;
+
+    /**
+        Gets the mixed virtual attributes for individual positions within the object.
+        For example, individual characters within a text object may require special highlighting.
+        Returns the number of virtual attributes found.
+    */
+    virtual int GetVirtualSubobjectAttributes(wxRichTextObject* obj, wxArrayInt& positions, wxRichTextAttrArray& attributes) const = 0;
+
+    /**
+        Do we have virtual text for this object? Virtual text allows an application
+        to replace characters in an object for editing and display purposes, for example
+        for highlighting special characters.
+    */
+    virtual bool HasVirtualText(const wxRichTextPlainText* obj) const = 0;
+
+    /**
+        Gets the virtual text for this object.
+    */
+    virtual bool GetVirtualText(const wxRichTextPlainText* obj, wxString& text) const = 0;
+

     /**
         Sets the name of the handler.
     */
     /**
         Sets the name of the handler.
     */