+/**
+ Border styles, used with wxTextAttrBorder.
+ */
+enum wxTextAttrBorderStyle
+{
+ wxTEXT_BOX_ATTR_BORDER_NONE = 0,
+ wxTEXT_BOX_ATTR_BORDER_SOLID = 1,
+ wxTEXT_BOX_ATTR_BORDER_DOTTED = 2,
+ wxTEXT_BOX_ATTR_BORDER_DASHED = 3,
+ wxTEXT_BOX_ATTR_BORDER_DOUBLE = 4,
+ wxTEXT_BOX_ATTR_BORDER_GROOVE = 5,
+ wxTEXT_BOX_ATTR_BORDER_RIDGE = 6,
+ wxTEXT_BOX_ATTR_BORDER_INSET = 7,
+ wxTEXT_BOX_ATTR_BORDER_OUTSET = 8
+};
+
+/**
+ Border style presence flags, used with wxTextAttrBorder.
+ */
+enum wxTextAttrBorderFlags
+{
+ wxTEXT_BOX_ATTR_BORDER_STYLE = 0x0001,
+ wxTEXT_BOX_ATTR_BORDER_COLOUR = 0x0002
+};
+
+/**
+ Border width symbols for qualitative widths, used with wxTextAttrBorder.
+ */
+enum wxTextAttrBorderWidth
+{
+ wxTEXT_BOX_ATTR_BORDER_THIN = -1,
+ wxTEXT_BOX_ATTR_BORDER_MEDIUM = -2,
+ wxTEXT_BOX_ATTR_BORDER_THICK = -3
+};
+
+/**
+ Float styles.
+ */
+enum wxTextBoxAttrFloatStyle
+{
+ wxTEXT_BOX_ATTR_FLOAT_NONE = 0,
+ wxTEXT_BOX_ATTR_FLOAT_LEFT = 1,
+ wxTEXT_BOX_ATTR_FLOAT_RIGHT = 2
+};
+
+/**
+ Clear styles.
+ */
+enum wxTextBoxAttrClearStyle
+{
+ wxTEXT_BOX_ATTR_CLEAR_NONE = 0,
+ wxTEXT_BOX_ATTR_CLEAR_LEFT = 1,
+ wxTEXT_BOX_ATTR_CLEAR_RIGHT = 2,
+ wxTEXT_BOX_ATTR_CLEAR_BOTH = 3
+};
+
+/**
+ Collapse mode styles. TODO: can they be switched on per side?
+ */
+enum wxTextBoxAttrCollapseMode
+{
+ wxTEXT_BOX_ATTR_COLLAPSE_NONE = 0,
+ wxTEXT_BOX_ATTR_COLLAPSE_FULL = 1
+};
+
+/**
+ Vertical alignment values.
+ */
+enum wxTextBoxAttrVerticalAlignment
+{
+ wxTEXT_BOX_ATTR_VERTICAL_ALIGNMENT_NONE = 0,
+ wxTEXT_BOX_ATTR_VERTICAL_ALIGNMENT_TOP = 1,
+ wxTEXT_BOX_ATTR_VERTICAL_ALIGNMENT_CENTRE = 2,
+ wxTEXT_BOX_ATTR_VERTICAL_ALIGNMENT_BOTTOM = 3
+};
+
+/**
+ @class wxTextAttrBorder
+ A class representing a rich text object border.
+
+ @library{wxrichtext}
+ @category{richtext}
+
+ @see wxRichTextAttr, wxRichTextCtrl, wxRichTextAttrBorders
+*/
+
+class WXDLLIMPEXP_RICHTEXT wxTextAttrBorder
+{
+public:
+ /**
+ Default constructor.
+ */
+ wxTextAttrBorder() { Reset(); }
+
+ /**
+ Equality operator.
+ */
+ bool operator==(const wxTextAttrBorder& border) const
+ {
+ return m_flags == border.m_flags && m_borderStyle == border.m_borderStyle &&
+ m_borderColour == border.m_borderColour && m_borderWidth == border.m_borderWidth;
+ }
+
+ /**
+ Resets the border style, colour, width and flags.
+ */
+ void Reset() { m_borderStyle = 0; m_borderColour = 0; m_flags = 0; m_borderWidth.Reset(); }
+
+ /**
+ Partial equality test.
+ */
+ bool EqPartial(const wxTextAttrBorder& border) const;
+
+ /**
+ Applies the border to this object, but not if the same as @a compareWith.
+
+ */
+ bool Apply(const wxTextAttrBorder& border, const wxTextAttrBorder* compareWith = NULL);
+
+ /**
+ Removes the specified attributes from this object.
+ */
+ bool RemoveStyle(const wxTextAttrBorder& attr);
+
+ /**
+ Collects the attributes that are common to a range of content, building up a note of
+ which attributes are absent in some objects and which clash in some objects.
+ */
+ void CollectCommonAttributes(const wxTextAttrBorder& attr, wxTextAttrBorder& clashingAttr, wxTextAttrBorder& absentAttr);
+
+ /**
+ Sets the border style.
+ */
+ void SetStyle(int style) { m_borderStyle = style; m_flags |= wxTEXT_BOX_ATTR_BORDER_STYLE; }
+
+ /**
+ Gets the border style.
+
+ */
+ int GetStyle() const { return m_borderStyle; }
+
+ /**
+ Sets the border colour.
+ */
+ void SetColour(unsigned long colour) { m_borderColour = colour; m_flags |= wxTEXT_BOX_ATTR_BORDER_COLOUR; }
+
+ /**
+ Sets the border colour.
+ */
+ void SetColour(const wxColour& colour) { m_borderColour = colour.GetRGB(); m_flags |= wxTEXT_BOX_ATTR_BORDER_COLOUR; }
+
+ /**
+ Gets the colour as a long.
+ */
+ unsigned long GetColourLong() const { return m_borderColour; }
+
+ /**
+ Gets the colour.
+ */
+ wxColour GetColour() const { return wxColour(m_borderColour); }
+
+ /**
+ Gets the border width.
+ */
+ wxTextAttrDimension& GetWidth() { return m_borderWidth; }
+ const wxTextAttrDimension& GetWidth() const { return m_borderWidth; }
+
+ /**
+ Sets the border width.
+ */
+ void SetWidth(const wxTextAttrDimension& width) { m_borderWidth = width; }
+ /**
+ Sets the border width.
+ */
+ void SetWidth(int value, wxTextAttrUnits units = wxTEXT_ATTR_UNITS_TENTHS_MM) { SetWidth(wxTextAttrDimension(value, units)); }
+
+ /**
+ True if the border has a valid style.
+ */
+ bool HasStyle() const { return (m_flags & wxTEXT_BOX_ATTR_BORDER_STYLE) != 0; }
+
+ /**
+ True if the border has a valid colour.
+ */
+ bool HasColour() const { return (m_flags & wxTEXT_BOX_ATTR_BORDER_COLOUR) != 0; }
+
+ /**
+ True if the border has a valid width.
+ */
+ bool HasWidth() const { return m_borderWidth.IsValid(); }
+
+ /**
+ True if the border is valid.
+ */
+ bool IsValid() const { return HasWidth(); }
+
+ /**
+ Set the valid flag for this border.
+ */
+ void MakeValid() { m_borderWidth.SetValid(true); }
+
+ /**
+ Returns the border flags.
+ */
+ int GetFlags() const { return m_flags; }
+
+ /**
+ Sets the border flags.
+ */
+ void SetFlags(int flags) { m_flags = flags; }
+
+ /**
+ Adds a border flag.
+ */
+ void AddFlag(int flag) { m_flags |= flag; }
+
+ /**
+ Removes a border flag.
+ */
+ void RemoveFlag(int flag) { m_flags &= ~flag; }
+
+ int m_borderStyle;
+ unsigned long m_borderColour;
+ wxTextAttrDimension m_borderWidth;
+ int m_flags;
+};
+
+/**
+ @class wxTextAttrBorders
+ A class representing a rich text object's borders.
+
+ @library{wxrichtext}
+ @category{richtext}
+
+ @see wxRichTextAttr, wxRichTextCtrl, wxRichTextAttrBorder
+*/
+
+class WXDLLIMPEXP_RICHTEXT wxTextAttrBorders
+{
+public:
+ /**
+ Default constructor.
+ */
+ wxTextAttrBorders() { }
+
+ /**
+ Equality operator.
+ */
+ bool operator==(const wxTextAttrBorders& borders) const
+ {
+ return m_left == borders.m_left && m_right == borders.m_right &&
+ m_top == borders.m_top && m_bottom == borders.m_bottom;
+ }
+
+ /**
+ Sets the style of all borders.
+ */
+ void SetStyle(int style);
+
+ /**
+ Sets colour of all borders.
+ */
+ void SetColour(unsigned long colour);
+
+ /**
+ Sets the colour for all borders.
+ */
+ void SetColour(const wxColour& colour);
+
+ /**
+ Sets the width of all borders.
+ */
+ void SetWidth(const wxTextAttrDimension& width);
+
+ /**
+ Sets the width of all borders.
+ */
+ void SetWidth(int value, wxTextAttrUnits units = wxTEXT_ATTR_UNITS_TENTHS_MM) { SetWidth(wxTextAttrDimension(value, units)); }
+
+ /**
+ Resets all borders.
+ */
+ void Reset() { m_left.Reset(); m_right.Reset(); m_top.Reset(); m_bottom.Reset(); }
+
+ /**
+ Partial equality test.
+ */
+ bool EqPartial(const wxTextAttrBorders& borders) const;
+
+ /**
+ Applies border to this object, but not if the same as @a compareWith.
+ */
+ bool Apply(const wxTextAttrBorders& borders, const wxTextAttrBorders* compareWith = NULL);
+
+ /**
+ Removes the specified attributes from this object.
+ */
+ bool RemoveStyle(const wxTextAttrBorders& attr);
+
+ /**
+ Collects the attributes that are common to a range of content, building up a note of
+ which attributes are absent in some objects and which clash in some objects.
+ */
+ void CollectCommonAttributes(const wxTextAttrBorders& attr, wxTextAttrBorders& clashingAttr, wxTextAttrBorders& absentAttr);
+
+ /**
+ Returns @true if all borders are valid.
+ */
+ bool IsValid() const { return m_left.IsValid() || m_right.IsValid() || m_top.IsValid() || m_bottom.IsValid(); }
+
+ /**
+ Returns the left border.
+ */
+ const wxTextAttrBorder& GetLeft() const { return m_left; }
+ wxTextAttrBorder& GetLeft() { return m_left; }
+
+ /**
+ Returns the right border.
+ */
+ const wxTextAttrBorder& GetRight() const { return m_right; }
+ wxTextAttrBorder& GetRight() { return m_right; }
+
+ /**
+ Returns the top border.
+ */
+ const wxTextAttrBorder& GetTop() const { return m_top; }
+ wxTextAttrBorder& GetTop() { return m_top; }
+
+ /**
+ Returns the bottom border.
+ */
+ const wxTextAttrBorder& GetBottom() const { return m_bottom; }
+ wxTextAttrBorder& GetBottom() { return m_bottom; }
+
+ wxTextAttrBorder m_left, m_right, m_top, m_bottom;
+
+};
+
+/**
+ @class wxTextBoxAttr
+ A class representing the box attributes of a rich text object.
+
+ @library{wxrichtext}
+ @category{richtext}
+
+ @see wxRichTextAttr, wxRichTextCtrl
+*/
+
+class WXDLLIMPEXP_RICHTEXT wxTextBoxAttr
+{
+public:
+ /**
+ Default constructor.
+ */
+ wxTextBoxAttr() { Init(); }
+
+ /**
+ Copy constructor.
+ */
+ wxTextBoxAttr(const wxTextBoxAttr& attr) { Init(); (*this) = attr; }
+
+ /**
+ Initialises this object.
+ */
+ void Init() { Reset(); }
+
+ /**
+ Resets this object.
+ */
+ void Reset();
+
+ // Copy. Unnecessary since we let it do a binary copy
+ //void Copy(const wxTextBoxAttr& attr);
+
+ // Assignment
+ //void operator= (const wxTextBoxAttr& attr);
+
+ /**
+ Equality test.
+ */
+ bool operator== (const wxTextBoxAttr& attr) const;
+
+ /**
+ Partial equality test, ignoring unset attributes.
+
+ */
+ bool EqPartial(const wxTextBoxAttr& attr) const;
+
+ /**
+ Merges the given attributes. If @a compareWith is non-NULL, then it will be used
+ to mask out those attributes that are the same in style and @a compareWith, for
+ situations where we don't want to explicitly set inherited attributes.
+ */
+ bool Apply(const wxTextBoxAttr& style, const wxTextBoxAttr* compareWith = NULL);
+
+ /**
+ Collects the attributes that are common to a range of content, building up a note of
+ which attributes are absent in some objects and which clash in some objects.
+ */
+ void CollectCommonAttributes(const wxTextBoxAttr& attr, wxTextBoxAttr& clashingAttr, wxTextBoxAttr& absentAttr);
+
+ /**
+ Removes the specified attributes from this object.
+ */
+ bool RemoveStyle(const wxTextBoxAttr& attr);
+
+ /**
+ Sets the flags.
+ */
+ void SetFlags(int flags) { m_flags = flags; }
+
+ /**
+ Returns the flags.
+ */
+ int GetFlags() const { return m_flags; }
+
+ /**
+ Is this flag present?
+ */
+ bool HasFlag(wxTextBoxAttrFlags flag) const { return (m_flags & flag) != 0; }
+
+ /**
+ Removes this flag.
+ */
+ void RemoveFlag(wxTextBoxAttrFlags flag) { m_flags &= ~flag; }
+
+ /**
+ Adds this flag.
+ */
+ void AddFlag(wxTextBoxAttrFlags flag) { m_flags |= flag; }
+
+ /**
+ Returns @true if no attributes are set.
+ */
+ bool IsDefault() const;
+
+ /**
+ Returns the float mode.
+ */
+ wxTextBoxAttrFloatStyle GetFloatMode() const { return m_floatMode; }
+
+ /**
+ Sets the float mode.
+ */
+ void SetFloatMode(wxTextBoxAttrFloatStyle mode) { m_floatMode = mode; m_flags |= wxTEXT_BOX_ATTR_FLOAT; }
+
+ /**
+ Returns @true if float mode is active.
+ */
+ bool HasFloatMode() const { return HasFlag(wxTEXT_BOX_ATTR_FLOAT); }
+
+ /**
+ Returns @true if this object is floating.
+ */
+ bool IsFloating() const { return HasFloatMode() && GetFloatMode() != wxTEXT_BOX_ATTR_FLOAT_NONE; }
+
+ /**
+ Returns the clear mode - whether to wrap text after object. Currently unimplemented.
+ */
+ wxTextBoxAttrClearStyle GetClearMode() const { return m_clearMode; }
+
+ /**
+ Set the clear mode. Currently unimplemented.
+ */
+ void SetClearMode(wxTextBoxAttrClearStyle mode) { m_clearMode = mode; m_flags |= wxTEXT_BOX_ATTR_CLEAR; }
+
+ /**
+ Returns @true if we have a clear flag.
+ */
+ bool HasClearMode() const { return HasFlag(wxTEXT_BOX_ATTR_CLEAR); }
+
+ /**
+ Returns the collapse mode - whether to collapse borders. Currently unimplemented.
+ */
+ wxTextBoxAttrCollapseMode GetCollapseBorders() const { return m_collapseMode; }
+
+ /**
+ Sets the collapse mode - whether to collapse borders. Currently unimplemented.
+ */
+ void SetCollapseBorders(wxTextBoxAttrCollapseMode collapse) { m_collapseMode = collapse; m_flags |= wxTEXT_BOX_ATTR_COLLAPSE_BORDERS; }
+
+ /**
+ Returns @true if the collapse borders flag is present.
+ */
+ bool HasCollapseBorders() const { return HasFlag(wxTEXT_BOX_ATTR_COLLAPSE_BORDERS); }
+
+ /**
+ Returns the vertical alignment.
+ */
+ wxTextBoxAttrVerticalAlignment GetVerticalAlignment() const { return m_verticalAlignment; }
+
+ /**
+ Sets the vertical alignment.
+ */
+ void SetVerticalAlignment(wxTextBoxAttrVerticalAlignment verticalAlignment) { m_verticalAlignment = verticalAlignment; m_flags |= wxTEXT_BOX_ATTR_VERTICAL_ALIGNMENT; }
+
+ /**
+ Returns @true if a vertical alignment flag is present.
+ */
+ bool HasVerticalAlignment() const { return HasFlag(wxTEXT_BOX_ATTR_VERTICAL_ALIGNMENT); }
+
+ /**
+ Returns the margin values.
+ */
+ wxTextAttrDimensions& GetMargins() { return m_margins; }
+ const wxTextAttrDimensions& GetMargins() const { return m_margins; }
+
+ /**
+ Returns the left margin.
+ */
+ wxTextAttrDimension& GetLeftMargin() { return m_margins.m_left; }
+ const wxTextAttrDimension& GetLeftMargin() const { return m_margins.m_left; }
+
+ /**
+ Returns the right margin.
+ */
+ wxTextAttrDimension& GetRightMargin() { return m_margins.m_right; }
+ const wxTextAttrDimension& GetRightMargin() const { return m_margins.m_right; }
+
+ /**
+ Returns the top margin.
+ */
+ wxTextAttrDimension& GetTopMargin() { return m_margins.m_top; }
+ const wxTextAttrDimension& GetTopMargin() const { return m_margins.m_top; }
+
+ /**
+ Returns the bottom margin.
+ */
+ wxTextAttrDimension& GetBottomMargin() { return m_margins.m_bottom; }
+ const wxTextAttrDimension& GetBottomMargin() const { return m_margins.m_bottom; }
+
+ /**
+ Returns the position.
+ */
+ wxTextAttrDimensions& GetPosition() { return m_position; }
+ const wxTextAttrDimensions& GetPosition() const { return m_position; }
+
+ /**
+ Returns the left position.
+ */
+ wxTextAttrDimension& GetLeft() { return m_position.m_left; }
+ const wxTextAttrDimension& GetLeft() const { return m_position.m_left; }
+
+ /**
+ Returns the right position.
+ */
+ wxTextAttrDimension& GetRight() { return m_position.m_right; }
+ const wxTextAttrDimension& GetRight() const { return m_position.m_right; }
+
+ /**
+ Returns the top position.
+ */
+ wxTextAttrDimension& GetTop() { return m_position.m_top; }
+ const wxTextAttrDimension& GetTop() const { return m_position.m_top; }
+
+ /**
+ Returns the bottom position.
+ */
+ wxTextAttrDimension& GetBottom() { return m_position.m_bottom; }
+ const wxTextAttrDimension& GetBottom() const { return m_position.m_bottom; }
+
+ /**
+ Returns the padding values.
+ */
+ wxTextAttrDimensions& GetPadding() { return m_padding; }
+ const wxTextAttrDimensions& GetPadding() const { return m_padding; }
+
+ /**
+ Returns the left padding value.
+ */
+ wxTextAttrDimension& GetLeftPadding() { return m_padding.m_left; }
+ const wxTextAttrDimension& GetLeftPadding() const { return m_padding.m_left; }
+
+ /**
+ Returns the right padding value.
+ */
+ wxTextAttrDimension& GetRightPadding() { return m_padding.m_right; }
+ const wxTextAttrDimension& GetRightPadding() const { return m_padding.m_right; }
+
+ /**
+ Returns the top padding value.
+ */
+ wxTextAttrDimension& GetTopPadding() { return m_padding.m_top; }
+ const wxTextAttrDimension& GetTopPadding() const { return m_padding.m_top; }
+
+ /**
+ Returns the bottom padding value.
+ */
+ wxTextAttrDimension& GetBottomPadding() { return m_padding.m_bottom; }
+ const wxTextAttrDimension& GetBottomPadding() const { return m_padding.m_bottom; }
+
+ /**
+ Returns the borders.
+ */
+ wxTextAttrBorders& GetBorder() { return m_border; }
+ const wxTextAttrBorders& GetBorder() const { return m_border; }
+
+ /**
+ Returns the left border.
+ */
+ wxTextAttrBorder& GetLeftBorder() { return m_border.m_left; }
+ const wxTextAttrBorder& GetLeftBorder() const { return m_border.m_left; }
+
+ /**
+ Returns the top border.
+ */
+ wxTextAttrBorder& GetTopBorder() { return m_border.m_top; }
+ const wxTextAttrBorder& GetTopBorder() const { return m_border.m_top; }
+
+ /**
+ Returns the right border.
+ */
+ wxTextAttrBorder& GetRightBorder() { return m_border.m_right; }
+ const wxTextAttrBorder& GetRightBorder() const { return m_border.m_right; }
+
+ /**
+ Returns the bottom border.
+ */
+ wxTextAttrBorder& GetBottomBorder() { return m_border.m_bottom; }
+ const wxTextAttrBorder& GetBottomBorder() const { return m_border.m_bottom; }
+
+ /**
+ Returns the outline.
+ */
+ wxTextAttrBorders& GetOutline() { return m_outline; }
+ const wxTextAttrBorders& GetOutline() const { return m_outline; }
+
+ /**
+ Returns the left outline.
+ */
+ wxTextAttrBorder& GetLeftOutline() { return m_outline.m_left; }
+ const wxTextAttrBorder& GetLeftOutline() const { return m_outline.m_left; }
+
+ /**
+ Returns the top outline.
+ */
+ wxTextAttrBorder& GetTopOutline() { return m_outline.m_top; }
+ const wxTextAttrBorder& GetTopOutline() const { return m_outline.m_top; }
+
+ /**
+ Returns the right outline.
+ */
+ wxTextAttrBorder& GetRightOutline() { return m_outline.m_right; }
+ const wxTextAttrBorder& GetRightOutline() const { return m_outline.m_right; }
+
+ /**
+ Returns the bottom outline.
+ */
+ wxTextAttrBorder& GetBottomOutline() { return m_outline.m_bottom; }
+ const wxTextAttrBorder& GetBottomOutline() const { return m_outline.m_bottom; }
+
+ /**
+ Returns the object size.
+ */
+ wxTextAttrSize& GetSize() { return m_size; }
+ const wxTextAttrSize& GetSize() const { return m_size; }
+
+ /**
+ Sets the object size.
+ */
+ void SetSize(const wxTextAttrSize& sz) { m_size = sz; }
+
+ /**
+ Returns the object width.
+ */
+ wxTextAttrDimension& GetWidth() { return m_size.m_width; }
+ const wxTextAttrDimension& GetWidth() const { return m_size.m_width; }
+
+ /**
+ Returns the object height.
+ */
+ wxTextAttrDimension& GetHeight() { return m_size.m_height; }
+ const wxTextAttrDimension& GetHeight() const { return m_size.m_height; }
+
+public:
+
+ int m_flags;
+
+ wxTextAttrDimensions m_margins;
+ wxTextAttrDimensions m_padding;
+ wxTextAttrDimensions m_position;
+
+ wxTextAttrSize m_size;
+
+ wxTextAttrBorders m_border;
+ wxTextAttrBorders m_outline;
+
+ wxTextBoxAttrFloatStyle m_floatMode;
+ wxTextBoxAttrClearStyle m_clearMode;
+ wxTextBoxAttrCollapseMode m_collapseMode;
+ wxTextBoxAttrVerticalAlignment m_verticalAlignment;
+};
+
+/**
+ @class wxRichTextAttr
+ A class representing enhanced attributes for rich text objects.
+ This adds a wxTextBoxAttr member to the basic wxTextAttr class.
+
+ @library{wxrichtext}
+ @category{richtext}
+
+ @see wxRichTextAttr, wxTextBoxAttr, wxRichTextCtrl
+*/
+
+class WXDLLIMPEXP_RICHTEXT wxRichTextAttr: public wxTextAttr
+{
+public:
+ /**
+ Constructor taking a wxTextAttr.
+ */
+ wxRichTextAttr(const wxTextAttr& attr) { wxTextAttr::Copy(attr); }
+
+ /**
+ Copy constructor.
+ */
+ wxRichTextAttr(const wxRichTextAttr& attr): wxTextAttr() { Copy(attr); }
+
+ /**
+ Default constructor.
+ */
+ wxRichTextAttr() {}
+
+ /**
+ Copy function.
+ */
+ void Copy(const wxRichTextAttr& attr);
+
+ /**
+ Assignment operator.
+ */
+ void operator=(const wxRichTextAttr& attr) { Copy(attr); }
+
+ /**
+ Assignment operator.
+ */
+ void operator=(const wxTextAttr& attr) { wxTextAttr::Copy(attr); }
+
+ /**
+ Equality test.
+ */
+ bool operator==(const wxRichTextAttr& attr) const;
+
+ /**
+ Partial equality test taking comparison object into account.
+ */
+ bool EqPartial(const wxRichTextAttr& attr) const;
+
+ /**
+ Merges the given attributes. If @a compareWith
+ is non-NULL, then it will be used to mask out those attributes that are the same in style
+ and @a compareWith, for situations where we don't want to explicitly set inherited attributes.
+ */
+ bool Apply(const wxRichTextAttr& style, const wxRichTextAttr* compareWith = NULL);
+
+ /**
+ Collects the attributes that are common to a range of content, building up a note of
+ which attributes are absent in some objects and which clash in some objects.
+ */
+ void CollectCommonAttributes(const wxRichTextAttr& attr, wxRichTextAttr& clashingAttr, wxRichTextAttr& absentAttr);
+
+ /**
+ Removes the specified attributes from this object.
+ */
+ bool RemoveStyle(const wxRichTextAttr& attr);
+
+ /**
+ Returns the text box attributes.
+ */
+ wxTextBoxAttr& GetTextBoxAttr() { return m_textBoxAttr; }
+ const wxTextBoxAttr& GetTextBoxAttr() const { return m_textBoxAttr; }
+
+ /**
+ Set the text box attributes.
+ */
+ void SetTextBoxAttr(const wxTextBoxAttr& attr) { m_textBoxAttr = attr; }
+
+ wxTextBoxAttr m_textBoxAttr;
+};
+
+WX_DECLARE_USER_EXPORTED_OBJARRAY(wxVariant, wxRichTextVariantArray, WXDLLIMPEXP_RICHTEXT);
+
+/**
+ @class wxRichTextProperties
+ A simple property class using wxVariants. This is used to give each rich text object the
+ ability to store custom properties that can be used by the application.
+
+ @library{wxrichtext}
+ @category{richtext}
+
+ @see wxRichTextBuffer, wxRichTextObject, wxRichTextCtrl
+*/
+
+class WXDLLIMPEXP_RICHTEXT wxRichTextProperties: public wxObject
+{
+DECLARE_DYNAMIC_CLASS(wxRichTextProperties)
+public:
+
+ /**
+ Default constructor.
+ */
+ wxRichTextProperties() {}
+
+ /**
+ Copy constructor.
+ */
+ wxRichTextProperties(const wxRichTextProperties& props): wxObject() { Copy(props); }
+
+ /**
+ Assignment operator.
+ */
+ void operator=(const wxRichTextProperties& props) { Copy(props); }
+
+ /**
+ Equality operator.
+ */
+ bool operator==(const wxRichTextProperties& props) const;
+
+ /**
+ Copies from @a props.
+ */
+ void Copy(const wxRichTextProperties& props) { m_properties = props.m_properties; }
+
+ /**
+ Returns the variant at the given index.
+ */
+ const wxVariant& operator[](size_t idx) const { return m_properties[idx]; }
+
+ /**
+ Returns the variant at the given index.
+ */
+ wxVariant& operator[](size_t idx) { return m_properties[idx]; }
+
+ /**
+ Clears the properties.
+ */
+ void Clear() { m_properties.Clear(); }
+
+ /**
+ Returns the array of variants implementing the properties.
+ */
+ const wxRichTextVariantArray& GetProperties() const { return m_properties; }
+
+ /**
+ Returns the array of variants implementing the properties.
+ */
+ wxRichTextVariantArray& GetProperties() { return m_properties; }
+
+ /**
+ Sets the array of variants.
+ */
+ void SetProperties(const wxRichTextVariantArray& props) { m_properties = props; }
+
+ /**
+ Returns all the property names.
+ */
+ wxArrayString GetPropertyNames() const;
+
+ /**
+ Returns a count of the properties.
+ */
+ size_t GetCount() const { return m_properties.GetCount(); }
+
+ /**
+ Returns @true if the given property is found.
+ */
+ bool HasProperty(const wxString& name) const { return Find(name) != -1; }
+
+ /**
+ Finds the given property.
+ */
+ int Find(const wxString& name) const;
+
+ /**
+ Gets the property variant by name.
+ */
+ const wxVariant& GetProperty(const wxString& name) const;
+
+ /**
+ Finds or creates a property with the given name, returning a pointer to the variant.
+ */
+ wxVariant* FindOrCreateProperty(const wxString& name);
+
+ /**
+ Gets the value of the named property as a string.
+ */
+ wxString GetPropertyString(const wxString& name) const;
+
+ /**
+ Gets the value of the named property as a long integer.
+ */
+ long GetPropertyLong(const wxString& name) const;
+
+ /**
+ Gets the value of the named property as a boolean.
+ */
+ bool GetPropertyBool(const wxString& name) const;
+
+ /**
+ Gets the value of the named property as a double.
+ */
+ double GetPropertyDouble(const wxString& name) const;
+
+ /**
+ Sets the property by passing a variant which contains a name and value.
+ */
+ void SetProperty(const wxVariant& variant);
+
+ /**
+ Sets a property by name and variant.
+ */
+ void SetProperty(const wxString& name, const wxVariant& variant);
+
+ /**
+ Sets a property by name and string value.
+ */
+ void SetProperty(const wxString& name, const wxString& value);
+
+ /**
+ Sets property by name and long integer value.
+ */
+ void SetProperty(const wxString& name, long value);
+
+ /**
+ Sets property by name and double value.
+ */
+ void SetProperty(const wxString& name, double value);
+
+ /**
+ Sets property by name and boolean value.
+ */
+ void SetProperty(const wxString& name, bool value);
+
+protected:
+ wxRichTextVariantArray m_properties;
+};
+
+
+/**
+ @class wxRichTextFontTable
+ Manages quick access to a pool of fonts for rendering rich text.
+
+ @library{wxrichtext}
+ @category{richtext}
+
+ @see wxRichTextBuffer, wxRichTextCtrl
+*/
+
+class WXDLLIMPEXP_RICHTEXT wxRichTextFontTable: public wxObject
+{
+public:
+ /**
+ Default constructor.
+ */
+ wxRichTextFontTable();
+
+ /**
+ Copy constructor.
+ */
+ wxRichTextFontTable(const wxRichTextFontTable& table);
+ virtual ~wxRichTextFontTable();
+
+ /**
+ Returns @true if the font table is valid.
+ */
+ bool IsOk() const { return m_refData != NULL; }
+
+ /**
+ Finds a font for the given attribute object.
+ */
+ wxFont FindFont(const wxRichTextAttr& fontSpec);
+
+ /**
+ Clears the font table.
+ */
+ void Clear();
+
+ /**
+ Assignment operator.
+ */
+ void operator= (const wxRichTextFontTable& table);
+
+ /**
+ Equality operator.
+ */
+ bool operator == (const wxRichTextFontTable& table) const;
+
+ /**
+ Inequality operator.
+ */
+ bool operator != (const wxRichTextFontTable& table) const { return !(*this == table); }
+
+protected:
+
+ DECLARE_DYNAMIC_CLASS(wxRichTextFontTable)
+};
+
+/**
+ @class wxRichTextRange
+
+ This stores beginning and end positions for a range of data.
+
+ @library{wxrichtext}
+ @category{richtext}
+
+ @see wxRichTextBuffer, wxRichTextCtrl
+*/
+
+class WXDLLIMPEXP_RICHTEXT wxRichTextRange
+{
+public:
+// Constructors
+
+ /**
+ Default constructor.
+ */
+ wxRichTextRange() { m_start = 0; m_end = 0; }
+
+ /**
+ Constructor taking start and end positions.
+ */
+ wxRichTextRange(long start, long end) { m_start = start; m_end = end; }
+
+ /**
+ Copy constructor.
+ */
+ wxRichTextRange(const wxRichTextRange& range) { m_start = range.m_start; m_end = range.m_end; }
+ ~wxRichTextRange() {}
+
+ /**
+ Assigns @a range to this range.
+ */
+ void operator =(const wxRichTextRange& range) { m_start = range.m_start; m_end = range.m_end; }
+
+ /**
+ Equality operator. Returns @true if @a range is the same as this range.
+ */
+ bool operator ==(const wxRichTextRange& range) const { return (m_start == range.m_start && m_end == range.m_end); }
+
+ /**
+ Inequality operator.
+ */
+ bool operator !=(const wxRichTextRange& range) const { return (m_start != range.m_start || m_end != range.m_end); }
+
+ /**
+ Subtracts a range from this range.
+ */
+ wxRichTextRange operator -(const wxRichTextRange& range) const { return wxRichTextRange(m_start - range.m_start, m_end - range.m_end); }
+
+ /**
+ Adds a range to this range.
+ */
+ wxRichTextRange operator +(const wxRichTextRange& range) const { return wxRichTextRange(m_start + range.m_start, m_end + range.m_end); }
+
+ /**
+ Sets the range start and end positions.
+ */
+ void SetRange(long start, long end) { m_start = start; m_end = end; }
+
+ /**
+ Sets the start position.
+ */
+ void SetStart(long start) { m_start = start; }
+
+ /**
+ Returns the start position.
+ */
+ long GetStart() const { return m_start; }
+
+ /**
+ Sets the end position.
+ */
+ void SetEnd(long end) { m_end = end; }
+
+ /**
+ Gets the end position.
+ */
+ long GetEnd() const { return m_end; }
+
+ /**
+ Returns true if this range is completely outside @a range.
+ */
+ bool IsOutside(const wxRichTextRange& range) const { return range.m_start > m_end || range.m_end < m_start; }
+
+ /**
+ Returns true if this range is completely within @a range.
+ */
+ bool IsWithin(const wxRichTextRange& range) const { return m_start >= range.m_start && m_end <= range.m_end; }
+
+ /**
+ Returns true if @a pos was within the range. Does not match if the range is empty.
+ */
+ bool Contains(long pos) const { return pos >= m_start && pos <= m_end ; }
+
+ /**
+ Limit this range to be within @a range.
+ */
+ bool LimitTo(const wxRichTextRange& range) ;
+
+ /**
+ Gets the length of the range.
+ */
+ long GetLength() const { return m_end - m_start + 1; }
+
+ /**
+ Swaps the start and end.
+ */
+ void Swap() { long tmp = m_start; m_start = m_end; m_end = tmp; }
+
+ /**
+ Converts the API-standard range, whose end is one past the last character in
+ the range, to the internal form, which uses the first and last character
+ positions of the range. In other words, one is subtracted from the end position.
+ (n, n) is the range of a single character.
+ */
+ wxRichTextRange ToInternal() const { return wxRichTextRange(m_start, m_end-1); }
+
+ /**
+ Converts the internal range, which uses the first and last character positions
+ of the range, to the API-standard range, whose end is one past the last
+ character in the range. In other words, one is added to the end position.
+ (n, n+1) is the range of a single character.
+ */
+ wxRichTextRange FromInternal() const { return wxRichTextRange(m_start, m_end+1); }
+
+protected:
+ long m_start;
+ long m_end;
+};
+
+WX_DECLARE_USER_EXPORTED_OBJARRAY(wxRichTextRange, wxRichTextRangeArray, WXDLLIMPEXP_RICHTEXT);
+
+#define wxRICHTEXT_ALL wxRichTextRange(-2, -2)
+#define wxRICHTEXT_NONE wxRichTextRange(-1, -1)
+
+#define wxRICHTEXT_NO_SELECTION wxRichTextRange(-2, -2)
+
+/**
+ @class wxRichTextSelection
+
+ Stores selection information. The selection does not have to be contiguous, though currently non-contiguous
+ selections are only supported for a range of table cells (a geometric block of cells can consist
+ of a set of non-contiguous positions).
+
+ The selection consists of an array of ranges, and the container that is the context for the selection. It
+ follows that a single selection object can only represent ranges with the same parent container.
+
+ @library{wxrichtext}
+ @category{richtext}
+
+ @see wxRichTextBuffer, wxRichTextCtrl
+*/
+
+class WXDLLIMPEXP_RICHTEXT wxRichTextSelection
+{
+public:
+ /**
+ Copy constructor.
+ */
+ wxRichTextSelection(const wxRichTextSelection& sel) { Copy(sel); }
+
+ /**
+ Creates a selection from a range and a container.
+ */
+ wxRichTextSelection(const wxRichTextRange& range, wxRichTextParagraphLayoutBox* container) { m_ranges.Add(range); m_container = container; }
+
+ /**
+ Default constructor.
+ */
+ wxRichTextSelection() { Reset(); }
+
+ /**
+ Resets the selection.
+ */
+ void Reset() { m_ranges.Clear(); m_container = NULL; }
+
+ /**
+ Sets the selection.
+ */
+
+ void Set(const wxRichTextRange& range, wxRichTextParagraphLayoutBox* container)
+ { m_ranges.Clear(); m_ranges.Add(range); m_container = container; }
+
+ /**
+ Adds a range to the selection.
+ */
+ void Add(const wxRichTextRange& range)
+ { m_ranges.Add(range); }
+
+ /**
+ Sets the selections from an array of ranges and a container object.
+ */
+ void Set(const wxRichTextRangeArray& ranges, wxRichTextParagraphLayoutBox* container)
+ { m_ranges = ranges; m_container = container; }
+
+ /**
+ Copies from @a sel.
+ */
+ void Copy(const wxRichTextSelection& sel)
+ { m_ranges = sel.m_ranges; m_container = sel.m_container; }
+
+ /**
+ Assignment operator.
+ */
+ void operator=(const wxRichTextSelection& sel) { Copy(sel); }
+
+ /**
+ Equality operator.
+ */
+ bool operator==(const wxRichTextSelection& sel) const;
+
+ /**
+ Index operator.
+ */
+ wxRichTextRange operator[](size_t i) const { return GetRange(i); }
+
+ /**
+ Returns the selection ranges.
+ */
+ wxRichTextRangeArray& GetRanges() { return m_ranges; }
+
+ /**
+ Returns the selection ranges.
+ */
+ const wxRichTextRangeArray& GetRanges() const { return m_ranges; }
+
+ /**
+ Sets the selection ranges.
+ */
+ void SetRanges(const wxRichTextRangeArray& ranges) { m_ranges = ranges; }
+
+ /**
+ Returns the number of ranges in the selection.
+ */
+ size_t GetCount() const { return m_ranges.GetCount(); }
+
+ /**
+ Returns the range at the given index.
+
+ */
+ wxRichTextRange GetRange(size_t i) const { return m_ranges[i]; }
+
+ /**
+ Returns the first range if there is one, otherwise wxRICHTEXT_NO_SELECTION.
+ */
+ wxRichTextRange GetRange() const { return (m_ranges.GetCount() > 0) ? (m_ranges[0]) : wxRICHTEXT_NO_SELECTION; }
+
+ /**
+ Sets a single range.
+ */
+ void SetRange(const wxRichTextRange& range) { m_ranges.Clear(); m_ranges.Add(range); }
+
+ /**
+ Returns the container for which the selection is valid.
+ */
+ wxRichTextParagraphLayoutBox* GetContainer() const { return m_container; }
+
+ /**
+ Sets the container for which the selection is valid.
+ */
+ void SetContainer(wxRichTextParagraphLayoutBox* container) { m_container = container; }
+
+ /**
+ Returns @true if the selection is valid.
+ */
+ bool IsValid() const { return m_ranges.GetCount() > 0 && GetContainer(); }
+
+ /**
+ Returns the selection appropriate to the specified object, if any; returns an empty array if none
+ at the level of the object's container.
+ */
+ wxRichTextRangeArray GetSelectionForObject(wxRichTextObject* obj) const;
+
+ /**
+ Returns @true if the given position is within the selection.
+ */
+ bool WithinSelection(long pos, wxRichTextObject* obj) const;
+
+ /**
+ Returns @true if the given position is within the selection.
+
+ */
+ bool WithinSelection(long pos) const { return WithinSelection(pos, m_ranges); }
+
+ /**
+ Returns @true if the given position is within the selection range.
+ */
+ static bool WithinSelection(long pos, const wxRichTextRangeArray& ranges);
+
+ /**
+ Returns @true if the given range is within the selection range.
+ */
+ static bool WithinSelection(const wxRichTextRange& range, const wxRichTextRangeArray& ranges);
+
+ wxRichTextRangeArray m_ranges;
+ wxRichTextParagraphLayoutBox* m_container;
+};
+
+/**
+ @class wxRichTextObject
+
+ This is the base for drawable rich text objects.
+
+ @library{wxrichtext}
+ @category{richtext}
+
+ @see wxRichTextBuffer, wxRichTextCtrl
+*/
+
+class WXDLLIMPEXP_RICHTEXT wxRichTextObject: public wxObject
+{
+ DECLARE_CLASS(wxRichTextObject)
+public:
+ /**
+ Constructor, taking an optional parent pointer.
+ */
+ wxRichTextObject(wxRichTextObject* parent = NULL);
+
+ virtual ~wxRichTextObject();
+
+// Overridables
+
+ /**
+ Draw the item, within the given range. Some objects may ignore the range (for
+ example paragraphs) while others must obey it (lines, to implement wrapping)
+ */
+ virtual bool Draw(wxDC& dc, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style) = 0;
+
+ /**
+ Lay the item out at the specified position with the given size constraint.
+ Layout must set the cached size.
+ */
+ virtual bool Layout(wxDC& dc, const wxRect& rect, int style) = 0;
+
+ /**
+ Hit-testing: returns a flag indicating hit test details, plus
+ information about position. @a contextObj is returned to specify what object
+ position is relevant to, since otherwise there's an ambiguity.
+ @ obj might not be a child of @a contextObj, since we may be referring to the container itself
+ if we have no hit on a child - for example if we click outside an object.
+
+ The function puts the position in @a textPosition if one is found.
+ @a pt is in logical units (a zero y position is at the beginning of the buffer).
+
+ @return One of the ::wxRichTextHitTestFlags values.
+ */
+
+ virtual int HitTest(wxDC& dc, const wxPoint& pt, long& textPosition, wxRichTextObject** obj, wxRichTextObject** contextObj, int flags = 0);
+
+ /**
+ Finds the absolute position and row height for the given character position.
+ */
+ virtual bool FindPosition(wxDC& WXUNUSED(dc), long WXUNUSED(index), wxPoint& WXUNUSED(pt), int* WXUNUSED(height), bool WXUNUSED(forceLineStart)) { return false; }
+
+ /**
+ Returns the best size, i.e. the ideal starting size for this object irrespective
+ of available space. For a short text string, it will be the size that exactly encloses
+ the text. For a longer string, it might use the parent width for example.
+ */
+ virtual wxSize GetBestSize() const { return m_size; }
+
+ /**
+ Returns the object size for the given range. Returns @false if the range
+ is invalid for this object.
+ */
+
+ virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, int flags, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const = 0;
+
+ /**
+ Do a split from @a pos, returning an object containing the second part, and setting
+ the first part in 'this'.
+ */
+ virtual wxRichTextObject* DoSplit(long WXUNUSED(pos)) { return NULL; }
+
+ /**
+ Calculates the range of the object. By default, guess that the object is 1 unit long.
+ */
+ virtual void CalculateRange(long start, long& end) { end = start ; m_range.SetRange(start, end); }
+
+ /**
+ Deletes the given range.
+ */
+ virtual bool DeleteRange(const wxRichTextRange& WXUNUSED(range)) { return false; }
+
+ /**
+ Returns @true if the object is empty.
+ */
+ virtual bool IsEmpty() const { return false; }
+
+ /**
+ Returns @true if this class of object is floatable.
+ */
+ virtual bool IsFloatable() const { return false; }
+
+ /**
+ Returns @true if this object is currently floating.
+ */
+ virtual bool IsFloating() const { return GetAttributes().GetTextBoxAttr().IsFloating(); }
+
+ /**
+ Returns the floating direction.
+ */
+ virtual int GetFloatDirection() const { return GetAttributes().GetTextBoxAttr().GetFloatMode(); }
+
+ /**
+ Returns any text in this object for the given range.
+ */
+ virtual wxString GetTextForRange(const wxRichTextRange& WXUNUSED(range)) const { return wxEmptyString; }
+
+ /**
+ Returns @true if this object can merge itself with the given one.
+ */
+ virtual bool CanMerge(wxRichTextObject* WXUNUSED(object)) const { return false; }
+
+ /**
+ 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; }
+
+ /**
+ Dump object data to the given output stream for debugging.
+ */
+ virtual void Dump(wxTextOutputStream& stream);
+
+ /**
+ Returns @true if we can edit the object's properties via a GUI.
+ */
+ virtual bool CanEditProperties() const { return false; }
+
+ /**
+ Edits the object's properties via a GUI.
+ */
+ virtual bool EditProperties(wxWindow* WXUNUSED(parent), wxRichTextBuffer* WXUNUSED(buffer)) { return false; }
+
+ /**
+ Returns the label to be used for the properties context menu item.
+ */
+ virtual wxString GetPropertiesMenuLabel() const { return wxEmptyString; }
+
+ /**
+ Returns @true if objects of this class can accept the focus, i.e. a call to SetFocusObject
+ is possible. For example, containers supporting text, such as a text box object, can accept the focus,
+ but a table can't (set the focus to individual cells instead).
+ */
+ virtual bool AcceptsFocus() const { return false; }
+
+#if wxUSE_XML
+ /**
+ Imports this object from XML.
+ */
+ virtual bool ImportFromXML(wxRichTextBuffer* buffer, wxXmlNode* node, wxRichTextXMLHandler* handler, bool* recurse);
+#endif
+
+#if wxRICHTEXT_HAVE_DIRECT_OUTPUT
+ /**
+ Exports this object directly to the given stream, bypassing the creation of a wxXmlNode hierarchy.
+ This method is considerably faster than creating a tree first. However, both versions of ExportXML must be
+ implemented so that if the tree method is made efficient in the future, we can deprecate the
+ more verbose direct output method. Compiled only if wxRICHTEXT_HAVE_DIRECT_OUTPUT is defined (on by default).
+ */
+ virtual bool ExportXML(wxOutputStream& stream, int indent, wxRichTextXMLHandler* handler);
+#endif
+
+#if wxRICHTEXT_HAVE_XMLDOCUMENT_OUTPUT
+ /**
+ Exports this object to the given parent node, usually creating at least one child node.
+ This method is less efficient than the direct-to-stream method but is retained to allow for
+ switching to this method if we make it more efficient. Compiled only if wxRICHTEXT_HAVE_XMLDOCUMENT_OUTPUT is defined
+ (on by default).
+ */
+ virtual bool ExportXML(wxXmlNode* parent, wxRichTextXMLHandler* handler);
+#endif
+
+ /**
+ Returns @true if this object takes note of paragraph attributes (text and image objects don't).
+ */
+ virtual bool UsesParagraphAttributes() const { return true; }
+
+ /**
+ Returns the XML node name of this object. This must be overridden for wxXmlNode-base XML export to work.
+ */
+ virtual wxString GetXMLNodeName() const { return wxT("unknown"); }
+
+ /**
+ Invalidates the object at the given range. With no argument, invalidates the whole object.
+ */
+ virtual void Invalidate(const wxRichTextRange& invalidRange = wxRICHTEXT_ALL);
+
+ /**
+ Returns @true if this object can handle the selections of its children, fOr example a table.
+ Required for composite selection handling to work.
+ */
+ virtual bool HandlesChildSelections() const { return false; }
+
+ /**
+ Returns a selection object specifying the selections between start and end character positions.
+ For example, a table would deduce what cells (of range length 1) are selected when dragging across the table.
+ */
+ virtual wxRichTextSelection GetSelection(long WXUNUSED(start), long WXUNUSED(end)) const { return wxRichTextSelection(); }
+
+// Accessors
+
+ /**
+ Gets the cached object size as calculated by Layout.
+ */
+ virtual wxSize GetCachedSize() const { return m_size; }
+
+ /**
+ Sets the cached object size as calculated by Layout.
+ */
+ virtual void SetCachedSize(const wxSize& sz) { m_size = sz; }
+
+ /**
+ Gets the maximum object size as calculated by Layout. This allows
+ us to fit an object to its contents or allocate extra space if required.
+ */
+ virtual wxSize GetMaxSize() const { return m_maxSize; }
+
+ /**
+ Sets the maximum object size as calculated by Layout. This allows
+ us to fit an object to its contents or allocate extra space if required.
+ */
+ virtual void SetMaxSize(const wxSize& sz) { m_maxSize = sz; }
+
+ /**
+ Gets the minimum object size as calculated by Layout. This allows
+ us to constrain an object to its absolute minimum size if necessary.
+ */
+ virtual wxSize GetMinSize() const { return m_minSize; }
+
+ /**
+ Sets the minimum object size as calculated by Layout. This allows
+ us to constrain an object to its absolute minimum size if necessary.
+ */
+ virtual void SetMinSize(const wxSize& sz) { m_minSize = sz; }
+
+ /**
+ Gets the 'natural' size for an object. For an image, it would be the
+ image size.
+ */
+ virtual wxTextAttrSize GetNaturalSize() const { return wxTextAttrSize(); }
+
+ /**
+ Returns the object position in pixels.
+ */
+ virtual wxPoint GetPosition() const { return m_pos; }
+
+ /**
+ Sets the object position in pixels.
+ */
+ virtual void SetPosition(const wxPoint& pos) { m_pos = pos; }
+
+ /**
+ Returns the absolute object position, by traversing up the child/parent hierarchy.
+ TODO: may not be needed, if all object positions are in fact relative to the
+ top of the coordinate space.
+ */
+ virtual wxPoint GetAbsolutePosition() const;
+
+ /**
+ Returns the rectangle enclosing the object.
+ */
+ virtual wxRect GetRect() const { return wxRect(GetPosition(), GetCachedSize()); }
+
+ /**
+ Sets the object's range within its container.
+ */
+ void SetRange(const wxRichTextRange& range) { m_range = range; }
+
+ /**
+ Returns the object's range.
+ */
+ const wxRichTextRange& GetRange() const { return m_range; }
+
+ /**
+ Returns the object's range.
+ */
+ wxRichTextRange& GetRange() { return m_range; }
+
+ /**
+ Set the object's own range, for a top-level object with its own position space.
+ */
+ void SetOwnRange(const wxRichTextRange& range) { m_ownRange = range; }
+
+ /**
+ Returns the object's own range (valid if top-level).
+ */
+ const wxRichTextRange& GetOwnRange() const { return m_ownRange; }
+
+ /**
+ Returns the object's own range (valid if top-level).
+ */
+ wxRichTextRange& GetOwnRange() { return m_ownRange; }
+
+ /**
+ Returns the object's own range only if a top-level object.
+ */
+ wxRichTextRange GetOwnRangeIfTopLevel() const { return IsTopLevel() ? m_ownRange : m_range; }
+
+ /**
+ Returns @true if this object this composite.
+ */
+ virtual bool IsComposite() const { return false; }
+
+ /**
+ Returns a pointer to the parent object.
+ */
+ virtual wxRichTextObject* GetParent() const { return m_parent; }
+
+ /**
+ Sets the pointer to the parent object.
+ */
+ virtual void SetParent(wxRichTextObject* parent) { m_parent = parent; }
+
+ /**
+ Returns the top-level container of this object.
+ May return itself if it's a container; use GetParentContainer to return
+ a different container.
+ */
+ virtual wxRichTextParagraphLayoutBox* GetContainer() const;
+
+ /**
+ Returns the top-level container of this object.
+ Returns a different container than itself, unless there's no parent, in which case it will return NULL.
+ */
+ virtual wxRichTextParagraphLayoutBox* GetParentContainer() const { return GetParent() ? GetParent()->GetContainer() : GetContainer(); }
+
+ /**
+ Set the margin around the object, in pixels.
+ */
+ virtual void SetMargins(int margin);
+
+ /**
+ Set the margin around the object, in pixels.
+ */
+ virtual void SetMargins(int leftMargin, int rightMargin, int topMargin, int bottomMargin);
+
+ /**
+ Returns the left margin of the object, in pixels.
+ */
+ virtual int GetLeftMargin() const;
+
+ /**
+ Returns the right margin of the object, in pixels.
+ */
+ virtual int GetRightMargin() const;
+
+ /**
+ Returns the top margin of the object, in pixels.
+ */
+ virtual int GetTopMargin() const;
+
+ /**
+ Returns the bottom margin of the object, in pixels.
+ */
+ virtual int GetBottomMargin() const;
+
+ /**
+ Calculates the available content space in the given rectangle, given the
+ margins, border and padding specified in the object's attributes.
+ */
+ virtual wxRect GetAvailableContentArea(wxDC& dc, const wxRect& outerRect) const;
+
+ /**
+ Lays out the object first with a given amount of space, and then if no width was specified in attr,
+ lays out the object again using the minimum size
+ */
+ virtual bool LayoutToBestSize(wxDC& dc, wxRichTextBuffer* buffer,
+ const wxRichTextAttr& parentAttr, const wxRichTextAttr& attr, const wxRect& availableParentSpace, int style);
+
+ /**
+ Sets the object's attributes.
+ */
+ void SetAttributes(const wxRichTextAttr& attr) { m_attributes = attr; }
+
+ /**
+ Returns the object's attributes.
+ */
+ const wxRichTextAttr& GetAttributes() const { return m_attributes; }
+
+ /**
+ Returns the object's attributes.
+ */
+ wxRichTextAttr& GetAttributes() { return m_attributes; }
+
+ /**
+ Sets the object's properties.
+ */
+ wxRichTextProperties& GetProperties() { return m_properties; }
+
+ /**
+ Returns the object's properties.
+ */
+ const wxRichTextProperties& GetProperties() const { return m_properties; }
+
+ /**
+ Returns the object's properties.
+ */
+ void SetProperties(const wxRichTextProperties& props) { m_properties = props; }
+
+ /**
+ Sets the stored descent value.
+ */
+ void SetDescent(int descent) { m_descent = descent; }
+
+ /**
+ Returns the stored descent value.
+ */
+ int GetDescent() const { return m_descent; }
+
+ /**
+ Returns the containing buffer.
+ */
+ wxRichTextBuffer* GetBuffer() const;
+
+ /**
+ Sets the identifying name for this object as a property using the "name" key.
+ */
+ void SetName(const wxString& name) { m_properties.SetProperty(wxT("name"), name); }
+
+ /**
+ Returns the identifying name for this object from the properties, using the "name" key.
+ */
+ wxString GetName() const { return m_properties.GetPropertyString(wxT("name")); }
+
+ /**
+ Returns @true if this object is top-level, i.e. contains its own paragraphs, such as a text box.
+ */
+ virtual bool IsTopLevel() const { return false; }
+
+ /**
+ Returns @true if the object will be shown, @false otherwise.
+ */
+ bool IsShown() const { return m_show; }
+
+// Operations
+
+ /**
+ Call to show or hide this object. This function does not cause the content to be
+ laid out or redrawn.
+ */
+ virtual void Show(bool show) { m_show = show; }
+
+ /**
+ Clones the object.
+ */
+ virtual wxRichTextObject* Clone() const { return NULL; }
+
+ /**
+ Copies the object.
+ */
+ void Copy(const wxRichTextObject& obj);
+
+ /**
+ Reference-counting allows us to use the same object in multiple
+ lists (not yet used).
+ */
+
+ void Reference() { m_refCount ++; }
+
+ /**
+ Reference-counting allows us to use the same object in multiple
+ lists (not yet used).
+ */
+ void Dereference();
+
+ /**
+ Moves the object recursively, by adding the offset from old to new.
+ */
+ virtual void Move(const wxPoint& pt);
+
+ /**
+ Converts units in tenths of a millimetre to device units.
+ */
+ int ConvertTenthsMMToPixels(wxDC& dc, int units) const;
+
+ /**
+ Converts units in tenths of a millimetre to device units.
+ */
+ static int ConvertTenthsMMToPixels(int ppi, int units, double scale = 1.0);
+
+ /**
+ Convert units in pixels to tenths of a millimetre.
+ */
+ int ConvertPixelsToTenthsMM(wxDC& dc, int pixels) const;
+
+ /**
+ Convert units in pixels to tenths of a millimetre.
+ */
+ static int ConvertPixelsToTenthsMM(int ppi, int pixels, double scale = 1.0);
+
+ /**
+ Draws the borders and background for the given rectangle and attributes.
+ @a boxRect is taken to be the outer margin box, not the box around the content.
+ */
+ static bool DrawBoxAttributes(wxDC& dc, wxRichTextBuffer* buffer, const wxRichTextAttr& attr, const wxRect& boxRect, int flags = 0);
+
+ /**
+ Draws a border.
+ */
+ static bool DrawBorder(wxDC& dc, wxRichTextBuffer* buffer, const wxTextAttrBorders& attr, const wxRect& rect, int flags = 0);
+
+ /**
+ Returns the various rectangles of the box model in pixels. You can either specify @a contentRect (inner)
+ or @a marginRect (outer), and the other must be the default rectangle (no width or height).
+ Note that the outline doesn't affect the position of the rectangle, it's drawn in whatever space
+ is available.
+ */
+ static bool GetBoxRects(wxDC& dc, wxRichTextBuffer* buffer, const wxRichTextAttr& attr, wxRect& marginRect, wxRect& borderRect, wxRect& contentRect, wxRect& paddingRect, wxRect& outlineRect);
+
+ /**
+ Returns the total margin for the object in pixels, taking into account margin, padding and border size.
+ */
+ static bool GetTotalMargin(wxDC& dc, wxRichTextBuffer* buffer, const wxRichTextAttr& attr, int& leftMargin, int& rightMargin,
+ int& topMargin, int& bottomMargin);
+
+ /**
+ Returns the rectangle which the child has available to it given restrictions specified in the
+ child attribute, e.g. 50% width of the parent, 400 pixels, x position 20% of the parent, etc.
+ */
+ static wxRect AdjustAvailableSpace(wxDC& dc, wxRichTextBuffer* buffer, const wxRichTextAttr& parentAttr, const wxRichTextAttr& childAttr, const wxRect& availableParentSpace);
+
+protected:
+ wxSize m_size;
+ wxSize m_maxSize;
+ wxSize m_minSize;
+ wxPoint m_pos;
+ int m_descent; // Descent for this object (if any)
+ int m_refCount;
+ bool m_show;
+ wxRichTextObject* m_parent;
+
+ // The range of this object (start position to end position)
+ wxRichTextRange m_range;
+
+ // The internal range of this object, if it's a top-level object with its own range space
+ wxRichTextRange m_ownRange;
+
+ // Attributes
+ wxRichTextAttr m_attributes;
+
+ // Properties
+ wxRichTextProperties m_properties;
+};
+
+WX_DECLARE_LIST_WITH_DECL( wxRichTextObject, wxRichTextObjectList, class WXDLLIMPEXP_RICHTEXT );
+
+/**
+ @class wxRichTextCompositeObject
+
+ Objects of this class can contain other objects.
+
+ @library{wxrichtext}
+ @category{richtext}
+
+ @see wxRichTextObject, wxRichTextBuffer, wxRichTextCtrl
+*/
+
+class WXDLLIMPEXP_RICHTEXT wxRichTextCompositeObject: public wxRichTextObject
+{
+ DECLARE_CLASS(wxRichTextCompositeObject)
+public:
+// Constructors
+
+ wxRichTextCompositeObject(wxRichTextObject* parent = NULL);
+ virtual ~wxRichTextCompositeObject();
+
+// Overridables
+
+ virtual int HitTest(wxDC& dc, const wxPoint& pt, long& textPosition, wxRichTextObject** obj, wxRichTextObject** contextObj, int flags = 0);
+
+ virtual bool FindPosition(wxDC& dc, long index, wxPoint& pt, int* height, bool forceLineStart);
+
+ virtual void CalculateRange(long start, long& end);
+
+ virtual bool DeleteRange(const wxRichTextRange& range);
+
+ virtual wxString GetTextForRange(const wxRichTextRange& range) const;
+
+ virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, int flags, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const;
+
+ virtual void Dump(wxTextOutputStream& stream);
+
+ virtual void Invalidate(const wxRichTextRange& invalidRange = wxRICHTEXT_ALL);
+
+// Accessors
+
+ /**
+ Returns the children.
+ */
+ wxRichTextObjectList& GetChildren() { return m_children; }
+ /**
+ Returns the children.
+ */
+ const wxRichTextObjectList& GetChildren() const { return m_children; }
+
+ /**
+ Returns the number of children.
+ */
+ size_t GetChildCount() const ;
+
+ /**
+ Returns the nth child.
+ */
+ wxRichTextObject* GetChild(size_t n) const ;
+
+ /**
+ Returns @true if this object is composite.
+ */
+ virtual bool IsComposite() const { return true; }
+
+ /**
+ Returns true if the buffer is empty.
+ */
+ virtual bool IsEmpty() const { return GetChildCount() == 0; }
+
+ /**
+ Returns the child object at the given character position.
+ */
+ virtual wxRichTextObject* GetChildAtPosition(long pos) const;
+
+// Operations
+
+ void Copy(const wxRichTextCompositeObject& obj);
+
+ void operator= (const wxRichTextCompositeObject& obj) { Copy(obj); }
+
+ /**
+ Appends a child, returning the position.
+ */
+ size_t AppendChild(wxRichTextObject* child) ;
+
+ /**
+ Inserts the child in front of the given object, or at the beginning.
+ */
+ bool InsertChild(wxRichTextObject* child, wxRichTextObject* inFrontOf) ;
+
+ /**
+ Removes and optionally deletes the specified child.
+ */
+ bool RemoveChild(wxRichTextObject* child, bool deleteChild = false) ;
+
+ /**
+ Deletes all the children.
+ */
+ bool DeleteChildren() ;
+
+ /**
+ Recursively merges all pieces that can be merged.
+ */
+ bool Defragment(const wxRichTextRange& range = wxRICHTEXT_ALL);
+
+ /**
+ Moves the object recursively, by adding the offset from old to new.
+ */
+ virtual void Move(const wxPoint& pt);
+
+protected:
+ wxRichTextObjectList m_children;
+};
+
+/**
+ @class wxRichTextParagraphBox
+
+ This class knows how to lay out paragraphs.
+
+ @library{wxrichtext}
+ @category{richtext}
+
+ @see wxRichTextCompositeObject, wxRichTextObject, wxRichTextBuffer, wxRichTextCtrl
+*/
+
+class WXDLLIMPEXP_RICHTEXT wxRichTextParagraphLayoutBox: public wxRichTextCompositeObject
+{
+ DECLARE_DYNAMIC_CLASS(wxRichTextParagraphLayoutBox)
+public:
+// Constructors
+
+ wxRichTextParagraphLayoutBox(wxRichTextObject* parent = NULL);
+ wxRichTextParagraphLayoutBox(const wxRichTextParagraphLayoutBox& obj): wxRichTextCompositeObject() { Init(); Copy(obj); }
+ ~wxRichTextParagraphLayoutBox();
+
+// Overridables
+
+ virtual int HitTest(wxDC& dc, const wxPoint& pt, long& textPosition, wxRichTextObject** obj, wxRichTextObject** contextObj, int flags = 0);
+
+ virtual bool Draw(wxDC& dc, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style);
+
+ virtual bool Layout(wxDC& dc, const wxRect& rect, int style);
+
+ virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, int flags, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const;
+
+ virtual bool DeleteRange(const wxRichTextRange& range);
+
+ virtual wxString GetTextForRange(const wxRichTextRange& range) const;
+
+#if wxUSE_XML
+ virtual bool ImportFromXML(wxRichTextBuffer* buffer, wxXmlNode* node, wxRichTextXMLHandler* handler, bool* recurse);
+#endif
+
+#if wxRICHTEXT_HAVE_DIRECT_OUTPUT
+ virtual bool ExportXML(wxOutputStream& stream, int indent, wxRichTextXMLHandler* handler);
+#endif
+
+#if wxRICHTEXT_HAVE_XMLDOCUMENT_OUTPUT
+ virtual bool ExportXML(wxXmlNode* parent, wxRichTextXMLHandler* handler);
+#endif
+
+ virtual wxString GetXMLNodeName() const { return wxT("paragraphlayout"); }
+
+ virtual bool AcceptsFocus() const { return true; }
+
+// Accessors
+
+ /**
+ Associates a control with the buffer, for operations that for example require refreshing the window.
+ */
+ void SetRichTextCtrl(wxRichTextCtrl* ctrl) { m_ctrl = ctrl; }
+
+ /**
+ Returns the associated control.
+ */
+ wxRichTextCtrl* GetRichTextCtrl() const { return m_ctrl; }
+
+ /**
+ Sets a flag indicating whether the last paragraph is partial or complete.
+ */
+ void SetPartialParagraph(bool partialPara) { m_partialParagraph = partialPara; }
+
+ /**
+ Returns a flag indicating whether the last paragraph is partial or complete.
+ */
+ bool GetPartialParagraph() const { return m_partialParagraph; }
+
+ /**
+ Returns the style sheet associated with the overall buffer.
+ */
+ virtual wxRichTextStyleSheet* GetStyleSheet() const;
+
+ virtual bool IsTopLevel() const { return true; }
+
+// Operations
+
+ /**
+ Submits a command to insert paragraphs.
+ */
+ bool InsertParagraphsWithUndo(long pos, const wxRichTextParagraphLayoutBox& paragraphs, wxRichTextCtrl* ctrl, wxRichTextBuffer* buffer, int flags = 0);
+
+ /**
+ Submits a command to insert the given text.
+ */
+ bool InsertTextWithUndo(long pos, const wxString& text, wxRichTextCtrl* ctrl, wxRichTextBuffer* buffer, int flags = 0);
+
+ /**
+ Submits a command to insert the given text.
+ */
+ bool InsertNewlineWithUndo(long pos, wxRichTextCtrl* ctrl, wxRichTextBuffer* buffer, int flags = 0);
+
+ /**
+ Submits a command to insert the given image.
+ */
+ bool InsertImageWithUndo(long pos, const wxRichTextImageBlock& imageBlock,
+ wxRichTextCtrl* ctrl, wxRichTextBuffer* buffer, int flags,
+ const wxRichTextAttr& textAttr);
+
+ /**
+ Returns the style that is appropriate for a new paragraph at this position.
+ If the previous paragraph has a paragraph style name, looks up the next-paragraph
+ style.
+ */
+ wxRichTextAttr GetStyleForNewParagraph(wxRichTextBuffer* buffer, long pos, bool caretPosition = false, bool lookUpNewParaStyle=false) const;
+
+ /**
+ Inserts an object.
+ */
+ wxRichTextObject* InsertObjectWithUndo(long pos, wxRichTextObject *object, wxRichTextCtrl* ctrl, wxRichTextBuffer* buffer, int flags = 0);
+
+ /**
+ Submits a command to delete this range.
+ */
+ bool DeleteRangeWithUndo(const wxRichTextRange& range, wxRichTextCtrl* ctrl, wxRichTextBuffer* buffer);
+
+ /**
+ Draws the floating objects in this buffer.
+ */
+ void DrawFloats(wxDC& dc, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style);
+
+ /**
+ Moves an anchored object to another paragraph.
+ */
+ void MoveAnchoredObjectToParagraph(wxRichTextParagraph* from, wxRichTextParagraph* to, wxRichTextObject* obj);
+
+ /**
+ Initializes the object.
+ */
+ void Init();
+
+ /**
+ Clears all the children.
+ */
+ virtual void Clear();
+
+ /**
+ Clears and initializes with one blank paragraph.
+ */
+ virtual void Reset();
+
+ /**
+ Convenience function to add a paragraph of text.
+ */
+ virtual wxRichTextRange AddParagraph(const wxString& text, wxRichTextAttr* paraStyle = NULL);
+
+ /**
+ Convenience function to add an image.
+ */
+ virtual wxRichTextRange AddImage(const wxImage& image, wxRichTextAttr* paraStyle = NULL);
+
+ /**
+ Adds multiple paragraphs, based on newlines.
+ */
+ virtual wxRichTextRange AddParagraphs(const wxString& text, wxRichTextAttr* paraStyle = NULL);
+
+ /**
+ Returns the line at the given position. If @a caretPosition is true, the position is
+ a caret position, which is normally a smaller number.
+ */
+ virtual wxRichTextLine* GetLineAtPosition(long pos, bool caretPosition = false) const;
+
+ /**
+ Returns the line at the given y pixel position, or the last line.
+ */
+ virtual wxRichTextLine* GetLineAtYPosition(int y) const;
+
+ /**
+ Returns the paragraph at the given character or caret position.
+ */
+ virtual wxRichTextParagraph* GetParagraphAtPosition(long pos, bool caretPosition = false) const;
+
+ /**
+ Returns the line size at the given position.
+ */
+ virtual wxSize GetLineSizeAtPosition(long pos, bool caretPosition = false) const;
+
+ /**
+ Given a position, returns the number of the visible line (potentially many to a paragraph),
+ starting from zero at the start of the buffer. We also have to pass a bool (@a startOfLine)
+ that indicates whether the caret is being shown at the end of the previous line or at the start
+ of the next, since the caret can be shown at two visible positions for the same underlying
+ position.
+ */
+ virtual long GetVisibleLineNumber(long pos, bool caretPosition = false, bool startOfLine = false) const;
+
+ /**
+ Given a line number, returns the corresponding wxRichTextLine object.
+ */
+ virtual wxRichTextLine* GetLineForVisibleLineNumber(long lineNumber) const;
+
+ /**
+ Returns the leaf object in a paragraph at this position.
+ */
+ virtual wxRichTextObject* GetLeafObjectAtPosition(long position) const;
+
+ /**
+ Returns the paragraph by number.
+ */
+ virtual wxRichTextParagraph* GetParagraphAtLine(long paragraphNumber) const;
+
+ /**
+ Returns the paragraph for a given line.
+ */
+ virtual wxRichTextParagraph* GetParagraphForLine(wxRichTextLine* line) const;
+
+ /**
+ Returns the length of the paragraph.
+ */
+ virtual int GetParagraphLength(long paragraphNumber) const;
+
+ /**
+ Returns the number of paragraphs.
+ */
+ virtual int GetParagraphCount() const { return static_cast<int>(GetChildCount()); }
+
+ /**
+ Returns the number of visible lines.
+ */
+ virtual int GetLineCount() const;
+
+ /**
+ Returns the text of the paragraph.
+ */
+ virtual wxString GetParagraphText(long paragraphNumber) const;
+
+ /**
+ Converts zero-based line column and paragraph number to a position.
+ */
+ virtual long XYToPosition(long x, long y) const;
+
+ /**
+ Converts a zero-based position to line column and paragraph number.
+ */
+ virtual bool PositionToXY(long pos, long* x, long* y) const;
+
+ /**
+ Sets the attributes for the given range. Pass 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. So, for example, to set the style for a character at position 5,
+ use the range (5,5).
+ This differs from the wxRichTextCtrl API, where you would specify (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.
+ */
+ virtual bool SetStyle(const wxRichTextRange& range, const wxRichTextAttr& style, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
+
+ /**
+ Sets the attributes for the given object only, for example the box attributes for a text box.
+ */
+ virtual void SetStyle(wxRichTextObject *obj, const wxRichTextAttr& textAttr, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
+
+ /**
+ Returns the combined text attributes for this 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.
+ */
+ virtual bool GetStyle(long position, wxRichTextAttr& style);
+
+ /**
+ Returns the content (uncombined) attributes for this position.
+ */
+ virtual bool GetUncombinedStyle(long position, wxRichTextAttr& style);
+
+ /**
+ Implementation helper for GetStyle. If combineStyles is true, combine base, paragraph and
+ context attributes.
+ */
+ virtual bool DoGetStyle(long position, wxRichTextAttr& style, bool combineStyles = true);
+
+ /**
+ This function gets a style representing the common, combined attributes in the