Version: 3.1.2
wxRichTextBuffer Class Reference

#include <wx/richtext/richtextbuffer.h>

+ Inheritance diagram for wxRichTextBuffer:

Detailed Description

This is a kind of paragraph layout box, used to represent the whole buffer.

Library:  wxRichText
Category:  Rich Text
See also
wxRichTextParagraphLayoutBox, wxRichTextCtrl

Public Member Functions

 wxRichTextBuffer ()
 Default constructor. More...
 
 wxRichTextBuffer (const wxRichTextBuffer &obj)
 Copy constructor. More...
 
virtual ~wxRichTextBuffer ()
 
wxCommandProcessorGetCommandProcessor () const
 Returns the command processor. More...
 
void SetStyleSheet (wxRichTextStyleSheet *styleSheet)
 Sets style sheet, if any. More...
 
virtual wxRichTextStyleSheetGetStyleSheet () const
 Returns the style sheet. More...
 
bool SetStyleSheetAndNotify (wxRichTextStyleSheet *sheet)
 Sets the style sheet and sends a notification of the change. More...
 
bool PushStyleSheet (wxRichTextStyleSheet *styleSheet)
 Pushes the style sheet to the top of the style sheet stack. More...
 
wxRichTextStyleSheetPopStyleSheet ()
 Pops the style sheet from the top of the style sheet stack. More...
 
wxRichTextFontTableGetFontTable ()
 Returns the table storing fonts, for quick access and font reuse. More...
 
const wxRichTextFontTableGetFontTable () const
 Returns the table storing fonts, for quick access and font reuse. More...
 
void SetFontTable (const wxRichTextFontTable &table)
 Sets table storing fonts, for quick access and font reuse. More...
 
void SetFontScale (double fontScale)
 Sets the scale factor for displaying fonts, for example for more comfortable editing. More...
 
double GetFontScale () const
 Returns the scale factor for displaying fonts, for example for more comfortable editing. More...
 
void SetDimensionScale (double dimScale)
 Sets the scale factor for displaying certain dimensions such as indentation and inter-paragraph spacing. More...
 
double GetDimensionScale () const
 Returns the scale factor for displaying certain dimensions such as indentation and inter-paragraph spacing. More...
 
void Init ()
 Initialisation. More...
 
virtual void ResetAndClearCommands ()
 Clears the buffer, adds an empty paragraph, and clears the command processor. More...
 
void SetHandlerFlags (int flags)
 Sets the handler flags, controlling loading and saving. More...
 
int GetHandlerFlags () const
 Gets the handler flags, controlling loading and saving. More...
 
virtual wxRichTextRange AddParagraph (const wxString &text, wxRichTextAttr *paraStyle=NULL)
 Convenience function to add a paragraph of text. More...
 
virtual bool BeginBatchUndo (const wxString &cmdName)
 Begin collapsing undo/redo commands. More...
 
virtual bool EndBatchUndo ()
 End collapsing undo/redo commands. More...
 
virtual bool BatchingUndo () const
 Returns true if we are collapsing commands. More...
 
virtual bool SubmitAction (wxRichTextAction *action)
 Submit the action immediately, or delay according to whether collapsing is on. More...
 
virtual wxRichTextCommandGetBatchedCommand () const
 Returns the collapsed command. More...
 
virtual bool BeginSuppressUndo ()
 Begin suppressing undo/redo commands. More...
 
virtual bool EndSuppressUndo ()
 End suppressing undo/redo commands. More...
 
virtual bool SuppressingUndo () const
 Are we suppressing undo?? More...
 
virtual bool CopyToClipboard (const wxRichTextRange &range)
 Copy the range to the clipboard. More...
 
virtual bool PasteFromClipboard (long position)
 Paste the clipboard content to the buffer. More...
 
virtual bool CanPasteFromClipboard () const
 Returns true if we can paste from the clipboard. More...
 
virtual bool BeginStyle (const wxRichTextAttr &style)
 Begin using a style. More...
 
virtual bool EndStyle ()
 End the style. More...
 
virtual bool EndAllStyles ()
 End all styles. More...
 
virtual void ClearStyleStack ()
 Clears the style stack. More...
 
virtual size_t GetStyleStackSize () const
 Returns the size of the style stack, for example to check correct nesting. More...
 
bool BeginBold ()
 Begins using bold. More...
 
bool EndBold ()
 Ends using bold. More...
 
bool BeginItalic ()
 Begins using italic. More...
 
bool EndItalic ()
 Ends using italic. More...
 
bool BeginUnderline ()
 Begins using underline. More...
 
bool EndUnderline ()
 Ends using underline. More...
 
bool BeginFontSize (int pointSize)
 Begins using point size. More...
 
bool EndFontSize ()
 Ends using point size. More...
 
bool BeginFont (const wxFont &font)
 Begins using this font. More...
 
bool EndFont ()
 Ends using a font. More...
 
bool BeginTextColour (const wxColour &colour)
 Begins using this colour. More...
 
bool EndTextColour ()
 Ends using a colour. More...
 
bool BeginAlignment (wxTextAttrAlignment alignment)
 Begins using alignment. More...
 
bool EndAlignment ()
 Ends alignment. More...
 
bool BeginLeftIndent (int leftIndent, int leftSubIndent=0)
 Begins using leftIndent for the left indent, and optionally leftSubIndent for the sub-indent. More...
 
bool EndLeftIndent ()
 Ends left indent. More...
 
bool BeginRightIndent (int rightIndent)
 Begins a right indent, specified in tenths of a millimetre. More...
 
bool EndRightIndent ()
 Ends right indent. More...
 
bool BeginParagraphSpacing (int before, int after)
 Begins paragraph spacing; pass the before-paragraph and after-paragraph spacing in tenths of a millimetre. More...
 
bool EndParagraphSpacing ()
 Ends paragraph spacing. More...
 
bool BeginLineSpacing (int lineSpacing)
 Begins line spacing using the specified value. More...
 
bool EndLineSpacing ()
 Ends line spacing. More...
 
bool BeginNumberedBullet (int bulletNumber, int leftIndent, int leftSubIndent, int bulletStyle=wxTEXT_ATTR_BULLET_STYLE_ARABIC|wxTEXT_ATTR_BULLET_STYLE_PERIOD)
 Begins numbered bullet. More...
 
bool EndNumberedBullet ()
 Ends numbered bullet. More...
 
bool BeginSymbolBullet (const wxString &symbol, int leftIndent, int leftSubIndent, int bulletStyle=wxTEXT_ATTR_BULLET_STYLE_SYMBOL)
 Begins applying a symbol bullet, using a character from the current font. More...
 
bool EndSymbolBullet ()
 Ends symbol bullet. More...
 
bool BeginStandardBullet (const wxString &bulletName, int leftIndent, int leftSubIndent, int bulletStyle=wxTEXT_ATTR_BULLET_STYLE_STANDARD)
 Begins applying a standard bullet, using one of the standard bullet names (currently standard/circle or standard/square. More...
 
bool EndStandardBullet ()
 Ends standard bullet. More...
 
bool BeginCharacterStyle (const wxString &characterStyle)
 Begins named character style. More...
 
bool EndCharacterStyle ()
 Ends named character style. More...
 
bool BeginParagraphStyle (const wxString &paragraphStyle)
 Begins named paragraph style. More...
 
bool EndParagraphStyle ()
 Ends named character style. More...
 
bool BeginListStyle (const wxString &listStyle, int level=1, int number=1)
 Begins named list style. More...
 
bool EndListStyle ()
 Ends named character style. More...
 
bool BeginURL (const wxString &url, const wxString &characterStyle=wxEmptyString)
 Begins applying wxTEXT_ATTR_URL to the content. More...
 
bool EndURL ()
 Ends URL. More...
 
bool AddEventHandler (wxEvtHandler *handler)
 Adds an event handler. More...
 
bool RemoveEventHandler (wxEvtHandler *handler, bool deleteHandler=false)
 Removes an event handler from the buffer's list of handlers, deleting the object if deleteHandler is true. More...
 
void ClearEventHandlers ()
 Clear event handlers. More...
 
bool SendEvent (wxEvent &event, bool sendToAll=true)
 Send event to event handlers. More...
 
virtual int HitTest (wxDC &dc, wxRichTextDrawingContext &context, const wxPoint &pt, long &textPosition, wxRichTextObject **obj, wxRichTextObject **contextObj, int flags=0)
 Hit-testing: returns a flag indicating hit test details, plus information about position. More...
 
void Copy (const wxRichTextBuffer &obj)
 Copies the buffer. More...
 
void operator= (const wxRichTextBuffer &obj)
 Assignment operator. More...
 
virtual wxRichTextObjectClone () const
 Clones the buffer. More...
 
bool InsertParagraphsWithUndo (long pos, const wxRichTextParagraphLayoutBox &paragraphs, wxRichTextCtrl *ctrl, int flags=0)
 Submits a command to insert paragraphs. More...
 
bool InsertTextWithUndo (long pos, const wxString &text, wxRichTextCtrl *ctrl, int flags=0)
 Submits a command to insert the given text. More...
 
bool InsertNewlineWithUndo (long pos, wxRichTextCtrl *ctrl, int flags=0)
 Submits a command to insert a newline. More...
 
bool InsertImageWithUndo (long pos, const wxRichTextImageBlock &imageBlock, wxRichTextCtrl *ctrl, int flags=0, const wxRichTextAttr &textAttr=wxRichTextAttr())
 Submits a command to insert the given image. More...
 
wxRichTextObjectInsertObjectWithUndo (long pos, wxRichTextObject *object, wxRichTextCtrl *ctrl, int flags)
 Submits a command to insert an object. More...
 
bool DeleteRangeWithUndo (const wxRichTextRange &range, wxRichTextCtrl *ctrl)
 Submits a command to delete this range. More...
 
void Modify (bool modify=true)
 Mark modified. More...
 
bool IsModified () const
 Returns true if the buffer was modified. More...
 
double GetScale () const
 Returns the scale factor for calculating dimensions. More...
 
void SetScale (double scale)
 Sets the scale factor for calculating dimensions. More...
 
virtual bool LoadFile (const wxString &filename, wxRichTextFileType type=wxRICHTEXT_TYPE_ANY)
 Loads content from a stream or file. More...
 
virtual bool LoadFile (wxInputStream &stream, wxRichTextFileType type=wxRICHTEXT_TYPE_ANY)
 Loads content from a stream or file. More...
 
virtual bool SaveFile (const wxString &filename, wxRichTextFileType type=wxRICHTEXT_TYPE_ANY)
 Saves content to a stream or file. More...
 
virtual bool SaveFile (wxOutputStream &stream, wxRichTextFileType type=wxRICHTEXT_TYPE_ANY)
 Saves content to a stream or file. More...
 
virtual void Dump ()
 Dumps contents of buffer for debugging purposes. More...
 
virtual void Dump (wxTextOutputStream &stream)
 Dumps contents of buffer for debugging purposes. More...
 
- Public Member Functions inherited from wxRichTextParagraphLayoutBox
 wxRichTextParagraphLayoutBox (wxRichTextObject *parent=NULL)
 
 wxRichTextParagraphLayoutBox (const wxRichTextParagraphLayoutBox &obj)
 
 ~wxRichTextParagraphLayoutBox ()
 
virtual bool Draw (wxDC &dc, wxRichTextDrawingContext &context, const wxRichTextRange &range, const wxRichTextSelection &selection, const wxRect &rect, int descent, int style)
 Draw the item, within the given range. More...
 
virtual bool Layout (wxDC &dc, wxRichTextDrawingContext &context, const wxRect &rect, const wxRect &parentRect, int style)
 Lay the item out at the specified position with the given size constraint. More...
 
virtual bool GetRangeSize (const wxRichTextRange &range, wxSize &size, int &descent, wxDC &dc, wxRichTextDrawingContext &context, int flags, const wxPoint &position=wxPoint(0, 0), const wxSize &parentSize=wxDefaultSize, wxArrayInt *partialExtents=NULL) const
 Returns the object size for the given range. More...
 
virtual bool DeleteRange (const wxRichTextRange &range)
 Deletes the given range. More...
 
virtual wxString GetTextForRange (const wxRichTextRange &range) const
 Returns any text in this object for the given range. More...
 
virtual bool ImportFromXML (wxRichTextBuffer *buffer, wxXmlNode *node, wxRichTextXMLHandler *handler, bool *recurse)
 Imports this object from XML. More...
 
virtual wxString GetXMLNodeName () const
 Returns the XML node name of this object. More...
 
virtual bool AcceptsFocus () const
 Returns true if objects of this class can accept the focus, i.e. a call to SetFocusObject is possible. More...
 
void SetRichTextCtrl (wxRichTextCtrl *ctrl)
 Associates a control with the buffer, for operations that for example require refreshing the window. More...
 
wxRichTextCtrlGetRichTextCtrl () const
 Returns the associated control. More...
 
void SetPartialParagraph (bool partialPara)
 Sets a flag indicating whether the last paragraph is partial or complete. More...
 
bool GetPartialParagraph () const
 Returns a flag indicating whether the last paragraph is partial or complete. More...
 
virtual bool IsTopLevel () const
 Returns true if this object is top-level, i.e. contains its own paragraphs, such as a text box. More...
 
bool InsertParagraphsWithUndo (wxRichTextBuffer *buffer, long pos, const wxRichTextParagraphLayoutBox &paragraphs, wxRichTextCtrl *ctrl, int flags=0)
 Submits a command to insert paragraphs. More...
 
bool InsertTextWithUndo (wxRichTextBuffer *buffer, long pos, const wxString &text, wxRichTextCtrl *ctrl, int flags=0)
 Submits a command to insert the given text. More...
 
bool InsertNewlineWithUndo (wxRichTextBuffer *buffer, long pos, wxRichTextCtrl *ctrl, int flags=0)
 Submits a command to insert the given text. More...
 
bool InsertImageWithUndo (wxRichTextBuffer *buffer, long pos, const wxRichTextImageBlock &imageBlock, wxRichTextCtrl *ctrl, int flags, const wxRichTextAttr &textAttr)
 Submits a command to insert the given image. More...
 
wxRichTextFieldInsertFieldWithUndo (wxRichTextBuffer *buffer, long pos, const wxString &fieldType, const wxRichTextProperties &properties, wxRichTextCtrl *ctrl, int flags, const wxRichTextAttr &textAttr)
 Submits a command to insert the given field. More...
 
wxRichTextAttr GetStyleForNewParagraph (wxRichTextBuffer *buffer, long pos, bool caretPosition=false, bool lookUpNewParaStyle=false) const
 Returns the style that is appropriate for a new paragraph at this position. More...
 
wxRichTextObjectInsertObjectWithUndo (wxRichTextBuffer *buffer, long pos, wxRichTextObject *object, wxRichTextCtrl *ctrl, int flags=0)
 Inserts an object. More...
 
bool DeleteRangeWithUndo (const wxRichTextRange &range, wxRichTextCtrl *ctrl, wxRichTextBuffer *buffer)
 Submits a command to delete this range. More...
 
void DrawFloats (wxDC &dc, wxRichTextDrawingContext &context, const wxRichTextRange &range, const wxRichTextSelection &selection, const wxRect &rect, int descent, int style)
 Draws the floating objects in this buffer. More...
 
void MoveAnchoredObjectToParagraph (wxRichTextParagraph *from, wxRichTextParagraph *to, wxRichTextObject *obj)
 Moves an anchored object to another paragraph. More...
 
void Init ()
 Initializes the object. More...
 
virtual void Clear ()
 Clears all the children. More...
 
virtual void Reset ()
 Clears and initializes with one blank paragraph. More...
 
virtual wxRichTextRange AddImage (const wxImage &image, wxRichTextAttr *paraStyle=NULL)
 Convenience function to add an image. More...
 
virtual wxRichTextRange AddParagraphs (const wxString &text, wxRichTextAttr *paraStyle=NULL)
 Adds multiple paragraphs, based on newlines. More...
 
virtual wxRichTextLineGetLineAtPosition (long pos, bool caretPosition=false) const
 Returns the line at the given position. More...
 
virtual wxRichTextLineGetLineAtYPosition (int y) const
 Returns the line at the given y pixel position, or the last line. More...
 
virtual wxRichTextParagraphGetParagraphAtPosition (long pos, bool caretPosition=false) const
 Returns the paragraph at the given character or caret position. More...
 
virtual wxSize GetLineSizeAtPosition (long pos, bool caretPosition=false) const
 Returns the line size at the given position. More...
 
virtual long GetVisibleLineNumber (long pos, bool caretPosition=false, bool startOfLine=false) const
 Given a position, returns the number of the visible line (potentially many to a paragraph), starting from zero at the start of the buffer. More...
 
virtual wxRichTextLineGetLineForVisibleLineNumber (long lineNumber) const
 Given a line number, returns the corresponding wxRichTextLine object. More...
 
virtual wxRichTextObjectGetLeafObjectAtPosition (long position) const
 Returns the leaf object in a paragraph at this position. More...
 
virtual wxRichTextParagraphGetParagraphAtLine (long paragraphNumber) const
 Returns the paragraph by number. More...
 
virtual wxRichTextParagraphGetParagraphForLine (wxRichTextLine *line) const
 Returns the paragraph for a given line. More...
 
virtual int GetParagraphLength (long paragraphNumber) const
 Returns the length of the paragraph. More...
 
virtual int GetParagraphCount () const
 Returns the number of paragraphs. More...
 
virtual int GetLineCount () const
 Returns the number of visible lines. More...
 
virtual wxString GetParagraphText (long paragraphNumber) const
 Returns the text of the paragraph. More...
 
virtual long XYToPosition (long x, long y) const
 Converts zero-based line column and paragraph number to a position. More...
 
virtual bool PositionToXY (long pos, long *x, long *y) const
 Converts a zero-based position to line column and paragraph number. More...
 
virtual bool SetStyle (const wxRichTextRange &range, const wxRichTextAttr &style, int flags=wxRICHTEXT_SETSTYLE_WITH_UNDO)
 Sets the attributes for the given range. More...
 
virtual void SetStyle (wxRichTextObject *obj, const wxRichTextAttr &textAttr, int flags=wxRICHTEXT_SETSTYLE_WITH_UNDO)
 Sets the attributes for the given object only, for example the box attributes for a text box. More...
 
virtual bool GetStyle (long position, wxRichTextAttr &style)
 Returns the combined text attributes for this position. More...
 
virtual bool GetUncombinedStyle (long position, wxRichTextAttr &style)
 Returns the content (uncombined) attributes for this position. More...
 
virtual bool DoGetStyle (long position, wxRichTextAttr &style, bool combineStyles=true)
 Implementation helper for GetStyle. More...
 
virtual bool GetStyleForRange (const wxRichTextRange &range, wxRichTextAttr &style)
 This function gets a style representing the common, combined attributes in the given range. More...
 
bool CollectStyle (wxRichTextAttr &currentStyle, const wxRichTextAttr &style, wxRichTextAttr &clashingAttr, wxRichTextAttr &absentAttr)
 Combines style with currentStyle for the purpose of summarising the attributes of a range of content. More...
 
virtual bool ClearListStyle (const wxRichTextRange &range, int flags=wxRICHTEXT_SETSTYLE_WITH_UNDO)
 Clears the list style from the given range, clearing list-related attributes and applying any named paragraph style associated with each paragraph. More...
 
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)
 Helper for NumberList and PromoteList, that does renumbering and promotion simultaneously def can be NULL/empty to indicate that the existing list style should be used. More...
 
virtual bool FindNextParagraphNumber (wxRichTextParagraph *previousParagraph, wxRichTextAttr &attr) const
 Fills in the attributes for numbering a paragraph after previousParagraph. More...
 
virtual bool SetProperties (const wxRichTextRange &range, const wxRichTextProperties &properties, int flags=wxRICHTEXT_SETPROPERTIES_WITH_UNDO)
 Sets the properties for the given range, passing flags to determine how the attributes are set. More...
 
virtual bool SetObjectPropertiesWithUndo (wxRichTextObject &obj, const wxRichTextProperties &properties, wxRichTextObject *objToSet=NULL)
 Sets with undo the properties for the given object. More...
 
virtual bool HasCharacterAttributes (const wxRichTextRange &range, const wxRichTextAttr &style) const
 Test if this whole range has character attributes of the specified kind. More...
 
virtual bool HasParagraphAttributes (const wxRichTextRange &range, const wxRichTextAttr &style) const
 Test if this whole range has paragraph attributes of the specified kind. More...
 
virtual void PrepareContent (wxRichTextParagraphLayoutBox &container)
 Prepares the content just before insertion (or after buffer reset). More...
 
virtual bool InsertFragment (long position, wxRichTextParagraphLayoutBox &fragment)
 Insert fragment into this box at the given position. More...
 
virtual bool CopyFragment (const wxRichTextRange &range, wxRichTextParagraphLayoutBox &fragment)
 Make a copy of the fragment corresponding to the given range, putting it in fragment. More...
 
virtual bool ApplyStyleSheet (wxRichTextStyleSheet *styleSheet)
 Apply the style sheet to the buffer, for example if the styles have changed. More...
 
void Copy (const wxRichTextParagraphLayoutBox &obj)
 
void operator= (const wxRichTextParagraphLayoutBox &obj)
 
virtual void UpdateRanges ()
 Calculate ranges. More...
 
virtual wxString GetText () const
 Get all the text. More...
 
virtual bool SetDefaultStyle (const wxRichTextAttr &style)
 Sets the default style, affecting the style currently being applied (for example, setting the default style to bold will cause subsequently inserted text to be bold). More...
 
virtual const wxRichTextAttrGetDefaultStyle () const
 Returns the current default style, affecting the style currently being applied (for example, setting the default style to bold will cause subsequently inserted text to be bold). More...
 
virtual void SetBasicStyle (const wxRichTextAttr &style)
 Sets the basic (overall) style. More...
 
virtual const wxRichTextAttrGetBasicStyle () const
 Returns the basic (overall) style. More...
 
virtual void Invalidate (const wxRichTextRange &invalidRange=wxRICHTEXT_ALL)
 Invalidates the buffer. More...
 
virtual void DoInvalidate (const wxRichTextRange &invalidRange)
 Do the (in)validation for this object only. More...
 
virtual void InvalidateHierarchy (const wxRichTextRange &invalidRange=wxRICHTEXT_ALL)
 Do the (in)validation both up and down the hierarchy. More...
 
virtual bool UpdateFloatingObjects (const wxRect &availableRect, wxRichTextObject *untilObj=NULL)
 Gather information about floating objects. More...
 
wxRichTextRange GetInvalidRange (bool wholeParagraphs=false) const
 Get invalid range, rounding to entire paragraphs if argument is true. More...
 
bool IsDirty () const
 Returns true if this object needs layout. More...
 
wxRichTextFloatCollector * GetFloatCollector ()
 Returns the wxRichTextFloatCollector of this object. More...
 
int GetFloatingObjectCount () const
 Returns the number of floating objects at this level. More...
 
bool GetFloatingObjects (wxRichTextObjectList &objects) const
 Returns a list of floating objects. More...
 
virtual bool SetListStyle (const wxRichTextRange &range, wxRichTextListStyleDefinition *def, int flags=wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom=1, int specifiedLevel=-1)
 Sets the list attributes for the given range, passing flags to determine how the attributes are set. More...
 
virtual bool SetListStyle (const wxRichTextRange &range, const wxString &defName, int flags=wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom=1, int specifiedLevel=-1)
 Sets the list attributes for the given range, passing flags to determine how the attributes are set. More...
 
virtual bool NumberList (const wxRichTextRange &range, wxRichTextListStyleDefinition *def=NULL, int flags=wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom=1, int specifiedLevel=-1)
 Numbers the paragraphs in the given range. More...
 
virtual bool NumberList (const wxRichTextRange &range, const wxString &defName, int flags=wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom=1, int specifiedLevel=-1)
 Numbers the paragraphs in the given range. More...
 
virtual bool PromoteList (int promoteBy, const wxRichTextRange &range, wxRichTextListStyleDefinition *def=NULL, int flags=wxRICHTEXT_SETSTYLE_WITH_UNDO, int specifiedLevel=-1)
 Promotes the list items within the given range. More...
 
virtual bool PromoteList (int promoteBy, const wxRichTextRange &range, const wxString &defName, int flags=wxRICHTEXT_SETSTYLE_WITH_UNDO, int specifiedLevel=-1)
 Promotes the list items within the given range. More...
 
- Public Member Functions inherited from wxRichTextCompositeObject
 wxRichTextCompositeObject (wxRichTextObject *parent=NULL)
 
virtual ~wxRichTextCompositeObject ()
 
virtual bool FindPosition (wxDC &dc, wxRichTextDrawingContext &context, long index, wxPoint &pt, int *height, bool forceLineStart)
 Finds the absolute position and row height for the given character position. More...
 
virtual void CalculateRange (long start, long &end)
 Calculates the range of the object. More...
 
wxRichTextObjectList & GetChildren ()
 Returns the children. More...
 
const wxRichTextObjectList & GetChildren () const
 Returns the children. More...
 
size_t GetChildCount () const
 Returns the number of children. More...
 
wxRichTextObjectGetChild (size_t n) const
 Returns the nth child. More...
 
virtual bool IsComposite () const
 Returns true if this object is composite. More...
 
virtual bool IsAtomic () const
 Returns true if no user editing can be done inside the object. More...
 
virtual bool IsEmpty () const
 Returns true if the buffer is empty. More...
 
virtual wxRichTextObjectGetChildAtPosition (long pos) const
 Returns the child object at the given character position. More...
 
void Copy (const wxRichTextCompositeObject &obj)
 
void operator= (const wxRichTextCompositeObject &obj)
 
size_t AppendChild (wxRichTextObject *child)
 Appends a child, returning the position. More...
 
bool InsertChild (wxRichTextObject *child, wxRichTextObject *inFrontOf)
 Inserts the child in front of the given object, or at the beginning. More...
 
bool RemoveChild (wxRichTextObject *child, bool deleteChild=false)
 Removes and optionally deletes the specified child. More...
 
bool DeleteChildren ()
 Deletes all the children. More...
 
bool Defragment (wxRichTextDrawingContext &context, const wxRichTextRange &range=wxRICHTEXT_ALL)
 Recursively merges all pieces that can be merged. More...
 
virtual void Move (const wxPoint &pt)
 Moves the object recursively, by adding the offset from old to new. More...
 
- Public Member Functions inherited from wxRichTextObject
 wxRichTextObject (wxRichTextObject *parent=NULL)
 Constructor, taking an optional parent pointer. More...
 
virtual ~wxRichTextObject ()
 
virtual wxSize GetBestSize () const
 Returns the best size, i.e. the ideal starting size for this object irrespective of available space. More...
 
virtual wxRichTextObjectDoSplit (long pos)
 Do a split from pos, returning an object containing the second part, and setting the first part in 'this'. More...
 
virtual bool IsFloatable () const
 Returns true if this class of object is floatable. More...
 
virtual bool IsFloating () const
 Returns true if this object is currently floating. More...
 
virtual int GetFloatDirection () const
 Returns the floating direction. More...
 
virtual bool CanMerge (wxRichTextObject *object, wxRichTextDrawingContext &context) const
 Returns true if this object can merge itself with the given one. More...
 
virtual bool Merge (wxRichTextObject *object, wxRichTextDrawingContext &context)
 Returns true if this object merged itself with the given one. More...
 
virtual bool CanSplit (wxRichTextDrawingContext &context) const
 Returns true if this object can potentially be split, by virtue of having different virtual attributes for individual sub-objects. More...
 
virtual wxRichTextObjectSplit (wxRichTextDrawingContext &context)
 Returns the final object in the split objects if this object was split due to differences between sub-object virtual attributes. More...
 
virtual bool CanEditProperties () const
 Returns true if we can edit the object's properties via a GUI. More...
 
virtual bool EditProperties (wxWindow *parent, wxRichTextBuffer *buffer)
 Edits the object's properties via a GUI. More...
 
virtual wxString GetPropertiesMenuLabel () const
 Returns the label to be used for the properties context menu item. More...
 
virtual bool UsesParagraphAttributes () const
 Returns true if this object takes note of paragraph attributes (text and image objects don't). More...
 
virtual bool HandlesChildSelections () const
 Returns true if this object can handle the selections of its children, fOr example a table. More...
 
virtual wxRichTextSelection GetSelection (long start, long end) const
 Returns a selection object specifying the selections between start and end character positions. More...
 
virtual wxSize GetCachedSize () const
 Gets the cached object size as calculated by Layout. More...
 
virtual void SetCachedSize (const wxSize &sz)
 Sets the cached object size as calculated by Layout. More...
 
virtual wxSize GetMaxSize () const
 Gets the maximum object size as calculated by Layout. More...
 
virtual void SetMaxSize (const wxSize &sz)
 Sets the maximum object size as calculated by Layout. More...
 
virtual wxSize GetMinSize () const
 Gets the minimum object size as calculated by Layout. More...
 
virtual void SetMinSize (const wxSize &sz)
 Sets the minimum object size as calculated by Layout. More...
 
virtual wxTextAttrSize GetNaturalSize () const
 Gets the 'natural' size for an object. More...
 
virtual wxPoint GetPosition () const
 Returns the object position in pixels. More...
 
virtual void SetPosition (const wxPoint &pos)
 Sets the object position in pixels. More...
 
virtual wxPoint GetAbsolutePosition () const
 Returns the absolute object position, by traversing up the child/parent hierarchy. More...
 
virtual wxRect GetRect () const
 Returns the rectangle enclosing the object. More...
 
void SetRange (const wxRichTextRange &range)
 Sets the object's range within its container. More...
 
const wxRichTextRangeGetRange () const
 Returns the object's range. More...
 
wxRichTextRangeGetRange ()
 Returns the object's range. More...
 
void SetOwnRange (const wxRichTextRange &range)
 Set the object's own range, for a top-level object with its own position space. More...
 
const wxRichTextRangeGetOwnRange () const
 Returns the object's own range (valid if top-level). More...
 
wxRichTextRangeGetOwnRange ()
 Returns the object's own range (valid if top-level). More...
 
wxRichTextRange GetOwnRangeIfTopLevel () const
 Returns the object's own range only if a top-level object. More...
 
virtual wxRichTextObjectGetParent () const
 Returns a pointer to the parent object. More...
 
virtual void SetParent (wxRichTextObject *parent)
 Sets the pointer to the parent object. More...
 
virtual
wxRichTextParagraphLayoutBox
GetContainer () const
 Returns the top-level container of this object. More...
 
virtual
wxRichTextParagraphLayoutBox
GetParentContainer () const
 Returns the top-level container of this object. More...
 
virtual void SetMargins (int margin)
 Set the margin around the object, in pixels. More...
 
virtual void SetMargins (int leftMargin, int rightMargin, int topMargin, int bottomMargin)
 Set the margin around the object, in pixels. More...
 
virtual int GetLeftMargin () const
 Returns the left margin of the object, in pixels. More...
 
virtual int GetRightMargin () const
 Returns the right margin of the object, in pixels. More...
 
virtual int GetTopMargin () const
 Returns the top margin of the object, in pixels. More...
 
virtual int GetBottomMargin () const
 Returns the bottom margin of the object, in pixels. More...
 
virtual wxRect GetAvailableContentArea (wxDC &dc, wxRichTextDrawingContext &context, const wxRect &outerRect) const
 Calculates the available content space in the given rectangle, given the margins, border and padding specified in the object's attributes. More...
 
virtual bool LayoutToBestSize (wxDC &dc, wxRichTextDrawingContext &context, wxRichTextBuffer *buffer, const wxRichTextAttr &parentAttr, const wxRichTextAttr &attr, const wxRect &availableParentSpace, const wxRect &availableContainerSpace, int style)
 Lays out the object first with a given amount of space, and then if no width was specified in attr, lays out the object again using the minimum size. More...
 
virtual bool AdjustAttributes (wxRichTextAttr &attr, wxRichTextDrawingContext &context)
 Adjusts the attributes for virtual attribute provision, collapsed borders, etc. More...
 
void SetAttributes (const wxRichTextAttr &attr)
 Sets the object's attributes. More...
 
const wxRichTextAttrGetAttributes () const
 Returns the object's attributes. More...
 
wxRichTextAttrGetAttributes ()
 Returns the object's attributes. More...
 
wxRichTextPropertiesGetProperties ()
 Returns the object's properties. More...
 
const wxRichTextPropertiesGetProperties () const
 Returns the object's properties. More...
 
void SetProperties (const wxRichTextProperties &props)
 Sets the object's properties. More...
 
void SetDescent (int descent)
 Sets the stored descent value. More...
 
int GetDescent () const
 Returns the stored descent value. More...
 
wxRichTextBufferGetBuffer () const
 Returns the containing buffer. More...
 
void SetName (const wxString &name)
 Sets the identifying name for this object as a property using the "name" key. More...
 
wxString GetName () const
 Returns the identifying name for this object from the properties, using the "name" key. More...
 
bool IsShown () const
 Returns true if the object will be shown, false otherwise. More...
 
virtual void Show (bool show)
 Call to show or hide this object. More...
 
void Copy (const wxRichTextObject &obj)
 Copies the object. More...
 
void Reference ()
 Reference-counting allows us to use the same object in multiple lists (not yet used). More...
 
void Dereference ()
 Reference-counting allows us to use the same object in multiple lists (not yet used). More...
 
int ConvertTenthsMMToPixels (wxDC &dc, int units) const
 Converts units in tenths of a millimetre to device units. More...
 
int ConvertPixelsToTenthsMM (wxDC &dc, int pixels) const
 Convert units in pixels to tenths of a millimetre. More...
 
- Public Member Functions inherited from wxObject
 wxObject ()
 Default ctor; initializes to NULL the internal reference data. More...
 
 wxObject (const wxObject &other)
 Copy ctor. More...
 
virtual ~wxObject ()
 Destructor. More...
 
virtual wxClassInfoGetClassInfo () const
 This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More...
 
wxObjectRefDataGetRefData () const
 Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More...
 
bool IsKindOf (const wxClassInfo *info) const
 Determines whether this class is a subclass of (or the same class as) the given class. More...
 
bool IsSameAs (const wxObject &obj) const
 Returns true if this object has the same data pointer as obj. More...
 
void Ref (const wxObject &clone)
 Makes this object refer to the data in clone. More...
 
void SetRefData (wxObjectRefData *data)
 Sets the wxObject::m_refData pointer. More...
 
void UnRef ()
 Decrements the reference count in the associated data, and if it is zero, deletes the data. More...
 
void UnShare ()
 This is the same of AllocExclusive() but this method is public. More...
 
void operator delete (void *buf)
 The delete operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 
void * operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
 The new operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 

Static Public Member Functions

static wxList & GetHandlers ()
 Returns the file handlers. More...
 
static void AddHandler (wxRichTextFileHandler *handler)
 Adds a file handler to the end. More...
 
static void InsertHandler (wxRichTextFileHandler *handler)
 Inserts a file handler at the front. More...
 
static bool RemoveHandler (const wxString &name)
 Removes a file handler. More...
 
static wxRichTextFileHandlerFindHandler (const wxString &name)
 Finds a file handler by name. More...
 
static wxRichTextFileHandlerFindHandler (const wxString &extension, wxRichTextFileType imageType)
 Finds a file handler by extension and type. More...
 
static wxRichTextFileHandlerFindHandlerFilenameOrType (const wxString &filename, wxRichTextFileType imageType)
 Finds a handler by filename or, if supplied, type. More...
 
static wxRichTextFileHandlerFindHandler (wxRichTextFileType imageType)
 Finds a handler by type. More...
 
static wxString GetExtWildcard (bool combine=false, bool save=false, wxArrayInt *types=NULL)
 Gets a wildcard incorporating all visible handlers. More...
 
static void CleanUpHandlers ()
 Clean up file handlers. More...
 
static void InitStandardHandlers ()
 Initialise the standard file handlers. More...
 
static wxList & GetDrawingHandlers ()
 Returns the drawing handlers. More...
 
static void AddDrawingHandler (wxRichTextDrawingHandler *handler)
 Adds a drawing handler to the end. More...
 
static void InsertDrawingHandler (wxRichTextDrawingHandler *handler)
 Inserts a drawing handler at the front. More...
 
static bool RemoveDrawingHandler (const wxString &name)
 Removes a drawing handler. More...
 
static wxRichTextDrawingHandlerFindDrawingHandler (const wxString &name)
 Finds a drawing handler by name. More...
 
static void CleanUpDrawingHandlers ()
 Clean up drawing handlers. More...
 
static wxRichTextFieldTypeHashMap & GetFieldTypes ()
 Returns the field types. More...
 
static void AddFieldType (wxRichTextFieldType *fieldType)
 Adds a field type. More...
 
static bool RemoveFieldType (const wxString &name)
 Removes a field type by name. More...
 
static wxRichTextFieldTypeFindFieldType (const wxString &name)
 Finds a field type by name. More...
 
static void CleanUpFieldTypes ()
 Cleans up field types. More...
 
static wxRichTextRendererGetRenderer ()
 Returns the renderer object. More...
 
static void SetRenderer (wxRichTextRenderer *renderer)
 Sets renderer as the object to be used to render certain aspects of the content, such as bullets. More...
 
static int GetBulletRightMargin ()
 Returns the minimum margin between bullet and paragraph in 10ths of a mm. More...
 
static void SetBulletRightMargin (int margin)
 Sets the minimum margin between bullet and paragraph in 10ths of a mm. More...
 
static float GetBulletProportion ()
 Returns the factor to multiply by character height to get a reasonable bullet size. More...
 
static void SetBulletProportion (float prop)
 Sets the factor to multiply by character height to get a reasonable bullet size. More...
 
static bool GetFloatingLayoutMode ()
 Returns the floating layout mode. More...
 
static void SetFloatingLayoutMode (bool mode)
 Sets the floating layout mode. More...
 
- Static Public Member Functions inherited from wxRichTextObject
static int ConvertTenthsMMToPixels (int ppi, int units, double scale=1.0)
 Converts units in tenths of a millimetre to device units. More...
 
static int ConvertPixelsToTenthsMM (int ppi, int pixels, double scale=1.0)
 Convert units in pixels to tenths of a millimetre. More...
 
static bool DrawBoxAttributes (wxDC &dc, wxRichTextBuffer *buffer, const wxRichTextAttr &attr, const wxRect &boxRect, int flags=0, wxRichTextObject *obj=NULL)
 Draws the borders and background for the given rectangle and attributes. More...
 
static bool DrawBorder (wxDC &dc, wxRichTextBuffer *buffer, const wxRichTextAttr &attr, const wxTextAttrBorders &borders, const wxRect &rect, int flags=0)
 Draws a border. More...
 
static bool GetBoxRects (wxDC &dc, wxRichTextBuffer *buffer, const wxRichTextAttr &attr, wxRect &marginRect, wxRect &borderRect, wxRect &contentRect, wxRect &paddingRect, wxRect &outlineRect)
 Returns the various rectangles of the box model in pixels. More...
 
static bool GetTotalMargin (wxDC &dc, wxRichTextBuffer *buffer, const wxRichTextAttr &attr, int &leftMargin, int &rightMargin, int &topMargin, int &bottomMargin)
 Returns the total margin for the object in pixels, taking into account margin, padding and border size. More...
 
static wxRect AdjustAvailableSpace (wxDC &dc, wxRichTextBuffer *buffer, const wxRichTextAttr &parentAttr, const wxRichTextAttr &childAttr, const wxRect &availableParentSpace, const wxRect &availableContainerSpace)
 Returns the rectangle which the child has available to it given restrictions specified in the child attribute, e.g. More...
 

Protected Attributes

wxCommandProcessorm_commandProcessor
 Command processor. More...
 
wxRichTextFontTable m_fontTable
 Table storing fonts. More...
 
bool m_modified
 Has been modified? More...
 
int m_batchedCommandDepth
 Collapsed command stack. More...
 
wxString m_batchedCommandsName
 Name for collapsed command. More...
 
wxRichTextCommandm_batchedCommand
 Current collapsed command accumulating actions. More...
 
int m_suppressUndo
 Whether to suppress undo. More...
 
wxRichTextStyleSheetm_styleSheet
 Style sheet, if any. More...
 
wxList m_eventHandlers
 List of event handlers that will be notified of events. More...
 
wxList m_attributeStack
 Stack of attributes for convenience functions. More...
 
int m_handlerFlags
 Flags to be passed to handlers. More...
 
double m_scale
 Scaling factor in use: needed to calculate correct dimensions when printing. More...
 
- Protected Attributes inherited from wxRichTextParagraphLayoutBox
wxRichTextCtrlm_ctrl
 
wxRichTextAttr m_defaultAttributes
 
wxRichTextRange m_invalidRange
 
bool m_partialParagraph
 
wxRichTextFloatCollector * m_floatCollector
 
- Protected Attributes inherited from wxRichTextCompositeObject
wxRichTextObjectList m_children
 
- Protected Attributes inherited from wxRichTextObject
wxSize m_size
 
wxSize m_maxSize
 
wxSize m_minSize
 
wxPoint m_pos
 
int m_descent
 
int m_refCount
 
bool m_show
 
wxRichTextObjectm_parent
 
wxRichTextRange m_range
 
wxRichTextRange m_ownRange
 
wxRichTextAttr m_attributes
 
wxRichTextProperties m_properties
 
- Protected Attributes inherited from wxObject
wxObjectRefDatam_refData
 Pointer to an object which is the object's reference-counted data. More...
 

Static Protected Attributes

static wxList sm_handlers
 File handlers. More...
 
static wxList sm_drawingHandlers
 Drawing handlers. More...
 
static wxRichTextFieldTypeHashMap sm_fieldTypes
 Field types. More...
 
static wxRichTextRenderersm_renderer
 Renderer. More...
 
static int sm_bulletRightMargin
 Minimum margin between bullet and paragraph in 10ths of a mm. More...
 
static float sm_bulletProportion
 Factor to multiply by character height to get a reasonable bullet size. More...
 

Additional Inherited Members

- Protected Member Functions inherited from wxObject
void AllocExclusive ()
 Ensure that this object's data is not shared with any other object. More...
 
virtual wxObjectRefDataCreateRefData () const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. More...
 
virtual wxObjectRefDataCloneRefData (const wxObjectRefData *data) const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. More...
 

Constructor & Destructor Documentation

wxRichTextBuffer::wxRichTextBuffer ( )
inline

Default constructor.

wxRichTextBuffer::wxRichTextBuffer ( const wxRichTextBuffer obj)
inline

Copy constructor.

virtual wxRichTextBuffer::~wxRichTextBuffer ( )
virtual

Member Function Documentation

static void wxRichTextBuffer::AddDrawingHandler ( wxRichTextDrawingHandler handler)
static

Adds a drawing handler to the end.

bool wxRichTextBuffer::AddEventHandler ( wxEvtHandler handler)

Adds an event handler.

A buffer associated with a control has the control as the only event handler, but the application is free to add more if further notification is required. All handlers are notified of an event originating from the buffer, such as the replacement of a style sheet during loading.

The buffer never deletes any of the event handlers, unless RemoveEventHandler() is called with true as the second argument.

static void wxRichTextBuffer::AddFieldType ( wxRichTextFieldType fieldType)
static
static void wxRichTextBuffer::AddHandler ( wxRichTextFileHandler handler)
static

Adds a file handler to the end.

virtual wxRichTextRange wxRichTextBuffer::AddParagraph ( const wxString text,
wxRichTextAttr paraStyle = NULL 
)
inlinevirtual

Convenience function to add a paragraph of text.

Reimplemented from wxRichTextParagraphLayoutBox.

virtual bool wxRichTextBuffer::BatchingUndo ( ) const
inlinevirtual

Returns true if we are collapsing commands.

bool wxRichTextBuffer::BeginAlignment ( wxTextAttrAlignment  alignment)

Begins using alignment.

virtual bool wxRichTextBuffer::BeginBatchUndo ( const wxString cmdName)
virtual

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.

cmdName should be the name of the combined command that will appear next to Undo and Redo in the edit menu.

bool wxRichTextBuffer::BeginBold ( )

Begins using bold.

bool wxRichTextBuffer::BeginCharacterStyle ( const wxString characterStyle)

Begins named character style.

bool wxRichTextBuffer::BeginFont ( const wxFont font)

Begins using this font.

bool wxRichTextBuffer::BeginFontSize ( int  pointSize)

Begins using point size.

bool wxRichTextBuffer::BeginItalic ( )

Begins using italic.

bool wxRichTextBuffer::BeginLeftIndent ( int  leftIndent,
int  leftSubIndent = 0 
)

Begins using leftIndent for the left indent, and optionally leftSubIndent for the sub-indent.

Both are expressed in tenths of a millimetre.

The sub-indent is an offset from the left of the paragraph, and is used for all but the first line in a paragraph. A positive value will cause the first line to appear to the left of the subsequent lines, and a negative value will cause the first line to be indented relative to the subsequent lines.

bool wxRichTextBuffer::BeginLineSpacing ( int  lineSpacing)

Begins line spacing using the specified value.

spacing is a multiple, where 10 means single-spacing, 15 means 1.5 spacing, and 20 means double spacing.

The wxTextAttrLineSpacing enumeration values are defined for convenience.

bool wxRichTextBuffer::BeginListStyle ( const wxString listStyle,
int  level = 1,
int  number = 1 
)

Begins named list style.

Optionally, you can also pass a level and a number.

bool wxRichTextBuffer::BeginNumberedBullet ( int  bulletNumber,
int  leftIndent,
int  leftSubIndent,
int  bulletStyle = wxTEXT_ATTR_BULLET_STYLE_ARABIC|wxTEXT_ATTR_BULLET_STYLE_PERIOD 
)

Begins numbered bullet.

This call will be needed for each item in the list, and the application should take care of incrementing the numbering.

bulletNumber is a number, usually starting with 1. leftIndent and leftSubIndent are values in tenths of a millimetre. bulletStyle is a bitlist of the following values:

wxRichTextBuffer uses indentation to render a bulleted item. The left indent is the distance between the margin and the bullet. The content of the paragraph, including the first line, starts at leftMargin + leftSubIndent. So the distance between the left edge of the bullet and the left of the actual paragraph is leftSubIndent.

bool wxRichTextBuffer::BeginParagraphSpacing ( int  before,
int  after 
)

Begins paragraph spacing; pass the before-paragraph and after-paragraph spacing in tenths of a millimetre.

bool wxRichTextBuffer::BeginParagraphStyle ( const wxString paragraphStyle)

Begins named paragraph style.

bool wxRichTextBuffer::BeginRightIndent ( int  rightIndent)

Begins a right indent, specified in tenths of a millimetre.

bool wxRichTextBuffer::BeginStandardBullet ( const wxString bulletName,
int  leftIndent,
int  leftSubIndent,
int  bulletStyle = wxTEXT_ATTR_BULLET_STYLE_STANDARD 
)

Begins applying a standard bullet, using one of the standard bullet names (currently standard/circle or standard/square.

See BeginNumberedBullet() for an explanation of how indentation is used to render the bulleted paragraph.

virtual bool wxRichTextBuffer::BeginStyle ( const wxRichTextAttr style)
virtual

Begin using a style.

virtual bool wxRichTextBuffer::BeginSuppressUndo ( )
virtual

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.

bool wxRichTextBuffer::BeginSymbolBullet ( const wxString symbol,
int  leftIndent,
int  leftSubIndent,
int  bulletStyle = wxTEXT_ATTR_BULLET_STYLE_SYMBOL 
)

Begins applying a symbol bullet, using a character from the current font.

See BeginNumberedBullet() for an explanation of how indentation is used to render the bulleted paragraph.

bool wxRichTextBuffer::BeginTextColour ( const wxColour colour)

Begins using this colour.

bool wxRichTextBuffer::BeginUnderline ( )

Begins using underline.

bool wxRichTextBuffer::BeginURL ( const wxString url,
const wxString characterStyle = wxEmptyString 
)

Begins applying wxTEXT_ATTR_URL to the content.

Pass a URL and optionally, a character style to apply, since it is common to mark a URL with a familiar style such as blue text with underlining.

virtual bool wxRichTextBuffer::CanPasteFromClipboard ( ) const
virtual

Returns true if we can paste from the clipboard.

static void wxRichTextBuffer::CleanUpDrawingHandlers ( )
static

Clean up drawing handlers.

static void wxRichTextBuffer::CleanUpFieldTypes ( )
static

Cleans up field types.

static void wxRichTextBuffer::CleanUpHandlers ( )
static

Clean up file handlers.

void wxRichTextBuffer::ClearEventHandlers ( )

Clear event handlers.

virtual void wxRichTextBuffer::ClearStyleStack ( )
virtual

Clears the style stack.

virtual wxRichTextObject* wxRichTextBuffer::Clone ( ) const
inlinevirtual

Clones the buffer.

Reimplemented from wxRichTextParagraphLayoutBox.

void wxRichTextBuffer::Copy ( const wxRichTextBuffer obj)

Copies the buffer.

virtual bool wxRichTextBuffer::CopyToClipboard ( const wxRichTextRange range)
virtual

Copy the range to the clipboard.

bool wxRichTextBuffer::DeleteRangeWithUndo ( const wxRichTextRange range,
wxRichTextCtrl ctrl 
)

Submits a command to delete this range.

virtual void wxRichTextBuffer::Dump ( )
virtual

Dumps contents of buffer for debugging purposes.

virtual void wxRichTextBuffer::Dump ( wxTextOutputStream stream)
inlinevirtual

Dumps contents of buffer for debugging purposes.

Reimplemented from wxRichTextCompositeObject.

bool wxRichTextBuffer::EndAlignment ( )
inline

Ends alignment.

virtual bool wxRichTextBuffer::EndAllStyles ( )
virtual

End all styles.

virtual bool wxRichTextBuffer::EndBatchUndo ( )
virtual

End collapsing undo/redo commands.

bool wxRichTextBuffer::EndBold ( )
inline

Ends using bold.

bool wxRichTextBuffer::EndCharacterStyle ( )
inline

Ends named character style.

bool wxRichTextBuffer::EndFont ( )
inline

Ends using a font.

bool wxRichTextBuffer::EndFontSize ( )
inline

Ends using point size.

bool wxRichTextBuffer::EndItalic ( )
inline

Ends using italic.

bool wxRichTextBuffer::EndLeftIndent ( )
inline

Ends left indent.

bool wxRichTextBuffer::EndLineSpacing ( )
inline

Ends line spacing.

bool wxRichTextBuffer::EndListStyle ( )
inline

Ends named character style.

bool wxRichTextBuffer::EndNumberedBullet ( )
inline

Ends numbered bullet.

bool wxRichTextBuffer::EndParagraphSpacing ( )
inline

Ends paragraph spacing.

bool wxRichTextBuffer::EndParagraphStyle ( )
inline

Ends named character style.

bool wxRichTextBuffer::EndRightIndent ( )
inline

Ends right indent.

bool wxRichTextBuffer::EndStandardBullet ( )
inline

Ends standard bullet.

virtual bool wxRichTextBuffer::EndStyle ( )
virtual

End the style.

virtual bool wxRichTextBuffer::EndSuppressUndo ( )
virtual

End suppressing undo/redo commands.

bool wxRichTextBuffer::EndSymbolBullet ( )
inline

Ends symbol bullet.

bool wxRichTextBuffer::EndTextColour ( )
inline

Ends using a colour.

bool wxRichTextBuffer::EndUnderline ( )
inline

Ends using underline.

bool wxRichTextBuffer::EndURL ( )
inline

Ends URL.

static wxRichTextDrawingHandler* wxRichTextBuffer::FindDrawingHandler ( const wxString name)
static

Finds a drawing handler by name.

static wxRichTextFieldType* wxRichTextBuffer::FindFieldType ( const wxString name)
static
static wxRichTextFileHandler* wxRichTextBuffer::FindHandler ( const wxString name)
static

Finds a file handler by name.

static wxRichTextFileHandler* wxRichTextBuffer::FindHandler ( const wxString extension,
wxRichTextFileType  imageType 
)
static

Finds a file handler by extension and type.

static wxRichTextFileHandler* wxRichTextBuffer::FindHandler ( wxRichTextFileType  imageType)
static

Finds a handler by type.

static wxRichTextFileHandler* wxRichTextBuffer::FindHandlerFilenameOrType ( const wxString filename,
wxRichTextFileType  imageType 
)
static

Finds a handler by filename or, if supplied, type.

virtual wxRichTextCommand* wxRichTextBuffer::GetBatchedCommand ( ) const
inlinevirtual

Returns the collapsed command.

static float wxRichTextBuffer::GetBulletProportion ( )
inlinestatic

Returns the factor to multiply by character height to get a reasonable bullet size.

static int wxRichTextBuffer::GetBulletRightMargin ( )
inlinestatic

Returns the minimum margin between bullet and paragraph in 10ths of a mm.

wxCommandProcessor* wxRichTextBuffer::GetCommandProcessor ( ) const
inline

Returns the command processor.

A text buffer always creates its own command processor when it is initialized.

double wxRichTextBuffer::GetDimensionScale ( ) const
inline

Returns the scale factor for displaying certain dimensions such as indentation and inter-paragraph spacing.

static wxList& wxRichTextBuffer::GetDrawingHandlers ( )
inlinestatic

Returns the drawing handlers.

static wxString wxRichTextBuffer::GetExtWildcard ( bool  combine = false,
bool  save = false,
wxArrayInt types = NULL 
)
static

Gets a wildcard incorporating all visible handlers.

If types is present, it will be filled with the file type corresponding to each filter. This can be used to determine the type to pass to LoadFile given a selected filter.

static wxRichTextFieldTypeHashMap& wxRichTextBuffer::GetFieldTypes ( )
inlinestatic

Returns the field types.

static bool wxRichTextBuffer::GetFloatingLayoutMode ( )
static

Returns the floating layout mode.

The default is true, where objects are laid out according to their floating status.

double wxRichTextBuffer::GetFontScale ( ) const
inline

Returns the scale factor for displaying fonts, for example for more comfortable editing.

wxRichTextFontTable& wxRichTextBuffer::GetFontTable ( )
inline

Returns the table storing fonts, for quick access and font reuse.

const wxRichTextFontTable& wxRichTextBuffer::GetFontTable ( ) const
inline

Returns the table storing fonts, for quick access and font reuse.

int wxRichTextBuffer::GetHandlerFlags ( ) const
inline

Gets the handler flags, controlling loading and saving.

static wxList& wxRichTextBuffer::GetHandlers ( )
inlinestatic

Returns the file handlers.

static wxRichTextRenderer* wxRichTextBuffer::GetRenderer ( )
inlinestatic

Returns the renderer object.

double wxRichTextBuffer::GetScale ( ) const
inline

Returns the scale factor for calculating dimensions.

virtual wxRichTextStyleSheet* wxRichTextBuffer::GetStyleSheet ( ) const
inlinevirtual

Returns the style sheet.

Reimplemented from wxRichTextParagraphLayoutBox.

virtual size_t wxRichTextBuffer::GetStyleStackSize ( ) const
inlinevirtual

Returns the size of the style stack, for example to check correct nesting.

virtual int wxRichTextBuffer::HitTest ( wxDC dc,
wxRichTextDrawingContext context,
const wxPoint pt,
long &  textPosition,
wxRichTextObject **  obj,
wxRichTextObject **  contextObj,
int  flags = 0 
)
virtual

Hit-testing: returns a flag indicating hit test details, plus information about position.

contextObj is returned to specify what object position is relevant to, since otherwise there's an ambiguity. @ obj might not be a child of contextObj, since we may be referring to the container itself if we have no hit on a child - for example if we click outside an object.

The function puts the position in textPosition if one is found. pt is in logical units (a zero y position is at the beginning of the buffer).

Returns
One of the wxRichTextHitTestFlags values.

Reimplemented from wxRichTextParagraphLayoutBox.

void wxRichTextBuffer::Init ( )

Initialisation.

static void wxRichTextBuffer::InitStandardHandlers ( )
static

Initialise the standard file handlers.

Currently, only the plain text loading/saving handler is initialised by default.

static void wxRichTextBuffer::InsertDrawingHandler ( wxRichTextDrawingHandler handler)
static

Inserts a drawing handler at the front.

static void wxRichTextBuffer::InsertHandler ( wxRichTextFileHandler handler)
static

Inserts a file handler at the front.

bool wxRichTextBuffer::InsertImageWithUndo ( long  pos,
const wxRichTextImageBlock imageBlock,
wxRichTextCtrl ctrl,
int  flags = 0,
const wxRichTextAttr textAttr = wxRichTextAttr() 
)

Submits a command to insert the given image.

bool wxRichTextBuffer::InsertNewlineWithUndo ( long  pos,
wxRichTextCtrl ctrl,
int  flags = 0 
)

Submits a command to insert a newline.

wxRichTextObject* wxRichTextBuffer::InsertObjectWithUndo ( long  pos,
wxRichTextObject object,
wxRichTextCtrl ctrl,
int  flags 
)

Submits a command to insert an object.

bool wxRichTextBuffer::InsertParagraphsWithUndo ( long  pos,
const wxRichTextParagraphLayoutBox paragraphs,
wxRichTextCtrl ctrl,
int  flags = 0 
)

Submits a command to insert paragraphs.

bool wxRichTextBuffer::InsertTextWithUndo ( long  pos,
const wxString text,
wxRichTextCtrl ctrl,
int  flags = 0 
)

Submits a command to insert the given text.

bool wxRichTextBuffer::IsModified ( ) const
inline

Returns true if the buffer was modified.

virtual bool wxRichTextBuffer::LoadFile ( const wxString filename,
wxRichTextFileType  type = wxRICHTEXT_TYPE_ANY 
)
virtual

Loads content from a stream or file.

Not all handlers will implement file loading.

virtual bool wxRichTextBuffer::LoadFile ( wxInputStream stream,
wxRichTextFileType  type = wxRICHTEXT_TYPE_ANY 
)
virtual

Loads content from a stream or file.

Not all handlers will implement file loading.

void wxRichTextBuffer::Modify ( bool  modify = true)
inline

Mark modified.

void wxRichTextBuffer::operator= ( const wxRichTextBuffer obj)
inline

Assignment operator.

virtual bool wxRichTextBuffer::PasteFromClipboard ( long  position)
virtual

Paste the clipboard content to the buffer.

wxRichTextStyleSheet* wxRichTextBuffer::PopStyleSheet ( )

Pops the style sheet from the top of the style sheet stack.

bool wxRichTextBuffer::PushStyleSheet ( wxRichTextStyleSheet styleSheet)

Pushes the style sheet to the top of the style sheet stack.

static bool wxRichTextBuffer::RemoveDrawingHandler ( const wxString name)
static

Removes a drawing handler.

bool wxRichTextBuffer::RemoveEventHandler ( wxEvtHandler handler,
bool  deleteHandler = false 
)

Removes an event handler from the buffer's list of handlers, deleting the object if deleteHandler is true.

static bool wxRichTextBuffer::RemoveFieldType ( const wxString name)
static
static bool wxRichTextBuffer::RemoveHandler ( const wxString name)
static

Removes a file handler.

virtual void wxRichTextBuffer::ResetAndClearCommands ( )
virtual

Clears the buffer, adds an empty paragraph, and clears the command processor.

virtual bool wxRichTextBuffer::SaveFile ( const wxString filename,
wxRichTextFileType  type = wxRICHTEXT_TYPE_ANY 
)
virtual

Saves content to a stream or file.

Not all handlers will implement file saving.

virtual bool wxRichTextBuffer::SaveFile ( wxOutputStream stream,
wxRichTextFileType  type = wxRICHTEXT_TYPE_ANY 
)
virtual

Saves content to a stream or file.

Not all handlers will implement file saving.

bool wxRichTextBuffer::SendEvent ( wxEvent event,
bool  sendToAll = true 
)

Send event to event handlers.

If sendToAll is true, will send to all event handlers, otherwise will stop at the first successful one.

static void wxRichTextBuffer::SetBulletProportion ( float  prop)
inlinestatic

Sets the factor to multiply by character height to get a reasonable bullet size.

static void wxRichTextBuffer::SetBulletRightMargin ( int  margin)
inlinestatic

Sets the minimum margin between bullet and paragraph in 10ths of a mm.

void wxRichTextBuffer::SetDimensionScale ( double  dimScale)

Sets the scale factor for displaying certain dimensions such as indentation and inter-paragraph spacing.

This can be useful when editing in a small control where you still want legible text, but a minimum of wasted white space.

static void wxRichTextBuffer::SetFloatingLayoutMode ( bool  mode)
static

Sets the floating layout mode.

Pass false to speed up editing by not performing floating layout. This setting affects all buffers.

void wxRichTextBuffer::SetFontScale ( double  fontScale)

Sets the scale factor for displaying fonts, for example for more comfortable editing.

void wxRichTextBuffer::SetFontTable ( const wxRichTextFontTable table)
inline

Sets table storing fonts, for quick access and font reuse.

void wxRichTextBuffer::SetHandlerFlags ( int  flags)
inline

Sets the handler flags, controlling loading and saving.

static void wxRichTextBuffer::SetRenderer ( wxRichTextRenderer renderer)
static

Sets renderer as the object to be used to render certain aspects of the content, such as bullets.

You can override default rendering by deriving a new class from wxRichTextRenderer or wxRichTextStdRenderer, overriding one or more virtual functions, and setting an instance of the class using this function.

void wxRichTextBuffer::SetScale ( double  scale)
inline

Sets the scale factor for calculating dimensions.

void wxRichTextBuffer::SetStyleSheet ( wxRichTextStyleSheet styleSheet)
inline

Sets style sheet, if any.

This will allow the application to use named character and paragraph styles found in the style sheet.

Neither the buffer nor the control owns the style sheet so must be deleted by the application.

bool wxRichTextBuffer::SetStyleSheetAndNotify ( wxRichTextStyleSheet sheet)

Sets the style sheet and sends a notification of the change.

virtual bool wxRichTextBuffer::SubmitAction ( wxRichTextAction action)
virtual

Submit the action immediately, or delay according to whether collapsing is on.

virtual bool wxRichTextBuffer::SuppressingUndo ( ) const
inlinevirtual

Are we suppressing undo??

Member Data Documentation

wxList wxRichTextBuffer::m_attributeStack
protected

Stack of attributes for convenience functions.

wxRichTextCommand* wxRichTextBuffer::m_batchedCommand
protected

Current collapsed command accumulating actions.

int wxRichTextBuffer::m_batchedCommandDepth
protected

Collapsed command stack.

wxString wxRichTextBuffer::m_batchedCommandsName
protected

Name for collapsed command.

wxCommandProcessor* wxRichTextBuffer::m_commandProcessor
protected

Command processor.

wxList wxRichTextBuffer::m_eventHandlers
protected

List of event handlers that will be notified of events.

wxRichTextFontTable wxRichTextBuffer::m_fontTable
protected

Table storing fonts.

int wxRichTextBuffer::m_handlerFlags
protected

Flags to be passed to handlers.

bool wxRichTextBuffer::m_modified
protected

Has been modified?

double wxRichTextBuffer::m_scale
protected

Scaling factor in use: needed to calculate correct dimensions when printing.

wxRichTextStyleSheet* wxRichTextBuffer::m_styleSheet
protected

Style sheet, if any.

int wxRichTextBuffer::m_suppressUndo
protected

Whether to suppress undo.

float wxRichTextBuffer::sm_bulletProportion
staticprotected

Factor to multiply by character height to get a reasonable bullet size.

int wxRichTextBuffer::sm_bulletRightMargin
staticprotected

Minimum margin between bullet and paragraph in 10ths of a mm.

wxList wxRichTextBuffer::sm_drawingHandlers
staticprotected

Drawing handlers.

wxRichTextFieldTypeHashMap wxRichTextBuffer::sm_fieldTypes
staticprotected

Field types.

wxList wxRichTextBuffer::sm_handlers
staticprotected

File handlers.

wxRichTextRenderer* wxRichTextBuffer::sm_renderer
staticprotected

Renderer.