wx.richtext.RichTextXMLHandler

A handler for loading and saving content in an XML format specific to wx.richtext.RichTextBuffer.

You can either add the handler to the buffer and load and save through the buffer or control API, or you can create an instance of the handler on the stack and call its functions directly.

Handler flags

The following flags can be used with this handler, via the handler’s SetFlags function or the buffer or control’s SetHandlerFlags() function:

• wx.richtext.RICHTEXT_HANDLER_INCLUDE_STYLESHEET Include the style sheet in loading and saving operations.

Class Hierarchy

Inheritance diagram for class RichTextXMLHandler:

Methods Summary

__init__	Constructor.
CanLoad	Returns True.
CanSave	Returns True.
ClearNodeToClassMap	Cleans up the mapping between node name and C++ class.
ExportXML	Recursively exports an object to the stream.
ImportXML	Recursively imports an object.
RegisterNodeName	Call with XML node name, C++ class name so that RTC can read in the node.

Class API

class wx.richtext.RichTextXMLHandler(RichTextFileHandler)

Possible constructors:

RichTextXMLHandler(name: str="XML", ext: str="xml", type:
                   int=RICHTEXT_TYPE_XML) -> None

A handler for loading and saving content in an XML format specific to RichTextBuffer.

Methods

__init__(self, name: str = 'XML', ext: str = 'xml', type: int = RICHTEXT_TYPE_XML)

Constructor.

Parameters:

• name (string)

• ext (string)

• type (int)

Return type:

None

---

CanLoad(self)

Returns True.

Return type:

bool

---

CanSave(self)

Returns True.

Return type:

bool

---

static ClearNodeToClassMap()

Cleans up the mapping between node name and C++ class.

Return type:

None

---

ExportXML(self, stream: OutputStream, obj: RichTextObject, level: int)

Recursively exports an object to the stream.

Parameters:

• stream (wx.OutputStream)

• obj (wx.richtext.RichTextObject)

• level (int)

Return type:

bool

---

ImportXML(self, buffer: RichTextBuffer, obj: RichTextObject, node: XmlNode)

Recursively imports an object.

Parameters:

• buffer (wx.richtext.RichTextBuffer)

• obj (wx.richtext.RichTextObject)

• node (wx.xml.XmlNode)

Return type:

bool

---

static RegisterNodeName(nodeName: str, className: str)

Call with XML node name, C++ class name so that RTC can read in the node.

If you add a custom object, call this.

Parameters:

• nodeName (string)

• className (string)

Return type:

None