X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/109bfc88a4a8583cc2fd5ca3fa6dbd74f5c7274c..2d55af1dfa7fd1cc2df13a6593fd51591cfcfcb1:/include/wx/richtext/richtextbuffer.h diff --git a/include/wx/richtext/richtextbuffer.h b/include/wx/richtext/richtextbuffer.h index e58631b143..c4bbb91781 100644 --- a/include/wx/richtext/richtextbuffer.h +++ b/include/wx/richtext/richtextbuffer.h @@ -71,9 +71,22 @@ #endif // Compatibility -#define wxRichTextAttr wxTextAttr #define wxTextAttrEx wxTextAttr +// Setting wxRICHTEXT_USE_OWN_CARET to 1 implements a +// caret reliably without using wxClientDC in case there +// are platform-specific problems with the generic caret. +#if defined(__WXGTK__) || defined(__WXMAC__) +#define wxRICHTEXT_USE_OWN_CARET 1 +#else +#define wxRICHTEXT_USE_OWN_CARET 0 +#endif + +// Switch off for binary compatibility, on for faster drawing +// Note: this seems to be buggy (overzealous use of extents) so +// don't use for now +#define wxRICHTEXT_USE_OPTIMIZED_LINE_DRAWING 0 + /*! * Special characters */ @@ -81,15 +94,17 @@ extern WXDLLIMPEXP_RICHTEXT const wxChar wxRichTextLineBreakChar; /*! - * File types + * File types in wxRichText context. */ - -#define wxRICHTEXT_TYPE_ANY 0 -#define wxRICHTEXT_TYPE_TEXT 1 -#define wxRICHTEXT_TYPE_XML 2 -#define wxRICHTEXT_TYPE_HTML 3 -#define wxRICHTEXT_TYPE_RTF 4 -#define wxRICHTEXT_TYPE_PDF 5 +enum wxRichTextFileType +{ + wxRICHTEXT_TYPE_ANY = 0, + wxRICHTEXT_TYPE_TEXT, + wxRICHTEXT_TYPE_XML, + wxRICHTEXT_TYPE_HTML, + wxRICHTEXT_TYPE_RTF, + wxRICHTEXT_TYPE_PDF +}; /*! * Forward declarations @@ -97,6 +112,7 @@ extern WXDLLIMPEXP_RICHTEXT const wxChar wxRichTextLineBreakChar; class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextCtrl; class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextObject; +class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextImage; class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextCacheObject; class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextObjectList; class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextLine; @@ -107,6 +123,8 @@ class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextListStyleDefinition; class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextEvent; class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextRenderer; class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextBuffer; +class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextAnchoredObject; +class wxRichTextFloatCollector; /*! * Flags determining the available space, passed to Layout @@ -133,17 +151,23 @@ class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextBuffer; /*! * Flags returned from hit-testing */ +enum wxRichTextHitTestFlags +{ + // The point was not on this object + wxRICHTEXT_HITTEST_NONE = 0x01, + + // The point was before the position returned from HitTest + wxRICHTEXT_HITTEST_BEFORE = 0x02, + + // The point was after the position returned from HitTest + wxRICHTEXT_HITTEST_AFTER = 0x04, -// The point was not on this object -#define wxRICHTEXT_HITTEST_NONE 0x01 -// The point was before the position returned from HitTest -#define wxRICHTEXT_HITTEST_BEFORE 0x02 -// The point was after the position returned from HitTest -#define wxRICHTEXT_HITTEST_AFTER 0x04 -// The point was on the position returned from HitTest -#define wxRICHTEXT_HITTEST_ON 0x08 -// The point was on space outside content -#define wxRICHTEXT_HITTEST_OUTSIDE 0x10 + // The point was on the position returned from HitTest + wxRICHTEXT_HITTEST_ON = 0x08, + + // The point was on space outside content + wxRICHTEXT_HITTEST_OUTSIDE = 0x10 +}; /*! * Flags for GetRangeSize @@ -152,6 +176,7 @@ class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextBuffer; #define wxRICHTEXT_FORMATTED 0x01 #define wxRICHTEXT_UNFORMATTED 0x02 #define wxRICHTEXT_CACHE_SIZE 0x04 +#define wxRICHTEXT_HEIGHT_ONLY 0x08 /*! * Flags for SetStyle/SetListStyle @@ -209,8 +234,472 @@ class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextBuffer; #define wxSCRIPT_MUL_FACTOR 1.5 -// Leave on for faster drawing, by storing the length of each object in a line -#define wxRICHTEXT_USE_OPTIMIZED_LINE_DRAWING 1 +typedef unsigned short wxTextAttrDimensionFlags; + +// Miscelaneous text box flags +enum wxTextBoxAttrFlags +{ + wxTEXT_BOX_ATTR_FLOAT = 0x00000001, + wxTEXT_BOX_ATTR_CLEAR = 0x00000002, + wxTEXT_BOX_ATTR_COLLAPSE_BORDERS = 0x00000004 +}; + +// Whether a value is present, used in dimension flags +enum wxTextAttrValueFlags +{ + wxTEXT_ATTR_VALUE_PRESENT = 0x1000, + wxTEXT_ATTR_VALUE_PRESENT_MASK = 0x1000 +}; + +// Units - included in the dimension value +enum wxTextAttrUnits +{ + wxTEXT_ATTR_UNITS_TENTHS_MM = 0x0001, + wxTEXT_ATTR_UNITS_PIXELS = 0x0002, + wxTEXT_ATTR_UNITS_PERCENTAGE = 0x0004, + wxTEXT_ATTR_UNITS_POINTS = 0x0008, + + wxTEXT_ATTR_UNITS_MASK = 0x000F +}; + +// Position - included in the dimension flags +enum wxTextBoxAttrPosition +{ + wxTEXT_BOX_ATTR_POSITION_STATIC = 0x0000, // Default is static, i.e. as per normal layout + wxTEXT_BOX_ATTR_POSITION_RELATIVE = 0x0010, + wxTEXT_BOX_ATTR_POSITION_ABSOLUTE = 0x0020, + + wxTEXT_BOX_ATTR_POSITION_MASK = 0x00F0 +}; + +// Dimension, including units and position +class WXDLLIMPEXP_RICHTEXT wxTextAttrDimension +{ +public: + wxTextAttrDimension() { Reset(); } + wxTextAttrDimension(int value, wxTextAttrDimensionFlags flags = wxTEXT_ATTR_VALUE_PRESENT|wxTEXT_ATTR_UNITS_TENTHS_MM) { m_value = value; m_flags = flags; } + + void Reset() { m_value = 0; m_flags = 0; } + + // Partial equality test + bool EqPartial(const wxTextAttrDimension& dim) const; + + // Apply + bool Apply(const wxTextAttrDimension& dim, const wxTextAttrDimension* compareWith = NULL); + + // Collects the attributes that are common to a range of content, building up a note of + // which attributes are absent in some objects and which clash in some objects. + void CollectCommonAttributes(const wxTextAttrDimension& attr, wxTextAttrDimension& clashingAttr, wxTextAttrDimension& absentAttr); + + bool operator==(const wxTextAttrDimension& dim) const { return m_value == dim.m_value && m_flags == dim.m_flags; } + + int GetValue() const { return m_value; } + float GetValueMM() const { return float(m_value) / 10.0; } + void SetValueMM(float value) { m_value = (int) ((value * 10.0) + 0.5); m_flags |= wxTEXT_ATTR_VALUE_PRESENT; } + void SetValue(int value) { m_value = value; m_flags |= wxTEXT_ATTR_VALUE_PRESENT; } + void SetValue(int value, wxTextAttrDimensionFlags flags) { m_value = value; m_flags = flags; } + + wxTextAttrUnits GetUnits() const { return (wxTextAttrUnits) (m_flags & wxTEXT_ATTR_UNITS_MASK); } + void SetUnits(wxTextAttrUnits units) { m_flags &= ~wxTEXT_ATTR_UNITS_MASK; m_flags |= units; } + + wxTextBoxAttrPosition GetPosition() const { return (wxTextBoxAttrPosition) (m_flags & wxTEXT_BOX_ATTR_POSITION_MASK); } + void SetPosition(wxTextBoxAttrPosition pos) { m_flags &= ~wxTEXT_BOX_ATTR_POSITION_MASK; m_flags |= pos; } + + bool IsPresent() const { return (m_flags & wxTEXT_ATTR_VALUE_PRESENT) != 0; } + void SetPresent(bool b) { m_flags &= ~wxTEXT_ATTR_VALUE_PRESENT_MASK; m_flags |= (b ? wxTEXT_ATTR_VALUE_PRESENT : 0); } + + int m_value; + wxTextAttrDimensionFlags m_flags; +}; + +class WXDLLIMPEXP_RICHTEXT wxTextBoxAttrDimensions +{ +public: + void Reset() { m_left.Reset(); m_top.Reset(); m_right.Reset(); m_bottom.Reset(); } + + bool operator==(const wxTextBoxAttrDimensions& 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 + bool EqPartial(const wxTextBoxAttrDimensions& dims) const; + + // Apply border to 'this', but not if the same as compareWith + bool Apply(const wxTextBoxAttrDimensions& dims, const wxTextBoxAttrDimensions* compareWith = NULL); + + // Collects the attributes that are common to a range of content, building up a note of + // which attributes are absent in some objects and which clash in some objects. + void CollectCommonAttributes(const wxTextBoxAttrDimensions& attr, wxTextBoxAttrDimensions& clashingAttr, wxTextBoxAttrDimensions& absentAttr); + + // Remove specified attributes from this object + bool RemoveStyle(const wxTextBoxAttrDimensions& attr); + + wxTextAttrDimension m_left; + wxTextAttrDimension m_top; + wxTextAttrDimension m_right; + wxTextAttrDimension m_bottom; +}; + +// Border styles +enum wxTextBoxAttrBorderStyle +{ + wxTEXT_BOX_ATTR_BORDER_NONE = 0, + wxTEXT_BOX_ATTR_BORDER_SOLID = 1, + wxTEXT_BOX_ATTR_BORDER_DOTTED = 2, + wxTEXT_BOX_ATTR_BORDER_DASHED = 3, + wxTEXT_BOX_ATTR_BORDER_DOUBLE = 4, + wxTEXT_BOX_ATTR_BORDER_GROOVE = 5, + wxTEXT_BOX_ATTR_BORDER_RIDGE = 6, + wxTEXT_BOX_ATTR_BORDER_INSET = 7, + wxTEXT_BOX_ATTR_BORDER_OUTSET = 8 +}; + +// Border style presence flags +enum wxTextBoxAttrBorderFlags +{ + wxTEXT_BOX_ATTR_BORDER_STYLE = 0x0001, + wxTEXT_BOX_ATTR_BORDER_COLOUR = 0x0002 +}; + +// Float styles +enum wxTextBoxAttrFloatStyle +{ + wxTEXT_BOX_ATTR_FLOAT_NONE = 0, + wxTEXT_BOX_ATTR_FLOAT_LEFT = 1, + wxTEXT_BOX_ATTR_FLOAT_RIGHT = 2 +}; + +// Clear styles +enum wxTextBoxAttrClearStyle +{ + wxTEXT_BOX_ATTR_CLEAR_NONE = 0, + wxTEXT_BOX_ATTR_CLEAR_LEFT = 1, + wxTEXT_BOX_ATTR_CLEAR_RIGHT = 2, + wxTEXT_BOX_ATTR_CLEAR_BOTH = 3 +}; + +// Collapse mode styles. TODO: can they be switched on per side? +enum wxTextBoxAttrCollapseMode +{ + wxTEXT_BOX_ATTR_COLLAPSE_NONE = 0, + wxTEXT_BOX_ATTR_COLLAPSE_FULL = 1 +}; + +// Border +class WXDLLIMPEXP_RICHTEXT wxTextBoxAttrBorder +{ +public: + wxTextBoxAttrBorder() { Reset(); } + + bool operator==(const wxTextBoxAttrBorder& border) const + { + return m_flags == border.m_flags && m_borderStyle == border.m_borderStyle && + m_borderColour == border.m_borderColour && m_borderWidth == border.m_borderWidth; + } + + void Reset() { m_borderStyle = 0; m_borderColour = 0; m_flags = 0; m_borderWidth.Reset(); } + + // Partial equality test + bool EqPartial(const wxTextBoxAttrBorder& border) const; + + // Apply border to 'this', but not if the same as compareWith + bool Apply(const wxTextBoxAttrBorder& border, const wxTextBoxAttrBorder* compareWith = NULL); + + // Remove specified attributes from this object + bool RemoveStyle(const wxTextBoxAttrBorder& attr); + + // Collects the attributes that are common to a range of content, building up a note of + // which attributes are absent in some objects and which clash in some objects. + void CollectCommonAttributes(const wxTextBoxAttrBorder& attr, wxTextBoxAttrBorder& clashingAttr, wxTextBoxAttrBorder& absentAttr); + + void SetStyle(int style) { m_borderStyle = style; m_flags |= wxTEXT_BOX_ATTR_BORDER_STYLE; } + int GetStyle() const { return m_borderStyle; } + + void SetColour(unsigned long colour) { m_borderColour = colour; m_flags |= wxTEXT_BOX_ATTR_BORDER_COLOUR; } + void SetColour(const wxColour& colour) { m_borderColour = colour.GetRGB(); m_flags |= wxTEXT_BOX_ATTR_BORDER_COLOUR; } + unsigned long GetColourLong() const { return m_borderColour; } + wxColour GetColour() const { return wxColour(m_borderColour); } + + wxTextAttrDimension& GetWidth() { return m_borderWidth; } + const wxTextAttrDimension& GetWidth() const { return m_borderWidth; } + void SetWidth(const wxTextAttrDimension& width) { m_borderWidth = width; } + + bool HasStyle() const { return (m_flags & wxTEXT_BOX_ATTR_BORDER_STYLE) == 0; } + bool HasColour() const { return (m_flags & wxTEXT_BOX_ATTR_BORDER_COLOUR) == 0; } + bool HasWidth() const { return m_borderWidth.IsPresent(); } + + int GetFlags() const { return m_flags; } + void SetFlags(int flags) { m_flags = flags; } + void AddFlag(int flag) { m_flags |= flag; } + void RemoveFlag(int flag) { m_flags &= ~flag; } + + int m_borderStyle; + unsigned long m_borderColour; + wxTextAttrDimension m_borderWidth; + int m_flags; +}; + +// Borders +class WXDLLIMPEXP_RICHTEXT wxTextBoxAttrBorders +{ +public: + wxTextBoxAttrBorders() { } + + bool operator==(const wxTextBoxAttrBorders& borders) const + { + return m_left == borders.m_left && m_right == borders.m_right && + m_top == borders.m_top && m_bottom == borders.m_bottom; + } + + // Set style of all borders + void SetStyle(int style); + + // Set colour of all borders + void SetColour(unsigned long colour); + void SetColour(const wxColour& colour); + + // Set width of all borders + void SetWidth(const wxTextAttrDimension& width); + + // Reset + void Reset() { m_left.Reset(); m_right.Reset(); m_top.Reset(); m_bottom.Reset(); } + + // Partial equality test + bool EqPartial(const wxTextBoxAttrBorders& borders) const; + + // Apply border to 'this', but not if the same as compareWith + bool Apply(const wxTextBoxAttrBorders& borders, const wxTextBoxAttrBorders* compareWith = NULL); + + // Remove specified attributes from this object + bool RemoveStyle(const wxTextBoxAttrBorders& attr); + + // Collects the attributes that are common to a range of content, building up a note of + // which attributes are absent in some objects and which clash in some objects. + void CollectCommonAttributes(const wxTextBoxAttrBorders& attr, wxTextBoxAttrBorders& clashingAttr, wxTextBoxAttrBorders& absentAttr); + + wxTextBoxAttrBorder m_left, m_right, m_top, m_bottom; + +}; + +// ---------------------------------------------------------------------------- +// wxTextBoxAttr: a structure containing box attributes +// ---------------------------------------------------------------------------- + +class WXDLLIMPEXP_RICHTEXT wxTextBoxAttr +{ +public: + // ctors + wxTextBoxAttr() { Init(); } + wxTextBoxAttr(const wxTextBoxAttr& attr) { Init(); (*this) = attr; } + + // Initialise this object. + void Init() { Reset(); } + + // Reset this object. + void Reset(); + + // Copy. Unecessary since we let it do a binary copy + //void Copy(const wxTextBoxAttr& attr); + + // Assignment + //void operator= (const wxTextBoxAttr& attr); + + // Equality test + bool operator== (const wxTextBoxAttr& attr) const; + + // Partial equality test + bool EqPartial(const wxTextBoxAttr& attr) const; + + // Merges the given attributes. If compareWith + // is non-NULL, then it will be used to mask out those attributes that are the same in style + // and compareWith, for situations where we don't want to explicitly set inherited attributes. + bool Apply(const wxTextBoxAttr& style, const wxTextBoxAttr* compareWith = NULL); + + // Collects the attributes that are common to a range of content, building up a note of + // which attributes are absent in some objects and which clash in some objects. + void CollectCommonAttributes(const wxTextBoxAttr& attr, wxTextBoxAttr& clashingAttr, wxTextBoxAttr& absentAttr); + + // Remove specified attributes from this object + bool RemoveStyle(const wxTextBoxAttr& attr); + + // Set flags + void SetFlags(int flags) { m_flags = flags; } + + // Get flags + int GetFlags() const { return m_flags; } + + // Is this flag present? + bool HasFlag(wxTextBoxAttrFlags flag) const { return (m_flags & flag) != 0; } + + // Remove this flag + void RemoveFlag(wxTextBoxAttrFlags flag) { m_flags &= ~flag; } + + // Add this flag + void AddFlag(wxTextBoxAttrFlags flag) { m_flags |= flag; } + + // Is this default? I.e. no flags set + bool IsDefault() const; + + // Float mode + short int GetFloatMode() const { return m_floatMode; } + void SetFloatMode(short int mode) { m_floatMode = mode; m_flags |= wxTEXT_BOX_ATTR_FLOAT; } + bool HasFloatMode() const { return HasFlag(wxTEXT_BOX_ATTR_FLOAT); } + bool IsFloating() const { return HasFloatMode() && GetFloatMode() != wxTEXT_BOX_ATTR_FLOAT_NONE; } + + // Whether to wrap text after object + short int GetClearMode() const { return m_clearMode; } + void SetClearMode(short int mode) { m_clearMode = mode; m_flags |= wxTEXT_BOX_ATTR_CLEAR; } + bool HasClearMode() const { return HasFlag(wxTEXT_BOX_ATTR_CLEAR); } + + // Whether to collapse borders + int GetCollapseBorders() const { return m_collapseMode ; } + void SetCollapseBorders(int collapse) { m_collapseMode = collapse; m_flags |= wxTEXT_BOX_ATTR_COLLAPSE_BORDERS; } + bool HasCollapseBorders() const { return HasFlag(wxTEXT_BOX_ATTR_COLLAPSE_BORDERS); } + + // Margins + + wxTextAttrDimension& GetLeftMargin() { return m_margins.m_left; } + const wxTextAttrDimension& GetLeftMargin() const { return m_margins.m_left; } + + wxTextAttrDimension& GetRightMargin() { return m_margins.m_right; } + const wxTextAttrDimension& GetRightMargin() const { return m_margins.m_right; } + + wxTextAttrDimension& GetTopMargin() { return m_margins.m_top; } + const wxTextAttrDimension& GetTopMargin() const { return m_margins.m_top; } + + wxTextAttrDimension& GetBottomMargin() { return m_margins.m_bottom; } + const wxTextAttrDimension& GetBottomMargin() const { return m_margins.m_bottom; } + + // Position + + wxTextAttrDimension& GetLeft() { return m_position.m_left; } + const wxTextAttrDimension& GetLeft() const { return m_position.m_left; } + + wxTextAttrDimension& GetRight() { return m_position.m_right; } + const wxTextAttrDimension& GetRight() const { return m_position.m_right; } + + wxTextAttrDimension& GetTop() { return m_position.m_top; } + const wxTextAttrDimension& GetTop() const { return m_position.m_top; } + + wxTextAttrDimension& GetBottom() { return m_position.m_bottom; } + const wxTextAttrDimension& GetBottom() const { return m_position.m_bottom; } + + // Padding + + wxTextAttrDimension& GetLeftPadding() { return m_padding.m_left; } + const wxTextAttrDimension& GetLeftPadding() const { return m_padding.m_left; } + + wxTextAttrDimension& GetRightPadding() { return m_padding.m_right; } + const wxTextAttrDimension& GetRightPadding() const { return m_padding.m_right; } + + wxTextAttrDimension& GetTopPadding() { return m_padding.m_top; } + const wxTextAttrDimension& GetTopPadding() const { return m_padding.m_top; } + + wxTextAttrDimension& GetBottomPadding() { return m_padding.m_bottom; } + const wxTextAttrDimension& GetBottomPadding() const { return m_padding.m_bottom; } + + // Border + + wxTextBoxAttrBorders& GetBorder() { return m_border; } + const wxTextBoxAttrBorders& GetBorder() const { return m_border; } + + wxTextBoxAttrBorder& GetLeftBorder() { return m_border.m_left; } + const wxTextBoxAttrBorder& GetLeftBorder() const { return m_border.m_left; } + + wxTextBoxAttrBorder& GetTopBorder() { return m_border.m_top; } + const wxTextBoxAttrBorder& GetTopBorder() const { return m_border.m_top; } + + wxTextBoxAttrBorder& GetRightBorder() { return m_border.m_right; } + const wxTextBoxAttrBorder& GetRightBorder() const { return m_border.m_right; } + + wxTextBoxAttrBorder& GetBottomBorder() { return m_border.m_bottom; } + const wxTextBoxAttrBorder& GetBottomBorder() const { return m_border.m_bottom; } + + // Outline + + wxTextBoxAttrBorders& GetOutline() { return m_outline; } + const wxTextBoxAttrBorders& GetOutline() const { return m_outline; } + + wxTextBoxAttrBorder& GetLeftOutline() { return m_outline.m_left; } + const wxTextBoxAttrBorder& GetLeftOutline() const { return m_outline.m_left; } + + wxTextBoxAttrBorder& GetTopOutline() { return m_outline.m_top; } + const wxTextBoxAttrBorder& GetTopOutline() const { return m_outline.m_top; } + + wxTextBoxAttrBorder& GetRightOutline() { return m_outline.m_right; } + const wxTextBoxAttrBorder& GetRightOutline() const { return m_outline.m_right; } + + wxTextBoxAttrBorder& GetBottomOutline() { return m_outline.m_bottom; } + const wxTextBoxAttrBorder& GetBottomOutline() const { return m_outline.m_bottom; } + + + // Width and height + + wxTextAttrDimension& GetWidth() { return m_width; } + const wxTextAttrDimension& GetWidth() const { return m_width; } + + wxTextAttrDimension& GetHeight() { return m_height; } + const wxTextAttrDimension& GetHeight() const { return m_height; } + +public: + + int m_flags; + + wxTextBoxAttrDimensions m_margins; + wxTextBoxAttrDimensions m_padding; + wxTextBoxAttrDimensions m_position; + + wxTextAttrDimension m_width; + wxTextAttrDimension m_height; + + wxTextBoxAttrBorders m_border; + wxTextBoxAttrBorders m_outline; + + short int m_floatMode; + short int m_clearMode; + short int m_collapseMode; +}; + +// ---------------------------------------------------------------------------- +// wxRichTextAttr: an enhanced attribute +// ---------------------------------------------------------------------------- + +class WXDLLIMPEXP_RICHTEXT wxRichTextAttr: public wxTextAttr +{ +public: + wxRichTextAttr(const wxTextAttr& attr) { wxTextAttr::Copy(attr); } + wxRichTextAttr(const wxRichTextAttr& attr) { Copy(attr); } + wxRichTextAttr() {} + + // Copy + void Copy(const wxRichTextAttr& attr); + + // Assignment + void operator=(const wxRichTextAttr& attr) { Copy(attr); } + void operator=(const wxTextAttr& attr) { wxTextAttr::Copy(attr); } + + // Equality test + bool operator==(const wxRichTextAttr& attr) const; + + // Partial equality test taking comparison object into account + bool EqPartial(const wxRichTextAttr& attr) const; + + // Merges the given attributes. If compareWith + // is non-NULL, then it will be used to mask out those attributes that are the same in style + // and compareWith, for situations where we don't want to explicitly set inherited attributes. + bool Apply(const wxRichTextAttr& style, const wxRichTextAttr* compareWith = NULL); + + // Collects the attributes that are common to a range of content, building up a note of + // which attributes are absent in some objects and which clash in some objects. + void CollectCommonAttributes(const wxRichTextAttr& attr, wxRichTextAttr& clashingAttr, wxRichTextAttr& absentAttr); + + // Remove specified attributes from this object + bool RemoveStyle(const wxRichTextAttr& attr); + + wxTextBoxAttr& GetTextBoxAttr() { return m_textBoxAttr; } + const wxTextBoxAttr& GetTextBoxAttr() const { return m_textBoxAttr; } + void SetTextBoxAttr(const wxTextBoxAttr& attr) { m_textBoxAttr = attr; } + + wxTextBoxAttr m_textBoxAttr; +}; /*! * wxRichTextFontTable @@ -227,7 +716,7 @@ public: bool IsOk() const { return m_refData != NULL; } - wxFont FindFont(const wxTextAttr& fontSpec); + wxFont FindFont(const wxRichTextAttr& fontSpec); void Clear(); void operator= (const wxRichTextFontTable& table); @@ -257,7 +746,7 @@ public: void operator =(const wxRichTextRange& range) { m_start = range.m_start; m_end = range.m_end; } bool operator ==(const wxRichTextRange& range) const { return (m_start == range.m_start && m_end == range.m_end); } - bool operator !=(const wxRichTextRange& range) const { return (m_start != range.m_start && m_end != range.m_end); } + bool operator !=(const wxRichTextRange& range) const { return (m_start != range.m_start || m_end != range.m_end); } wxRichTextRange operator -(const wxRichTextRange& range) const { return wxRichTextRange(m_start - range.m_start, m_end - range.m_end); } wxRichTextRange operator +(const wxRichTextRange& range) const { return wxRichTextRange(m_start + range.m_start, m_end + range.m_end); } @@ -357,6 +846,18 @@ public: /// Returns true if the object is empty virtual bool IsEmpty() const { return false; } + /// Whether this object floatable + virtual bool IsFloatable() const { return false; } + + /// Whether this object is currently floating + virtual bool IsFloating() const { return false; } + + /// Whether this object is a place holding one + // virtual bool IsPlaceHolding() const { return false; } + + /// Floating direction + virtual int GetFloatDirection() const { return wxTEXT_BOX_ATTR_FLOAT_NONE; } + /// Get any text in this object for the given range virtual wxString GetTextForRange(const wxRichTextRange& WXUNUSED(range)) const { return wxEmptyString; } @@ -370,6 +871,12 @@ public: /// Dump to output stream for debugging virtual void Dump(wxTextOutputStream& stream); + /// Can we edit properties via a GUI? + virtual bool CanEditProperties() const { return false; } + + /// Edit properties via a GUI + virtual bool EditProperties(wxWindow* WXUNUSED(parent), wxRichTextBuffer* WXUNUSED(buffer)) { return false; } + // Accessors /// Get/set the cached object size as calculated by Layout. @@ -410,9 +917,9 @@ public: virtual int GetBottomMargin() const { return m_bottomMargin; } /// Set attributes object - void SetAttributes(const wxTextAttr& attr) { m_attributes = attr; } - const wxTextAttr& GetAttributes() const { return m_attributes; } - wxTextAttr& GetAttributes() { return m_attributes; } + void SetAttributes(const wxRichTextAttr& attr) { m_attributes = attr; } + const wxRichTextAttr& GetAttributes() const { return m_attributes; } + wxRichTextAttr& GetAttributes() { return m_attributes; } /// Set/get stored descent void SetDescent(int descent) { m_descent = descent; } @@ -435,9 +942,13 @@ public: void Dereference(); /// Convert units in tenths of a millimetre to device units - int ConvertTenthsMMToPixels(wxDC& dc, int units); + int ConvertTenthsMMToPixels(wxDC& dc, int units) const; static int ConvertTenthsMMToPixels(int ppi, int units); + /// Convert units in pixels to tenths of a millimetre + int ConvertPixelsToTenthsMM(wxDC& dc, int pixels) const; + static int ConvertPixelsToTenthsMM(int ppi, int pixels); + protected: wxSize m_size; wxPoint m_pos; @@ -456,7 +967,7 @@ protected: int m_bottomMargin; /// Attributes - wxTextAttr m_attributes; + wxRichTextAttr m_attributes; }; WX_DECLARE_LIST_WITH_DECL( wxRichTextObject, wxRichTextObjectList, class WXDLLIMPEXP_RICHTEXT ); @@ -597,9 +1108,14 @@ public: wxRichTextParagraphLayoutBox(wxRichTextObject* parent = NULL); wxRichTextParagraphLayoutBox(const wxRichTextParagraphLayoutBox& obj): wxRichTextBox() { Init(); Copy(obj); } + ~wxRichTextParagraphLayoutBox(); // Overrideables + /// Hit-testing: returns a flag indicating hit test details, plus + /// information about position + virtual int HitTest(wxDC& dc, const wxPoint& pt, long& textPosition); + /// Draw the item virtual bool Draw(wxDC& dc, const wxRichTextRange& range, const wxRichTextRange& selectionRange, const wxRect& rect, int descent, int style); @@ -633,6 +1149,11 @@ public: virtual wxRichTextStyleSheet* GetStyleSheet() const { return NULL; } // Operations + /// Draw the floats of this buffer + void DrawFloats(wxDC& dc, const wxRichTextRange& range, const wxRichTextRange& selectionRange, const wxRect& rect, int descent, int style); + + /// Move an anchored object to another paragraph + void MoveAnchoredObjectToParagraph(wxRichTextParagraph* from, wxRichTextParagraph* to, wxRichTextAnchoredObject* obj); /// Initialize the object. void Init(); @@ -644,13 +1165,13 @@ public: virtual void Reset(); /// Convenience function to add a paragraph of text - virtual wxRichTextRange AddParagraph(const wxString& text, wxTextAttr* paraStyle = NULL); + virtual wxRichTextRange AddParagraph(const wxString& text, wxRichTextAttr* paraStyle = NULL); /// Convenience function to add an image - virtual wxRichTextRange AddImage(const wxImage& image, wxTextAttr* paraStyle = NULL); + virtual wxRichTextRange AddImage(const wxImage& image, wxRichTextAttr* paraStyle = NULL); /// Adds multiple paragraphs, based on newlines. - virtual wxRichTextRange AddParagraphs(const wxString& text, wxTextAttr* paraStyle = NULL); + virtual wxRichTextRange AddParagraphs(const wxString& text, wxRichTextAttr* paraStyle = NULL); /// Get the line at the given position. If caretPosition is true, the position is /// a caret position, which is normally a smaller number. @@ -689,7 +1210,7 @@ public: virtual int GetParagraphLength(long paragraphNumber) const; /// Get the number of paragraphs - virtual int GetParagraphCount() const { return GetChildCount(); } + virtual int GetParagraphCount() const { return static_cast(GetChildCount()); } /// Get the number of visible lines virtual int GetLineCount() const; @@ -704,25 +1225,28 @@ public: virtual bool PositionToXY(long pos, long* x, long* y) const; /// Set text attributes: character and/or paragraph styles. - virtual bool SetStyle(const wxRichTextRange& range, const wxTextAttr& style, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO); + virtual bool SetStyle(const wxRichTextRange& range, const wxRichTextAttr& style, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO); + + /// Set image attribute + void SetImageStyle(wxRichTextImage *image, const wxRichTextAttr& textAttr, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO); /// Get the conbined text attributes for this position. - virtual bool GetStyle(long position, wxTextAttr& style); + virtual bool GetStyle(long position, wxRichTextAttr& style); /// Get the content (uncombined) attributes for this position. - virtual bool GetUncombinedStyle(long position, wxTextAttr& style); + virtual bool GetUncombinedStyle(long position, wxRichTextAttr& style); /// Implementation helper for GetStyle. If combineStyles is true, combine base, paragraph and /// context attributes. - virtual bool DoGetStyle(long position, wxTextAttr& style, bool combineStyles = true); + virtual bool DoGetStyle(long position, wxRichTextAttr& style, bool combineStyles = true); /// Get the combined style for a range - if any attribute is different within the range, /// that attribute is not present within the flags - virtual bool GetStyleForRange(const wxRichTextRange& range, wxTextAttr& style); + virtual bool GetStyleForRange(const wxRichTextRange& range, wxRichTextAttr& style); /// Combines 'style' with 'currentStyle' for the purpose of summarising the attributes of a range of /// content. - bool CollectStyle(wxTextAttr& currentStyle, const wxTextAttr& style, long& multipleStyleAttributes, int& multipleTextEffectAttributes); + bool CollectStyle(wxRichTextAttr& currentStyle, const wxRichTextAttr& style, wxRichTextAttr& clashingAttr, wxRichTextAttr& absentAttr); /// Set list style virtual bool SetListStyle(const wxRichTextRange& range, wxRichTextListStyleDefinition* def, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1); @@ -746,19 +1270,19 @@ public: virtual bool DoNumberList(const wxRichTextRange& range, const wxRichTextRange& promotionRange, int promoteBy, wxRichTextListStyleDefinition* def, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1); /// Fills in the attributes for numbering a paragraph after previousParagraph. - virtual bool FindNextParagraphNumber(wxRichTextParagraph* previousParagraph, wxTextAttr& attr) const; + virtual bool FindNextParagraphNumber(wxRichTextParagraph* previousParagraph, wxRichTextAttr& attr) const; /// Test if this whole range has character attributes of the specified kind. If any /// of the attributes are different within the range, the test fails. You /// can use this to implement, for example, bold button updating. style must have /// flags indicating which attributes are of interest. - virtual bool HasCharacterAttributes(const wxRichTextRange& range, const wxTextAttr& style) const; + virtual bool HasCharacterAttributes(const wxRichTextRange& range, const wxRichTextAttr& style) const; /// Test if this whole range has paragraph attributes of the specified kind. If any /// of the attributes are different within the range, the test fails. You /// can use this to implement, for example, centering button updating. style must have /// flags indicating which attributes are of interest. - virtual bool HasParagraphAttributes(const wxRichTextRange& range, const wxTextAttr& style) const; + virtual bool HasParagraphAttributes(const wxRichTextRange& range, const wxRichTextAttr& style) const; /// Clone virtual wxRichTextObject* Clone() const { return new wxRichTextParagraphLayoutBox(*this); } @@ -788,32 +1312,43 @@ public: /// Set default style for new content. Setting it to a default attribute /// makes new content take on the 'basic' style. - virtual bool SetDefaultStyle(const wxTextAttr& style); + virtual bool SetDefaultStyle(const wxRichTextAttr& style); /// Get default style - virtual const wxTextAttr& GetDefaultStyle() const { return m_defaultAttributes; } + virtual const wxRichTextAttr& GetDefaultStyle() const { return m_defaultAttributes; } /// Set basic (overall) style - virtual void SetBasicStyle(const wxTextAttr& style) { m_attributes = style; } + virtual void SetBasicStyle(const wxRichTextAttr& style) { m_attributes = style; } /// Get basic (overall) style - virtual const wxTextAttr& GetBasicStyle() const { return m_attributes; } + virtual const wxRichTextAttr& GetBasicStyle() const { return m_attributes; } /// Invalidate the buffer. With no argument, invalidates whole buffer. void Invalidate(const wxRichTextRange& invalidRange = wxRICHTEXT_ALL); + /// Gather information about floating objects. If untilObj is non-NULL, + /// will stop getting information if the current object is this, since we + /// will collect the rest later. + virtual bool UpdateFloatingObjects(int width, wxRichTextObject* untilObj = NULL); + /// Get invalid range, rounding to entire paragraphs if argument is true. wxRichTextRange GetInvalidRange(bool wholeParagraphs = false) const; + /// Get the wxRichTextFloatCollector of this object + wxRichTextFloatCollector* GetFloatCollector() { return m_floatCollector; } + protected: wxRichTextCtrl* m_ctrl; - wxTextAttr m_defaultAttributes; + wxRichTextAttr m_defaultAttributes; /// The invalidated range that will need full layout wxRichTextRange m_invalidRange; // Is the last paragraph partial or complete? bool m_partialParagraph; + + // The floating layout state + wxRichTextFloatCollector* m_floatCollector; }; /*! @@ -918,8 +1453,8 @@ class WXDLLIMPEXP_RICHTEXT wxRichTextParagraph: public wxRichTextBox public: // Constructors - wxRichTextParagraph(wxRichTextObject* parent = NULL, wxTextAttr* style = NULL); - wxRichTextParagraph(const wxString& text, wxRichTextObject* parent = NULL, wxTextAttr* paraStyle = NULL, wxTextAttr* charStyle = NULL); + wxRichTextParagraph(wxRichTextObject* parent = NULL, wxRichTextAttr* style = NULL); + wxRichTextParagraph(const wxString& text, wxRichTextObject* parent = NULL, wxRichTextAttr* paraStyle = NULL, wxRichTextAttr* charStyle = NULL); virtual ~wxRichTextParagraph(); wxRichTextParagraph(const wxRichTextParagraph& obj): wxRichTextBox() { Copy(obj); } @@ -964,7 +1499,7 @@ public: // Implementation /// Apply paragraph styles such as centering to the wrapped lines - virtual void ApplyParagraphStyle(const wxTextAttr& attr, const wxRect& rect); + virtual void ApplyParagraphStyle(const wxRichTextAttr& attr, const wxRect& rect, wxDC& dc); /// Insert text at the given position virtual bool InsertText(long pos, const wxString& text); @@ -1001,10 +1536,10 @@ public: /// Get combined attributes of the base style, paragraph style and character style. We use this to dynamically /// retrieve the actual style. - wxTextAttr GetCombinedAttributes(const wxTextAttr& contentStyle) const; + wxRichTextAttr GetCombinedAttributes(const wxRichTextAttr& contentStyle) const; /// Get combined attributes of the base style and paragraph style. - wxTextAttr GetCombinedAttributes() const; + wxRichTextAttr GetCombinedAttributes() const; /// Get the first position from pos that has a line break character. long GetFirstLineBreakPosition(long pos); @@ -1018,12 +1553,17 @@ public: /// Get default tabstop array static const wxArrayInt& GetDefaultTabs() { return sm_defaultTabs; } + /// Layout the floats object + void LayoutFloat(wxDC& dc, const wxRect& rect, int style, wxRichTextFloatCollector* floatCollector); + protected: /// The lines that make up the wrapped paragraph wxRichTextLineList m_cachedLines; /// Default tabstops static wxArrayInt sm_defaultTabs; + +friend class wxRichTextFloatCollector; }; /*! @@ -1037,7 +1577,7 @@ class WXDLLIMPEXP_RICHTEXT wxRichTextPlainText: public wxRichTextObject public: // Constructors - wxRichTextPlainText(const wxString& text = wxEmptyString, wxRichTextObject* parent = NULL, wxTextAttr* style = NULL); + wxRichTextPlainText(const wxString& text = wxEmptyString, wxRichTextObject* parent = NULL, wxRichTextAttr* style = NULL); wxRichTextPlainText(const wxRichTextPlainText& obj): wxRichTextObject() { Copy(obj); } // Overrideables @@ -1097,7 +1637,7 @@ public: /// Clone virtual wxRichTextObject* Clone() const { return new wxRichTextPlainText(*this); } private: - bool DrawTabbedString(wxDC& dc, const wxTextAttr& attr, const wxRect& rect, wxString& str, wxCoord& x, wxCoord& y, bool selected); + bool DrawTabbedString(wxDC& dc, const wxRichTextAttr& attr, const wxRect& rect, wxString& str, wxCoord& x, wxCoord& y, bool selected); protected: wxString m_text; @@ -1125,11 +1665,18 @@ public: // 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. - virtual bool MakeImageBlock(const wxString& filename, int imageType, wxImage& image, bool convertToJPEG = true); + virtual bool MakeImageBlock(const wxString& filename, wxBitmapType imageType, + wxImage& image, bool convertToJPEG = true); // Make an image block from the wxImage in the given // format. - virtual bool MakeImageBlock(wxImage& image, int imageType, int quality = 80); + 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) + virtual bool MakeImageBlockDefaultQuality(const wxImage& image, wxBitmapType imageType); + + // Makes the image block + virtual bool DoMakeImageBlock(const wxImage& image, wxBitmapType imageType); // Write to a file bool Write(const wxString& filename); @@ -1138,7 +1685,7 @@ public: bool WriteHex(wxOutputStream& stream); // Read data in hex from a stream - bool ReadHex(wxInputStream& stream, int length, int imageType); + bool ReadHex(wxInputStream& stream, int length, wxBitmapType imageType); // Copy from 'block' void Copy(const wxRichTextImageBlock& block); @@ -1153,11 +1700,11 @@ public: unsigned char* GetData() const { return m_data; } size_t GetDataSize() const { return m_dataSize; } - int GetImageType() const { return m_imageType; } + wxBitmapType GetImageType() const { return m_imageType; } void SetData(unsigned char* image) { m_data = image; } void SetDataSize(size_t size) { m_dataSize = size; } - void SetImageType(int imageType) { m_imageType = imageType; } + void SetImageType(wxBitmapType imageType) { m_imageType = imageType; } bool Ok() const { return IsOk(); } bool IsOk() const { return GetData() != NULL; } @@ -1182,25 +1729,59 @@ protected: // This is in the raw, original form such as a JPEG file. unsigned char* m_data; size_t m_dataSize; - int m_imageType; // wxWin type id + wxBitmapType m_imageType; }; +/*! + * wxRichTextAnchoredObject class declaration + * This object is an abstract one that represent some objects which can floats + */ +class WXDLLIMPEXP_RICHTEXT wxRichTextAnchoredObject: public wxRichTextObject +{ + DECLARE_CLASS(wxRichTextAnchoredObject) +public: +// Constructors + wxRichTextAnchoredObject(wxRichTextObject* parent = NULL, const wxRichTextAttr& attr = wxRichTextAttr()); + wxRichTextAnchoredObject(const wxRichTextAnchoredObject& obj) : wxRichTextObject(obj) /* , m_ph(NULL) */ { Copy(obj); } + ~wxRichTextAnchoredObject(); + +// Virtuals + virtual bool IsFloatable() const { return true; } + + /// Whether this object is currently floating + virtual bool IsFloating() const { return GetAttributes().GetTextBoxAttr().IsFloating(); } + + virtual void SetParent(wxRichTextObject* parent); + +// Accessors + + /// The floating direction + virtual int GetFloatDirection() const { return GetAttributes().GetTextBoxAttr().GetFloatMode(); } + + void operator=(const wxRichTextAnchoredObject&) { wxASSERT("Nobody can reset this object using ="); } + +// Functions + void Copy(const wxRichTextAnchoredObject& obj); + +protected: + +}; /*! * wxRichTextImage class declaration * This object represents an image. */ -class WXDLLIMPEXP_RICHTEXT wxRichTextImage: public wxRichTextObject +class WXDLLIMPEXP_RICHTEXT wxRichTextImage: public wxRichTextAnchoredObject { DECLARE_DYNAMIC_CLASS(wxRichTextImage) public: // Constructors - wxRichTextImage(wxRichTextObject* parent = NULL): wxRichTextObject(parent) { } - wxRichTextImage(const wxImage& image, wxRichTextObject* parent = NULL, wxTextAttr* charStyle = NULL); - wxRichTextImage(const wxRichTextImageBlock& imageBlock, wxRichTextObject* parent = NULL, wxTextAttr* charStyle = NULL); - wxRichTextImage(const wxRichTextImage& obj): wxRichTextObject() { Copy(obj); } + wxRichTextImage(wxRichTextObject* parent = NULL): wxRichTextAnchoredObject(parent) { } + wxRichTextImage(const wxImage& image, wxRichTextObject* parent = NULL, wxRichTextAttr* charStyle = NULL); + wxRichTextImage(const wxRichTextImageBlock& imageBlock, wxRichTextObject* parent = NULL, wxRichTextAttr* charStyle = NULL); + wxRichTextImage(const wxRichTextImage& obj): wxRichTextAnchoredObject(obj) { Copy(obj); } // Overrideables @@ -1215,15 +1796,24 @@ public: virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, int flags, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const; /// Returns true if the object is empty - virtual bool IsEmpty() const { return !m_image.Ok(); } + virtual bool IsEmpty() const { return !m_imageBlock.Ok(); } + + /// Can we edit properties via a GUI? + virtual bool CanEditProperties() const { return true; } + + /// Edit properties via a GUI + virtual bool EditProperties(wxWindow* parent, wxRichTextBuffer* buffer); // Accessors - /// Get the image - const wxImage& GetImage() const { return m_image; } + /// Get the image cache (scaled bitmap) + const wxBitmap& GetImageCache() const { return m_imageCache; } - /// Set the image - void SetImage(const wxImage& image) { m_image = image; } + /// Set the image cache + void SetImageCache(const wxBitmap& bitmap) { m_imageCache = bitmap; } + + /// Reset the image cache + void ResetImageCache() { m_imageCache = wxNullBitmap; } /// Get the image block containing the raw data wxRichTextImageBlock& GetImageBlock() { return m_imageBlock; } @@ -1236,17 +1826,12 @@ public: /// Clone virtual wxRichTextObject* Clone() const { return new wxRichTextImage(*this); } - /// Load wxImage from the block - virtual bool LoadFromBlock(); - - /// Make block from the wxImage - virtual bool MakeBlock(); + /// Create a cached image at the required size + virtual bool LoadImageCache(wxDC& dc, bool resetCache = false); protected: - // TODO: reduce the multiple representations of data - wxImage m_image; - wxBitmap m_bitmap; wxRichTextImageBlock m_imageBlock; + wxBitmap m_imageCache; }; @@ -1300,16 +1885,16 @@ public: virtual void ResetAndClearCommands(); /// Load a file - virtual bool LoadFile(const wxString& filename, int type = wxRICHTEXT_TYPE_ANY); + virtual bool LoadFile(const wxString& filename, wxRichTextFileType type = wxRICHTEXT_TYPE_ANY); /// Save a file - virtual bool SaveFile(const wxString& filename, int type = wxRICHTEXT_TYPE_ANY); + virtual bool SaveFile(const wxString& filename, wxRichTextFileType type = wxRICHTEXT_TYPE_ANY); /// Load from a stream - virtual bool LoadFile(wxInputStream& stream, int type = wxRICHTEXT_TYPE_ANY); + virtual bool LoadFile(wxInputStream& stream, wxRichTextFileType type = wxRICHTEXT_TYPE_ANY); /// Save to a stream - virtual bool SaveFile(wxOutputStream& stream, int type = wxRICHTEXT_TYPE_ANY); + virtual bool SaveFile(wxOutputStream& stream, wxRichTextFileType type = wxRICHTEXT_TYPE_ANY); /// Set the handler flags, controlling loading and saving void SetHandlerFlags(int flags) { m_handlerFlags = flags; } @@ -1318,7 +1903,7 @@ public: int GetHandlerFlags() const { return m_handlerFlags; } /// Convenience function to add a paragraph of text - virtual wxRichTextRange AddParagraph(const wxString& text, wxTextAttr* paraStyle = NULL) { Modify(); return wxRichTextParagraphLayoutBox::AddParagraph(text, paraStyle); } + 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 @@ -1359,7 +1944,7 @@ public: virtual bool CanPasteFromClipboard() const; /// Begin using a style - virtual bool BeginStyle(const wxTextAttr& style); + virtual bool BeginStyle(const wxRichTextAttr& style); /// End the style virtual bool EndStyle(); @@ -1514,7 +2099,11 @@ public: bool InsertNewlineWithUndo(long pos, wxRichTextCtrl* ctrl, int flags = 0); /// Submit command to insert the given image - bool InsertImageWithUndo(long pos, const wxRichTextImageBlock& imageBlock, wxRichTextCtrl* ctrl, int flags = 0); + bool InsertImageWithUndo(long pos, const wxRichTextImageBlock& imageBlock, wxRichTextCtrl* ctrl, int flags = 0, + const wxRichTextAttr& textAttr = wxRichTextAttr()); + + /// Submit command to insert an object + bool InsertObjectWithUndo(long pos, wxRichTextObject *object, wxRichTextCtrl* ctrl, int flags); /// Submit command to delete this range bool DeleteRangeWithUndo(const wxRichTextRange& range, wxRichTextCtrl* ctrl); @@ -1526,7 +2115,7 @@ public: /// Get the style that is appropriate for a new paragraph at this position. /// If the previous paragraph has a paragraph style name, look up the next-paragraph /// style. - wxTextAttr GetStyleForNewParagraph(long pos, bool caretPosition = false, bool lookUpNewParaStyle=false) const; + wxRichTextAttr GetStyleForNewParagraph(long pos, bool caretPosition = false, bool lookUpNewParaStyle=false) const; /// Dumps contents of buffer for debugging purposes virtual void Dump(); @@ -1548,13 +2137,14 @@ public: static wxRichTextFileHandler *FindHandler(const wxString& name); /// Finds a handler by extension and type - static wxRichTextFileHandler *FindHandler(const wxString& extension, int imageType); + static wxRichTextFileHandler *FindHandler(const wxString& extension, wxRichTextFileType imageType); /// Finds a handler by filename or, if supplied, type - static wxRichTextFileHandler *FindHandlerFilenameOrType(const wxString& filename, int imageType); + static wxRichTextFileHandler *FindHandlerFilenameOrType(const wxString& filename, + wxRichTextFileType imageType); /// Finds a handler by type - static wxRichTextFileHandler *FindHandler(int imageType); + 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 @@ -1697,7 +2287,7 @@ public: /// Update the control appearance void UpdateAppearance(long caretPosition, bool sendUpdateEvent = false, - wxArrayInt* optimizationLineCharPositions = NULL, wxArrayInt* optimizationLineYPositions = NULL); + wxArrayInt* optimizationLineCharPositions = NULL, wxArrayInt* optimizationLineYPositions = NULL, bool isDoCmd = true); /// Replace the buffer paragraphs with the given fragment. void ApplyParagraphs(const wxRichTextParagraphLayoutBox& fragment); @@ -1706,6 +2296,9 @@ public: wxRichTextParagraphLayoutBox& GetNewParagraphs() { return m_newParagraphs; } wxRichTextParagraphLayoutBox& GetOldParagraphs() { return m_oldParagraphs; } + /// Calculate arrays for refresh optimization + void CalculateRefreshOptimizations(wxArrayInt& optimizationLineCharPositions, wxArrayInt& optimizationLineYPositions); + /// Set/get the position used for e.g. insertion void SetPosition(long pos) { m_position = pos; } long GetPosition() const { return m_position; } @@ -1766,6 +2359,10 @@ protected: // in a larger document #define wxRICHTEXT_HANDLER_NO_HEADER_FOOTER 0x0080 +// Convert the more common face names to names that will work on the current platform +// in a larger document +#define wxRICHTEXT_HANDLER_CONVERT_FACENAMES 0x0100 + /*! * wxRichTextFileHandler * Base class for file handlers @@ -1848,7 +2445,9 @@ class WXDLLIMPEXP_RICHTEXT wxRichTextPlainTextHandler: public wxRichTextFileHand { DECLARE_CLASS(wxRichTextPlainTextHandler) public: - wxRichTextPlainTextHandler(const wxString& name = wxT("Text"), const wxString& ext = wxT("txt"), int type = wxRICHTEXT_TYPE_TEXT) + wxRichTextPlainTextHandler(const wxString& name = wxT("Text"), + const wxString& ext = wxT("txt"), + wxRichTextFileType type = wxRICHTEXT_TYPE_TEXT) : wxRichTextFileHandler(name, ext, type) { } @@ -1878,7 +2477,7 @@ class WXDLLIMPEXP_RICHTEXT wxRichTextBufferDataObject: public wxDataObjectSimple public: // ctor doesn't copy the pointer, so it shouldn't go away while this object // is alive - wxRichTextBufferDataObject(wxRichTextBuffer* richTextBuffer = (wxRichTextBuffer*) NULL); + wxRichTextBufferDataObject(wxRichTextBuffer* richTextBuffer = NULL); virtual ~wxRichTextBufferDataObject(); // after a call to this function, the buffer is owned by the caller and it @@ -1920,13 +2519,13 @@ public: virtual ~wxRichTextRenderer() {} /// Draw a standard bullet, as specified by the value of GetBulletName - virtual bool DrawStandardBullet(wxRichTextParagraph* paragraph, wxDC& dc, const wxTextAttr& attr, const wxRect& rect) = 0; + 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 - virtual bool DrawTextBullet(wxRichTextParagraph* paragraph, wxDC& dc, const wxTextAttr& attr, const wxRect& rect, const wxString& text) = 0; + 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 - virtual bool DrawBitmapBullet(wxRichTextParagraph* paragraph, wxDC& dc, const wxTextAttr& attr, const wxRect& rect) = 0; + virtual bool DrawBitmapBullet(wxRichTextParagraph* paragraph, wxDC& dc, const wxRichTextAttr& attr, const wxRect& rect) = 0; /// Enumerate the standard bullet names currently supported virtual bool EnumerateStandardBulletNames(wxArrayString& bulletNames) = 0; @@ -1942,13 +2541,13 @@ public: wxRichTextStdRenderer() {} /// Draw a standard bullet, as specified by the value of GetBulletName - virtual bool DrawStandardBullet(wxRichTextParagraph* paragraph, wxDC& dc, const wxTextAttr& attr, const wxRect& rect); + 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 - virtual bool DrawTextBullet(wxRichTextParagraph* paragraph, wxDC& dc, const wxTextAttr& attr, const wxRect& rect, const wxString& text); + 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 - virtual bool DrawBitmapBullet(wxRichTextParagraph* paragraph, wxDC& dc, const wxTextAttr& attr, const wxRect& rect); + virtual bool DrawBitmapBullet(wxRichTextParagraph* paragraph, wxDC& dc, const wxRichTextAttr& attr, const wxRect& rect); /// Enumerate the standard bullet names currently supported virtual bool EnumerateStandardBulletNames(wxArrayString& bulletNames); @@ -1965,18 +2564,18 @@ inline bool wxRichTextHasStyle(int flags, int style) } /// Compare two attribute objects -WXDLLIMPEXP_RICHTEXT bool wxTextAttrEq(const wxTextAttr& attr1, const wxTextAttr& attr2); -WXDLLIMPEXP_RICHTEXT bool wxTextAttrEq(const wxTextAttr& attr1, const wxTextAttr& attr2); +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 wxTextAttr& attr1, const wxTextAttr& attr2, int flags); +WXDLLIMPEXP_RICHTEXT bool wxTextAttrEqPartial(const wxRichTextAttr& attr1, const wxRichTextAttr& attr2); /// Apply one style to another -WXDLLIMPEXP_RICHTEXT bool wxRichTextApplyStyle(wxTextAttr& destStyle, const wxTextAttr& style, wxTextAttr* compareWith = NULL); +WXDLLIMPEXP_RICHTEXT bool wxRichTextApplyStyle(wxRichTextAttr& destStyle, const wxRichTextAttr& style, wxRichTextAttr* compareWith = NULL); // Remove attributes -WXDLLIMPEXP_RICHTEXT bool wxRichTextRemoveStyle(wxTextAttr& destStyle, const wxTextAttr& style); +WXDLLIMPEXP_RICHTEXT bool wxRichTextRemoveStyle(wxRichTextAttr& destStyle, const wxRichTextAttr& style); /// Combine two bitlists WXDLLIMPEXP_RICHTEXT bool wxRichTextCombineBitlists(int& valueA, int valueB, int& flagsA, int flagsB); @@ -1985,7 +2584,7 @@ WXDLLIMPEXP_RICHTEXT bool wxRichTextCombineBitlists(int& valueA, int valueB, int WXDLLIMPEXP_RICHTEXT bool wxRichTextBitlistsEqPartial(int valueA, int valueB, int flags); /// Split into paragraph and character styles -WXDLLIMPEXP_RICHTEXT bool wxRichTextSplitParaCharStyles(const wxTextAttr& style, wxTextAttr& parStyle, wxTextAttr& charStyle); +WXDLLIMPEXP_RICHTEXT bool wxRichTextSplitParaCharStyles(const wxRichTextAttr& style, wxRichTextAttr& parStyle, wxRichTextAttr& charStyle); /// Compare tabs WXDLLIMPEXP_RICHTEXT bool wxRichTextTabsEq(const wxArrayInt& tabs1, const wxArrayInt& tabs2); @@ -1993,6 +2592,10 @@ WXDLLIMPEXP_RICHTEXT bool wxRichTextTabsEq(const wxArrayInt& tabs1, const wxArra /// Convert a decimal to Roman numerals WXDLLIMPEXP_RICHTEXT wxString wxRichTextDecimalToRoman(long n); +// Collects the attributes that are common to a range of content, building up a note of +// which attributes are absent in some objects and which clash in some objects. +WXDLLIMPEXP_RICHTEXT void wxTextAttrCollectCommonAttributes(wxTextAttr& currentStyle, const wxTextAttr& attr, wxTextAttr& clashingAttr, wxTextAttr& absentAttr); + WXDLLIMPEXP_RICHTEXT void wxRichTextModuleInit(); #endif