// =========================================================================== // Purpose: wxRichText library // Author: John Labenski // Created: 07/03/2007 // Copyright: (c) 2007 John Labenski. All rights reserved. // Licence: wxWidgets licence // wxWidgets: Updated to 2.8.4 // =========================================================================== // NOTE: This file is mostly copied from wxWidget's include/richtext/*.h headers // to make updating it easier. %if wxLUA_USE_wxRichText && %wxchkver_2_8 && wxUSE_RICHTEXT %include "wx/richtext/richtextbuffer.h" %define wxRICHTEXT_TYPE_ANY %define wxRICHTEXT_TYPE_TEXT %define wxRICHTEXT_TYPE_XML %define wxRICHTEXT_TYPE_HTML %define wxRICHTEXT_TYPE_RTF %define wxRICHTEXT_TYPE_PDF /* %define wxRICHTEXT_FIXED_WIDTH %define wxRICHTEXT_FIXED_HEIGHT %define wxRICHTEXT_VARIABLE_WIDTH %define wxRICHTEXT_VARIABLE_HEIGHT %define wxRICHTEXT_LAYOUT_SPECIFIED_RECT %define wxRICHTEXT_DRAW_IGNORE_CACHE // The point was not on this object %define wxRICHTEXT_HITTEST_NONE // The point was before the position returned from HitTest %define wxRICHTEXT_HITTEST_BEFORE // The point was after the position returned from HitTest %define wxRICHTEXT_HITTEST_AFTER // The point was on the position returned from HitTest %define wxRICHTEXT_HITTEST_ON // The point was on space outside content %define wxRICHTEXT_HITTEST_OUTSIDE // Flags for GetRangeSize %define wxRICHTEXT_FORMATTED %define wxRICHTEXT_UNFORMATTED // Flags for SetStyle/SetListStyle %define wxRICHTEXT_SETSTYLE_NONE // Specifies that this operation should be undoable %define wxRICHTEXT_SETSTYLE_WITH_UNDO // Specifies that the style should not be applied if the // combined style at this point is already the style in question. %define wxRICHTEXT_SETSTYLE_OPTIMIZE // Specifies that the style should only be applied to paragraphs, // and not the content. This allows content styling to be // preserved independently from that of e.g. a named paragraph style. %define wxRICHTEXT_SETSTYLE_PARAGRAPHS_ONLY // Specifies that the style should only be applied to characters, // and not the paragraph. This allows content styling to be // preserved independently from that of e.g. a named paragraph style. %define wxRICHTEXT_SETSTYLE_CHARACTERS_ONLY // For SetListStyle only: specifies starting from the given number, otherwise // deduces number from existing attributes %define wxRICHTEXT_SETSTYLE_RENUMBER // For SetListStyle only: specifies the list level for all paragraphs, otherwise // the current indentation will be used %define wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL // Resets the existing style before applying the new style %define wxRICHTEXT_SETSTYLE_RESET // Removes the given style instead of applying it %define wxRICHTEXT_SETSTYLE_REMOVE // Flags for text insertion %define wxRICHTEXT_INSERT_NONE %define wxRICHTEXT_INSERT_WITH_PREVIOUS_PARAGRAPH_STYLE // Extra formatting flags not in wxTextAttr %define wxTEXT_ATTR_PARA_SPACING_AFTER %define wxTEXT_ATTR_PARA_SPACING_BEFORE %define wxTEXT_ATTR_LINE_SPACING %define wxTEXT_ATTR_CHARACTER_STYLE_NAME %define wxTEXT_ATTR_PARAGRAPH_STYLE_NAME %define wxTEXT_ATTR_LIST_STYLE_NAME %define wxTEXT_ATTR_BULLET_STYLE %define wxTEXT_ATTR_BULLET_NUMBER %define wxTEXT_ATTR_BULLET_TEXT %define wxTEXT_ATTR_BULLET_NAME %define wxTEXT_ATTR_URL %define wxTEXT_ATTR_PAGE_BREAK %define wxTEXT_ATTR_EFFECTS %define wxTEXT_ATTR_OUTLINE_LEVEL // Styles for wxTextAttrEx::SetBulletStyle %define wxTEXT_ATTR_BULLET_STYLE_NONE %define wxTEXT_ATTR_BULLET_STYLE_ARABIC %define wxTEXT_ATTR_BULLET_STYLE_LETTERS_UPPER %define wxTEXT_ATTR_BULLET_STYLE_LETTERS_LOWER %define wxTEXT_ATTR_BULLET_STYLE_ROMAN_UPPER %define wxTEXT_ATTR_BULLET_STYLE_ROMAN_LOWER %define wxTEXT_ATTR_BULLET_STYLE_SYMBOL %define wxTEXT_ATTR_BULLET_STYLE_BITMAP %define wxTEXT_ATTR_BULLET_STYLE_PARENTHESES %define wxTEXT_ATTR_BULLET_STYLE_PERIOD %define wxTEXT_ATTR_BULLET_STYLE_STANDARD %define wxTEXT_ATTR_BULLET_STYLE_RIGHT_PARENTHESIS %define wxTEXT_ATTR_BULLET_STYLE_OUTLINE %define wxTEXT_ATTR_BULLET_STYLE_ALIGN_LEFT %define wxTEXT_ATTR_BULLET_STYLE_ALIGN_RIGHT %define wxTEXT_ATTR_BULLET_STYLE_ALIGN_CENTRE // Styles for wxTextAttrEx::SetTextEffects %define wxTEXT_ATTR_EFFECT_NONE %define wxTEXT_ATTR_EFFECT_CAPITALS %define wxTEXT_ATTR_EFFECT_SMALL_CAPITALS %define wxTEXT_ATTR_EFFECT_STRIKETHROUGH %define wxTEXT_ATTR_EFFECT_DOUBLE_STRIKETHROUGH %define wxTEXT_ATTR_EFFECT_SHADOW %define wxTEXT_ATTR_EFFECT_EMBOSS %define wxTEXT_ATTR_EFFECT_OUTLINE %define wxTEXT_ATTR_EFFECT_ENGRAVE %define wxTEXT_ATTR_EFFECT_SUPERSCRIPT %define wxTEXT_ATTR_EFFECT_SUBSCRIPT // Line spacing values %define wxTEXT_ATTR_LINE_SPACING_NORMAL //10 %define wxTEXT_ATTR_LINE_SPACING_HALF //15 %define wxTEXT_ATTR_LINE_SPACING_TWICE //20 // Character and paragraph combined styles %define wxTEXT_ATTR_CHARACTER //(wxTEXT_ATTR_FONT|wxTEXT_ATTR_EFFECTS|wxTEXT_ATTR_BACKGROUND_COLOUR|wxTEXT_ATTR_TEXT_COLOUR|wxTEXT_ATTR_CHARACTER_STYLE_NAME|wxTEXT_ATTR_URL) %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_TEXT|wxTEXT_ATTR_BULLET_NAME|\ //wxTEXT_ATTR_PARAGRAPH_STYLE_NAME|wxTEXT_ATTR_LIST_STYLE_NAME|wxTEXT_ATTR_OUTLINE_LEVEL) %define wxTEXT_ATTR_ALL //(wxTEXT_ATTR_CHARACTER|wxTEXT_ATTR_PARAGRAPH) %class %delete %noclassinfo %encapsulate wxRichTextRange //#define wxRICHTEXT_ALL wxRichTextRange(-2, -2) // FIXME //#define wxRICHTEXT_NONE wxRichTextRange(-1, -1) // FIXME wxRichTextRange() wxRichTextRange(long start, long end) wxRichTextRange(const wxRichTextRange& range) //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); } //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); } void SetRange(long start, long end) void SetStart(long start) long GetStart() const void SetEnd(long end) long GetEnd() const /// Returns true if this range is completely outside 'range' bool IsOutside(const wxRichTextRange& range) const /// Returns true if this range is completely within 'range' bool IsWithin(const wxRichTextRange& range) const /// Returns true if the given position is within this range. Allow /// for the possibility of an empty range - assume the position /// is within this empty range. NO, I think we should not match with an empty range. // bool Contains(long pos) const { return pos >= m_start && (pos <= m_end || GetLength() == 0); } bool Contains(long pos) const /// Limit this range to be within 'range' bool LimitTo(const wxRichTextRange& range) ; /// Gets the length of the range long GetLength() const /// Swaps the start and end void Swap() /// Convert to internal form: (n, n) is the range of a single character. wxRichTextRange ToInternal() const /// Convert from internal to public API form: (n, n+1) is the range of a single character. wxRichTextRange FromInternal() const %endclass %class %delete %noclassinfo %encapsulate wxTextAttrEx, wxTextAttr wxTextAttrEx(const wxTextAttrEx& attr); wxTextAttrEx(const wxTextAttr& attr) wxTextAttrEx() // Initialise this object //void Init(); // Copy void Copy(const wxTextAttrEx& attr); // 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) void SetParagraphStyleName(const wxString& name) void SetListStyleName(const wxString& name) void SetParagraphSpacingAfter(int spacing) void SetParagraphSpacingBefore(int spacing) void SetLineSpacing(int spacing) void SetBulletStyle(int style) void SetBulletNumber(int n) void SetBulletText(const wxString& text) void SetBulletName(const wxString& name) void SetBulletFont(const wxString& bulletFont) void SetURL(const wxString& url) void SetPageBreak(bool pageBreak = true) void SetTextEffects(int effects) void SetTextEffectFlags(int effects) void SetOutlineLevel(int level) const wxString& GetCharacterStyleName() const const wxString& GetParagraphStyleName() const const wxString& GetListStyleName() const int GetParagraphSpacingAfter() const int GetParagraphSpacingBefore() const int GetLineSpacing() const int GetBulletStyle() const int GetBulletNumber() const const wxString& GetBulletText() const const wxString& GetBulletName() const const wxString& GetBulletFont() const const wxString& GetURL() const int GetTextEffects() const int GetTextEffectFlags() const int GetOutlineLevel() const bool HasFontWeight() const bool HasFontSize() const bool HasFontItalic() const bool HasFontUnderlined() const bool HasFontFaceName() const bool HasParagraphSpacingAfter() const bool HasParagraphSpacingBefore() const bool HasLineSpacing() const bool HasCharacterStyleName() const bool HasParagraphStyleName() const bool HasListStyleName() const bool HasBulletStyle() const bool HasBulletNumber() const bool HasBulletText() const bool HasBulletName() const bool HasURL() const bool HasPageBreak() const bool HasTextEffects() const bool HasTextEffect(int effect) const bool HasOutlineLevel() const // Is this a character style? bool IsCharacterStyle() const bool IsParagraphStyle() const // returns false if we have any attributes set, true otherwise bool IsDefault() const // 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 wxTextCtrl *text); %endclass %class %delete %noclassinfo %encapsulate wxRichTextAttr wxRichTextAttr(const wxTextAttrEx& attr); wxRichTextAttr(const wxRichTextAttr& attr); wxRichTextAttr() { Init(); } wxRichTextAttr(const wxColour& colText, const wxColour& colBack = wxNullColour, wxTextAttrAlignment alignment = wxTEXT_ALIGNMENT_DEFAULT); // Initialise this object. //void Init(); // Copy void Copy(const wxRichTextAttr& attr); // 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 ; // Create font from font attributes. wxFont CreateFont() const; // Get attributes from font. bool GetFontAttributes(const wxFont& font); // setters void SetTextColour(const wxColour& colText) void SetBackgroundColour(const wxColour& colBack) void SetAlignment(wxTextAttrAlignment alignment) void SetTabs(const wxArrayInt& tabs) void SetLeftIndent(int indent, int subIndent = 0) void SetRightIndent(int indent) void SetFontSize(int pointSize) void SetFontStyle(int fontStyle) void SetFontWeight(int fontWeight) void SetFontFaceName(const wxString& faceName) void SetFontUnderlined(bool underlined) void SetFlags(long flags) void SetCharacterStyleName(const wxString& name) void SetParagraphStyleName(const wxString& name) void SetListStyleName(const wxString& name) void SetParagraphSpacingAfter(int spacing) void SetParagraphSpacingBefore(int spacing) void SetLineSpacing(int spacing) void SetBulletStyle(int style) void SetBulletNumber(int n) void SetBulletText(const wxString& text) void SetBulletFont(const wxString& bulletFont) void SetBulletName(const wxString& name) void SetURL(const wxString& url) void SetPageBreak(bool pageBreak = true) void SetTextEffects(int effects) void SetTextEffectFlags(int effects) void SetOutlineLevel(int level) const wxColour& GetTextColour() const const wxColour& GetBackgroundColour() const wxTextAttrAlignment GetAlignment() const const wxArrayInt& GetTabs() const long GetLeftIndent() const long GetLeftSubIndent() const long GetRightIndent() const long GetFlags() const int GetFontSize() const int GetFontStyle() const int GetFontWeight() const bool GetFontUnderlined() const const wxString& GetFontFaceName() const const wxString& GetCharacterStyleName() const const wxString& GetParagraphStyleName() const const wxString& GetListStyleName() const int GetParagraphSpacingAfter() const int GetParagraphSpacingBefore() const int GetLineSpacing() const int GetBulletStyle() const int GetBulletNumber() const const wxString& GetBulletText() const const wxString& GetBulletFont() const const wxString& GetBulletName() const const wxString& GetURL() const int GetTextEffects() const int GetTextEffectFlags() const int GetOutlineLevel() const // accessors bool HasTextColour() const bool HasBackgroundColour() const bool HasAlignment() const bool HasTabs() const bool HasLeftIndent() const bool HasRightIndent() const bool HasFontWeight() const bool HasFontSize() const bool HasFontItalic() const bool HasFontUnderlined() const bool HasFontFaceName() const bool HasFont() const bool HasParagraphSpacingAfter() const bool HasParagraphSpacingBefore() const bool HasLineSpacing() const bool HasCharacterStyleName() const bool HasParagraphStyleName() const bool HasListStyleName() const bool HasBulletStyle() const bool HasBulletNumber() const bool HasBulletText() const bool HasBulletName() const bool HasURL() const bool HasPageBreak() const bool HasTextEffects() const bool HasTextEffect(int effect) const bool HasOutlineLevel() const bool HasFlag(long flag) const // Is this a character style? bool IsCharacterStyle() const bool IsParagraphStyle() const // returns false if we have any attributes set, true otherwise bool IsDefault() const // Merges the given attributes. Does not affect 'this'. 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); // Merges the given attributes and returns the result. Does not affect 'this'. 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. wxRichTextAttr Combine(const wxRichTextAttr& style, const wxRichTextAttr* compareWith = NULL) const; %endclass %class %delete wxRichTextObject, wxObject // No constructor - base class //wxRichTextObject(wxRichTextObject* parent = NULL); // Overrideables /// Draw the item, within the given range. Some objects may ignore the range (for /// example paragraphs) while others must obey it (lines, to implement wrapping) virtual bool Draw(wxDC& dc, const wxRichTextRange& range, const wxRichTextRange& selectionRange, const wxRect& rect, int descent, int style) //= 0; /// Lay the item out at the specified position with the given size constraint. /// Layout must set the cached size. virtual bool Layout(wxDC& dc, const wxRect& rect, int style) //= 0; /// Hit-testing: returns a flag indicating hit test details, plus /// information about position virtual int HitTest(wxDC& dc, const wxPoint& pt, long& textPosition) /// Finds the absolute position and row height for the given character position virtual bool FindPosition(wxDC& dc, long index, wxPoint& pt, int* height, bool forceLineStart) /// Get the best size, i.e. the ideal starting size for this object irrespective /// of available space. For a short text string, it will be the size that exactly encloses /// the text. For a longer string, it might use the parent width for example. virtual wxSize GetBestSize() const /// Get the object size for the given range. Returns false if the range /// is invalid for this object. virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, int flags, wxPoint position /* = wxPoint(0,0) */ ) const //= 0; /// Do a split, returning an object containing the second part, and setting /// the first part in 'this'. virtual wxRichTextObject* DoSplit(long pos) /// Calculate range. By default, guess that the object is 1 unit long. virtual void CalculateRange(long start, long& end) /// Delete range virtual bool DeleteRange(const wxRichTextRange& range) /// Returns true if the object is empty virtual bool IsEmpty() const /// Get any text in this object for the given range virtual wxString GetTextForRange(const wxRichTextRange& range) const /// Returns true if this object can merge itself with the given one. virtual bool CanMerge(wxRichTextObject* object) const /// Returns true if this object merged itself with the given one. /// The calling code will then delete the given object. virtual bool Merge(wxRichTextObject* object) /// Dump to output stream for debugging //virtual void Dump(wxTextOutputStream& stream); // Accessors /// Get/set the cached object size as calculated by Layout. virtual wxSize GetCachedSize() const virtual void SetCachedSize(const wxSize& sz) /// Get/set the object position virtual wxPoint GetPosition() const virtual void SetPosition(const wxPoint& pos) /// Get the rectangle enclosing the object virtual wxRect GetRect() const /// Set the range void SetRange(const wxRichTextRange& range) /// Get the range const wxRichTextRange& GetRange() const wxRichTextRange& GetRange() /// Get/set dirty flag (whether the object needs Layout to be called) virtual bool GetDirty() const virtual void SetDirty(bool dirty) /// Is this composite? virtual bool IsComposite() const /// Get/set the parent. virtual wxRichTextObject* GetParent() const virtual void SetParent(wxRichTextObject* parent) /// Set the margin around the object virtual void SetMargins(int margin); virtual void SetMargins(int leftMargin, int rightMargin, int topMargin, int bottomMargin); virtual int GetLeftMargin() const virtual int GetRightMargin() const virtual int GetTopMargin() const virtual int GetBottomMargin() const /// Set attributes object void SetAttributes(const wxTextAttrEx& attr) const wxTextAttrEx& GetAttributes() const wxTextAttrEx& GetAttributes() /// Set/get stored descent void SetDescent(int descent) int GetDescent() const /// Gets the containing buffer wxRichTextBuffer* GetBuffer() const; // Operations /// Clone the object virtual wxRichTextObject* Clone() const /// Copy void Copy(const wxRichTextObject& obj); /// Reference-counting allows us to use the same object in multiple /// lists (not yet used) void Reference() void Dereference(); /// Convert units in tenths of a millimetre to device units int ConvertTenthsMMToPixels(wxDC& dc, int units); static int ConvertTenthsMMToPixels(int ppi, int units); %endclass //WX_DECLARE_LIST_WITH_DECL( wxRichTextObject, wxRichTextObjectList, class WXDLLIMPEXP_RICHTEXT ); %class wxRichTextCompositeObject, wxRichTextObject wxRichTextCompositeObject(wxRichTextObject* parent = NULL); // Accessors /// Get the children //wxRichTextObjectList& GetChildren() //const wxRichTextObjectList& GetChildren() const /// Get the child count size_t GetChildCount() const ; /// Get the nth child wxRichTextObject* GetChild(size_t n) const ; /// Get/set dirty flag virtual bool GetDirty() const virtual void SetDirty(bool dirty) /// Is this composite? virtual bool IsComposite() const /// Returns true if the buffer is empty virtual bool IsEmpty() const // Operations /// Copy void Copy(const wxRichTextCompositeObject& obj); /// Assignment //void operator= (const wxRichTextCompositeObject& obj) { Copy(obj); } /// Append a child, returning the position size_t AppendChild(wxRichTextObject* child) ; /// Insert the child in front of the given object, or at the beginning bool InsertChild(wxRichTextObject* child, wxRichTextObject* inFrontOf) ; /// Delete the child bool RemoveChild(wxRichTextObject* child, bool deleteChild = false) ; /// Delete all children bool DeleteChildren() ; /// Recursively merge all pieces that can be merged. bool Defragment(); %endclass %class %delete wxRichTextBox, wxRichTextCompositeObject wxRichTextBox(wxRichTextObject* parent = NULL); wxRichTextBox(const wxRichTextBox& obj) // Accessors // Operations /// Clone virtual wxRichTextObject* Clone() const /// Copy void Copy(const wxRichTextBox& obj); %endclass /*! * wxRichTextParagraphBox class declaration * This box knows how to lay out paragraphs. */ %class %delete wxRichTextParagraphLayoutBox, wxRichTextBox wxRichTextParagraphLayoutBox(wxRichTextObject* parent = NULL); wxRichTextParagraphLayoutBox(const wxRichTextParagraphLayoutBox& obj) // Accessors /// Associate a control with the buffer, for operations that for example require refreshing the window. void SetRichTextCtrl(wxRichTextCtrl* ctrl) /// Get the associated control. wxRichTextCtrl* GetRichTextCtrl() const /// Get/set whether the last paragraph is partial or complete void SetPartialParagraph(bool partialPara) bool GetPartialParagraph() const /// If this is a buffer, returns the current style sheet. The base layout box /// class doesn't have an associated style sheet. virtual wxRichTextStyleSheet* GetStyleSheet() const // Operations /// Initialize the object. void Init(); /// Clear all children virtual void Clear(); /// Clear and initialize with one blank paragraph virtual void Reset(); /// Convenience function to add a paragraph of text virtual wxRichTextRange AddParagraph(const wxString& text, wxTextAttrEx* paraStyle = NULL); /// Convenience function to add an image virtual wxRichTextRange AddImage(const wxImage& image, wxTextAttrEx* paraStyle = NULL); /// Adds multiple paragraphs, based on newlines. virtual wxRichTextRange AddParagraphs(const wxString& text, wxTextAttrEx* 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 wxRichTextLine* GetLineAtPosition(long pos, bool caretPosition = false) const; /// Get the line at the given y pixel position, or the last line. virtual wxRichTextLine* GetLineAtYPosition(int y) const; /// Get the paragraph at the given character or caret position virtual wxRichTextParagraph* GetParagraphAtPosition(long pos, bool caretPosition = false) const; /// Get the line size at the given position virtual wxSize GetLineSizeAtPosition(long pos, bool caretPosition = false) const; /// Given a position, get the number of the visible line (potentially many to a paragraph), /// starting from zero at the start of the buffer. We also have to pass a bool (startOfLine) /// that indicates whether the caret is being shown at the end of the previous line or at the start /// of the next, since the caret can be shown at 2 visible positions for the same underlying /// position. virtual long GetVisibleLineNumber(long pos, bool caretPosition = false, bool startOfLine = false) const; /// Given a line number, get the corresponding wxRichTextLine object. virtual wxRichTextLine* GetLineForVisibleLineNumber(long lineNumber) const; /// Get the leaf object in a paragraph at this position. /// Given a line number, get the corresponding wxRichTextLine object. virtual wxRichTextObject* GetLeafObjectAtPosition(long position) const; /// Get the paragraph by number virtual wxRichTextParagraph* GetParagraphAtLine(long paragraphNumber) const; /// Get the paragraph for a given line virtual wxRichTextParagraph* GetParagraphForLine(wxRichTextLine* line) const; /// Get the length of the paragraph virtual int GetParagraphLength(long paragraphNumber) const; /// Get the number of paragraphs virtual int GetParagraphCount() const /// Get the number of visible lines virtual int GetLineCount() const; /// Get the text of the paragraph virtual wxString GetParagraphText(long paragraphNumber) const; /// Convert zero-based line column and paragraph number to a position. virtual long XYToPosition(long x, long y) const; /// Convert zero-based position to line column and paragraph 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); /// Get the conbined text attributes for this position. virtual bool GetStyle(long position, wxTextAttrEx& style); virtual bool GetStyle(long position, wxRichTextAttr& style); /// Get the content (uncombined) attributes for this position. virtual bool GetUncombinedStyle(long position, wxTextAttrEx& 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, wxTextAttrEx& 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); /// 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, 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); virtual bool SetListStyle(const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1); /// Clear list for given range virtual bool ClearListStyle(const wxRichTextRange& range, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO); /// Number/renumber any list elements in the given range. /// def/defName can be NULL/empty to indicate that the existing list style should be used. virtual bool NumberList(const wxRichTextRange& range, wxRichTextListStyleDefinition* def = NULL, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1); virtual bool NumberList(const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1); /// Promote the list items within the given range. promoteBy can be a positive or negative number, e.g. 1 or -1 /// def/defName can be NULL/empty to indicate that the existing list style should be used. virtual bool PromoteList(int promoteBy, const wxRichTextRange& range, wxRichTextListStyleDefinition* def = NULL, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int specifiedLevel = -1); virtual bool PromoteList(int promoteBy, const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int specifiedLevel = -1); /// Helper for NumberList and PromoteList, that does renumbering and promotion simultaneously /// 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, 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 wxTextAttrEx& 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 wxTextAttrEx& style) const; virtual bool HasParagraphAttributes(const wxRichTextRange& range, const wxRichTextAttr& style) const; /// Clone virtual wxRichTextObject* Clone() const /// Insert fragment into this box at the given position. If partialParagraph is true, /// it is assumed that the last (or only) paragraph is just a piece of data with no paragraph /// marker. virtual bool InsertFragment(long position, wxRichTextParagraphLayoutBox& fragment); /// Make a copy of the fragment corresponding to the given range, putting it in 'fragment'. virtual bool CopyFragment(const wxRichTextRange& range, wxRichTextParagraphLayoutBox& fragment); /// Apply the style sheet to the buffer, for example if the styles have changed. virtual bool ApplyStyleSheet(wxRichTextStyleSheet* styleSheet); /// Copy void Copy(const wxRichTextParagraphLayoutBox& obj); /// Assignment //void operator= (const wxRichTextParagraphLayoutBox& obj) { Copy(obj); } /// Calculate ranges virtual void UpdateRanges() /// Get all the text virtual wxString GetText() const; /// 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); /// Get default style virtual const wxTextAttrEx& GetDefaultStyle() const /// Set basic (overall) style virtual void SetBasicStyle(const wxTextAttrEx& style) virtual void SetBasicStyle(const wxRichTextAttr& style) /// Get basic (overall) style virtual const wxTextAttrEx& GetBasicStyle() const /// Invalidate the buffer. With no argument, invalidates whole buffer. void Invalidate(const wxRichTextRange& invalidRange = wxRICHTEXT_ALL); /// Get invalid range, rounding to entire paragraphs if argument is true. wxRichTextRange GetInvalidRange(bool wholeParagraphs = false) const; %endclass /*! * wxRichTextLine class declaration * This object represents a line in a paragraph, and stores * offsets from the start of the paragraph representing the * start and end positions of the line. */ %class %delete %encapsulate %noclassinfo wxRichTextLine wxRichTextLine(wxRichTextParagraph* parent); wxRichTextLine(const wxRichTextLine& obj) // Overrideables // Accessors /// Set the range void SetRange(const wxRichTextRange& range) void SetRange(long from, long to) /// Get the parent paragraph wxRichTextParagraph* GetParent() /// Get the range const wxRichTextRange& GetRange() const wxRichTextRange& GetRange() /// Get the absolute range wxRichTextRange GetAbsoluteRange() const; /// Get/set the line size as calculated by Layout. virtual wxSize GetSize() const virtual void SetSize(const wxSize& sz) /// Get/set the object position relative to the parent virtual wxPoint GetPosition() const virtual void SetPosition(const wxPoint& pos) /// Get the absolute object position virtual wxPoint GetAbsolutePosition() const; /// Get the rectangle enclosing the line virtual wxRect GetRect() const /// Set/get stored descent void SetDescent(int descent) int GetDescent() const // Operations /// Initialisation void Init(wxRichTextParagraph* parent); /// Copy void Copy(const wxRichTextLine& obj); /// Clone virtual wxRichTextLine* Clone() const %endclass //WX_DECLARE_LIST_WITH_DECL( wxRichTextLine, wxRichTextLineList , class WXDLLIMPEXP_RICHTEXT ); /*! * wxRichTextParagraph class declaration * This object represents a single paragraph (or in a straight text editor, a line). */ %class %delete wxRichTextParagraph, wxRichTextBox wxRichTextParagraph(wxRichTextObject* parent = NULL, wxTextAttrEx* style = NULL); wxRichTextParagraph(const wxString& text, wxRichTextObject* parent = NULL, wxTextAttrEx* paraStyle = NULL, wxTextAttrEx* charStyle = NULL); wxRichTextParagraph(const wxRichTextParagraph& obj) // Accessors /// Get the cached lines //wxRichTextLineList& GetLines() // Operations /// Copy void Copy(const wxRichTextParagraph& obj); /// Clone virtual wxRichTextObject* Clone() const /// Clear the cached lines void ClearLines(); // Implementation /// Apply paragraph styles such as centering to the wrapped lines virtual void ApplyParagraphStyle(const wxTextAttrEx& attr, const wxRect& rect); /// Insert text at the given position virtual bool InsertText(long pos, const wxString& text); /// Split an object at this position if necessary, and return /// the previous object, or NULL if inserting at beginning. virtual wxRichTextObject* SplitAt(long pos, wxRichTextObject** previousObject = NULL); /// Move content to a list from this point virtual void MoveToList(wxRichTextObject* obj, wxList& list); /// Add content back from list virtual void MoveFromList(wxList& list); /// Get the plain text searching from the start or end of the range. /// The resulting string may be shorter than the range given. bool GetContiguousPlainText(wxString& text, const wxRichTextRange& range, bool fromStart = true); /// Find a suitable wrap position. wrapPosition is the last position in the line to the left /// of the split. bool FindWrapPosition(const wxRichTextRange& range, wxDC& dc, int availableSpace, long& wrapPosition); /// Find the object at the given position wxRichTextObject* FindObjectAtPosition(long position); /// Get the bullet text for this paragraph. wxString GetBulletText(); /// Allocate or reuse a line object wxRichTextLine* AllocateLine(int pos); /// Clear remaining unused line objects, if any bool ClearUnusedLines(int lineCount); /// 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; /// Get combined attributes of the base style and paragraph style. wxTextAttrEx 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(); /// Clear default tabstop array static void ClearDefaultTabs(); /// Get default tabstop array static const wxArrayInt& GetDefaultTabs() %endclass /*! * wxRichTextPlainText class declaration * This object represents a single piece of text. */ %class %delete wxRichTextPlainText, wxRichTextObject wxRichTextPlainText(const wxString& text = wxEmptyString, wxRichTextObject* parent = NULL, wxTextAttrEx* style = NULL); wxRichTextPlainText(const wxRichTextPlainText& obj) // Accessors /// Get the text const wxString& GetText() const /// Set the text void SetText(const wxString& text) // Operations /// Copy void Copy(const wxRichTextPlainText& obj); /// Clone virtual wxRichTextObject* Clone() const %endclass /*! * wxRichTextImageBlock stores information about an image, in binary in-memory form */ %class %delete wxRichTextImageBlock, wxObject wxRichTextImageBlock(); wxRichTextImageBlock(const wxRichTextImageBlock& block); void Init(); void Clear(); // Load the original image into a memory block. // If the image is not a JPEG, we must convert it into a JPEG // to conserve space. // If it's not a JPEG we can make use of 'image', already scaled, so we don't have to // load the image a 2nd time. virtual bool MakeImageBlock(const wxString& filename, int 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); // Write to a file bool Write(const wxString& filename); // Write data in hex to a stream bool WriteHex(wxOutputStream& stream); // Read data in hex from a stream bool ReadHex(wxInputStream& stream, int length, int imageType); // Copy from 'block' void Copy(const wxRichTextImageBlock& block); // Load a wxImage from the block bool Load(wxImage& image); //// Operators //void operator=(const wxRichTextImageBlock& block); //// Accessors unsigned char* GetData() const size_t GetDataSize() const int GetImageType() const void SetData(unsigned char* image) void SetDataSize(size_t size) void SetImageType(int imageType) bool Ok() const bool IsOk() const // Gets the extension for the block's type wxString GetExtension() const; /// Implementation // 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); // Write memory block to stream static bool WriteBlock(wxOutputStream& stream, unsigned char* block, size_t size); // Write memory block to file static bool WriteBlock(const wxString& filename, unsigned char* block, size_t size); %endclass /*! * wxRichTextImage class declaration * This object represents an image. */ %class %delete wxRichTextImage, wxRichTextObject wxRichTextImage(wxRichTextObject* parent = NULL): wxRichTextObject(parent) wxRichTextImage(const wxImage& image, wxRichTextObject* parent = NULL, wxTextAttrEx* charStyle = NULL); wxRichTextImage(const wxRichTextImageBlock& imageBlock, wxRichTextObject* parent = NULL, wxTextAttrEx* charStyle = NULL); wxRichTextImage(const wxRichTextImage& obj) // Accessors /// Get the image const wxImage& GetImage() const /// Set the image void SetImage(const wxImage& image) /// Get the image block containing the raw data wxRichTextImageBlock& GetImageBlock() // Operations /// Copy void Copy(const wxRichTextImage& obj); /// Clone virtual wxRichTextObject* Clone() const /// Load wxImage from the block virtual bool LoadFromBlock(); /// Make block from the wxImage virtual bool MakeBlock(); %endclass /*! * wxRichTextBuffer class declaration * This is a kind of box, used to represent the whole buffer */ %class %delete wxRichTextBuffer, wxRichTextParagraphLayoutBox wxRichTextBuffer() wxRichTextBuffer(const wxRichTextBuffer& obj) // Accessors /// Gets the command processor wxCommandProcessor* GetCommandProcessor() const /// Set style sheet, if any. void SetStyleSheet(wxRichTextStyleSheet* styleSheet) virtual wxRichTextStyleSheet* GetStyleSheet() const /// 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(); // Operations /// Initialisation void Init(); /// 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 a file virtual bool SaveFile(const wxString& filename, int type = wxRICHTEXT_TYPE_ANY); /// Load from a stream virtual bool LoadFile(wxInputStream& stream, 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) /// Get the handler flags, controlling loading and saving int GetHandlerFlags() const /// Convenience function to add a paragraph of text virtual wxRichTextRange AddParagraph(const wxString& text, wxTextAttrEx* paraStyle = NULL) /// Begin collapsing undo/redo commands. Note that this may not work properly /// if combining commands that delete or insert content, changing ranges for /// subsequent actions. virtual bool BeginBatchUndo(const wxString& cmdName); /// End collapsing undo/redo commands virtual bool EndBatchUndo(); /// Collapsing commands? virtual bool BatchingUndo() const /// Submit immediately, or delay according to whether collapsing is on virtual bool SubmitAction(wxRichTextAction* action); /// Get collapsed command virtual wxRichTextCommand* GetBatchedCommand() const /// Begin suppressing undo/redo commands. The way undo is suppressed may be implemented /// differently by each command. If not dealt with by a command implementation, then /// it will be implemented automatically by not storing the command in the undo history /// when the action is submitted to the command processor. virtual bool BeginSuppressUndo(); /// End suppressing undo/redo commands. virtual bool EndSuppressUndo(); /// Collapsing commands? virtual bool SuppressingUndo() const /// Copy the range to the clipboard virtual bool CopyToClipboard(const wxRichTextRange& range); /// Paste the clipboard content to the buffer virtual bool PasteFromClipboard(long position); /// Can we paste from the clipboard? virtual bool CanPasteFromClipboard() const; /// Begin using a style virtual bool BeginStyle(const wxTextAttrEx& style); /// End the style virtual bool EndStyle(); /// End all styles virtual bool EndAllStyles(); /// Clear the style stack virtual void ClearStyleStack(); /// Get the size of the style stack, for example to check correct nesting virtual size_t GetStyleStackSize() const /// Begin using bold bool BeginBold(); /// End using bold bool EndBold() /// Begin using italic bool BeginItalic(); /// End using italic bool EndItalic() /// Begin using underline bool BeginUnderline(); /// End using underline bool EndUnderline() /// Begin using point size bool BeginFontSize(int pointSize); /// End using point size bool EndFontSize() /// Begin using this font bool BeginFont(const wxFont& font); /// End using a font bool EndFont() /// Begin using this colour bool BeginTextColour(const wxColour& colour); /// End using a colour bool EndTextColour() /// Begin using alignment bool BeginAlignment(wxTextAttrAlignment alignment); /// End alignment bool EndAlignment() /// Begin left indent bool BeginLeftIndent(int leftIndent, int leftSubIndent = 0); /// End left indent bool EndLeftIndent() /// Begin right indent bool BeginRightIndent(int rightIndent); /// End right indent bool EndRightIndent() /// Begin paragraph spacing bool BeginParagraphSpacing(int before, int after); /// End paragraph spacing bool EndParagraphSpacing() /// Begin line spacing bool BeginLineSpacing(int lineSpacing); /// End line spacing bool EndLineSpacing() { return EndStyle(); } /// Begin numbered bullet bool BeginNumberedBullet(int bulletNumber, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_ARABIC|wxTEXT_ATTR_BULLET_STYLE_PERIOD); /// End numbered bullet bool EndNumberedBullet() /// Begin symbol bullet bool BeginSymbolBullet(const wxString& symbol, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_SYMBOL); /// End symbol bullet bool EndSymbolBullet() /// Begin standard bullet bool BeginStandardBullet(const wxString& bulletName, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_STANDARD); /// End standard bullet bool EndStandardBullet() /// Begin named character style bool BeginCharacterStyle(const wxString& characterStyle); /// End named character style bool EndCharacterStyle() /// Begin named paragraph style bool BeginParagraphStyle(const wxString& paragraphStyle); /// End named character style bool EndParagraphStyle() /// Begin named list style bool BeginListStyle(const wxString& listStyle, int level = 1, int number = 1); /// End named character style bool EndListStyle() /// Begin URL bool BeginURL(const wxString& url, const wxString& characterStyle = wxEmptyString); /// End URL bool EndURL() // 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 void Copy(const wxRichTextBuffer& obj); /// Clone virtual wxRichTextObject* Clone() const /// Submit command to insert paragraphs bool InsertParagraphsWithUndo(long pos, const wxRichTextParagraphLayoutBox& paragraphs, wxRichTextCtrl* ctrl, int flags = 0); /// Submit command to insert the given text bool InsertTextWithUndo(long pos, const wxString& text, wxRichTextCtrl* ctrl, int flags = 0); /// Submit command to insert a newline 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); /// Submit command to delete this range bool DeleteRangeWithUndo(const wxRichTextRange& range, wxRichTextCtrl* ctrl); /// Mark modified void Modify(bool modify = true) bool IsModified() const /// 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, bool lookUpNewParaStyle=false) const; /// Dumps contents of buffer for debugging purposes virtual void Dump(); //virtual void Dump(wxTextOutputStream& stream) /// Returns the file handlers static wxList& GetHandlers() /// Adds a handler to the end static void AddHandler(wxRichTextFileHandler *handler); /// Inserts a handler at the front static void InsertHandler(wxRichTextFileHandler *handler); /// Removes a handler static bool RemoveHandler(const wxString& name); /// Finds a handler by name static wxRichTextFileHandler *FindHandler(const wxString& name); /// Finds a handler by extension and type static wxRichTextFileHandler *FindHandler(const wxString& extension, int imageType); /// Finds a handler by filename or, if supplied, type static wxRichTextFileHandler *FindHandlerFilenameOrType(const wxString& filename, int imageType); /// Finds a handler by type static wxRichTextFileHandler *FindHandler(int imageType); /// Gets a wildcard incorporating all visible handlers. If 'types' is present, /// will be filled with the file type corresponding to each filter. This can be /// used to determine the type to pass to LoadFile given a selected filter. static wxString GetExtWildcard(bool combine = false, bool save = false, wxArrayInt* types = NULL); /// Clean up handlers static void CleanUpHandlers(); /// Initialise the standard handlers static void InitStandardHandlers(); /// Get renderer static wxRichTextRenderer* GetRenderer() /// Set renderer, deleting old one static void SetRenderer(wxRichTextRenderer* renderer); /// Minimum margin between bullet and paragraph in 10ths of a mm static int GetBulletRightMargin() static void SetBulletRightMargin(int margin) /// Factor to multiply by character height to get a reasonable bullet size static float GetBulletProportion() static void SetBulletProportion(float prop) /// Scale factor for calculating dimensions double GetScale() const void SetScale(double scale) %endclass /*! * The command identifiers * */ %enum wxRichTextCommandId wxRICHTEXT_INSERT, wxRICHTEXT_DELETE, wxRICHTEXT_CHANGE_STYLE %endenum /*! * Command classes for undo/redo * */ %class %delete wxRichTextCommand, wxCommand wxRichTextCommand(const wxString& name, wxRichTextCommandId id, wxRichTextBuffer* buffer, wxRichTextCtrl* ctrl, bool ignoreFirstTime = false); // Ctor for multiple actions wxRichTextCommand(const wxString& name); bool Do(); bool Undo(); void AddAction(wxRichTextAction* action); void ClearActions(); wxList& GetActions() %endclass /*! * wxRichTextAction class declaration * There can be more than one action in a command. */ %class %delete wxRichTextAction, wxObject wxRichTextAction(wxRichTextCommand* cmd, const wxString& name, wxRichTextCommandId id, wxRichTextBuffer* buffer, wxRichTextCtrl* ctrl, bool ignoreFirstTime = false); bool Do(); bool Undo(); /// Update the control appearance 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); /// Get the fragments wxRichTextParagraphLayoutBox& GetNewParagraphs() wxRichTextParagraphLayoutBox& GetOldParagraphs() /// Set/get the position used for e.g. insertion void SetPosition(long pos) long GetPosition() const /// Set/get the range for e.g. deletion void SetRange(const wxRichTextRange& range) const wxRichTextRange& GetRange() const /// Get name const wxString& GetName() const %endclass /*! * Handler flags */ // Include style sheet when loading and saving %define wxRICHTEXT_HANDLER_INCLUDE_STYLESHEET // Save images to memory file system in HTML handler %define wxRICHTEXT_HANDLER_SAVE_IMAGES_TO_MEMORY // Save images to files in HTML handler %define wxRICHTEXT_HANDLER_SAVE_IMAGES_TO_FILES // Save images as inline base64 data in HTML handler %define wxRICHTEXT_HANDLER_SAVE_IMAGES_TO_BASE64 // Don't write header and footer (or BODY), so we can include the fragment // in a larger document %define wxRICHTEXT_HANDLER_NO_HEADER_FOOTER /*! * wxRichTextFileHandler * Base class for file handlers */ %class %delete wxRichTextFileHandler, wxObject wxRichTextFileHandler(const wxString& name = wxEmptyString, const wxString& ext = wxEmptyString, int type = 0) %if wxUSE_STREAMS bool LoadFile(wxRichTextBuffer *buffer, wxInputStream& stream) bool SaveFile(wxRichTextBuffer *buffer, wxOutputStream& stream) %endif // wxUSE_STREAMS bool LoadFile(wxRichTextBuffer *buffer, const wxString& filename); bool SaveFile(wxRichTextBuffer *buffer, const wxString& filename); /// Can we handle this filename (if using files)? By default, checks the extension. virtual bool CanHandle(const wxString& filename) const; /// Can we save using this handler? virtual bool CanSave() const /// Can we load using this handler? virtual bool CanLoad() const /// Should this handler be visible to the user? virtual bool IsVisible() const virtual void SetVisible(bool visible) /// The name of the nandler void SetName(const wxString& name) wxString GetName() const /// The default extension to recognise void SetExtension(const wxString& ext) wxString GetExtension() const /// The handler type void SetType(int type) int GetType() const /// Flags controlling how loading and saving is done void SetFlags(int flags) int GetFlags() const /// Encoding to use when saving a file. If empty, a suitable encoding is chosen void SetEncoding(const wxString& encoding) const wxString& GetEncoding() const %endclass /*! * wxRichTextPlainTextHandler * Plain text handler */ %class %delete wxRichTextPlainTextHandler, wxRichTextFileHandler wxRichTextPlainTextHandler(const wxString& name = wxT("Text"), const wxString& ext = wxT("txt"), int type = wxRICHTEXT_TYPE_TEXT) %endclass %if wxUSE_DATAOBJ /*! * The data object for a wxRichTextBuffer */ %class %delete wxRichTextBufferDataObject, wxDataObjectSimple // ctor doesn't copy the pointer, so it shouldn't go away while this object // is alive wxRichTextBufferDataObject(wxRichTextBuffer* richTextBuffer = (wxRichTextBuffer*) NULL); // after a call to this function, the buffer is owned by the caller and it // is responsible for deleting it wxRichTextBuffer* GetRichTextBuffer(); // Returns the id for the new data format static const wxChar* GetRichTextBufferFormatId() // base class pure virtuals virtual wxDataFormat GetPreferredFormat(Direction dir) const; virtual size_t GetDataSize() const; virtual bool GetDataHere(void *pBuf) const; virtual bool SetData(size_t len, const void *buf); // prevent warnings virtual size_t GetDataSize(const wxDataFormat&) const virtual bool GetDataHere(const wxDataFormat&, void *buf) const virtual bool SetData(const wxDataFormat&, size_t len, const void *buf) %endclass %endif /*! * wxRichTextRenderer isolates common drawing functionality */ %class %delete %noclassinfo wxRichTextRenderer, wxObject //wxRichTextRenderer() {} /// Draw a standard bullet, as specified by the value of GetBulletName virtual bool DrawStandardBullet(wxRichTextParagraph* paragraph, wxDC& dc, const wxTextAttrEx& 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 wxTextAttrEx& 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 wxTextAttrEx& attr, const wxRect& rect) //= 0; /// Enumerate the standard bullet names currently supported virtual bool EnumerateStandardBulletNames(wxArrayString& bulletNames) // = 0; %endclass /*! * wxRichTextStdRenderer: standard renderer */ %class %delete %noclassinfo wxRichTextStdRenderer, wxRichTextRenderer wxRichTextStdRenderer() {} /// Draw a standard bullet, as specified by the value of GetBulletName //virtual bool DrawStandardBullet(wxRichTextParagraph* paragraph, wxDC& dc, const wxTextAttrEx& 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 wxTextAttrEx& 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 wxTextAttrEx& attr, const wxRect& rect); /// Enumerate the standard bullet names currently supported //virtual bool EnumerateStandardBulletNames(wxArrayString& bulletNames); %endclass /*! * Utilities * */ %function bool wxRichTextHasStyle(int flags, int style) /// Compare two attribute objects %function bool wxTextAttrEq(const wxTextAttrEx& attr1, const wxTextAttrEx& attr2); %function bool wxTextAttrEq(const wxTextAttr& attr1, const wxRichTextAttr& attr2); /// Compare two attribute objects, but take into account the flags /// specifying attributes of interest. %function bool wxTextAttrEqPartial(const wxTextAttrEx& attr1, const wxTextAttrEx& attr2, int flags); %function bool wxTextAttrEqPartial(const wxTextAttrEx& attr1, const wxRichTextAttr& attr2, int flags); /// Apply one style to another %function bool wxRichTextApplyStyle(wxTextAttrEx& destStyle, const wxTextAttrEx& style); %function bool wxRichTextApplyStyle(wxRichTextAttr& destStyle, const wxTextAttrEx& style); %function bool wxRichTextApplyStyle(wxTextAttrEx& destStyle, const wxRichTextAttr& style, wxRichTextAttr* compareWith = NULL); %function bool wxRichTextApplyStyle(wxRichTextAttr& destStyle, const wxRichTextAttr& style, wxRichTextAttr* compareWith = NULL); // Remove attributes %function bool wxRichTextRemoveStyle(wxTextAttrEx& destStyle, const wxRichTextAttr& style); /// Combine two bitlists %function bool wxRichTextCombineBitlists(int& valueA, int valueB, int& flagsA, int flagsB); /// Compare two bitlists %function bool wxRichTextBitlistsEqPartial(int valueA, int valueB, int flags); /// Split into paragraph and character styles %function bool wxRichTextSplitParaCharStyles(const wxTextAttrEx& style, wxTextAttrEx& parStyle, wxTextAttrEx& charStyle); /// Compare tabs %function bool wxRichTextTabsEq(const wxArrayInt& tabs1, const wxArrayInt& tabs2); /// Set the font without changing the font attributes %function void wxSetFontPreservingStyles(wxTextAttr& attr, const wxFont& font); /// Convert a decimal to Roman numerals %function wxString wxRichTextDecimalToRoman(long n); */ %endif // wxLUA_USE_wxRichText && %wxchkver_2_8 && wxUSE_RICHTEXT