class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextLine;
class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextParagraph;
class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextFileHandler;
+class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextDrawingHandler;
+class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextField;
+class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextFieldType;
class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextStyleSheet;
class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextListStyleDefinition;
class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextEvent;
wxRICHTEXT_HITTEST_NO_NESTED_OBJECTS = 0x20,
// Ignore floating objects
- wxRICHTEXT_HITTEST_NO_FLOATING_OBJECTS = 0x40
+ wxRICHTEXT_HITTEST_NO_FLOATING_OBJECTS = 0x40,
+
+ // Don't recurse into objects marked as atomic
+ wxRICHTEXT_HITTEST_HONOUR_ATOMIC = 0x80
};
/**
// Removes the given style instead of applying it
#define wxRICHTEXT_SETSTYLE_REMOVE 0x80
+/**
+ Flags for SetProperties.
+ */
+
+#define wxRICHTEXT_SETPROPERTIES_NONE 0x00
+
+// Specifies that this operation should be undoable
+#define wxRICHTEXT_SETPROPERTIES_WITH_UNDO 0x01
+
+// Specifies that the properties should only be applied to paragraphs,
+// and not the content.
+#define wxRICHTEXT_SETPROPERTIES_PARAGRAPHS_ONLY 0x02
+
+// Specifies that the properties should only be applied to characters,
+// and not the paragraph.
+#define wxRICHTEXT_SETPROPERTIES_CHARACTERS_ONLY 0x04
+
+// Resets the existing properties before applying the new properties.
+#define wxRICHTEXT_SETPROPERTIES_RESET 0x08
+
+// Removes the given properties instead of applying them.
+#define wxRICHTEXT_SETPROPERTIES_REMOVE 0x10
+
/**
Flags for object insertion.
*/
// A special flag telling the buffer to keep the first paragraph style
// as-is, when deleting a paragraph marker. In future we might pass a
// flag to InsertFragment and DeleteRange to indicate the appropriate mode.
-#define wxTEXT_ATTR_KEEP_FIRST_PARA_STYLE 0x10000000
+#define wxTEXT_ATTR_KEEP_FIRST_PARA_STYLE 0x20000000
/**
Default superscript/subscript font multiplication factor.
wxTEXT_BOX_ATTR_FLOAT = 0x00000001,
wxTEXT_BOX_ATTR_CLEAR = 0x00000002,
wxTEXT_BOX_ATTR_COLLAPSE_BORDERS = 0x00000004,
- wxTEXT_BOX_ATTR_VERTICAL_ALIGNMENT = 0x00000008
+ wxTEXT_BOX_ATTR_VERTICAL_ALIGNMENT = 0x00000008,
+ wxTEXT_BOX_ATTR_BOX_STYLE_NAME = 0x00000010
};
/**
{
wxTEXT_BOX_ATTR_POSITION_STATIC = 0x0000, // Default is static, i.e. as per normal layout
wxTEXT_BOX_ATTR_POSITION_RELATIVE = 0x0010, // Relative to the relevant edge
- wxTEXT_BOX_ATTR_POSITION_ABSOLUTE = 0x0020,
+ wxTEXT_BOX_ATTR_POSITION_ABSOLUTE = 0x0020, // Relative to the parent
+ wxTEXT_BOX_ATTR_POSITION_FIXED = 0x0040, // Relative to the top-level window
wxTEXT_BOX_ATTR_POSITION_MASK = 0x00F0
};
void Reset() { m_value = 0; m_flags = 0; }
/**
- Partial equality test.
+ Partial equality test. If @a weakTest is @true, attributes of this object do not
+ have to be present if those attributes of @a dim are present. If @a weakTest is
+ @false, the function will fail if an attribute is present in @a dim but not
+ in this object.
*/
- bool EqPartial(const wxTextAttrDimension& dim) const;
+ bool EqPartial(const wxTextAttrDimension& dim, bool weakTest = true) const;
/** Apply the dimension, but not those identical to @a compareWith if present.
*/
bool operator==(const wxTextAttrDimensions& dims) const { return m_left == dims.m_left && m_top == dims.m_top && m_right == dims.m_right && m_bottom == dims.m_bottom; }
/**
- Partial equality test.
+ Partial equality test. If @a weakTest is @true, attributes of this object do not
+ have to be present if those attributes of @a dim sare present. If @a weakTest is
+ @false, the function will fail if an attribute is present in @a dims but not
+ in this object.
*/
- bool EqPartial(const wxTextAttrDimensions& dims) const;
+ bool EqPartial(const wxTextAttrDimensions& dims, bool weakTest = true) const;
/**
- Apply border to 'this', but not if the same as @a compareWith.
+ Apply to 'this', but not if the same as @a compareWith.
*/
bool Apply(const wxTextAttrDimensions& dims, const wxTextAttrDimensions* compareWith = NULL);
const wxTextAttrDimension& GetBottom() const { return m_bottom; }
wxTextAttrDimension& GetBottom() { return m_bottom; }
+ /**
+ Are all dimensions valid?
+
+ */
+ bool IsValid() const { return m_left.IsValid() && m_top.IsValid() && m_right.IsValid() && m_bottom.IsValid(); }
+
wxTextAttrDimension m_left;
wxTextAttrDimension m_top;
wxTextAttrDimension m_right;
bool operator==(const wxTextAttrSize& size) const { return m_width == size.m_width && m_height == size.m_height ; }
/**
- Partial equality test.
+ Partial equality test. If @a weakTest is @true, attributes of this object do not
+ have to be present if those attributes of @a size are present. If @a weakTest is
+ @false, the function will fail if an attribute is present in @a size but not
+ in this object.
*/
- bool EqPartial(const wxTextAttrSize& dims) const;
+ bool EqPartial(const wxTextAttrSize& size, bool weakTest = true) const;
/**
- Apply border to this object, but not if the same as @a compareWith.
+ Apply to this object, but not if the same as @a compareWith.
*/
bool Apply(const wxTextAttrSize& dims, const wxTextAttrSize* compareWith = NULL);
Sets the width.
*/
void SetWidth(int value, wxTextAttrDimensionFlags flags) { m_width.SetValue(value, flags); }
+
/**
Sets the width.
*/
void SetWidth(int value, wxTextAttrUnits units) { m_width.SetValue(value, units); }
+
/**
Sets the width.
*/
Sets the height.
*/
void SetHeight(int value, wxTextAttrDimensionFlags flags) { m_height.SetValue(value, flags); }
+
/**
Sets the height.
*/
void SetHeight(int value, wxTextAttrUnits units) { m_height.SetValue(value, units); }
+
/**
Sets the height.
*/
void SetHeight(const wxTextAttrDimension& dim) { m_height.SetValue(dim); }
+ /**
+ Is the size valid?
+ */
+ bool IsValid() const { return m_width.IsValid() && m_height.IsValid(); }
+
wxTextAttrDimension m_width;
wxTextAttrDimension m_height;
};
void Reset() { m_borderStyle = 0; m_borderColour = 0; m_flags = 0; m_borderWidth.Reset(); }
/**
- Partial equality test.
+ Partial equality test. If @a weakTest is @true, attributes of this object do not
+ have to be present if those attributes of @a border are present. If @a weakTest is
+ @false, the function will fail if an attribute is present in @a border but not
+ in this object.
*/
- bool EqPartial(const wxTextAttrBorder& border) const;
+ bool EqPartial(const wxTextAttrBorder& border, bool weakTest = true) const;
/**
Applies the border to this object, but not if the same as @a compareWith.
void Reset() { m_left.Reset(); m_right.Reset(); m_top.Reset(); m_bottom.Reset(); }
/**
- Partial equality test.
+ Partial equality test. If @a weakTest is @true, attributes of this object do not
+ have to be present if those attributes of @a borders are present. If @a weakTest is
+ @false, the function will fail if an attribute is present in @a borders but not
+ in this object.
*/
- bool EqPartial(const wxTextAttrBorders& borders) const;
+ bool EqPartial(const wxTextAttrBorders& borders, bool weakTest = true) const;
/**
Applies border to this object, but not if the same as @a compareWith.
bool operator== (const wxTextBoxAttr& attr) const;
/**
- Partial equality test, ignoring unset attributes.
+ Partial equality test, ignoring unset attributes. If @a weakTest is @true, attributes of this object do not
+ have to be present if those attributes of @a attr are present. If @a weakTest is
+ @false, the function will fail if an attribute is present in @a attr but not
+ in this object.
*/
- bool EqPartial(const wxTextBoxAttr& attr) const;
+ bool EqPartial(const wxTextBoxAttr& attr, bool weakTest = true) const;
/**
Merges the given attributes. If @a compareWith is non-NULL, then it will be used
wxTextAttrSize& GetSize() { return m_size; }
const wxTextAttrSize& GetSize() const { return m_size; }
+ /**
+ Returns the object minimum size.
+ */
+
+ wxTextAttrSize& GetMinSize() { return m_minSize; }
+ const wxTextAttrSize& GetMinSize() const { return m_minSize; }
+
+ /**
+ Returns the object maximum size.
+ */
+
+ wxTextAttrSize& GetMaxSize() { return m_maxSize; }
+ const wxTextAttrSize& GetMaxSize() const { return m_maxSize; }
+
/**
Sets the object size.
*/
void SetSize(const wxTextAttrSize& sz) { m_size = sz; }
+ /**
+ Sets the object minimum size.
+ */
+ void SetMinSize(const wxTextAttrSize& sz) { m_minSize = sz; }
+
+ /**
+ Sets the object maximum size.
+ */
+ void SetMaxSize(const wxTextAttrSize& sz) { m_maxSize = sz; }
+
/**
Returns the object width.
*/
wxTextAttrDimension& GetHeight() { return m_size.m_height; }
const wxTextAttrDimension& GetHeight() const { return m_size.m_height; }
+ /**
+ Returns the box style name.
+ */
+ const wxString& GetBoxStyleName() const { return m_boxStyleName; }
+
+ /**
+ Sets the box style name.
+ */
+ void SetBoxStyleName(const wxString& name) { m_boxStyleName = name; AddFlag(wxTEXT_BOX_ATTR_BOX_STYLE_NAME); }
+
+ /**
+ Returns @true if the box style name is present.
+ */
+ bool HasBoxStyleName() const { return HasFlag(wxTEXT_BOX_ATTR_BOX_STYLE_NAME); }
+
public:
int m_flags;
wxTextAttrDimensions m_position;
wxTextAttrSize m_size;
+ wxTextAttrSize m_minSize;
+ wxTextAttrSize m_maxSize;
wxTextAttrBorders m_border;
wxTextAttrBorders m_outline;
wxTextBoxAttrClearStyle m_clearMode;
wxTextBoxAttrCollapseMode m_collapseMode;
wxTextBoxAttrVerticalAlignment m_verticalAlignment;
+ wxString m_boxStyleName;
};
/**
bool operator==(const wxRichTextAttr& attr) const;
/**
- Partial equality test taking comparison object into account.
+ Partial equality test. If @a weakTest is @true, attributes of this object do not
+ have to be present if those attributes of @a attr are present. If @a weakTest is
+ @false, the function will fail if an attribute is present in @a attr but not
+ in this object.
*/
- bool EqPartial(const wxRichTextAttr& attr) const;
+ bool EqPartial(const wxRichTextAttr& attr, bool weakTest = true) const;
/**
Merges the given attributes. If @a compareWith
*/
int Find(const wxString& name) const;
+ /**
+ Removes the given property.
+ */
+ bool Remove(const wxString& name);
+
/**
Gets the property variant by name.
*/
*/
void SetProperty(const wxString& name, bool value);
+ /**
+ Removes the given properties from these properties.
+ */
+ void RemoveProperties(const wxRichTextProperties& properties);
+
+ /**
+ Merges the given properties with these properties.
+ */
+ void MergeProperties(const wxRichTextProperties& properties);
+
protected:
wxRichTextVariantArray m_properties;
};
*/
bool operator != (const wxRichTextFontTable& table) const { return !(*this == table); }
+ /**
+ Set the font scale factor.
+ */
+ void SetFontScale(double fontScale);
+
protected:
+ double m_fontScale;
+
DECLARE_DYNAMIC_CLASS(wxRichTextFontTable)
};
wxRichTextParagraphLayoutBox* m_container;
};
+/**
+ @class wxRichTextDrawingContext
+
+ A class for passing information to drawing and measuring functions.
+
+ @library{wxrichtext}
+ @category{richtext}
+
+ @see wxRichTextBuffer, wxRichTextCtrl
+*/
+
+class WXDLLIMPEXP_RICHTEXT wxRichTextDrawingContext: public wxObject
+{
+ DECLARE_CLASS(wxRichTextDrawingContext)
+public:
+
+ /**
+ Pass the buffer to the context so the context can retrieve information
+ such as virtual attributes.
+ */
+ wxRichTextDrawingContext(wxRichTextBuffer* buffer) { Init(); m_buffer = buffer; }
+
+ void Init() { m_buffer = NULL; }
+
+ /**
+ Does this object have virtual attributes?
+ Virtual attributes can be provided for visual cues without
+ affecting the actual styling.
+ */
+ bool HasVirtualAttributes(wxRichTextObject* obj) const;
+
+ /**
+ Returns the virtual attributes for this object.
+ Virtual attributes can be provided for visual cues without
+ affecting the actual styling.
+ */
+ wxRichTextAttr GetVirtualAttributes(wxRichTextObject* obj) const;
+
+ /**
+ Applies any virtual attributes relevant to this object.
+ */
+ bool ApplyVirtualAttributes(wxRichTextAttr& attr, wxRichTextObject* obj) const;
+
+ wxRichTextBuffer* m_buffer;
+};
+
/**
@class wxRichTextObject
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;
+ virtual bool Draw(wxDC& dc, wxRichTextDrawingContext& context, 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.
+ Layout must set the cached size. @rect is the available space for the object,
+ and @a parentRect is the container that is used to determine a relative size
+ or position (for example if a text box must be 50% of the parent text box).
*/
- virtual bool Layout(wxDC& dc, const wxRect& rect, int style) = 0;
+ virtual bool Layout(wxDC& dc, wxRichTextDrawingContext& context, const wxRect& rect, const wxRect& parentRect, int style) = 0;
/**
Hit-testing: returns a flag indicating hit test details, plus
- information about position. contextObj is returned to specify what object
+ information about position. @a contextObj is returned to specify what object
position is relevant to, since otherwise there's an ambiguity.
- obj may not a child of contextObj, since we may be referring to the container itself
+ @ 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).
+
+ Pass wxRICHTEXT_HITTEST_NO_NESTED_OBJECTS if you only want to consider objects
+ directly under the object you are calling HitTest on. Otherwise, it will recurse
+ and potentially find a nested object.
+
+ @return One of the ::wxRichTextHitTestFlags values.
*/
- virtual int HitTest(wxDC& dc, const wxPoint& pt, long& textPosition, wxRichTextObject** obj, wxRichTextObject** contextObj, int flags = 0);
+
+ virtual int HitTest(wxDC& dc, wxRichTextDrawingContext& context, 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; }
+ virtual bool FindPosition(wxDC& WXUNUSED(dc), wxRichTextDrawingContext& WXUNUSED(context), 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
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;
+ 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;
/**
Do a split from @a pos, returning an object containing the second part, and setting
wxRichTextRange GetOwnRangeIfTopLevel() const { return IsTopLevel() ? m_ownRange : m_range; }
/**
- Returns @true if this object this composite.
+ Returns @true if this object is composite.
*/
virtual bool IsComposite() const { return false; }
+ /**
+ Returns @true if no user editing can be done inside the object. This returns @true for simple objects,
+ @false for most composite objects, but @true for fields, which if composite, should not be user-edited.
+ */
+ virtual bool IsAtomic() const { return true; }
+
/**
Returns a pointer to the parent object.
*/
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;
+ virtual wxRect GetAvailableContentArea(wxDC& dc, wxRichTextDrawingContext& context, 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
+ lays out the object again using the minimum size. @a availableParentSpace is the maximum space
+ for the object, whereas @a availableContainerSpace is the container with which relative positions and
+ sizes should be computed. For example, a text box whose space has already been constrained
+ in a previous layout pass to @a availableParentSpace, but should have a width of 50% of @a availableContainerSpace.
+ (If these two rects were the same, a 2nd pass could see the object getting too small.)
*/
- virtual bool LayoutToBestSize(wxDC& dc, wxRichTextBuffer* buffer,
- const wxRichTextAttr& parentAttr, const wxRichTextAttr& attr, const wxRect& availableParentSpace, int style);
+ virtual bool LayoutToBestSize(wxDC& dc, wxRichTextDrawingContext& context, wxRichTextBuffer* buffer,
+ const wxRichTextAttr& parentAttr, const wxRichTextAttr& attr,
+ const wxRect& availableParentSpace, const wxRect& availableContainerSpace, int style);
/**
Sets the object's attributes.
wxRichTextAttr& GetAttributes() { return m_attributes; }
/**
- Sets the object's properties.
+ Returns the object's properties.
*/
wxRichTextProperties& GetProperties() { return m_properties; }
const wxRichTextProperties& GetProperties() const { return m_properties; }
/**
- Returns the object's properties.
+ Sets the object's properties.
*/
void SetProperties(const wxRichTextProperties& props) { m_properties = props; }
/**
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.
+ availableContainerSpace might be a parent that the cell has to compute its width relative to.
+ E.g. a cell that's 50% of its parent.
*/
- static wxRect AdjustAvailableSpace(wxDC& dc, wxRichTextBuffer* buffer, const wxRichTextAttr& parentAttr, const wxRichTextAttr& childAttr, const wxRect& availableParentSpace);
+ static wxRect AdjustAvailableSpace(wxDC& dc, wxRichTextBuffer* buffer, const wxRichTextAttr& parentAttr, const wxRichTextAttr& childAttr,
+ const wxRect& availableParentSpace, const wxRect& availableContainerSpace);
protected:
wxSize m_size;
// Overridables
- virtual int HitTest(wxDC& dc, const wxPoint& pt, long& textPosition, wxRichTextObject** obj, wxRichTextObject** contextObj, int flags = 0);
+ virtual int HitTest(wxDC& dc, wxRichTextDrawingContext& context, 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 bool FindPosition(wxDC& dc, wxRichTextDrawingContext& context, long index, wxPoint& pt, int* height, bool forceLineStart);
virtual void CalculateRange(long start, long& end);
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 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 void Dump(wxTextOutputStream& stream);
*/
virtual bool IsComposite() const { return true; }
+ /**
+ Returns @true if no user editing can be done inside the object. This returns @true for simple objects,
+ @false for most composite objects, but @true for fields, which if composite, should not be user-edited.
+ */
+ virtual bool IsAtomic() const { return false; }
+
/**
Returns true if the buffer is empty.
*/
// Overridables
- virtual int HitTest(wxDC& dc, const wxPoint& pt, long& textPosition, wxRichTextObject** obj, wxRichTextObject** contextObj, int flags = 0);
+ virtual int HitTest(wxDC& dc, wxRichTextDrawingContext& context, 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 Draw(wxDC& dc, wxRichTextDrawingContext& context, 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 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, 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, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const;
virtual bool DeleteRange(const wxRichTextRange& range);
/**
Submits a command to insert paragraphs.
*/
- bool InsertParagraphsWithUndo(long pos, const wxRichTextParagraphLayoutBox& paragraphs, wxRichTextCtrl* ctrl, wxRichTextBuffer* buffer, int flags = 0);
+ bool InsertParagraphsWithUndo(wxRichTextBuffer* buffer, long pos, const wxRichTextParagraphLayoutBox& paragraphs, wxRichTextCtrl* ctrl, 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);
+ bool InsertTextWithUndo(wxRichTextBuffer* buffer, long pos, const wxString& text, wxRichTextCtrl* ctrl, int flags = 0);
/**
Submits a command to insert the given text.
*/
- bool InsertNewlineWithUndo(long pos, wxRichTextCtrl* ctrl, wxRichTextBuffer* buffer, int flags = 0);
+ bool InsertNewlineWithUndo(wxRichTextBuffer* buffer, long pos, wxRichTextCtrl* ctrl, int flags = 0);
/**
Submits a command to insert the given image.
*/
- bool InsertImageWithUndo(long pos, const wxRichTextImageBlock& imageBlock,
- wxRichTextCtrl* ctrl, wxRichTextBuffer* buffer, int flags,
+ bool InsertImageWithUndo(wxRichTextBuffer* buffer, long pos, const wxRichTextImageBlock& imageBlock,
+ wxRichTextCtrl* ctrl, int flags, const wxRichTextAttr& textAttr);
+
+ /**
+ Submits a command to insert the given field. Field data can be included in properties.
+
+ @see wxRichTextField, wxRichTextFieldType, wxRichTextFieldTypeStandard
+ */
+ wxRichTextField* InsertFieldWithUndo(wxRichTextBuffer* buffer, long pos, const wxString& fieldType,
+ const wxRichTextProperties& properties,
+ wxRichTextCtrl* ctrl, int flags,
const wxRichTextAttr& textAttr);
/**
/**
Inserts an object.
*/
- wxRichTextObject* InsertObjectWithUndo(long pos, wxRichTextObject *object, wxRichTextCtrl* ctrl, wxRichTextBuffer* buffer, int flags = 0);
+ wxRichTextObject* InsertObjectWithUndo(wxRichTextBuffer* buffer, long pos, wxRichTextObject *object, wxRichTextCtrl* ctrl, int flags = 0);
/**
Submits a command to delete this range.
/**
Draws the floating objects in this buffer.
*/
- void DrawFloats(wxDC& dc, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style);
+ void DrawFloats(wxDC& dc, wxRichTextDrawingContext& context, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style);
/**
Moves an anchored object to another paragraph.
virtual bool PositionToXY(long pos, long* x, long* y) const;
/**
- Sets text attributes: character and/or paragraph styles.
+ 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);
/**
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);
virtual bool DoGetStyle(long position, wxRichTextAttr& style, bool combineStyles = true);
/**
- Returns the combined style for a range - if any attribute is different within the range,
- that attribute is not present within the flags.
+ This function gets a style representing the common, combined attributes in the
+ given range.
+ Attributes which have different values within the specified range will not be
+ included the style flags.
+
+ The function is used to get the attributes to display in the formatting dialog:
+ the user can edit the attributes common to the selection, and optionally specify the
+ values of further attributes to be applied uniformly.
+
+ To apply the edited attributes, you can use SetStyle() specifying
+ the wxRICHTEXT_SETSTYLE_OPTIMIZE flag, which will only apply attributes that
+ are different from the @e combined attributes within the range.
+ So, the user edits the effective, displayed attributes for the range,
+ but his choice won't be applied unnecessarily to content. As an example,
+ say the style for a paragraph specifies bold, but the paragraph text doesn't
+ specify a weight.
+ The combined style is bold, and this is what the user will see on-screen and
+ in the formatting dialog. The user now specifies red text, in addition to bold.
+ When applying with SetStyle(), the content font weight attributes won't be
+ changed to bold because this is already specified by the paragraph.
+ However the text colour attributes @e will be changed to show red.
*/
virtual bool GetStyleForRange(const wxRichTextRange& range, wxRichTextAttr& style);
*/
bool CollectStyle(wxRichTextAttr& currentStyle, const wxRichTextAttr& style, wxRichTextAttr& clashingAttr, wxRichTextAttr& absentAttr);
+ //@{
/**
- Set the list style.
- */
- virtual bool SetListStyle(const wxRichTextRange& range, wxRichTextListStyleDefinition* def, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1);
+ 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.
- /**
- Set the list style.
+ @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 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);
+ //@}
/**
- Clear the list for the given range.
+ 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()
*/
virtual bool ClearListStyle(const wxRichTextRange& range, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
+ //@{
/**
- Number/renumber any list elements in the given range.
+ 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.
+
@a def can be NULL to indicate that the existing list style should be used.
- */
- virtual bool NumberList(const wxRichTextRange& range, wxRichTextListStyleDefinition* def = NULL, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1);
- /**
- Number/renumber any list elements in the given range.
- @a defName can be empty to indicate that the existing list style should be used.
+ @see SetListStyle(), PromoteList(), ClearListStyle()
*/
+ 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);
+ //@}
+ //@{
/**
- Promotes the list items within the given range. @a promoteBy can be a positive or negative number, e.g. 1 or -1.
- */
- virtual bool PromoteList(int promoteBy, const wxRichTextRange& range, wxRichTextListStyleDefinition* def = NULL, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int specifiedLevel = -1);
+ Promotes the list items within 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.
- /**
- Promotes the list items within the given range. @a promoteBy can be a positive or negative number, e.g. 1 or -1.
+ @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(), SetListStyle(), ClearListStyle()
*/
+ 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);
+ //@}
/**
Helper for NumberList and PromoteList, that does renumbering and promotion simultaneously
*/
virtual bool FindNextParagraphNumber(wxRichTextParagraph* previousParagraph, wxRichTextAttr& attr) const;
+ /**
+ Sets the properties for the given range, passing flags to determine how the
+ attributes are set. You can merge properties or replace them.
+
+ 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 properties for a character at
+ position 5, use the range (5,6).
+
+ @a flags may contain a bit list of the following values:
+ - wxRICHTEXT_SETPROPERTIES_NONE: no flag.
+ - wxRICHTEXT_SETPROPERTIES_WITH_UNDO: specifies that this operation should be
+ undoable.
+ - wxRICHTEXT_SETPROPERTIES_PARAGRAPHS_ONLY: specifies that the properties should only be
+ applied to paragraphs, and not the content.
+ - wxRICHTEXT_SETPROPERTIES_CHARACTERS_ONLY: specifies that the properties should only be
+ applied to characters, and not the paragraph.
+ - wxRICHTEXT_SETPROPERTIES_RESET: resets (clears) the existing properties before applying
+ the new properties.
+ - wxRICHTEXT_SETPROPERTIES_REMOVE: removes the specified properties.
+ */
+ virtual bool SetProperties(const wxRichTextRange& range, const wxRichTextProperties& properties, int flags = wxRICHTEXT_SETPROPERTIES_WITH_UNDO);
+
/**
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
virtual wxRichTextObject* Clone() const { return new wxRichTextParagraphLayoutBox(*this); }
+ /**
+ Prepares the content just before insertion (or after buffer reset).
+ Currently is only called if undo mode is on.
+ */
+ virtual void PrepareContent(wxRichTextParagraphLayoutBox& container);
+
/**
Insert fragment into this box at the given position. If partialParagraph is true,
it is assumed that the last (or only) paragraph is just a piece of data with no paragraph
virtual wxString GetText() const;
/**
- Sets the default style for new content. Setting it to a default attribute
- makes new content take on the 'basic' style.
+ Sets the default style, affecting the style currently being applied
+ (for example, setting the default style to bold will cause subsequently
+ inserted text to be bold).
+
+ This is not cumulative - setting the default style will replace the previous
+ default style.
+
+ Setting it to a default attribute object makes new content take on the 'basic' style.
*/
virtual bool SetDefaultStyle(const wxRichTextAttr& style);
/**
- Returns the default style.
+ Returns the current default style, affecting the style currently being applied
+ (for example, setting the default style to bold will cause subsequently
+ inserted text to be bold).
*/
virtual const wxRichTextAttr& GetDefaultStyle() const { return m_defaultAttributes; }
/**
- Sets the basic (overall) style.
+ 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 void SetBasicStyle(const wxRichTextAttr& style) { m_attributes = style; }
/**
Returns 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 const wxRichTextAttr& GetBasicStyle() const { return m_attributes; }
// Overridables
- virtual bool Draw(wxDC& dc, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style);
+ virtual bool Draw(wxDC& dc, wxRichTextDrawingContext& context, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style);
virtual wxString GetXMLNodeName() const { return wxT("textbox"); }
};
/**
- @class wxRichTextLine
-
- This object represents a line in a paragraph, and stores
- offsets from the start of the paragraph representing the
- start and end positions of the line.
+ @class wxRichTextField
+
+ This class implements the general concept of a field, an object that represents
+ additional functionality such as a footnote, a bookmark, a page number, a table
+ of contents, and so on. Extra information (such as a bookmark name) can be stored
+ in the object properties.
+
+ Drawing, layout, and property editing is delegated to classes derived
+ from wxRichTextFieldType, such as instances of wxRichTextFieldTypeStandard; this makes
+ the use of fields an efficient method of introducing extra functionality, since
+ most of the information required to draw a field (such as a bitmap) is kept centrally
+ in a single field type definition.
+
+ The FieldType property, accessed by SetFieldType/GetFieldType, is used to retrieve
+ the field type definition. So be careful not to overwrite this property.
+
+ wxRichTextField is derived from wxRichTextParagraphLayoutBox, which means that it
+ can contain its own read-only content, refreshed when the application calls the UpdateField
+ function. Whether a field is treated as a composite or a single graphic is determined
+ by the field type definition. If using wxRichTextFieldTypeStandard, passing the display
+ type wxRICHTEXT_FIELD_STYLE_COMPOSITE to the field type definition causes the field
+ to behave like a composite; the other display styles display a simple graphic.
+ When implementing a composite field, you will still need to derive from wxRichTextFieldTypeStandard
+ or wxRichTextFieldType, if only to implement UpdateField to refresh the field content
+ appropriately. wxRichTextFieldTypeStandard is only one possible implementation, but
+ covers common needs especially for simple, static fields using text or a bitmap.
+
+ Register field types on application initialisation with the static function
+ wxRichTextParagraphLayoutBox::AddFieldType. They will be deleted automatically
+ on application exit.
+
+ An application can write a field to a control with wxRichTextCtrl::WriteField,
+ taking a field type, the properties for the field, and optional attributes.
@library{wxrichtext}
@category{richtext}
- @see wxRichTextBuffer, wxRichTextCtrl
+ @see wxRichTextFieldTypeStandard, wxRichTextFieldType, wxRichTextParagraphLayoutBox, wxRichTextProperties, wxRichTextCtrl
*/
-class WXDLLIMPEXP_RICHTEXT wxRichTextLine
+class WXDLLIMPEXP_RICHTEXT wxRichTextField: public wxRichTextParagraphLayoutBox
{
+ DECLARE_DYNAMIC_CLASS(wxRichTextField)
public:
// Constructors
- wxRichTextLine(wxRichTextParagraph* parent);
- wxRichTextLine(const wxRichTextLine& obj) { Init( NULL); Copy(obj); }
- virtual ~wxRichTextLine() {}
-
-// Overridables
-
-// Accessors
-
/**
- Sets the range associated with this line.
+ Default constructor; optionally pass the parent object.
*/
- void SetRange(const wxRichTextRange& range) { m_range = range; }
+
+ wxRichTextField(const wxString& fieldType = wxEmptyString, wxRichTextObject* parent = NULL);
+
/**
- Sets the range associated with this line.
+ Copy constructor.
*/
- void SetRange(long from, long to) { m_range = wxRichTextRange(from, to); }
+
+ wxRichTextField(const wxRichTextField& obj): wxRichTextParagraphLayoutBox() { Copy(obj); }
+
+// Overridables
+
+ virtual bool Draw(wxDC& dc, wxRichTextDrawingContext& context, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, 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 wxString GetXMLNodeName() const { return wxT("field"); }
+
+ virtual bool CanEditProperties() const;
+
+ virtual bool EditProperties(wxWindow* parent, wxRichTextBuffer* buffer);
+
+ virtual wxString GetPropertiesMenuLabel() const;
+
+ virtual bool AcceptsFocus() const { return false; }
+
+ virtual void CalculateRange(long start, long& end);
/**
- Returns the parent paragraph.
+ If a field has children, we don't want the user to be able to edit it.
*/
- wxRichTextParagraph* GetParent() { return m_parent; }
+ virtual bool IsAtomic() const { return true; }
+
+ virtual bool IsEmpty() const { return false; }
+
+ virtual bool IsTopLevel() const;
+
+// Accessors
+
+ void SetFieldType(const wxString& fieldType) { GetProperties().SetProperty(wxT("FieldType"), fieldType); }
+ wxString GetFieldType() const { return GetProperties().GetPropertyString(wxT("FieldType")); }
+
+// Operations
/**
- Returns the range.
- */
- const wxRichTextRange& GetRange() const { return m_range; }
+ Update the field; delegated to the associated field type. This would typically expand the field to its value,
+ if this is a dynamically changing and/or composite field.
+ */
+ virtual bool UpdateField(wxRichTextBuffer* buffer);
+
+ virtual wxRichTextObject* Clone() const { return new wxRichTextField(*this); }
+
+ void Copy(const wxRichTextField& obj);
+
+protected:
+};
+
+/**
+ @class wxRichTextFieldType
+
+ The base class for custom field types. Each type definition handles one
+ field type. Override functions to provide drawing, layout, updating and
+ property editing functionality for a field.
+
+ Register field types on application initialisation with the static function
+ wxRichTextParagraphLayoutBox::AddFieldType. They will be deleted automatically
+ on application exit.
+
+ @library{wxrichtext}
+ @category{richtext}
+
+ @see wxRichTextFieldTypeStandard, wxRichTextField, wxRichTextCtrl
+*/
+
+class WXDLLIMPEXP_RICHTEXT wxRichTextFieldType: public wxObject
+{
+ DECLARE_CLASS(wxRichTextFieldType)
+public:
/**
- Returns the range.
+ Creates a field type definition.
*/
- wxRichTextRange& GetRange() { return m_range; }
+ wxRichTextFieldType(const wxString& name = wxEmptyString)
+ : m_name(name)
+ { }
/**
- Returns the absolute range.
+ Copy constructor.
*/
- wxRichTextRange GetAbsoluteRange() const;
+ wxRichTextFieldType(const wxRichTextFieldType& fieldType)
+ : wxObject(fieldType)
+ { Copy(fieldType); }
+
+ void Copy(const wxRichTextFieldType& fieldType) { m_name = fieldType.m_name; }
/**
- Returns the line size as calculated by Layout.
+ 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 wxSize GetSize() const { return m_size; }
+ virtual bool Draw(wxRichTextField* obj, wxDC& dc, wxRichTextDrawingContext& context, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style) = 0;
/**
- Sets the line size as calculated by Layout.
+ Lay the item out at the specified position with the given size constraint.
+ Layout must set the cached size. @rect is the available space for the object,
+ and @a parentRect is the container that is used to determine a relative size
+ or position (for example if a text box must be 50% of the parent text box).
*/
- virtual void SetSize(const wxSize& sz) { m_size = sz; }
+ virtual bool Layout(wxRichTextField* obj, wxDC& dc, wxRichTextDrawingContext& context, const wxRect& rect, const wxRect& parentRect, int style) = 0;
/**
- Returns the object position relative to the parent.
+ Returns the object size for the given range. Returns @false if the range
+ is invalid for this object.
*/
- virtual wxPoint GetPosition() const { return m_pos; }
+ 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;
/**
- Sets the object position relative to the parent.
+ Returns @true if we can edit the object's properties via a GUI.
*/
- virtual void SetPosition(const wxPoint& pos) { m_pos = pos; }
+ virtual bool CanEditProperties(wxRichTextField* WXUNUSED(obj)) const { return false; }
/**
- Returns the absolute object position.
+ Edits the object's properties via a GUI.
*/
- virtual wxPoint GetAbsolutePosition() const;
+ virtual bool EditProperties(wxRichTextField* WXUNUSED(obj), wxWindow* WXUNUSED(parent), wxRichTextBuffer* WXUNUSED(buffer)) { return false; }
/**
- Returns the rectangle enclosing the line.
+ Returns the label to be used for the properties context menu item.
*/
- virtual wxRect GetRect() const { return wxRect(GetAbsolutePosition(), GetSize()); }
+ virtual wxString GetPropertiesMenuLabel(wxRichTextField* WXUNUSED(obj)) const { return wxEmptyString; }
/**
- Sets the stored descent.
- */
- void SetDescent(int descent) { m_descent = descent; }
+ Update the field. This would typically expand the field to its value,
+ if this is a dynamically changing and/or composite field.
+ */
+ virtual bool UpdateField(wxRichTextBuffer* WXUNUSED(buffer), wxRichTextField* WXUNUSED(obj)) { return false; }
/**
- Returns the stored descent.
+ Returns @true if this object is top-level, i.e. contains its own paragraphs, such as a text box.
*/
- int GetDescent() const { return m_descent; }
-
-#if wxRICHTEXT_USE_OPTIMIZED_LINE_DRAWING
- wxArrayInt& GetObjectSizes() { return m_objectSizes; }
- const wxArrayInt& GetObjectSizes() const { return m_objectSizes; }
-#endif
-
-// Operations
+ virtual bool IsTopLevel(wxRichTextField* WXUNUSED(obj)) const { return true; }
/**
- Initialises the object.
+ Sets the field type name. There should be a unique name per field type object.
*/
- void Init(wxRichTextParagraph* parent);
+ void SetName(const wxString& name) { m_name = name; }
/**
- Copies from @a obj.
+ Returns the field type name. There should be a unique name per field type object.
*/
- void Copy(const wxRichTextLine& obj);
-
- virtual wxRichTextLine* Clone() const { return new wxRichTextLine(*this); }
+ wxString GetName() const { return m_name; }
protected:
- // The range of the line (start position to end position)
- // This is relative to the parent paragraph.
- wxRichTextRange m_range;
+ wxString m_name;
+};
+
+WX_DECLARE_STRING_HASH_MAP(wxRichTextFieldType*, wxRichTextFieldTypeHashMap);
+
+/**
+ @class wxRichTextFieldTypeStandard
+
+ A field type that can handle fields with text or bitmap labels, with a small range
+ of styles for implementing rectangular fields and fields that can be used for start
+ and end tags.
+
+ The border, text and background colours can be customised; the default is
+ white text on a black background.
+
+ The following display styles can be used.
+
+ @beginStyleTable
+ @style{wxRICHTEXT_FIELD_STYLE_COMPOSITE}
+ Creates a composite field; you will probably need to derive a new class to implement UpdateField.
+ @style{wxRICHTEXT_FIELD_STYLE_RECTANGLE}
+ Shows a rounded rectangle background.
+ @style{wxRICHTEXT_FIELD_STYLE_NO_BORDER}
+ Suppresses the background and border; mostly used with a bitmap label.
+ @style{wxRICHTEXT_FIELD_STYLE_START_TAG}
+ Shows a start tag background, with the pointy end facing right.
+ @style{wxRICHTEXT_FIELD_STYLE_END_TAG}
+ Shows an end tag background, with the pointy end facing left.
+ @endStyleTable
+
+ @library{wxrichtext}
+ @category{richtext}
+
+ @see wxRichTextFieldType, wxRichTextField, wxRichTextBuffer, wxRichTextCtrl
+*/
+
+class WXDLLIMPEXP_RICHTEXT wxRichTextFieldTypeStandard: public wxRichTextFieldType
+{
+ DECLARE_CLASS(wxRichTextFieldTypeStandard)
+public:
+
+ // Display style types
+ enum { wxRICHTEXT_FIELD_STYLE_COMPOSITE = 0x01,
+ wxRICHTEXT_FIELD_STYLE_RECTANGLE = 0x02,
+ wxRICHTEXT_FIELD_STYLE_NO_BORDER = 0x04,
+ wxRICHTEXT_FIELD_STYLE_START_TAG = 0x08,
+ wxRICHTEXT_FIELD_STYLE_END_TAG = 0x10
+ };
+
+ /**
+ Constructor, creating a field type definition with a text label.
+
+ @param parent
+ The name of the type definition. This must be unique, and is the type
+ name used when adding a field to a control.
+ @param label
+ The text label to be shown on the field.
+ @param displayStyle
+ The display style: one of wxRICHTEXT_FIELD_STYLE_RECTANGLE,
+ wxRICHTEXT_FIELD_STYLE_NO_BORDER, wxRICHTEXT_FIELD_STYLE_START_TAG,
+ wxRICHTEXT_FIELD_STYLE_END_TAG.
+
+ */
+ wxRichTextFieldTypeStandard(const wxString& name, const wxString& label, int displayStyle = wxRICHTEXT_FIELD_STYLE_RECTANGLE);
+
+ /**
+ Constructor, creating a field type definition with a bitmap label.
+
+ @param parent
+ The name of the type definition. This must be unique, and is the type
+ name used when adding a field to a control.
+ @param label
+ The bitmap label to be shown on the field.
+ @param displayStyle
+ The display style: one of wxRICHTEXT_FIELD_STYLE_RECTANGLE,
+ wxRICHTEXT_FIELD_STYLE_NO_BORDER, wxRICHTEXT_FIELD_STYLE_START_TAG,
+ wxRICHTEXT_FIELD_STYLE_END_TAG.
+
+ */
+ wxRichTextFieldTypeStandard(const wxString& name, const wxBitmap& bitmap, int displayStyle = wxRICHTEXT_FIELD_STYLE_NO_BORDER);
+
+ /**
+ The default constructor.
+
+ */
+ wxRichTextFieldTypeStandard() { Init(); }
+
+ /**
+ The copy constructor.
+
+ */
+ wxRichTextFieldTypeStandard(const wxRichTextFieldTypeStandard& field)
+ : wxRichTextFieldType(field)
+ { Copy(field); }
+
+ /**
+ Initialises the object.
+ */
+ void Init();
+
+ /**
+ Copies the object.
+ */
+ void Copy(const wxRichTextFieldTypeStandard& field);
+
+ /**
+ The assignment operator.
+ */
+ void operator=(const wxRichTextFieldTypeStandard& field) { Copy(field); }
+
+ /**
+ 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(wxRichTextField* obj, wxDC& dc, wxRichTextDrawingContext& context, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style);
+
+ /**
+ Lay the item out at the specified position with the given size constraint.
+ Layout must set the cached size. @rect is the available space for the object,
+ and @a parentRect is the container that is used to determine a relative size
+ or position (for example if a text box must be 50% of the parent text box).
+ */
+ virtual bool Layout(wxRichTextField* obj, wxDC& dc, wxRichTextDrawingContext& context, const wxRect& rect, const wxRect& parentRect, int style);
+
+ /**
+ 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;
+
+ /**
+ Get the size of the field, given the label, font size, and so on.
+ */
+ wxSize GetSize(wxRichTextField* obj, wxDC& dc, wxRichTextDrawingContext& context, int style) const;
+
+ /**
+ Returns @true if the display type is wxRICHTEXT_FIELD_STYLE_COMPOSITE, @false otherwise.
+ */
+ virtual bool IsTopLevel(wxRichTextField* WXUNUSED(obj)) const { return (GetDisplayStyle() & wxRICHTEXT_FIELD_STYLE_COMPOSITE) != 0; }
+
+ /**
+ Sets the text label for fields of this type.
+ */
+ void SetLabel(const wxString& label) { m_label = label; }
+
+ /**
+ Returns the text label for fields of this type.
+ */
+ const wxString& GetLabel() const { return m_label; }
+
+ /**
+ Sets the bitmap label for fields of this type.
+ */
+ void SetBitmap(const wxBitmap& bitmap) { m_bitmap = bitmap; }
+
+ /**
+ Gets the bitmap label for fields of this type.
+ */
+ const wxBitmap& GetBitmap() const { return m_bitmap; }
+
+ /**
+ Gets the display style for fields of this type.
+ */
+ int GetDisplayStyle() const { return m_displayStyle; }
+
+ /**
+ Sets the display style for fields of this type.
+ */
+ void SetDisplayStyle(int displayStyle) { m_displayStyle = displayStyle; }
+
+ /**
+ Gets the font used for drawing the text label.
+ */
+ const wxFont& GetFont() const { return m_font; }
+
+ /**
+ Sets the font used for drawing the text label.
+ */
+ void SetFont(const wxFont& font) { m_font = font; }
+
+ /**
+ Gets the colour used for drawing the text label.
+ */
+ const wxColour& GetTextColour() const { return m_textColour; }
+
+ /**
+ Sets the colour used for drawing the text label.
+ */
+ void SetTextColour(const wxColour& colour) { m_textColour = colour; }
+
+ /**
+ Gets the colour used for drawing the field border.
+ */
+ const wxColour& GetBorderColour() const { return m_borderColour; }
+
+ /**
+ Sets the colour used for drawing the field border.
+ */
+ void SetBorderColour(const wxColour& colour) { m_borderColour = colour; }
+
+ /**
+ Gets the colour used for drawing the field background.
+ */
+ const wxColour& GetBackgroundColour() const { return m_backgroundColour; }
+
+ /**
+ Sets the colour used for drawing the field background.
+ */
+ void SetBackgroundColour(const wxColour& colour) { m_backgroundColour = colour; }
+
+ /**
+ Sets the vertical padding (the distance between the border and the text).
+ */
+ void SetVerticalPadding(int padding) { m_verticalPadding = padding; }
+
+ /**
+ Gets the vertical padding (the distance between the border and the text).
+ */
+ int GetVerticalPadding() const { return m_verticalPadding; }
+
+ /**
+ Sets the horizontal padding (the distance between the border and the text).
+ */
+ void SetHorizontalPadding(int padding) { m_horizontalPadding = padding; }
+
+ /**
+ Sets the horizontal padding (the distance between the border and the text).
+ */
+ int GetHorizontalPadding() const { return m_horizontalPadding; }
+
+ /**
+ Sets the horizontal margin surrounding the field object.
+ */
+ void SetHorizontalMargin(int margin) { m_horizontalMargin = margin; }
+
+ /**
+ Gets the horizontal margin surrounding the field object.
+ */
+ int GetHorizontalMargin() const { return m_horizontalMargin; }
+
+ /**
+ Sets the vertical margin surrounding the field object.
+ */
+ void SetVerticalMargin(int margin) { m_verticalMargin = margin; }
+
+ /**
+ Gets the vertical margin surrounding the field object.
+ */
+ int GetVerticalMargin() const { return m_verticalMargin; }
+
+protected:
+
+ wxString m_label;
+ int m_displayStyle;
+ wxFont m_font;
+ wxColour m_textColour;
+ wxColour m_borderColour;
+ wxColour m_backgroundColour;
+ int m_verticalPadding;
+ int m_horizontalPadding;
+ int m_horizontalMargin;
+ int m_verticalMargin;
+ wxBitmap m_bitmap;
+};
+
+/**
+ @class wxRichTextLine
+
+ This object represents a line in a paragraph, and stores
+ offsets from the start of the paragraph representing the
+ start and end positions of the line.
+
+ @library{wxrichtext}
+ @category{richtext}
+
+ @see wxRichTextBuffer, wxRichTextCtrl
+*/
+
+class WXDLLIMPEXP_RICHTEXT wxRichTextLine
+{
+public:
+// Constructors
+
+ wxRichTextLine(wxRichTextParagraph* parent);
+ wxRichTextLine(const wxRichTextLine& obj) { Init( NULL); Copy(obj); }
+ virtual ~wxRichTextLine() {}
+
+// Overridables
+
+// Accessors
+
+ /**
+ Sets the range associated with this line.
+ */
+ void SetRange(const wxRichTextRange& range) { m_range = range; }
+ /**
+ Sets the range associated with this line.
+ */
+ void SetRange(long from, long to) { m_range = wxRichTextRange(from, to); }
+
+ /**
+ Returns the parent paragraph.
+ */
+ wxRichTextParagraph* GetParent() { return m_parent; }
+
+ /**
+ Returns the range.
+ */
+ const wxRichTextRange& GetRange() const { return m_range; }
+ /**
+ Returns the range.
+ */
+ wxRichTextRange& GetRange() { return m_range; }
+
+ /**
+ Returns the absolute range.
+ */
+ wxRichTextRange GetAbsoluteRange() const;
+
+ /**
+ Returns the line size as calculated by Layout.
+ */
+ virtual wxSize GetSize() const { return m_size; }
+
+ /**
+ Sets the line size as calculated by Layout.
+ */
+ virtual void SetSize(const wxSize& sz) { m_size = sz; }
+
+ /**
+ Returns the object position relative to the parent.
+ */
+ virtual wxPoint GetPosition() const { return m_pos; }
+
+ /**
+ Sets the object position relative to the parent.
+ */
+ virtual void SetPosition(const wxPoint& pos) { m_pos = pos; }
+
+ /**
+ Returns the absolute object position.
+ */
+ virtual wxPoint GetAbsolutePosition() const;
+
+ /**
+ Returns the rectangle enclosing the line.
+ */
+ virtual wxRect GetRect() const { return wxRect(GetAbsolutePosition(), GetSize()); }
+
+ /**
+ Sets the stored descent.
+ */
+ void SetDescent(int descent) { m_descent = descent; }
+
+ /**
+ Returns the stored descent.
+ */
+ int GetDescent() const { return m_descent; }
+
+#if wxRICHTEXT_USE_OPTIMIZED_LINE_DRAWING
+ wxArrayInt& GetObjectSizes() { return m_objectSizes; }
+ const wxArrayInt& GetObjectSizes() const { return m_objectSizes; }
+#endif
+
+// Operations
+
+ /**
+ Initialises the object.
+ */
+ void Init(wxRichTextParagraph* parent);
+
+ /**
+ Copies from @a obj.
+ */
+ void Copy(const wxRichTextLine& obj);
+
+ virtual wxRichTextLine* Clone() const { return new wxRichTextLine(*this); }
+
+protected:
+
+ // The range of the line (start position to end position)
+ // This is relative to the parent paragraph.
+ wxRichTextRange m_range;
// Size and position measured relative to top of paragraph
wxPoint m_pos;
// Overridables
- virtual bool Draw(wxDC& dc, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style);
+ virtual bool Draw(wxDC& dc, wxRichTextDrawingContext& context, 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 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, 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, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const;
- virtual bool FindPosition(wxDC& dc, long index, wxPoint& pt, int* height, bool forceLineStart);
+ virtual bool FindPosition(wxDC& dc, wxRichTextDrawingContext& context, long index, wxPoint& pt, int* height, bool forceLineStart);
- virtual int HitTest(wxDC& dc, const wxPoint& pt, long& textPosition, wxRichTextObject** obj, wxRichTextObject** contextObj, int flags = 0);
+ virtual int HitTest(wxDC& dc, wxRichTextDrawingContext& context, const wxPoint& pt, long& textPosition, wxRichTextObject** obj, wxRichTextObject** contextObj, int flags = 0);
virtual void CalculateRange(long start, long& end);
Finds a suitable wrap position. @a wrapPosition is the last position in the line to the left
of the split.
*/
- bool FindWrapPosition(const wxRichTextRange& range, wxDC& dc, int availableSpace, long& wrapPosition, wxArrayInt* partialExtents);
+ bool FindWrapPosition(const wxRichTextRange& range, wxDC& dc, wxRichTextDrawingContext& context, int availableSpace, long& wrapPosition, wxArrayInt* partialExtents);
/**
Finds the object at the given position.
/**
Lays out the floating objects.
*/
- void LayoutFloat(wxDC& dc, const wxRect& rect, int style, wxRichTextFloatCollector* floatCollector);
+ void LayoutFloat(wxDC& dc, wxRichTextDrawingContext& context, const wxRect& rect, const wxRect& parentRect, int style, wxRichTextFloatCollector* floatCollector);
protected:
public:
// Constructors
+ /**
+ Constructor.
+ */
wxRichTextPlainText(const wxString& text = wxEmptyString, wxRichTextObject* parent = NULL, wxRichTextAttr* style = NULL);
- wxRichTextPlainText(const wxRichTextPlainText& obj): wxRichTextObject() { Copy(obj); }
-// Overridables
+ /**
+ Copy constructor.
+ */
+ wxRichTextPlainText(const wxRichTextPlainText& obj): wxRichTextObject() { Copy(obj); }
- virtual bool Draw(wxDC& dc, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style);
+// Overridables
+
+ virtual bool Draw(wxDC& dc, wxRichTextDrawingContext& context, 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 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, 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, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const;
virtual wxString GetTextForRange(const wxRichTextRange& range) const;
virtual void Dump(wxTextOutputStream& stream);
- /// Get the first position from pos that has a line break character.
+ /**
+ Get the first position from pos that has a line break character.
+ */
long GetFirstLineBreakPosition(long pos);
/// Does this object take note of paragraph attributes? Text and image objects don't.
// Accessors
- /// Get the text
+ /**
+ Returns the text.
+ */
const wxString& GetText() const { return m_text; }
- /// Set the text
+ /**
+ Sets the text.
+ */
void SetText(const wxString& text) { m_text = text; }
// Operations
- /// Copy
+ // Copies the text object,
void Copy(const wxRichTextPlainText& obj);
- /// Clone
+ // Clones the text object.
virtual wxRichTextObject* Clone() const { return new wxRichTextPlainText(*this); }
+
private:
bool DrawTabbedString(wxDC& dc, const wxRichTextAttr& attr, const wxRect& rect, wxString& str, wxCoord& x, wxCoord& y, bool selected);
class WXDLLIMPEXP_RICHTEXT wxRichTextImageBlock: public wxObject
{
public:
+ /**
+ Constructor.
+ */
wxRichTextImageBlock();
+
+ /**
+ Copy constructor.
+ */
wxRichTextImageBlock(const wxRichTextImageBlock& block);
virtual ~wxRichTextImageBlock();
+ /**
+ Initialises the block.
+ */
void Init();
+
+ /**
+ Clears the block.
+ */
+
void Clear();
- // Load the original image into a memory block.
- // If the image is not a JPEG, we must convert it into a JPEG
- // to conserve space.
- // If it's not a JPEG we can make use of 'image', already scaled, so we don't have to
- // load the image a 2nd time.
+ /**
+ Load the original image into a memory block.
+ If the image is not a JPEG, we must convert it into a JPEG
+ to conserve space.
+ If it's not a JPEG we can make use of @a image, already scaled, so we don't have to
+ load the image a second time.
+ */
virtual bool MakeImageBlock(const wxString& filename, wxBitmapType imageType,
wxImage& image, bool convertToJPEG = true);
- // Make an image block from the wxImage in the given
- // format.
+ /**
+ Make an image block from the wxImage in the given
+ format.
+ */
virtual bool MakeImageBlock(wxImage& image, wxBitmapType imageType, int quality = 80);
- // Uses a const wxImage for efficiency, but can't set quality (only relevant for JPEG)
+ /**
+ Uses a const wxImage for efficiency, but can't set quality (only relevant for JPEG)
+ */
virtual bool MakeImageBlockDefaultQuality(const wxImage& image, wxBitmapType imageType);
- // Makes the image block
+ /**
+ Makes the image block.
+ */
virtual bool DoMakeImageBlock(const wxImage& image, wxBitmapType imageType);
- // Write to a file
+ /**
+ Writes the block to a file.
+ */
bool Write(const wxString& filename);
- // Write data in hex to a stream
+ /**
+ Writes the data in hex to a stream.
+ */
bool WriteHex(wxOutputStream& stream);
- // Read data in hex from a stream
+ /**
+ Reads the data in hex from a stream.
+ */
bool ReadHex(wxInputStream& stream, int length, wxBitmapType imageType);
- // Copy from 'block'
+ /**
+ Copy from @a block.
+ */
void Copy(const wxRichTextImageBlock& block);
// Load a wxImage from the block
+ /**
+ */
bool Load(wxImage& image);
-//// Operators
+// Operators
+
+ /**
+ Assignment operation.
+ */
void operator=(const wxRichTextImageBlock& block);
-//// Accessors
+// Accessors
+ /**
+ Returns the raw data.
+ */
unsigned char* GetData() const { return m_data; }
+
+ /**
+ Returns the data size in bytes.
+ */
size_t GetDataSize() const { return m_dataSize; }
+
+ /**
+ Returns the image type.
+ */
wxBitmapType GetImageType() const { return m_imageType; }
+ /**
+ */
void SetData(unsigned char* image) { m_data = image; }
+
+ /**
+ Sets the data size.
+ */
void SetDataSize(size_t size) { m_dataSize = size; }
+
+ /**
+ Sets the image type.
+ */
void SetImageType(wxBitmapType imageType) { m_imageType = imageType; }
- bool Ok() const { return IsOk(); }
+ /**
+ Returns @true if the data is non-NULL.
+ */
bool IsOk() const { return GetData() != NULL; }
+ bool Ok() const { return IsOk(); }
- // Gets the extension for the block's type
+ /**
+ Gets the extension for the block's type.
+ */
wxString GetExtension() const;
/// Implementation
- // Allocate and read from stream as a block of memory
+ /**
+ Allocates and reads from a stream as a block of memory.
+ */
static unsigned char* ReadBlock(wxInputStream& stream, size_t size);
+
+ /**
+ Allocates and reads from a file as a block of memory.
+ */
static unsigned char* ReadBlock(const wxString& filename, size_t size);
- // Write memory block to stream
+ /**
+ Writes a memory block to stream.
+ */
static bool WriteBlock(wxOutputStream& stream, unsigned char* block, size_t size);
- // Write memory block to file
+ /**
+ Writes a memory block to a file.
+ */
static bool WriteBlock(const wxString& filename, unsigned char* block, size_t size);
protected:
public:
// Constructors
- wxRichTextImage(wxRichTextObject* parent = NULL): wxRichTextObject(parent) { }
+ /**
+ Default constructor.
+ */
+ wxRichTextImage(wxRichTextObject* parent = NULL): wxRichTextObject(parent) { Init(); }
+
+ /**
+ Creates a wxRichTextImage from a wxImage.
+ */
wxRichTextImage(const wxImage& image, wxRichTextObject* parent = NULL, wxRichTextAttr* charStyle = NULL);
+
+ /**
+ Creates a wxRichTextImage from an image block.
+ */
wxRichTextImage(const wxRichTextImageBlock& imageBlock, wxRichTextObject* parent = NULL, wxRichTextAttr* charStyle = NULL);
+
+ /**
+ Copy constructor.
+ */
wxRichTextImage(const wxRichTextImage& obj): wxRichTextObject(obj) { Copy(obj); }
+ /**
+ Initialisation.
+ */
+ void Init();
+
// Overridables
- virtual bool Draw(wxDC& dc, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style);
+ virtual bool Draw(wxDC& dc, wxRichTextDrawingContext& context, 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 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, 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, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const;
- /// Get the 'natural' size for an object. For an image, it would be the
- /// image size.
+ /**
+ Returns the 'natural' size for this object - the image size.
+ */
virtual wxTextAttrSize GetNaturalSize() const;
- virtual bool IsEmpty() const { return false; /* !m_imageBlock.Ok(); */ }
+ virtual bool IsEmpty() const { return false; /* !m_imageBlock.IsOk(); */ }
virtual bool CanEditProperties() const { return true; }
// Accessors
- /// Get the image cache (scaled bitmap)
+ /**
+ Returns the image cache (a scaled bitmap).
+ */
const wxBitmap& GetImageCache() const { return m_imageCache; }
- /// Set the image cache
- void SetImageCache(const wxBitmap& bitmap) { m_imageCache = bitmap; }
+ /**
+ Sets the image cache.
+ */
+ void SetImageCache(const wxBitmap& bitmap) { m_imageCache = bitmap; m_originalImageSize = wxSize(bitmap.GetWidth(), bitmap.GetHeight()); }
- /// Reset the image cache
- void ResetImageCache() { m_imageCache = wxNullBitmap; }
+ /**
+ Resets the image cache.
+ */
+ void ResetImageCache() { m_imageCache = wxNullBitmap; m_originalImageSize = wxSize(-1, -1); }
- /// Get the image block containing the raw data
+ /**
+ Returns the image block containing the raw data.
+ */
wxRichTextImageBlock& GetImageBlock() { return m_imageBlock; }
// Operations
- /// Copy
+ /**
+ Copies the image object.
+ */
void Copy(const wxRichTextImage& obj);
- /// Clone
+ /**
+ Clones the image object.
+ */
virtual wxRichTextObject* Clone() const { return new wxRichTextImage(*this); }
- /// Create a cached image at the required size
+ /**
+ Creates a cached image at the required size.
+ */
virtual bool LoadImageCache(wxDC& dc, bool resetCache = false);
+ /**
+ Gets the original image size.
+ */
+ wxSize GetOriginalImageSize() const { return m_originalImageSize; }
+
+ /**
+ Sets the original image size.
+ */
+ void SetOriginalImageSize(const wxSize& sz) { m_originalImageSize = sz; }
+
protected:
wxRichTextImageBlock m_imageBlock;
wxBitmap m_imageCache;
+ wxSize m_originalImageSize;
};
class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextCommand;
public:
// Constructors
+ /**
+ Default constructor.
+ */
wxRichTextBuffer() { Init(); }
+
+ /**
+ Copy constructor.
+ */
wxRichTextBuffer(const wxRichTextBuffer& obj): wxRichTextParagraphLayoutBox() { Init(); Copy(obj); }
+
virtual ~wxRichTextBuffer() ;
// Accessors
- /// Gets the command processor
+ /**
+ Returns the command processor.
+ A text buffer always creates its own command processor when it is initialized.
+ */
wxCommandProcessor* GetCommandProcessor() const { return m_commandProcessor; }
- /// Set style sheet, if any.
+ /**
+ Sets style sheet, if any. This will allow the application to use named character and paragraph
+ styles found in the style sheet.
+
+ Neither the buffer nor the control owns the style sheet so must be deleted by the application.
+ */
void SetStyleSheet(wxRichTextStyleSheet* styleSheet) { m_styleSheet = styleSheet; }
+
+ /**
+ Returns the style sheet.
+ */
virtual wxRichTextStyleSheet* GetStyleSheet() const { return m_styleSheet; }
- /// Set style sheet and notify of the change
+ /**
+ Sets the style sheet and sends a notification of the change.
+ */
bool SetStyleSheetAndNotify(wxRichTextStyleSheet* sheet);
- /// Push style sheet to top of stack
+ /**
+ Pushes the style sheet to the top of the style sheet stack.
+ */
bool PushStyleSheet(wxRichTextStyleSheet* styleSheet);
- /// Pop style sheet from top of stack
+ /**
+ Pops the style sheet from the top of the style sheet stack.
+ */
wxRichTextStyleSheet* PopStyleSheet();
- /// Set/get table storing fonts
+ /**
+ Returns the table storing fonts, for quick access and font reuse.
+ */
wxRichTextFontTable& GetFontTable() { return m_fontTable; }
+
+ /**
+ Returns the table storing fonts, for quick access and font reuse.
+ */
const wxRichTextFontTable& GetFontTable() const { return m_fontTable; }
+
+ /**
+ Sets table storing fonts, for quick access and font reuse.
+ */
void SetFontTable(const wxRichTextFontTable& table) { m_fontTable = table; }
+ /**
+ Sets the scale factor for displaying fonts, for example for more comfortable
+ editing.
+ */
+ void SetFontScale(double fontScale);
+
+ /**
+ Returns the scale factor for displaying fonts, for example for more comfortable
+ editing.
+ */
+ double GetFontScale() const { return m_fontScale; }
+
+ /**
+ Sets the scale factor for displaying certain dimensions such as indentation and
+ inter-paragraph spacing. This can be useful when editing in a small control
+ where you still want legible text, but a minimum of wasted white space.
+ */
+ void SetDimensionScale(double dimScale);
+
+ /**
+ Returns the scale factor for displaying certain dimensions such as indentation
+ and inter-paragraph spacing.
+ */
+ double GetDimensionScale() const { return m_dimensionScale; }
+
// Operations
- /// Initialisation
+ /**
+ Initialisation.
+ */
void Init();
- /// Clears the buffer, adds an empty paragraph, and clears the command processor.
+ /**
+ Clears the buffer, adds an empty paragraph, and clears the command processor.
+ */
virtual void ResetAndClearCommands();
- /// Load a file
+ //@{
+ /**
+ Loads content from a stream or file.
+ Not all handlers will implement file loading.
+ */
virtual bool LoadFile(const wxString& filename, wxRichTextFileType type = wxRICHTEXT_TYPE_ANY);
-
- /// Save a file
- virtual bool SaveFile(const wxString& filename, wxRichTextFileType type = wxRICHTEXT_TYPE_ANY);
-
- /// Load from a stream
virtual bool LoadFile(wxInputStream& stream, wxRichTextFileType type = wxRICHTEXT_TYPE_ANY);
+ //@}
- /// Save to a stream
+ //@{
+ /**
+ Saves content to a stream or file.
+ Not all handlers will implement file saving.
+ */
+ virtual bool SaveFile(const wxString& filename, wxRichTextFileType type = wxRICHTEXT_TYPE_ANY);
virtual bool SaveFile(wxOutputStream& stream, wxRichTextFileType type = wxRICHTEXT_TYPE_ANY);
+ //@}
- /// Set the handler flags, controlling loading and saving
+ /**
+ Sets the handler flags, controlling loading and saving.
+ */
void SetHandlerFlags(int flags) { m_handlerFlags = flags; }
- /// Get the handler flags, controlling loading and saving
+ /**
+ Gets the handler flags, controlling loading and saving.
+ */
int GetHandlerFlags() const { return m_handlerFlags; }
- /// Convenience function to add a paragraph of text
+ /**
+ Convenience function to add a paragraph of text.
+ */
virtual wxRichTextRange AddParagraph(const wxString& text, wxRichTextAttr* paraStyle = NULL) { Modify(); return wxRichTextParagraphLayoutBox::AddParagraph(text, paraStyle); }
- /// Begin collapsing undo/redo commands. Note that this may not work properly
- /// if combining commands that delete or insert content, changing ranges for
- /// subsequent actions.
+ /**
+ Begin collapsing undo/redo commands. Note that this may not work properly
+ if combining commands that delete or insert content, changing ranges for
+ subsequent actions.
+
+ @a cmdName should be the name of the combined command that will appear
+ next to Undo and Redo in the edit menu.
+ */
virtual bool BeginBatchUndo(const wxString& cmdName);
- /// End collapsing undo/redo commands
+ /**
+ End collapsing undo/redo commands.
+ */
virtual bool EndBatchUndo();
- /// Collapsing commands?
+ /**
+ Returns @true if we are collapsing commands.
+ */
virtual bool BatchingUndo() const { return m_batchedCommandDepth > 0; }
- /// Submit immediately, or delay according to whether collapsing is on
+ /**
+ Submit the action immediately, or delay according to whether collapsing is on.
+ */
virtual bool SubmitAction(wxRichTextAction* action);
- /// Get collapsed command
+ /**
+ Returns the collapsed command.
+ */
virtual wxRichTextCommand* GetBatchedCommand() const { return m_batchedCommand; }
- /// Begin suppressing undo/redo commands. The way undo is suppressed may be implemented
- /// differently by each command. If not dealt with by a command implementation, then
- /// it will be implemented automatically by not storing the command in the undo history
- /// when the action is submitted to the command processor.
+ /**
+ Begin suppressing undo/redo commands. The way undo is suppressed may be implemented
+ differently by each command. If not dealt with by a command implementation, then
+ it will be implemented automatically by not storing the command in the undo history
+ when the action is submitted to the command processor.
+ */
virtual bool BeginSuppressUndo();
- /// End suppressing undo/redo commands.
+ /**
+ End suppressing undo/redo commands.
+ */
virtual bool EndSuppressUndo();
- /// Collapsing commands?
+ /**
+ Are we suppressing undo??
+ */
virtual bool SuppressingUndo() const { return m_suppressUndo > 0; }
- /// Copy the range to the clipboard
+ /**
+ Copy the range to the clipboard.
+ */
virtual bool CopyToClipboard(const wxRichTextRange& range);
- /// Paste the clipboard content to the buffer
+ /**
+ Paste the clipboard content to the buffer.
+ */
virtual bool PasteFromClipboard(long position);
- /// Can we paste from the clipboard?
+ /**
+ Returns @true if we can paste from the clipboard.
+ */
virtual bool CanPasteFromClipboard() const;
- /// Begin using a style
+ /**
+ Begin using a style.
+ */
virtual bool BeginStyle(const wxRichTextAttr& style);
- /// End the style
+ /**
+ End the style.
+ */
virtual bool EndStyle();
- /// End all styles
+ /**
+ End all styles.
+ */
virtual bool EndAllStyles();
- /// Clear the style stack
+ /**
+ Clears the style stack.
+ */
virtual void ClearStyleStack();
- /// Get the size of the style stack, for example to check correct nesting
+ /**
+ Returns the size of the style stack, for example to check correct nesting.
+ */
virtual size_t GetStyleStackSize() const { return m_attributeStack.GetCount(); }
- /// Begin using bold
+ /**
+ Begins using bold.
+ */
bool BeginBold();
- /// End using bold
+ /**
+ Ends using bold.
+ */
bool EndBold() { return EndStyle(); }
- /// Begin using italic
+ /**
+ Begins using italic.
+ */
bool BeginItalic();
- /// End using italic
+ /**
+ Ends using italic.
+ */
bool EndItalic() { return EndStyle(); }
- /// Begin using underline
+ /**
+ Begins using underline.
+ */
bool BeginUnderline();
- /// End using underline
+ /**
+ Ends using underline.
+ */
bool EndUnderline() { return EndStyle(); }
- /// Begin using point size
+ /**
+ Begins using point size.
+ */
bool BeginFontSize(int pointSize);
- /// End using point size
+ /**
+ Ends using point size.
+ */
bool EndFontSize() { return EndStyle(); }
- /// Begin using this font
+ /**
+ Begins using this font.
+ */
bool BeginFont(const wxFont& font);
- /// End using a font
+ /**
+ Ends using a font.
+ */
bool EndFont() { return EndStyle(); }
- /// Begin using this colour
+ /**
+ Begins using this colour.
+ */
bool BeginTextColour(const wxColour& colour);
- /// End using a colour
+ /**
+ Ends using a colour.
+ */
bool EndTextColour() { return EndStyle(); }
- /// Begin using alignment
+ /**
+ Begins using alignment.
+ */
bool BeginAlignment(wxTextAttrAlignment alignment);
- /// End alignment
+ /**
+ Ends alignment.
+ */
bool EndAlignment() { return EndStyle(); }
- /// Begin left indent
+ /**
+ Begins using @a leftIndent for the left indent, and optionally @a leftSubIndent for
+ the sub-indent. Both are expressed in tenths of a millimetre.
+
+ The sub-indent is an offset from the left 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 relative to the subsequent lines.
+ */
bool BeginLeftIndent(int leftIndent, int leftSubIndent = 0);
- /// End left indent
+ /**
+ Ends left indent.
+ */
bool EndLeftIndent() { return EndStyle(); }
- /// Begin right indent
+ /**
+ Begins a right indent, specified in tenths of a millimetre.
+ */
bool BeginRightIndent(int rightIndent);
- /// End right indent
+ /**
+ Ends right indent.
+ */
bool EndRightIndent() { return EndStyle(); }
- /// Begin paragraph spacing
+ /**
+ Begins paragraph spacing; pass the before-paragraph and after-paragraph spacing
+ in tenths of a millimetre.
+ */
bool BeginParagraphSpacing(int before, int after);
- /// End paragraph spacing
+ /**
+ Ends paragraph spacing.
+ */
bool EndParagraphSpacing() { return EndStyle(); }
- /// Begin line spacing
+ /**
+ Begins line spacing using the specified value. @e spacing is a multiple, where
+ 10 means single-spacing, 15 means 1.5 spacing, and 20 means double spacing.
+
+ The ::wxTextAttrLineSpacing enumeration values are defined for convenience.
+ */
bool BeginLineSpacing(int lineSpacing);
- /// End line spacing
+ /**
+ Ends line spacing.
+ */
bool EndLineSpacing() { return EndStyle(); }
- /// Begin numbered bullet
+ /**
+ Begins 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 following 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);
- /// End numbered bullet
+ /**
+ Ends numbered bullet.
+ */
bool EndNumberedBullet() { return EndStyle(); }
- /// Begin symbol bullet
+ /**
+ 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.
+ */
bool BeginSymbolBullet(const wxString& symbol, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_SYMBOL);
- /// End symbol bullet
+ /**
+ Ends symbol bullet.
+ */
bool EndSymbolBullet() { return EndStyle(); }
- /// Begin standard bullet
+ /**
+ Begins applying a standard bullet, using one of the standard bullet names
+ (currently @c standard/circle or @c standard/square.
+
+ See BeginNumberedBullet() for an explanation of how indentation is used to
+ render the bulleted paragraph.
+ */
bool BeginStandardBullet(const wxString& bulletName, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_STANDARD);
- /// End standard bullet
+ /**
+ Ends standard bullet.
+ */
bool EndStandardBullet() { return EndStyle(); }
- /// Begin named character style
+ /**
+ Begins named character style.
+ */
bool BeginCharacterStyle(const wxString& characterStyle);
- /// End named character style
+ /**
+ Ends named character style.
+ */
bool EndCharacterStyle() { return EndStyle(); }
- /// Begin named paragraph style
+ /**
+ Begins named paragraph style.
+ */
bool BeginParagraphStyle(const wxString& paragraphStyle);
- /// End named character style
+ /**
+ Ends named character style.
+ */
bool EndParagraphStyle() { return EndStyle(); }
- /// Begin named list style
+ /**
+ Begins named list style.
+
+ Optionally, you can also pass a level and a number.
+ */
bool BeginListStyle(const wxString& listStyle, int level = 1, int number = 1);
- /// End named character style
+ /**
+ Ends named character style.
+ */
bool EndListStyle() { return EndStyle(); }
- /// Begin URL
+ /**
+ 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.
+ */
bool BeginURL(const wxString& url, const wxString& characterStyle = wxEmptyString);
- /// End URL
+ /**
+ Ends URL.
+ */
bool EndURL() { return EndStyle(); }
// Event handling
- /// Add an event handler
+ /**
+ Adds an event handler.
+
+ A buffer associated with a control has the control as the only event handler,
+ but the application is free to add more if further notification is required.
+ All handlers are notified of an event originating from the buffer, such as
+ the replacement of a style sheet during loading.
+
+ The buffer never deletes any of the event handlers, unless RemoveEventHandler()
+ is called with @true as the second argument.
+ */
bool AddEventHandler(wxEvtHandler* handler);
- /// Remove an event handler
+ /**
+ Removes an event handler from the buffer's list of handlers, deleting the
+ object if @a deleteHandler is @true.
+ */
bool RemoveEventHandler(wxEvtHandler* handler, bool deleteHandler = false);
- /// Clear event handlers
+ /**
+ Clear event handlers.
+ */
void ClearEventHandlers();
- /// Send event to event handlers. If sendToAll is true, will send to all event handlers,
- /// otherwise will stop at the first successful one.
+ /**
+ Send event to event handlers. If sendToAll is true, will send to all event handlers,
+ otherwise will stop at the first successful one.
+ */
bool SendEvent(wxEvent& event, bool sendToAll = true);
// Implementation
- virtual int HitTest(wxDC& dc, const wxPoint& pt, long& textPosition, wxRichTextObject** obj, wxRichTextObject** contextObj, int flags = 0);
+ virtual int HitTest(wxDC& dc, wxRichTextDrawingContext& context, const wxPoint& pt, long& textPosition, wxRichTextObject** obj, wxRichTextObject** contextObj, int flags = 0);
- /// Copy
+ /**
+ Copies the buffer.
+ */
void Copy(const wxRichTextBuffer& obj);
- /// Assignment
+ /**
+ Assignment operator.
+ */
void operator= (const wxRichTextBuffer& obj) { Copy(obj); }
- /// Clone
+ /**
+ Clones the buffer.
+ */
virtual wxRichTextObject* Clone() const { return new wxRichTextBuffer(*this); }
- /// Submit command to insert paragraphs
+ /**
+ Submits a command to insert paragraphs.
+ */
bool InsertParagraphsWithUndo(long pos, const wxRichTextParagraphLayoutBox& paragraphs, wxRichTextCtrl* ctrl, int flags = 0);
- /// Submit command to insert the given text
+ /**
+ Submits a command to insert the given text.
+ */
bool InsertTextWithUndo(long pos, const wxString& text, wxRichTextCtrl* ctrl, int flags = 0);
- /// Submit command to insert a newline
+ /**
+ Submits a command to insert a newline.
+ */
bool InsertNewlineWithUndo(long pos, wxRichTextCtrl* ctrl, int flags = 0);
- /// Submit command to insert the given image
+ /**
+ Submits a command to insert the given image.
+ */
bool InsertImageWithUndo(long pos, const wxRichTextImageBlock& imageBlock, wxRichTextCtrl* ctrl, int flags = 0,
const wxRichTextAttr& textAttr = wxRichTextAttr());
- /// Submit command to insert an object
+ /**
+ Submits a command to insert an object.
+ */
wxRichTextObject* InsertObjectWithUndo(long pos, wxRichTextObject *object, wxRichTextCtrl* ctrl, int flags);
- /// Submit command to delete this range
+ /**
+ Submits a command to delete this range.
+ */
bool DeleteRangeWithUndo(const wxRichTextRange& range, wxRichTextCtrl* ctrl);
- /// Mark modified
+ /**
+ Mark modified.
+ */
void Modify(bool modify = true) { m_modified = modify; }
+
+ /**
+ Returns @true if the buffer was modified.
+ */
bool IsModified() const { return m_modified; }
- /// Dumps contents of buffer for debugging purposes
+ //@{
+ /**
+ Dumps contents of buffer for debugging purposes.
+ */
virtual void Dump();
virtual void Dump(wxTextOutputStream& stream) { wxRichTextParagraphLayoutBox::Dump(stream); }
+ //@}
- /// Returns the file handlers
+ /**
+ Returns the file handlers.
+ */
static wxList& GetHandlers() { return sm_handlers; }
- /// Adds a handler to the end
+ /**
+ Adds a file handler to the end.
+ */
static void AddHandler(wxRichTextFileHandler *handler);
- /// Inserts a handler at the front
+ /**
+ Inserts a file handler at the front.
+ */
static void InsertHandler(wxRichTextFileHandler *handler);
- /// Removes a handler
+ /**
+ Removes a file handler.
+ */
static bool RemoveHandler(const wxString& name);
- /// Finds a handler by name
+ /**
+ Finds a file handler by name.
+ */
static wxRichTextFileHandler *FindHandler(const wxString& name);
- /// Finds a handler by extension and type
+ /**
+ Finds a file handler by extension and type.
+ */
static wxRichTextFileHandler *FindHandler(const wxString& extension, wxRichTextFileType imageType);
- /// Finds a handler by filename or, if supplied, type
+ /**
+ Finds a handler by filename or, if supplied, type.
+ */
static wxRichTextFileHandler *FindHandlerFilenameOrType(const wxString& filename,
wxRichTextFileType imageType);
- /// Finds a handler by type
+ /**
+ Finds a handler by type.
+ */
static wxRichTextFileHandler *FindHandler(wxRichTextFileType imageType);
- /// Gets a wildcard incorporating all visible handlers. If 'types' is present,
- /// will be filled with the file type corresponding to each filter. This can be
- /// used to determine the type to pass to LoadFile given a selected filter.
+ /**
+ Gets a wildcard incorporating all visible handlers. If @a types is present,
+ it will be filled with the file type corresponding to each filter. This can be
+ used to determine the type to pass to LoadFile given a selected filter.
+ */
static wxString GetExtWildcard(bool combine = false, bool save = false, wxArrayInt* types = NULL);
- /// Clean up handlers
+ /**
+ Clean up file handlers.
+ */
static void CleanUpHandlers();
- /// Initialise the standard handlers
- static void InitStandardHandlers();
+ /**
+ Initialise the standard file handlers.
+ Currently, only the plain text loading/saving handler is initialised by default.
+ */
+ static void InitStandardHandlers();
+
+ /**
+ Returns the drawing handlers.
+ */
+ static wxList& GetDrawingHandlers() { return sm_drawingHandlers; }
+
+ /**
+ Adds a drawing handler to the end.
+ */
+ static void AddDrawingHandler(wxRichTextDrawingHandler *handler);
+
+ /**
+ Inserts a drawing handler at the front.
+ */
+ static void InsertDrawingHandler(wxRichTextDrawingHandler *handler);
+
+ /**
+ Removes a drawing handler.
+ */
+ static bool RemoveDrawingHandler(const wxString& name);
+
+ /**
+ Finds a drawing handler by name.
+ */
+ static wxRichTextDrawingHandler *FindDrawingHandler(const wxString& name);
+
+ /**
+ Clean up drawing handlers.
+ */
+ static void CleanUpDrawingHandlers();
+
+ /**
+ Returns the field types.
+ */
+ static wxRichTextFieldTypeHashMap& GetFieldTypes() { return sm_fieldTypes; }
+
+ /**
+ Adds a field type.
+
+ @see RemoveFieldType(), FindFieldType(), wxRichTextField, wxRichTextFieldType, wxRichTextFieldTypeStandard
+
+ */
+ static void AddFieldType(wxRichTextFieldType *fieldType);
+
+ /**
+ Removes a field type by name.
+
+ @see AddFieldType(), FindFieldType(), wxRichTextField, wxRichTextFieldType, wxRichTextFieldTypeStandard
+ */
+ static bool RemoveFieldType(const wxString& name);
+
+ /**
+ Finds a field type by name.
+
+ @see RemoveFieldType(), AddFieldType(), wxRichTextField, wxRichTextFieldType, wxRichTextFieldTypeStandard
+ */
+ static wxRichTextFieldType *FindFieldType(const wxString& name);
+
+ /**
+ Cleans up field types.
+ */
+ static void CleanUpFieldTypes();
- /// Get renderer
+ /**
+ Returns the renderer object.
+ */
static wxRichTextRenderer* GetRenderer() { return sm_renderer; }
- /// Set renderer, deleting old one
+ /**
+ Sets @a renderer as the object to be used to render certain aspects of the
+ content, such as bullets.
+
+ You can override default rendering by deriving a new class from
+ wxRichTextRenderer or wxRichTextStdRenderer, overriding one or more
+ virtual functions, and setting an instance of the class using this function.
+ */
static void SetRenderer(wxRichTextRenderer* renderer);
- /// Minimum margin between bullet and paragraph in 10ths of a mm
+ /**
+ Returns the minimum margin between bullet and paragraph in 10ths of a mm.
+ */
static int GetBulletRightMargin() { return sm_bulletRightMargin; }
+
+ /**
+ Sets the minimum margin between bullet and paragraph in 10ths of a mm.
+ */
static void SetBulletRightMargin(int margin) { sm_bulletRightMargin = margin; }
- /// Factor to multiply by character height to get a reasonable bullet size
+ /**
+ Returns the factor to multiply by character height to get a reasonable bullet size.
+ */
static float GetBulletProportion() { return sm_bulletProportion; }
+
+ /**
+ Sets the factor to multiply by character height to get a reasonable bullet size.
+ */
static void SetBulletProportion(float prop) { sm_bulletProportion = prop; }
- /// Scale factor for calculating dimensions
+ /**
+ Returns the scale factor for calculating dimensions.
+ */
double GetScale() const { return m_scale; }
+
+ /**
+ Sets the scale factor for calculating dimensions.
+ */
void SetScale(double scale) { m_scale = scale; }
protected:
/// File handlers
static wxList sm_handlers;
+ /// Drawing handlers
+ static wxList sm_drawingHandlers;
+
+ /// Field types
+ static wxRichTextFieldTypeHashMap sm_fieldTypes;
+
/// Renderer
static wxRichTextRenderer* sm_renderer;
/// Scaling factor in use: needed to calculate correct dimensions when printing
double m_scale;
+
+ /// Font scale for adjusting the text size when editing
+ double m_fontScale;
+
+ /// Dimension scale for reducing redundant whitespace when editing
+ double m_dimensionScale;
};
/**
// Overridables
- virtual bool Draw(wxDC& dc, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style);
+ virtual bool Draw(wxDC& dc, wxRichTextDrawingContext& context, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style);
virtual wxString GetXMLNodeName() const { return wxT("cell"); }
// Overridables
- virtual bool Draw(wxDC& dc, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style);
+ virtual bool Draw(wxDC& dc, wxRichTextDrawingContext& context, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style);
virtual wxString GetXMLNodeName() const { return wxT("table"); }
- virtual bool Layout(wxDC& dc, const wxRect& rect, 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, 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, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const;
virtual bool DeleteRange(const wxRichTextRange& range);
virtual bool ExportXML(wxXmlNode* parent, wxRichTextXMLHandler* handler);
#endif
- virtual bool FindPosition(wxDC& dc, long index, wxPoint& pt, int* height, bool forceLineStart);
+ virtual bool FindPosition(wxDC& dc, wxRichTextDrawingContext& context, long index, wxPoint& pt, int* height, bool forceLineStart);
virtual void CalculateRange(long start, long& end);
// Accessors
+ /**
+ Returns the cells array.
+ */
const wxRichTextObjectPtrArrayArray& GetCells() const { return m_cells; }
+
+ /**
+ Returns the cells array.
+ */
wxRichTextObjectPtrArrayArray& GetCells() { return m_cells; }
+ /**
+ Returns the row count.
+ */
int GetRowCount() const { return m_rowCount; }
+
+ /**
+ Returns the column count.
+ */
int GetColumnCount() const { return m_colCount; }
- /// Get the cell at the given row/column position
+ /**
+ Returns the cell at the given row/column position.
+ */
virtual wxRichTextCell* GetCell(int row, int col) const;
- /// Get the cell at the given character position (in the range of the table).
+ /**
+ Returns the cell at the given character position (in the range of the table).
+ */
virtual wxRichTextCell* GetCell(long pos) const;
- /// Get the row/column for a given character position
+ /**
+ Returns the row/column for a given character position.
+ */
virtual bool GetCellRowColumnPosition(long pos, int& row, int& col) const;
// Operations
};
-/*!
- * The command identifiers
- *
- */
+/**
+ The command identifiers for Do/Undo.
+*/
enum wxRichTextCommandId
{
wxRICHTEXT_DELETE,
wxRICHTEXT_CHANGE_ATTRIBUTES,
wxRICHTEXT_CHANGE_STYLE,
+ wxRICHTEXT_CHANGE_PROPERTIES,
wxRICHTEXT_CHANGE_OBJECT
};
class WXDLLIMPEXP_RICHTEXT wxRichTextObjectAddress
{
public:
- // Creates the address given container and object.
+ /**
+ Creates the address given a container and an object.
+ */
wxRichTextObjectAddress(wxRichTextParagraphLayoutBox* topLevelContainer, wxRichTextObject* obj) { Create(topLevelContainer, obj); }
+ /**
+ */
wxRichTextObjectAddress() { Init(); }
+ /**
+ */
wxRichTextObjectAddress(const wxRichTextObjectAddress& address) { Copy(address); }
void Init() {}
+
+ /**
+ Copies the address.
+ */
void Copy(const wxRichTextObjectAddress& address) { m_address = address.m_address; }
+
+ /**
+ Assignment operator.
+ */
void operator=(const wxRichTextObjectAddress& address) { Copy(address); }
+ /**
+ Returns the object specified by the address, given a top level container.
+ */
wxRichTextObject* GetObject(wxRichTextParagraphLayoutBox* topLevelContainer) const;
+
+ /**
+ Creates the address given a container and an object.
+ */
bool Create(wxRichTextParagraphLayoutBox* topLevelContainer, wxRichTextObject* obj);
+ /**
+ Returns the array of integers representing the object address.
+ */
wxArrayInt& GetAddress() { return m_address; }
+
+ /**
+ Returns the array of integers representing the object address.
+ */
const wxArrayInt& GetAddress() const { return m_address; }
+
+ /**
+ Sets the address from an array of integers.
+ */
void SetAddress(const wxArrayInt& address) { m_address = address; }
protected:
class WXDLLIMPEXP_RICHTEXT wxRichTextCommand: public wxCommand
{
public:
- // Ctor for one action
+ /**
+ Constructor for one action.
+ */
wxRichTextCommand(const wxString& name, wxRichTextCommandId id, wxRichTextBuffer* buffer,
wxRichTextParagraphLayoutBox* container, wxRichTextCtrl* ctrl, bool ignoreFirstTime = false);
- // Ctor for multiple actions
+ /**
+ Constructor for multiple actions.
+ */
wxRichTextCommand(const wxString& name);
virtual ~wxRichTextCommand();
+ /**
+ Performs the command.
+ */
bool Do();
+
+ /**
+ Undoes the command.
+ */
bool Undo();
+ /**
+ Adds an action to the action list.
+ */
void AddAction(wxRichTextAction* action);
+
+ /**
+ Clears the action list.
+ */
void ClearActions();
+ /**
+ Returns the action list.
+ */
wxList& GetActions() { return m_actions; }
protected:
class WXDLLIMPEXP_RICHTEXT wxRichTextAction: public wxObject
{
public:
- /// Constructor. 'buffer' is the top-level buffer, while 'container' is the object within
- /// which the action is taking place. In the simplest case, they are the same.
+ /**
+ Constructor. @a buffer is the top-level buffer, while @a container is the object within
+ which the action is taking place. In the simplest case, they are the same.
+ */
wxRichTextAction(wxRichTextCommand* cmd, const wxString& name, wxRichTextCommandId id,
wxRichTextBuffer* buffer, wxRichTextParagraphLayoutBox* container,
wxRichTextCtrl* ctrl, bool ignoreFirstTime = false);
virtual ~wxRichTextAction();
+ /**
+ Performs the action.
+ */
bool Do();
+
+ /**
+ Undoes the action.
+ */
bool Undo();
- /// Update the control appearance
+ /**
+ Updates the control appearance, optimizing if possible given information from the call to Layout.
+ */
void UpdateAppearance(long caretPosition, bool sendUpdateEvent = false,
wxArrayInt* optimizationLineCharPositions = NULL, wxArrayInt* optimizationLineYPositions = NULL, bool isDoCmd = true);
- /// Replace the buffer paragraphs with the given fragment.
+ /**
+ Replaces the buffer paragraphs with the given fragment.
+ */
void ApplyParagraphs(const wxRichTextParagraphLayoutBox& fragment);
- /// Get the fragments
+ /**
+ Returns the new fragments.
+ */
wxRichTextParagraphLayoutBox& GetNewParagraphs() { return m_newParagraphs; }
+
+ /**
+ Returns the old fragments.
+ */
wxRichTextParagraphLayoutBox& GetOldParagraphs() { return m_oldParagraphs; }
- /// Get the attributes
+ /**
+ Returns the attributes, for single-object commands.
+ */
wxRichTextAttr& GetAttributes() { return m_attributes; }
- /// An object to replace the one at the position
- /// defined by the container address and the action's range start position.
+ /**
+ Returns the object to replace the one at the position defined by the container address
+ and the action's range start position.
+ */
wxRichTextObject* GetObject() const { return m_object; }
+
+ /**
+ Sets the object to replace the one at the position defined by the container address
+ and the action's range start position.
+ */
void SetObject(wxRichTextObject* obj) { m_object = obj; m_objectAddress.Create(m_buffer, m_object); }
+
+ /**
+ Makes an address from the given object.
+ */
void MakeObject(wxRichTextObject* obj) { m_objectAddress.Create(m_buffer, obj); }
- /// Calculate arrays for refresh optimization
+ /**
+ Calculate arrays for refresh optimization.
+ */
void CalculateRefreshOptimizations(wxArrayInt& optimizationLineCharPositions, wxArrayInt& optimizationLineYPositions);
- /// Set/get the position used for e.g. insertion
+ /**
+ Sets the position used for e.g. insertion.
+ */
void SetPosition(long pos) { m_position = pos; }
+
+ /**
+ Returns the position used for e.g. insertion.
+ */
long GetPosition() const { return m_position; }
- /// Set/get the range for e.g. deletion
+ /**
+ Sets the range for e.g. deletion.
+ */
void SetRange(const wxRichTextRange& range) { m_range = range; }
+
+ /**
+ Returns the range for e.g. deletion.
+ */
const wxRichTextRange& GetRange() const { return m_range; }
- /// The address (nested position) of the container within the buffer being manipulated
+ /**
+ Returns the address (nested position) of the container within the buffer being manipulated.
+ */
wxRichTextObjectAddress& GetContainerAddress() { return m_containerAddress; }
+
+ /**
+ Returns the address (nested position) of the container within the buffer being manipulated.
+ */
const wxRichTextObjectAddress& GetContainerAddress() const { return m_containerAddress; }
+
+ /**
+ Sets the address (nested position) of the container within the buffer being manipulated.
+ */
void SetContainerAddress(const wxRichTextObjectAddress& address) { m_containerAddress = address; }
+
+ /**
+ Sets the address (nested position) of the container within the buffer being manipulated.
+ */
void SetContainerAddress(wxRichTextParagraphLayoutBox* container, wxRichTextObject* obj) { m_containerAddress.Create(container, obj); }
- /// Returns the container that this action refers to, using the container address and top-level buffer.
+ /**
+ Returns the container that this action refers to, using the container address and top-level buffer.
+ */
wxRichTextParagraphLayoutBox* GetContainer() const;
- /// Get name
+
+ /**
+ Returns the action name.
+ */
const wxString& GetName() const { return m_name; }
protected:
{
DECLARE_CLASS(wxRichTextFileHandler)
public:
+ /**
+ Creates a file handler object.
+ */
wxRichTextFileHandler(const wxString& name = wxEmptyString, const wxString& ext = wxEmptyString, int type = 0)
: m_name(name), m_extension(ext), m_type(type), m_flags(0), m_visible(true)
{ }
#if wxUSE_STREAMS
+ /**
+ Loads the buffer from a stream.
+ Not all handlers will implement file loading.
+ */
bool LoadFile(wxRichTextBuffer *buffer, wxInputStream& stream)
{ return DoLoadFile(buffer, stream); }
+
+ /**
+ Saves the buffer to a stream.
+ Not all handlers will implement file saving.
+ */
bool SaveFile(wxRichTextBuffer *buffer, wxOutputStream& stream)
{ return DoSaveFile(buffer, stream); }
#endif
#if wxUSE_FFILE && wxUSE_STREAMS
+ /**
+ Loads the buffer from a file.
+ */
virtual bool LoadFile(wxRichTextBuffer *buffer, const wxString& filename);
+
+ /**
+ Saves the buffer to a file.
+ */
virtual bool SaveFile(wxRichTextBuffer *buffer, const wxString& filename);
#endif // wxUSE_STREAMS && wxUSE_STREAMS
- /// Can we handle this filename (if using files)? By default, checks the extension.
+ /**
+ Returns @true if we handle this filename (if using files). By default, checks the extension.
+ */
virtual bool CanHandle(const wxString& filename) const;
- /// Can we save using this handler?
+ /**
+ Returns @true if we can save using this handler.
+ */
virtual bool CanSave() const { return false; }
- /// Can we load using this handler?
+ /**
+ Returns @true if we can load using this handler.
+ */
virtual bool CanLoad() const { return false; }
- /// Should this handler be visible to the user?
+ /**
+ Returns @true if this handler should be visible to the user.
+ */
virtual bool IsVisible() const { return m_visible; }
+
+ /**
+ Sets whether the handler should be visible to the user (via the application's
+ load and save dialogs).
+ */
virtual void SetVisible(bool visible) { m_visible = visible; }
- /// The name of the nandler
+ /**
+ Sets the name of the handler.
+ */
void SetName(const wxString& name) { m_name = name; }
+
+ /**
+ Returns the name of the handler.
+ */
wxString GetName() const { return m_name; }
- /// The default extension to recognise
+ /**
+ Sets the default extension to recognise.
+ */
void SetExtension(const wxString& ext) { m_extension = ext; }
+
+ /**
+ Returns the default extension to recognise.
+ */
wxString GetExtension() const { return m_extension; }
- /// The handler type
+ /**
+ Sets the handler type.
+ */
void SetType(int type) { m_type = type; }
+
+ /**
+ Returns the handler type.
+ */
int GetType() const { return m_type; }
- /// Flags controlling how loading and saving is done
+ /**
+ 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.
+
+ You call this function directly if you are using a file handler explicitly
+ (without going through the text control or buffer LoadFile/SaveFile API).
+ Or, you can call the control or buffer's SetHandlerFlags function to set
+ the flags that will be used for subsequent load and save operations.
+ */
void SetFlags(int flags) { m_flags = flags; }
+
+ /**
+ Returns flags controlling how loading and saving is done.
+ */
int GetFlags() const { return m_flags; }
- /// Encoding to use when saving a file. If empty, a suitable encoding is chosen
+ /**
+ Sets the encoding to use when saving a file. If empty, a suitable encoding is chosen.
+ */
void SetEncoding(const wxString& encoding) { m_encoding = encoding; }
+
+ /**
+ Returns the encoding to use when saving a file. If empty, a suitable encoding is chosen.
+ */
const wxString& GetEncoding() const { return m_encoding; }
protected:
#if wxUSE_STREAMS
+ /**
+ Override to load content from @a stream into @a buffer.
+ */
virtual bool DoLoadFile(wxRichTextBuffer *buffer, wxInputStream& stream) = 0;
+
+ /**
+ Override to save content to @a stream from @a buffer.
+ */
virtual bool DoSaveFile(wxRichTextBuffer *buffer, wxOutputStream& stream) = 0;
#endif
: wxRichTextFileHandler(name, ext, type)
{ }
- /// Can we save using this handler?
+ // Can we save using this handler?
virtual bool CanSave() const { return true; }
- /// Can we load using this handler?
+ // Can we load using this handler?
virtual bool CanLoad() const { return true; }
protected:
};
+/**
+ @class wxRichTextDrawingHandler
+
+ The base class for custom drawing handlers.
+ Currently, drawing handlers can provide virtual attributes.
+
+ @library{wxrichtext}
+ @category{richtext}
+
+ @see wxRichTextBuffer, wxRichTextCtrl
+*/
+
+class WXDLLIMPEXP_RICHTEXT wxRichTextDrawingHandler: public wxObject
+{
+ DECLARE_CLASS(wxRichTextDrawingHandler)
+public:
+ /**
+ Creates a drawing handler object.
+ */
+ wxRichTextDrawingHandler(const wxString& name = wxEmptyString)
+ : m_name(name)
+ { }
+
+ /**
+ Returns @true if this object has virtual attributes that we can provide.
+ */
+ virtual bool HasVirtualAttributes(wxRichTextObject* obj) const = 0;
+
+ /**
+ Provides virtual attributes that we can provide.
+ */
+ virtual bool GetVirtualAttributes(wxRichTextAttr& attr, wxRichTextObject* obj) const = 0;
+
+ /**
+ Sets the name of the handler.
+ */
+ void SetName(const wxString& name) { m_name = name; }
+
+ /**
+ Returns the name of the handler.
+ */
+ wxString GetName() const { return m_name; }
+
+protected:
+
+ wxString m_name;
+};
+
#if wxUSE_DATAOBJ
/**
class WXDLLIMPEXP_RICHTEXT wxRichTextBufferDataObject: public wxDataObjectSimple
{
public:
- // ctor doesn't copy the pointer, so it shouldn't go away while this object
- // is alive
+ /**
+ The constructor doesn't copy the pointer, so it shouldn't go away while this object
+ is alive.
+ */
wxRichTextBufferDataObject(wxRichTextBuffer* richTextBuffer = NULL);
virtual ~wxRichTextBufferDataObject();
- // after a call to this function, the buffer is owned by the caller and it
- // is responsible for deleting it
+ /**
+ After a call to this function, the buffer is owned by the caller and it
+ is responsible for deleting it.
+ */
wxRichTextBuffer* GetRichTextBuffer();
- // Returns the id for the new data format
+ /**
+ Returns the id for the new data format.
+ */
static const wxChar* GetRichTextBufferFormatId() { return ms_richTextBufferFormatId; }
// base class pure virtuals
class WXDLLIMPEXP_RICHTEXT wxRichTextRenderer: public wxObject
{
public:
+ /**
+ Constructor.
+ */
wxRichTextRenderer() {}
virtual ~wxRichTextRenderer() {}
- /// Draw a standard bullet, as specified by the value of GetBulletName
+ /**
+ Draws a standard bullet, as specified by the value of GetBulletName. This function should be overridden.
+ */
virtual bool DrawStandardBullet(wxRichTextParagraph* paragraph, wxDC& dc, const wxRichTextAttr& attr, const wxRect& rect) = 0;
- /// Draw a bullet that can be described by text, such as numbered or symbol bullets
+ /**
+ Draws a bullet that can be described by text, such as numbered or symbol bullets. This function should be overridden.
+ */
virtual bool DrawTextBullet(wxRichTextParagraph* paragraph, wxDC& dc, const wxRichTextAttr& attr, const wxRect& rect, const wxString& text) = 0;
- /// Draw a bitmap bullet, where the bullet bitmap is specified by the value of GetBulletName
+ /**
+ Draws a bitmap bullet, where the bullet bitmap is specified by the value of GetBulletName. This function should be overridden.
+ */
virtual bool DrawBitmapBullet(wxRichTextParagraph* paragraph, wxDC& dc, const wxRichTextAttr& attr, const wxRect& rect) = 0;
- /// Enumerate the standard bullet names currently supported
+ /**
+ Enumerate the standard bullet names currently supported. This function should be overridden.
+ */
virtual bool EnumerateStandardBulletNames(wxArrayString& bulletNames) = 0;
};
class WXDLLIMPEXP_RICHTEXT wxRichTextStdRenderer: public wxRichTextRenderer
{
public:
+ /**
+ Constructor.
+ */
wxRichTextStdRenderer() {}
- /// Draw a standard bullet, as specified by the value of GetBulletName
+ // Draw a standard bullet, as specified by the value of GetBulletName
virtual bool DrawStandardBullet(wxRichTextParagraph* paragraph, wxDC& dc, const wxRichTextAttr& attr, const wxRect& rect);
- /// Draw a bullet that can be described by text, such as numbered or symbol bullets
+ // Draw a bullet that can be described by text, such as numbered or symbol bullets
virtual bool DrawTextBullet(wxRichTextParagraph* paragraph, wxDC& dc, const wxRichTextAttr& attr, const wxRect& rect, const wxString& text);
- /// Draw a bitmap bullet, where the bullet bitmap is specified by the value of GetBulletName
+ // Draw a bitmap bullet, where the bullet bitmap is specified by the value of GetBulletName
virtual bool DrawBitmapBullet(wxRichTextParagraph* paragraph, wxDC& dc, const wxRichTextAttr& attr, const wxRect& rect);
- /// Enumerate the standard bullet names currently supported
+ // Enumerate the standard bullet names currently supported
virtual bool EnumerateStandardBulletNames(wxArrayString& bulletNames);
};
WXDLLIMPEXP_RICHTEXT bool wxTextAttrEq(const wxRichTextAttr& attr1, const wxRichTextAttr& attr2);
WXDLLIMPEXP_RICHTEXT bool wxTextAttrEq(const wxRichTextAttr& attr1, const wxRichTextAttr& attr2);
-/// Compare two attribute objects, but take into account the flags
-/// specifying attributes of interest.
-WXDLLIMPEXP_RICHTEXT bool wxTextAttrEqPartial(const wxRichTextAttr& attr1, const wxRichTextAttr& attr2);
-
/// Apply one style to another
WXDLLIMPEXP_RICHTEXT bool wxRichTextApplyStyle(wxRichTextAttr& destStyle, const wxRichTextAttr& style, wxRichTextAttr* compareWith = NULL);
projects / wxWidgets.git / blobdiff