#include "wx/dataobj.h"
#endif
-// Experimental dynamic styles to avoid user-specific character styles from being
-// overwritten by paragraph styles.
-#define wxRICHTEXT_USE_DYNAMIC_STYLES 1
+// Compatibility
+#define wxRichTextAttr wxTextAttr
+#define wxTextAttrEx wxTextAttr
+
+/*!
+ * Special characters
+ */
+
+extern WXDLLIMPEXP_RICHTEXT const wxChar wxRichTextLineBreakChar;
/*!
* File types
* Forward declarations
*/
-class WXDLLIMPEXP_RICHTEXT wxRichTextCtrl;
-class WXDLLIMPEXP_RICHTEXT wxRichTextObject;
-class WXDLLIMPEXP_RICHTEXT wxRichTextCacheObject;
-class WXDLLIMPEXP_RICHTEXT wxRichTextObjectList;
-class WXDLLIMPEXP_RICHTEXT wxRichTextLine;
-class WXDLLIMPEXP_RICHTEXT wxRichTextParagraph;
-class WXDLLIMPEXP_RICHTEXT wxRichTextFileHandler;
-class WXDLLIMPEXP_RICHTEXT wxRichTextStyleSheet;
-class WXDLLIMPEXP_RICHTEXT wxTextAttrEx;
-class WXDLLIMPEXP_RICHTEXT wxRichTextListStyleDefinition;
+class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextCtrl;
+class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextObject;
+class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextCacheObject;
+class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextObjectList;
+class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextLine;
+class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextParagraph;
+class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextFileHandler;
+class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextStyleSheet;
+class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextListStyleDefinition;
+class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextEvent;
+class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextRenderer;
+class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextBuffer;
/*!
* Flags determining the available space, passed to Layout
// the rect passed to Layout.
#define wxRICHTEXT_LAYOUT_SPECIFIED_RECT 0x10
+/*!
+ * Flags to pass to Draw
+ */
+
+// Ignore paragraph cache optimization, e.g. for printing purposes
+// where one line may be drawn higher (on the next page) compared
+// with the previous line
+#define wxRICHTEXT_DRAW_IGNORE_CACHE 0x01
+
/*!
* Flags returned from hit-testing
*/
#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
/*!
* Flags for GetRangeSize
// the current indentation will be used
#define wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL 0x20
+// Resets the existing style before applying the new style
+#define wxRICHTEXT_SETSTYLE_RESET 0x40
+
+// Removes the given style instead of applying it
+#define wxRICHTEXT_SETSTYLE_REMOVE 0x80
+
/*!
* Flags for text insertion
*/
#define wxRICHTEXT_INSERT_WITH_PREVIOUS_PARAGRAPH_STYLE 0x01
/*!
- * Extra formatting flags not in wxTextAttr
+ * wxRichTextFontTable
+ * Manages quick access to a pool of fonts for rendering rich text
*/
-#define wxTEXT_ATTR_PARA_SPACING_AFTER 0x00000800
-#define wxTEXT_ATTR_PARA_SPACING_BEFORE 0x00001000
-#define wxTEXT_ATTR_LINE_SPACING 0x00002000
-#define wxTEXT_ATTR_CHARACTER_STYLE_NAME 0x00004000
-#define wxTEXT_ATTR_PARAGRAPH_STYLE_NAME 0x00008000
-#define wxTEXT_ATTR_LIST_STYLE_NAME 0x00010000
-#define wxTEXT_ATTR_BULLET_STYLE 0x00020000
-#define wxTEXT_ATTR_BULLET_NUMBER 0x00040000
-#define wxTEXT_ATTR_BULLET_SYMBOL 0x00080000
-#define wxTEXT_ATTR_BULLET_NAME 0x00100000
+class WXDLLIMPEXP_RICHTEXT wxRichTextFontTable: public wxObject
+{
+public:
+ wxRichTextFontTable();
-/*!
- * Styles for wxTextAttrEx::SetBulletStyle
- */
+ wxRichTextFontTable(const wxRichTextFontTable& table);
+ virtual ~wxRichTextFontTable();
-#define wxTEXT_ATTR_BULLET_STYLE_NONE 0x0000
-#define wxTEXT_ATTR_BULLET_STYLE_ARABIC 0x0001
-#define wxTEXT_ATTR_BULLET_STYLE_LETTERS_UPPER 0x0002
-#define wxTEXT_ATTR_BULLET_STYLE_LETTERS_LOWER 0x0004
-#define wxTEXT_ATTR_BULLET_STYLE_ROMAN_UPPER 0x0008
-#define wxTEXT_ATTR_BULLET_STYLE_ROMAN_LOWER 0x0010
-#define wxTEXT_ATTR_BULLET_STYLE_SYMBOL 0x0020
-#define wxTEXT_ATTR_BULLET_STYLE_BITMAP 0x0040
-#define wxTEXT_ATTR_BULLET_STYLE_PARENTHESES 0x0080
-#define wxTEXT_ATTR_BULLET_STYLE_PERIOD 0x0100
-#define wxTEXT_ATTR_BULLET_STYLE_STANDARD 0x0200
+ bool IsOk() const { return m_refData != NULL; }
-/*!
- * Line spacing values
- */
+ wxFont FindFont(const wxTextAttr& fontSpec);
+ void Clear();
-#define wxTEXT_ATTR_LINE_SPACING_NORMAL 10
-#define wxTEXT_ATTR_LINE_SPACING_HALF 15
-#define wxTEXT_ATTR_LINE_SPACING_TWICE 20
+ void operator= (const wxRichTextFontTable& table);
+ bool operator == (const wxRichTextFontTable& table) const;
+ bool operator != (const wxRichTextFontTable& table) const { return !(*this == table); }
+
+protected:
+
+ DECLARE_DYNAMIC_CLASS(wxRichTextFontTable)
+};
/*!
* wxRichTextRange class declaration
* This stores beginning and end positions for a range of data.
+ * TODO: consider renaming wxTextRange and using for all text controls.
*/
class WXDLLIMPEXP_RICHTEXT wxRichTextRange
#define wxRICHTEXT_ALL wxRichTextRange(-2, -2)
#define wxRICHTEXT_NONE wxRichTextRange(-1, -1)
-/*!
- * wxTextAttrEx is an extended version of wxTextAttr with more paragraph attributes.
- */
-
-class WXDLLIMPEXP_RICHTEXT wxTextAttrEx: public wxTextAttr
-{
-public:
- // ctors
- wxTextAttrEx(const wxTextAttrEx& attr);
- wxTextAttrEx(const wxTextAttr& attr) { Init(); (*this) = attr; }
- wxTextAttrEx() { Init(); }
-
- // Initialise this object
- void Init();
-
- // Assignment from a wxTextAttrEx object
- void operator= (const wxTextAttrEx& attr);
-
- // Assignment from a wxTextAttr object
- void operator= (const wxTextAttr& attr);
-
- // Equality test
- bool operator== (const wxTextAttrEx& attr) const;
-
- // setters
- void SetCharacterStyleName(const wxString& name) { m_characterStyleName = name; SetFlags(GetFlags() | wxTEXT_ATTR_CHARACTER_STYLE_NAME); }
- void SetParagraphStyleName(const wxString& name) { m_paragraphStyleName = name; SetFlags(GetFlags() | wxTEXT_ATTR_PARAGRAPH_STYLE_NAME); }
- void SetListStyleName(const wxString& name) { m_listStyleName = name; SetFlags(GetFlags() | wxTEXT_ATTR_LIST_STYLE_NAME); }
- void SetParagraphSpacingAfter(int spacing) { m_paragraphSpacingAfter = spacing; SetFlags(GetFlags() | wxTEXT_ATTR_PARA_SPACING_AFTER); }
- void SetParagraphSpacingBefore(int spacing) { m_paragraphSpacingBefore = spacing; SetFlags(GetFlags() | wxTEXT_ATTR_PARA_SPACING_BEFORE); }
- void SetLineSpacing(int spacing) { m_lineSpacing = spacing; SetFlags(GetFlags() | wxTEXT_ATTR_LINE_SPACING); }
- void SetBulletStyle(int style) { m_bulletStyle = style; SetFlags(GetFlags() | wxTEXT_ATTR_BULLET_STYLE); }
- void SetBulletNumber(int n) { m_bulletNumber = n; SetFlags(GetFlags() | wxTEXT_ATTR_BULLET_NUMBER); }
- void SetBulletSymbol(wxChar symbol) { m_bulletSymbol = symbol; SetFlags(GetFlags() | wxTEXT_ATTR_BULLET_SYMBOL); }
- void SetBulletName(const wxString& name) { m_bulletName = name; SetFlags(GetFlags() | wxTEXT_ATTR_BULLET_NAME); }
- void SetBulletFont(const wxString& bulletFont) { m_bulletFont = bulletFont; }
-
- const wxString& GetCharacterStyleName() const { return m_characterStyleName; }
- const wxString& GetParagraphStyleName() const { return m_paragraphStyleName; }
- const wxString& GetListStyleName() const { return m_listStyleName; }
- int GetParagraphSpacingAfter() const { return m_paragraphSpacingAfter; }
- int GetParagraphSpacingBefore() const { return m_paragraphSpacingBefore; }
- int GetLineSpacing() const { return m_lineSpacing; }
- int GetBulletStyle() const { return m_bulletStyle; }
- int GetBulletNumber() const { return m_bulletNumber; }
- wxChar GetBulletSymbol() const { return m_bulletSymbol; }
- const wxString& GetBulletName() const { return m_bulletName; }
- const wxString& GetBulletFont() const { return m_bulletFont; }
-
- bool HasWeight() const { return (GetFlags() & wxTEXT_ATTR_FONT_WEIGHT) != 0; }
- bool HasSize() const { return (GetFlags() & wxTEXT_ATTR_FONT_SIZE) != 0; }
- bool HasItalic() const { return (GetFlags() & wxTEXT_ATTR_FONT_ITALIC) != 0; }
- bool HasUnderlined() const { return (GetFlags() & wxTEXT_ATTR_FONT_UNDERLINE) != 0; }
- bool HasFaceName() const { return (GetFlags() & wxTEXT_ATTR_FONT_FACE) != 0; }
-
- bool HasParagraphSpacingAfter() const { return HasFlag(wxTEXT_ATTR_PARA_SPACING_AFTER); }
- bool HasParagraphSpacingBefore() const { return HasFlag(wxTEXT_ATTR_PARA_SPACING_BEFORE); }
- bool HasLineSpacing() const { return HasFlag(wxTEXT_ATTR_LINE_SPACING); }
- bool HasCharacterStyleName() const { return HasFlag(wxTEXT_ATTR_CHARACTER_STYLE_NAME) || !m_characterStyleName.IsEmpty(); }
- bool HasParagraphStyleName() const { return HasFlag(wxTEXT_ATTR_PARAGRAPH_STYLE_NAME) || !m_paragraphStyleName.IsEmpty(); }
- bool HasListStyleName() const { return HasFlag(wxTEXT_ATTR_LIST_STYLE_NAME) || !m_listStyleName.IsEmpty(); }
- bool HasBulletStyle() const { return HasFlag(wxTEXT_ATTR_BULLET_STYLE); }
- bool HasBulletNumber() const { return HasFlag(wxTEXT_ATTR_BULLET_NUMBER); }
- bool HasBulletSymbol() const { return HasFlag(wxTEXT_ATTR_BULLET_SYMBOL); }
- bool HasBulletName() const { return HasFlag(wxTEXT_ATTR_BULLET_NAME); }
-
- // Is this a character style?
- bool IsCharacterStyle() const { return (0 != (GetFlags() & (wxTEXT_ATTR_FONT | wxTEXT_ATTR_BACKGROUND_COLOUR | wxTEXT_ATTR_TEXT_COLOUR))); }
- bool IsParagraphStyle() const { return (0 != (GetFlags() & (wxTEXT_ATTR_ALIGNMENT|wxTEXT_ATTR_LEFT_INDENT|wxTEXT_ATTR_RIGHT_INDENT|wxTEXT_ATTR_TABS|
- wxTEXT_ATTR_PARA_SPACING_BEFORE|wxTEXT_ATTR_PARA_SPACING_AFTER|wxTEXT_ATTR_LINE_SPACING|
- wxTEXT_ATTR_BULLET_STYLE|wxTEXT_ATTR_BULLET_NUMBER|wxTEXT_ATTR_BULLET_NAME))); }
-
- // returns false if we have any attributes set, true otherwise
- bool IsDefault() const
- {
- return !HasTextColour() && !HasBackgroundColour() && !HasFont() && !HasAlignment() &&
- !HasTabs() && !HasLeftIndent() && !HasRightIndent() &&
- !HasParagraphSpacingAfter() && !HasParagraphSpacingBefore() && !HasLineSpacing() &&
- !HasCharacterStyleName() && !HasParagraphStyleName() && !HasListStyleName() &&
- !HasBulletNumber() && !HasBulletStyle() && !HasBulletSymbol() && !HasBulletName();
- }
-
- // return the attribute having the valid font and colours: it uses the
- // attributes set in attr and falls back first to attrDefault and then to
- // the text control font/colours for those attributes which are not set
- static wxTextAttrEx CombineEx(const wxTextAttrEx& attr,
- const wxTextAttrEx& attrDef,
- const wxTextCtrlBase *text);
-
-private:
- // Paragraph styles
- int m_paragraphSpacingAfter;
- int m_paragraphSpacingBefore;
- int m_lineSpacing;
- int m_bulletStyle;
- int m_bulletNumber;
- wxChar m_bulletSymbol;
- wxString m_bulletFont;
- wxString m_bulletName;
-
- // Character style
- wxString m_characterStyleName;
-
- // Paragraph style
- wxString m_paragraphStyleName;
-
- // List style
- wxString m_listStyleName;
-};
-
-/*!
- * wxRichTextAttr stores attributes without a wxFont object, so is a much more
- * efficient way to query styles.
- */
-
-class WXDLLIMPEXP_RICHTEXT wxRichTextAttr
-{
-public:
- // ctors
- wxRichTextAttr(const wxTextAttrEx& attr);
- wxRichTextAttr() { Init(); }
- wxRichTextAttr(const wxColour& colText,
- const wxColour& colBack = wxNullColour,
- wxTextAttrAlignment alignment = wxTEXT_ALIGNMENT_DEFAULT);
-
- // Initialise this object.
- void Init();
-
- // Assignment from a wxRichTextAttr object.
- void operator= (const wxRichTextAttr& attr);
-
- // Assignment from a wxTextAttrEx object.
- void operator= (const wxTextAttrEx& attr);
-
- // Equality test
- bool operator== (const wxRichTextAttr& attr) const;
-
- // Making a wxTextAttrEx object.
- operator wxTextAttrEx () const ;
-
- // Copy to a wxTextAttr
- void CopyTo(wxTextAttrEx& attr) const;
-
- // Create font from font attributes.
- wxFont CreateFont() const;
-
- // Get attributes from font.
- bool GetFontAttributes(const wxFont& font);
-
- // setters
- void SetTextColour(const wxColour& colText) { m_colText = colText; m_flags |= wxTEXT_ATTR_TEXT_COLOUR; }
- void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; m_flags |= wxTEXT_ATTR_BACKGROUND_COLOUR; }
- void SetAlignment(wxTextAttrAlignment alignment) { m_textAlignment = alignment; m_flags |= wxTEXT_ATTR_ALIGNMENT; }
- void SetTabs(const wxArrayInt& tabs) { m_tabs = tabs; m_flags |= wxTEXT_ATTR_TABS; }
- void SetLeftIndent(int indent, int subIndent = 0) { m_leftIndent = indent; m_leftSubIndent = subIndent; m_flags |= wxTEXT_ATTR_LEFT_INDENT; }
- void SetRightIndent(int indent) { m_rightIndent = indent; m_flags |= wxTEXT_ATTR_RIGHT_INDENT; }
-
- void SetFontSize(int pointSize) { m_fontSize = pointSize; m_flags |= wxTEXT_ATTR_FONT_SIZE; }
- void SetFontStyle(int fontStyle) { m_fontStyle = fontStyle; m_flags |= wxTEXT_ATTR_FONT_ITALIC; }
- void SetFontWeight(int fontWeight) { m_fontWeight = fontWeight; m_flags |= wxTEXT_ATTR_FONT_WEIGHT; }
- void SetFontFaceName(const wxString& faceName) { m_fontFaceName = faceName; m_flags |= wxTEXT_ATTR_FONT_FACE; }
- void SetFontUnderlined(bool underlined) { m_fontUnderlined = underlined; m_flags |= wxTEXT_ATTR_FONT_UNDERLINE; }
-
- void SetFlags(long flags) { m_flags = flags; }
-
- void SetCharacterStyleName(const wxString& name) { m_characterStyleName = name; m_flags |= wxTEXT_ATTR_CHARACTER_STYLE_NAME; }
- void SetParagraphStyleName(const wxString& name) { m_paragraphStyleName = name; m_flags |= wxTEXT_ATTR_PARAGRAPH_STYLE_NAME; }
- void SetListStyleName(const wxString& name) { m_listStyleName = name; SetFlags(GetFlags() | wxTEXT_ATTR_LIST_STYLE_NAME); }
- void SetParagraphSpacingAfter(int spacing) { m_paragraphSpacingAfter = spacing; m_flags |= wxTEXT_ATTR_PARA_SPACING_AFTER; }
- void SetParagraphSpacingBefore(int spacing) { m_paragraphSpacingBefore = spacing; m_flags |= wxTEXT_ATTR_PARA_SPACING_BEFORE; }
- void SetLineSpacing(int spacing) { m_lineSpacing = spacing; m_flags |= wxTEXT_ATTR_LINE_SPACING; }
- void SetBulletStyle(int style) { m_bulletStyle = style; m_flags |= wxTEXT_ATTR_BULLET_STYLE; }
- void SetBulletNumber(int n) { m_bulletNumber = n; m_flags |= wxTEXT_ATTR_BULLET_NUMBER; }
- void SetBulletSymbol(wxChar symbol) { m_bulletSymbol = symbol; m_flags |= wxTEXT_ATTR_BULLET_NUMBER; }
- void SetBulletFont(const wxString& bulletFont) { m_bulletFont = bulletFont; }
- void SetBulletName(const wxString& name) { m_bulletName = name; }
-
- const wxColour& GetTextColour() const { return m_colText; }
- const wxColour& GetBackgroundColour() const { return m_colBack; }
- wxTextAttrAlignment GetAlignment() const { return m_textAlignment; }
- const wxArrayInt& GetTabs() const { return m_tabs; }
- long GetLeftIndent() const { return m_leftIndent; }
- long GetLeftSubIndent() const { return m_leftSubIndent; }
- long GetRightIndent() const { return m_rightIndent; }
- long GetFlags() const { return m_flags; }
-
- int GetFontSize() const { return m_fontSize; }
- int GetFontStyle() const { return m_fontStyle; }
- int GetFontWeight() const { return m_fontWeight; }
- bool GetFontUnderlined() const { return m_fontUnderlined; }
- const wxString& GetFontFaceName() const { return m_fontFaceName; }
-
- const wxString& GetCharacterStyleName() const { return m_characterStyleName; }
- const wxString& GetParagraphStyleName() const { return m_paragraphStyleName; }
- const wxString& GetListStyleName() const { return m_listStyleName; }
- int GetParagraphSpacingAfter() const { return m_paragraphSpacingAfter; }
- int GetParagraphSpacingBefore() const { return m_paragraphSpacingBefore; }
- int GetLineSpacing() const { return m_lineSpacing; }
- int GetBulletStyle() const { return m_bulletStyle; }
- int GetBulletNumber() const { return m_bulletNumber; }
- wxChar GetBulletSymbol() const { return m_bulletSymbol; }
- const wxString& GetBulletFont() const { return m_bulletFont; }
- const wxString& GetBulletName() const { return m_bulletName; }
-
- // accessors
- bool HasTextColour() const { return m_colText.Ok() && HasFlag(wxTEXT_ATTR_TEXT_COLOUR) ; }
- bool HasBackgroundColour() const { return m_colBack.Ok() && HasFlag(wxTEXT_ATTR_BACKGROUND_COLOUR) ; }
- bool HasAlignment() const { return (m_textAlignment != wxTEXT_ALIGNMENT_DEFAULT) || ((m_flags & wxTEXT_ATTR_ALIGNMENT) != 0) ; }
- bool HasTabs() const { return (m_flags & wxTEXT_ATTR_TABS) != 0 ; }
- bool HasLeftIndent() const { return (m_flags & wxTEXT_ATTR_LEFT_INDENT) != 0 ; }
- bool HasRightIndent() const { return (m_flags & wxTEXT_ATTR_RIGHT_INDENT) != 0 ; }
- bool HasWeight() const { return (m_flags & wxTEXT_ATTR_FONT_WEIGHT) != 0; }
- bool HasSize() const { return (m_flags & wxTEXT_ATTR_FONT_SIZE) != 0; }
- bool HasItalic() const { return (m_flags & wxTEXT_ATTR_FONT_ITALIC) != 0; }
- bool HasUnderlined() const { return (m_flags & wxTEXT_ATTR_FONT_UNDERLINE) != 0; }
- bool HasFaceName() const { return (m_flags & wxTEXT_ATTR_FONT_FACE) != 0; }
- bool HasFont() const { return (m_flags & (wxTEXT_ATTR_FONT)) != 0; }
-
- bool HasParagraphSpacingAfter() const { return (m_flags & wxTEXT_ATTR_PARA_SPACING_AFTER) != 0; }
- bool HasParagraphSpacingBefore() const { return (m_flags & wxTEXT_ATTR_PARA_SPACING_BEFORE) != 0; }
- bool HasLineSpacing() const { return (m_flags & wxTEXT_ATTR_LINE_SPACING) != 0; }
- bool HasCharacterStyleName() const { return (m_flags & wxTEXT_ATTR_CHARACTER_STYLE_NAME) != 0 || !m_characterStyleName.IsEmpty(); }
- bool HasParagraphStyleName() const { return (m_flags & wxTEXT_ATTR_PARAGRAPH_STYLE_NAME) != 0 || !m_paragraphStyleName.IsEmpty(); }
- bool HasListStyleName() const { return HasFlag(wxTEXT_ATTR_LIST_STYLE_NAME) || !m_listStyleName.IsEmpty(); }
- bool HasBulletStyle() const { return (m_flags & wxTEXT_ATTR_BULLET_STYLE) != 0; }
- bool HasBulletNumber() const { return (m_flags & wxTEXT_ATTR_BULLET_NUMBER) != 0; }
- bool HasBulletSymbol() const { return (m_flags & wxTEXT_ATTR_BULLET_SYMBOL) != 0; }
- bool HasBulletName() const { return (m_flags & wxTEXT_ATTR_BULLET_NAME) != 0; }
-
- bool HasFlag(long flag) const { return (m_flags & flag) != 0; }
-
- // Is this a character style?
- bool IsCharacterStyle() const { return (0 != (GetFlags() & (wxTEXT_ATTR_FONT | wxTEXT_ATTR_BACKGROUND_COLOUR | wxTEXT_ATTR_TEXT_COLOUR))); }
- bool IsParagraphStyle() const { return (0 != (GetFlags() & (wxTEXT_ATTR_ALIGNMENT|wxTEXT_ATTR_LEFT_INDENT|wxTEXT_ATTR_RIGHT_INDENT|wxTEXT_ATTR_TABS|
- wxTEXT_ATTR_PARA_SPACING_BEFORE|wxTEXT_ATTR_PARA_SPACING_AFTER|wxTEXT_ATTR_LINE_SPACING|
- wxTEXT_ATTR_BULLET_STYLE|wxTEXT_ATTR_BULLET_NUMBER|wxTEXT_ATTR_BULLET_NAME))); }
-
- // returns false if we have any attributes set, true otherwise
- bool IsDefault() const
- {
- return !HasTextColour() && !HasBackgroundColour() && !HasFont() && !HasAlignment() &&
- !HasTabs() && !HasLeftIndent() && !HasRightIndent() &&
- !HasParagraphSpacingAfter() && !HasParagraphSpacingBefore() && !HasLineSpacing() &&
- !HasCharacterStyleName() && !HasParagraphStyleName() && !HasListStyleName() &&
- !HasBulletNumber() && !HasBulletStyle() && !HasBulletSymbol() && !HasBulletName();
- }
-
- // return the attribute having the valid font and colours: it uses the
- // attributes set in attr and falls back first to attrDefault and then to
- // the text control font/colours for those attributes which are not set
- static wxRichTextAttr Combine(const wxRichTextAttr& attr,
- const wxRichTextAttr& attrDef,
- const wxTextCtrlBase *text);
-private:
- long m_flags;
-
- // Paragraph styles
- wxArrayInt m_tabs; // array of int: tab stops in 1/10 mm
- int m_leftIndent; // left indent in 1/10 mm
- int m_leftSubIndent; // left indent for all but the first
- // line in a paragraph relative to the
- // first line, in 1/10 mm
- int m_rightIndent; // right indent in 1/10 mm
- wxTextAttrAlignment m_textAlignment;
-
- int m_paragraphSpacingAfter;
- int m_paragraphSpacingBefore;
- int m_lineSpacing;
- int m_bulletStyle;
- int m_bulletNumber;
- wxChar m_bulletSymbol;
- wxString m_bulletFont;
- wxString m_bulletName;
-
- // Character styles
- wxColour m_colText,
- m_colBack;
- int m_fontSize;
- int m_fontStyle;
- int m_fontWeight;
- bool m_fontUnderlined;
- wxString m_fontFaceName;
-
- // Character style
- wxString m_characterStyleName;
-
- // Paragraph style
- wxString m_paragraphStyleName;
-
- // List style
- wxString m_listStyleName;
-};
-
-#define wxTEXT_ATTR_CHARACTER (wxTEXT_ATTR_FONT | wxTEXT_ATTR_BACKGROUND_COLOUR | wxTEXT_ATTR_TEXT_COLOUR | wxTEXT_ATTR_CHARACTER_STYLE_NAME)
-
-#define wxTEXT_ATTR_PARAGRAPH (wxTEXT_ATTR_ALIGNMENT|wxTEXT_ATTR_LEFT_INDENT|wxTEXT_ATTR_RIGHT_INDENT|wxTEXT_ATTR_TABS|\
- wxTEXT_ATTR_PARA_SPACING_BEFORE|wxTEXT_ATTR_PARA_SPACING_AFTER|wxTEXT_ATTR_LINE_SPACING|\
- wxTEXT_ATTR_BULLET_STYLE|wxTEXT_ATTR_BULLET_NUMBER|wxTEXT_ATTR_BULLET_SYMBOL|wxTEXT_ATTR_BULLET_NAME|\
- wxTEXT_ATTR_PARAGRAPH_STYLE_NAME|wxTEXT_ATTR_LIST_STYLE_NAME)
-
-#define wxTEXT_ATTR_ALL (wxTEXT_ATTR_CHARACTER|wxTEXT_ATTR_PARAGRAPH)
-
/*!
* wxRichTextObject class declaration
* This is the base for drawable objects.
virtual int GetBottomMargin() const { return m_bottomMargin; }
/// Set attributes object
- void SetAttributes(const wxTextAttrEx& attr) { m_attributes = attr; }
- const wxTextAttrEx& GetAttributes() const { return m_attributes; }
- wxTextAttrEx& GetAttributes() { return m_attributes; }
+ void SetAttributes(const wxTextAttr& attr) { m_attributes = attr; }
+ const wxTextAttr& GetAttributes() const { return m_attributes; }
+ wxTextAttr& GetAttributes() { return m_attributes; }
/// Set/get stored descent
void SetDescent(int descent) { m_descent = descent; }
int GetDescent() const { return m_descent; }
+ /// Gets the containing buffer
+ wxRichTextBuffer* GetBuffer() const;
+
// Operations
/// Clone the object
void Reference() { m_refCount ++; }
void Dereference();
- /// Convert units in tends of a millimetre to device units
+ /// Convert units in tenths of a millimetre to device units
int ConvertTenthsMMToPixels(wxDC& dc, int units);
+ static int ConvertTenthsMMToPixels(int ppi, int units);
protected:
wxSize m_size;
int m_bottomMargin;
/// Attributes
- wxTextAttrEx m_attributes;
+ wxTextAttr m_attributes;
};
WX_DECLARE_LIST_WITH_DECL( wxRichTextObject, wxRichTextObjectList, class WXDLLIMPEXP_RICHTEXT );
virtual void Reset();
/// Convenience function to add a paragraph of text
- virtual wxRichTextRange AddParagraph(const wxString& text, wxTextAttrEx* paraStyle = NULL);
+ virtual wxRichTextRange AddParagraph(const wxString& text, wxTextAttr* paraStyle = NULL);
/// Convenience function to add an image
- virtual wxRichTextRange AddImage(const wxImage& image, wxTextAttrEx* paraStyle = NULL);
+ virtual wxRichTextRange AddImage(const wxImage& image, wxTextAttr* paraStyle = NULL);
/// Adds multiple paragraphs, based on newlines.
- virtual wxRichTextRange AddParagraphs(const wxString& text, wxTextAttrEx* paraStyle = NULL);
+ virtual wxRichTextRange AddParagraphs(const wxString& text, wxTextAttr* 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.
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 wxRichTextAttr& style, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
- virtual bool SetStyle(const wxRichTextRange& range, const wxTextAttrEx& style, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
+ virtual bool SetStyle(const wxRichTextRange& range, const wxTextAttr& style, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
/// Get the conbined text attributes for this position.
- virtual bool GetStyle(long position, wxTextAttrEx& style);
- virtual bool GetStyle(long position, wxRichTextAttr& style);
+ virtual bool GetStyle(long position, wxTextAttr& style);
/// Get the content (uncombined) attributes for this position.
- virtual bool GetUncombinedStyle(long position, wxTextAttrEx& style);
- virtual bool GetUncombinedStyle(long position, wxRichTextAttr& style);
+ virtual bool GetUncombinedStyle(long position, wxTextAttr& style);
/// Implementation helper for GetStyle. If combineStyles is true, combine base, paragraph and
/// context attributes.
- virtual bool DoGetStyle(long position, wxTextAttrEx& style, bool combineStyles = true);
+ virtual bool DoGetStyle(long position, wxTextAttr& 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, wxTextAttrEx& style);
+ virtual bool GetStyleForRange(const wxRichTextRange& range, wxTextAttr& style);
/// Combines 'style' with 'currentStyle' for the purpose of summarising the attributes of a range of
/// content.
- bool CollectStyle(wxTextAttrEx& currentStyle, const wxTextAttrEx& style, long& multipleStyleAttributes);
+ bool CollectStyle(wxTextAttr& currentStyle, const wxTextAttr& style, long& multipleStyleAttributes, int& multipleTextEffectAttributes);
/// Set list style
virtual bool SetListStyle(const wxRichTextRange& range, wxRichTextListStyleDefinition* def, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1);
/// def/defName can be NULL/empty to indicate that the existing list style should be used.
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;
+
/// 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 wxTextAttrEx& style) const;
- virtual bool HasCharacterAttributes(const wxRichTextRange& range, const wxRichTextAttr& style) const;
+ virtual bool HasCharacterAttributes(const wxRichTextRange& range, const wxTextAttr& 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 wxTextAttrEx& style) const;
- virtual bool HasParagraphAttributes(const wxRichTextRange& range, const wxRichTextAttr& style) const;
+ virtual bool HasParagraphAttributes(const wxRichTextRange& range, const wxTextAttr& style) const;
/// Clone
virtual wxRichTextObject* Clone() const { return new wxRichTextParagraphLayoutBox(*this); }
/// Set default style for new content. Setting it to a default attribute
/// makes new content take on the 'basic' style.
- virtual bool SetDefaultStyle(const wxTextAttrEx& style);
+ virtual bool SetDefaultStyle(const wxTextAttr& style);
/// Get default style
- virtual const wxTextAttrEx& GetDefaultStyle() const { return m_defaultAttributes; }
+ virtual const wxTextAttr& GetDefaultStyle() const { return m_defaultAttributes; }
/// Set basic (overall) style
- virtual void SetBasicStyle(const wxTextAttrEx& style) { m_attributes = style; }
- virtual void SetBasicStyle(const wxRichTextAttr& style) { style.CopyTo(m_attributes); }
+ virtual void SetBasicStyle(const wxTextAttr& style) { m_attributes = style; }
/// Get basic (overall) style
- virtual const wxTextAttrEx& GetBasicStyle() const { return m_attributes; }
+ virtual const wxTextAttr& GetBasicStyle() const { return m_attributes; }
/// Invalidate the buffer. With no argument, invalidates whole buffer.
void Invalidate(const wxRichTextRange& invalidRange = wxRICHTEXT_ALL);
protected:
wxRichTextCtrl* m_ctrl;
- wxTextAttrEx m_defaultAttributes;
+ wxTextAttr m_defaultAttributes;
/// The invalidated range that will need full layout
wxRichTextRange m_invalidRange;
public:
// Constructors
- wxRichTextParagraph(wxRichTextObject* parent = NULL, wxTextAttrEx* style = NULL);
- wxRichTextParagraph(const wxString& text, wxRichTextObject* parent = NULL, wxTextAttrEx* style = NULL);
+ wxRichTextParagraph(wxRichTextObject* parent = NULL, wxTextAttr* style = NULL);
+ wxRichTextParagraph(const wxString& text, wxRichTextObject* parent = NULL, wxTextAttr* paraStyle = NULL, wxTextAttr* charStyle = NULL);
virtual ~wxRichTextParagraph();
wxRichTextParagraph(const wxRichTextParagraph& obj): wxRichTextBox() { Copy(obj); }
// Implementation
/// Apply paragraph styles such as centering to the wrapped lines
- virtual void ApplyParagraphStyle(const wxTextAttrEx& attr, const wxRect& rect);
+ virtual void ApplyParagraphStyle(const wxTextAttr& attr, const wxRect& rect);
/// Insert text at the given position
virtual bool InsertText(long pos, const wxString& text);
/// Get combined attributes of the base style, paragraph style and character style. We use this to dynamically
/// retrieve the actual style.
- wxTextAttrEx GetCombinedAttributes(const wxTextAttrEx& contentStyle) const;
+ wxTextAttr GetCombinedAttributes(const wxTextAttr& contentStyle) const;
/// Get combined attributes of the base style and paragraph style.
- wxTextAttrEx GetCombinedAttributes() const;
+ wxTextAttr GetCombinedAttributes() const;
+
+ /// Get the first position from pos that has a line break character.
+ long GetFirstLineBreakPosition(long pos);
/// Create default tabstop array
static void InitDefaultTabs();
public:
// Constructors
- wxRichTextPlainText(const wxString& text = wxEmptyString, wxRichTextObject* parent = NULL, wxTextAttrEx* style = NULL);
+ wxRichTextPlainText(const wxString& text = wxEmptyString, wxRichTextObject* parent = NULL, wxTextAttr* style = NULL);
wxRichTextPlainText(const wxRichTextPlainText& obj): wxRichTextObject() { Copy(obj); }
// Overrideables
/// Dump to output stream for debugging
virtual void Dump(wxTextOutputStream& stream);
+ /// Get the first position from pos that has a line break character.
+ long GetFirstLineBreakPosition(long pos);
+
// Accessors
/// Get the text
/// Clone
virtual wxRichTextObject* Clone() const { return new wxRichTextPlainText(*this); }
private:
- bool DrawTabbedString(wxDC& dc, const wxTextAttrEx& attr, const wxRect& rect, wxString& str, wxCoord& x, wxCoord& y, bool selected);
+ bool DrawTabbedString(wxDC& dc, const wxTextAttr& attr, const wxRect& rect, wxString& str, wxCoord& x, wxCoord& y, bool selected);
protected:
wxString m_text;
* wxRichTextImageBlock stores information about an image, in binary in-memory form
*/
-class WXDLLIMPEXP_BASE wxDataInputStream;
-class WXDLLIMPEXP_BASE wxDataOutputStream;
+class WXDLLIMPEXP_FWD_BASE wxDataInputStream;
+class WXDLLIMPEXP_FWD_BASE wxDataOutputStream;
class WXDLLIMPEXP_RICHTEXT wxRichTextImageBlock: public wxObject
{
bool Ok() const { return IsOk(); }
bool IsOk() const { return GetData() != NULL; }
+ // Gets the extension for the block's type
+ wxString GetExtension() const;
+
/// Implementation
- /// Allocate and read from stream as a block of memory
+ // Allocate and read from stream as a block of memory
static unsigned char* ReadBlock(wxInputStream& stream, size_t size);
static unsigned char* ReadBlock(const wxString& filename, size_t size);
// Constructors
wxRichTextImage(wxRichTextObject* parent = NULL): wxRichTextObject(parent) { }
- wxRichTextImage(const wxImage& image, wxRichTextObject* parent = NULL);
- wxRichTextImage(const wxRichTextImageBlock& imageBlock, wxRichTextObject* parent = NULL);
+ 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); }
// Overrideables
* This is a kind of box, used to represent the whole buffer
*/
-class WXDLLIMPEXP_RICHTEXT wxRichTextCommand;
-class WXDLLIMPEXP_RICHTEXT wxRichTextAction;
+class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextCommand;
+class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextAction;
class WXDLLIMPEXP_RICHTEXT wxRichTextBuffer: public wxRichTextParagraphLayoutBox
{
void SetStyleSheet(wxRichTextStyleSheet* styleSheet) { m_styleSheet = styleSheet; }
virtual wxRichTextStyleSheet* GetStyleSheet() const { return m_styleSheet; }
+ /// Set style sheet and notify of the change
+ bool SetStyleSheetAndNotify(wxRichTextStyleSheet* sheet);
+
/// Push style sheet to top of stack
bool PushStyleSheet(wxRichTextStyleSheet* styleSheet);
/// Pop style sheet from top of stack
wxRichTextStyleSheet* PopStyleSheet();
+ /// Set/get table storing fonts
+ wxRichTextFontTable& GetFontTable() { return m_fontTable; }
+ const wxRichTextFontTable& GetFontTable() const { return m_fontTable; }
+ void SetFontTable(const wxRichTextFontTable& table) { m_fontTable = table; }
+
// Operations
/// Initialisation
void Init();
- /// Clears the buffer and resets the command processor
- virtual void Clear();
-
- /// The same as Clear, and adds an empty paragraph.
- virtual void Reset();
+ /// Clears the buffer, adds an empty paragraph, and clears the command processor.
+ virtual void ResetAndClearCommands();
/// Load a file
virtual bool LoadFile(const wxString& filename, int type = wxRICHTEXT_TYPE_ANY);
/// Save to a stream
virtual bool SaveFile(wxOutputStream& stream, int type = wxRICHTEXT_TYPE_ANY);
+ /// Set the handler flags, controlling loading and saving
+ void SetHandlerFlags(int flags) { m_handlerFlags = flags; }
+
+ /// Get the handler flags, controlling loading and saving
+ int GetHandlerFlags() const { return m_handlerFlags; }
+
/// Convenience function to add a paragraph of text
- virtual wxRichTextRange AddParagraph(const wxString& text, wxTextAttrEx* paraStyle = NULL) { Modify(); return wxRichTextParagraphLayoutBox::AddParagraph(text, paraStyle); }
+ virtual wxRichTextRange AddParagraph(const wxString& text, wxTextAttr* 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
virtual bool CanPasteFromClipboard() const;
/// Begin using a style
- virtual bool BeginStyle(const wxTextAttrEx& style);
+ virtual bool BeginStyle(const wxTextAttr& style);
/// End the style
virtual bool EndStyle();
bool EndNumberedBullet() { return EndStyle(); }
/// Begin symbol bullet
- bool BeginSymbolBullet(wxChar symbol, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_SYMBOL);
+ bool BeginSymbolBullet(const wxString& symbol, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_SYMBOL);
/// End symbol bullet
bool EndSymbolBullet() { return EndStyle(); }
/// End named character style
bool EndListStyle() { return EndStyle(); }
+ /// Begin URL
+ bool BeginURL(const wxString& url, const wxString& characterStyle = wxEmptyString);
+
+ /// End URL
+ bool EndURL() { return EndStyle(); }
+
+// Event handling
+
+ /// Add an event handler
+ bool AddEventHandler(wxEvtHandler* handler);
+
+ /// Remove an event handler
+ bool RemoveEventHandler(wxEvtHandler* handler, bool deleteHandler = false);
+
+ /// 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.
+ bool SendEvent(wxEvent& event, bool sendToAll = true);
+
// Implementation
/// Copy
bool InsertImageWithUndo(long pos, const wxRichTextImageBlock& imageBlock, wxRichTextCtrl* ctrl, int flags = 0);
/// Submit command to delete this range
- bool DeleteRangeWithUndo(const wxRichTextRange& range, long initialCaretPosition, long newCaretPositon, wxRichTextCtrl* ctrl);
+ bool DeleteRangeWithUndo(const wxRichTextRange& range, wxRichTextCtrl* ctrl);
/// Mark modified
void Modify(bool modify = true) { m_modified = modify; }
/// 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.
- wxRichTextAttr GetStyleForNewParagraph(long pos, bool caretPosition = false) const;
+ wxTextAttr GetStyleForNewParagraph(long pos, bool caretPosition = false, bool lookUpNewParaStyle=false) const;
/// Dumps contents of buffer for debugging purposes
virtual void Dump();
/// Initialise the standard handlers
static void InitStandardHandlers();
+ /// Get renderer
+ static wxRichTextRenderer* GetRenderer() { return sm_renderer; }
+
+ /// Set renderer, deleting old one
+ static void SetRenderer(wxRichTextRenderer* renderer);
+
+ /// Minimum margin between bullet and paragraph in 10ths of a mm
+ static int GetBulletRightMargin() { return sm_bulletRightMargin; }
+ static void SetBulletRightMargin(int margin) { sm_bulletRightMargin = margin; }
+
+ /// Factor to multiply by character height to get a reasonable bullet size
+ static float GetBulletProportion() { return sm_bulletProportion; }
+ static void SetBulletProportion(float prop) { sm_bulletProportion = prop; }
+
+ /// Scale factor for calculating dimensions
+ double GetScale() const { return m_scale; }
+ void SetScale(double scale) { m_scale = scale; }
+
protected:
/// Command processor
wxCommandProcessor* m_commandProcessor;
+ /// Table storing fonts
+ wxRichTextFontTable m_fontTable;
+
/// Has been modified?
bool m_modified;
/// Style sheet, if any
wxRichTextStyleSheet* m_styleSheet;
+ /// List of event handlers that will be notified of events
+ wxList m_eventHandlers;
+
/// Stack of attributes for convenience functions
wxList m_attributeStack;
+ /// Flags to be passed to handlers
+ int m_handlerFlags;
+
/// File handlers
static wxList sm_handlers;
+
+ /// Renderer
+ static wxRichTextRenderer* sm_renderer;
+
+ /// Minimum margin between bullet and paragraph in 10ths of a mm
+ static int sm_bulletRightMargin;
+
+ /// Factor to multiply by character height to get a reasonable bullet size
+ static float sm_bulletProportion;
+
+ /// Scaling factor in use: needed to calculate correct dimensions when printing
+ double m_scale;
};
/*!
*
*/
-class WXDLLIMPEXP_RICHTEXT wxRichTextAction;
+class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextAction;
class WXDLLIMPEXP_RICHTEXT wxRichTextCommand: public wxCommand
{
public:
bool Undo();
/// Update the control appearance
- void UpdateAppearance(long caretPosition, bool sendUpdateEvent = false);
+ void UpdateAppearance(long caretPosition, bool sendUpdateEvent = false,
+ wxArrayInt* optimizationLineCharPositions = NULL, wxArrayInt* optimizationLineYPositions = NULL);
/// Replace the buffer paragraphs with the given fragment.
void ApplyParagraphs(const wxRichTextParagraphLayoutBox& fragment);
wxRichTextCommandId m_cmdId;
};
+/*!
+ * Handler flags
+ */
+
+// Include style sheet when loading and saving
+#define wxRICHTEXT_HANDLER_INCLUDE_STYLESHEET 0x0001
+
+// Save images to memory file system in HTML handler
+#define wxRICHTEXT_HANDLER_SAVE_IMAGES_TO_MEMORY 0x0010
+
+// Save images to files in HTML handler
+#define wxRICHTEXT_HANDLER_SAVE_IMAGES_TO_FILES 0x0020
+
+// Save images as inline base64 data in HTML handler
+#define wxRICHTEXT_HANDLER_SAVE_IMAGES_TO_BASE64 0x0040
+
+// Don't write header and footer (or BODY), so we can include the fragment
+// in a larger document
+#define wxRICHTEXT_HANDLER_NO_HEADER_FOOTER 0x0080
+
/*!
* wxRichTextFileHandler
* Base class for file handlers
DECLARE_CLASS(wxRichTextFileHandler)
public:
wxRichTextFileHandler(const wxString& name = wxEmptyString, const wxString& ext = wxEmptyString, int type = 0)
- : m_name(name), m_extension(ext), m_type(type), m_visible(true)
+ : m_name(name), m_extension(ext), m_type(type), m_flags(0), m_visible(true)
{ }
#if wxUSE_STREAMS
{ return DoSaveFile(buffer, stream); }
#endif
- bool LoadFile(wxRichTextBuffer *buffer, const wxString& filename);
- bool SaveFile(wxRichTextBuffer *buffer, const wxString& filename);
+#if wxUSE_FFILE && wxUSE_STREAMS
+ virtual bool LoadFile(wxRichTextBuffer *buffer, const wxString& filename);
+ 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.
virtual bool CanHandle(const wxString& filename) const;
void SetType(int type) { m_type = type; }
int GetType() const { return m_type; }
+ /// Flags controlling how loading and saving is done
+ void SetFlags(int flags) { m_flags = flags; }
+ int GetFlags() const { return m_flags; }
+
/// Encoding to use when saving a file. If empty, a suitable encoding is chosen
void SetEncoding(const wxString& encoding) { m_encoding = encoding; }
const wxString& GetEncoding() const { return m_encoding; }
wxString m_encoding;
wxString m_extension;
int m_type;
+ int m_flags;
bool m_visible;
};
* The data object for a wxRichTextBuffer
*/
-class wxRichTextBufferDataObject: public wxDataObjectSimple
+class WXDLLIMPEXP_RICHTEXT wxRichTextBufferDataObject: public wxDataObjectSimple
{
public:
// ctor doesn't copy the pointer, so it shouldn't go away while this object
#endif
+/*!
+ * wxRichTextRenderer isolates common drawing functionality
+ */
+
+class WXDLLIMPEXP_RICHTEXT wxRichTextRenderer: public wxObject
+{
+public:
+ wxRichTextRenderer() {}
+ 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;
+
+ /// 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;
+
+ /// 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;
+
+ /// Enumerate the standard bullet names currently supported
+ virtual bool EnumerateStandardBulletNames(wxArrayString& bulletNames) = 0;
+};
+
+/*!
+ * wxRichTextStdRenderer: standard renderer
+ */
+
+class WXDLLIMPEXP_RICHTEXT wxRichTextStdRenderer: public wxRichTextRenderer
+{
+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);
+
+ /// 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);
+
+ /// 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);
+
+ /// Enumerate the standard bullet names currently supported
+ virtual bool EnumerateStandardBulletNames(wxArrayString& bulletNames);
+};
+
/*!
* Utilities
*
}
/// Compare two attribute objects
-bool wxTextAttrEq(const wxTextAttrEx& attr1, const wxTextAttrEx& attr2);
-bool wxTextAttrEq(const wxTextAttr& attr1, const wxRichTextAttr& attr2);
+WXDLLIMPEXP_RICHTEXT bool wxTextAttrEq(const wxTextAttr& attr1, const wxTextAttr& attr2);
+WXDLLIMPEXP_RICHTEXT bool wxTextAttrEq(const wxTextAttr& attr1, const wxTextAttr& attr2);
/// Compare two attribute objects, but take into account the flags
/// specifying attributes of interest.
-bool wxTextAttrEqPartial(const wxTextAttrEx& attr1, const wxTextAttrEx& attr2, int flags);
-bool wxTextAttrEqPartial(const wxTextAttrEx& attr1, const wxRichTextAttr& attr2, int flags);
+WXDLLIMPEXP_RICHTEXT bool wxTextAttrEqPartial(const wxTextAttr& attr1, const wxTextAttr& attr2, int flags);
/// Apply one style to another
-bool wxRichTextApplyStyle(wxTextAttrEx& destStyle, const wxTextAttrEx& style);
-bool wxRichTextApplyStyle(wxRichTextAttr& destStyle, const wxTextAttrEx& style);
-bool wxRichTextApplyStyle(wxTextAttrEx& destStyle, const wxRichTextAttr& style, wxRichTextAttr* compareWith = NULL);
+WXDLLIMPEXP_RICHTEXT bool wxRichTextApplyStyle(wxTextAttr& destStyle, const wxTextAttr& style, wxTextAttr* compareWith = NULL);
-/// Compare tabs
-bool wxRichTextTabsEq(const wxArrayInt& tabs1, const wxArrayInt& tabs2);
+// Remove attributes
+WXDLLIMPEXP_RICHTEXT bool wxRichTextRemoveStyle(wxTextAttr& destStyle, const wxTextAttr& style);
-/// Set the font without changing the font attributes
-void wxSetFontPreservingStyles(wxTextAttr& attr, const wxFont& font);
+/// Combine two bitlists
+WXDLLIMPEXP_RICHTEXT bool wxRichTextCombineBitlists(int& valueA, int valueB, int& flagsA, int flagsB);
-/// Convert a decimal to Roman numerals
-wxString wxRichTextDecimalToRoman(long n);
+/// Compare two bitlists
+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);
+
+/// Compare tabs
+WXDLLIMPEXP_RICHTEXT bool wxRichTextTabsEq(const wxArrayInt& tabs1, const wxArrayInt& tabs2);
+
+/// Convert a decimal to Roman numerals
+WXDLLIMPEXP_RICHTEXT wxString wxRichTextDecimalToRoman(long n);
WXDLLIMPEXP_RICHTEXT void wxRichTextModuleInit();
#endif
// _WX_RICHTEXTBUFFER_H_
+
projects / wxWidgets.git / blobdiff