1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.richtext.RichTextXMLHandler:
==========================================================================================================================================
|phoenix_title| **wx.richtext.RichTextXMLHandler**
==========================================================================================================================================
A handler for loading and saving content in an ``XML`` format specific to :ref:`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.
|phoenix_title| Handler flags
=============================
The following flags can be used with this handler, via the handler's :meth:`~wx.richtext.RichTextXMLHandler.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| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>RichTextXMLHandler</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.richtext.RichTextXMLHandler_inheritance.png" alt="Inheritance diagram of RichTextXMLHandler" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Object.html" title="wx.Object" alt="" coords="75,5,156,35"/> <area shape="rect" id="node2" href="wx.richtext.RichTextFileHandler.html" title="wx.richtext.RichTextFileHandler" alt="" coords="9,83,223,112"/> <area shape="rect" id="node3" href="wx.richtext.RichTextXMLHandler.html" title="wx.richtext.RichTextXMLHandler" alt="" coords="5,160,227,189"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.richtext.RichTextXMLHandler.__init__` Constructor.
:meth:`~wx.richtext.RichTextXMLHandler.CanLoad` Returns ``True``.
:meth:`~wx.richtext.RichTextXMLHandler.CanSave` Returns ``True``.
:meth:`~wx.richtext.RichTextXMLHandler.ClearNodeToClassMap` Cleans up the mapping between node name and C++ class.
:meth:`~wx.richtext.RichTextXMLHandler.ExportXML` Recursively exports an object to the stream.
:meth:`~wx.richtext.RichTextXMLHandler.ImportXML` Recursively imports an object.
:meth:`~wx.richtext.RichTextXMLHandler.RegisterNodeName` Call with ``XML`` node name, C++ class name so that ``RTC`` can read in the node.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.richtext.RichTextXMLHandler(RichTextFileHandler)
**Possible constructors**::
RichTextXMLHandler(name="XML", ext="xml", type=RICHTEXT_TYPE_XML)
A handler for loading and saving content in an ``XML`` format specific to
RichTextBuffer.
.. method:: __init__(self, name="XML", ext="xml", type=RICHTEXT_TYPE_XML)
Constructor.
:param `name`:
:type `name`: string
:param `ext`:
:type `ext`: string
:param `type`:
:type `type`: int
.. method:: CanLoad(self)
Returns ``True``.
:rtype: `bool`
.. method:: CanSave(self)
Returns ``True``.
:rtype: `bool`
.. staticmethod:: ClearNodeToClassMap()
Cleans up the mapping between node name and C++ class.
.. method:: ExportXML(self, stream, obj, level)
Recursively exports an object to the stream.
:param `stream`:
:type `stream`: wx.OutputStream
:param `obj`:
:type `obj`: wx.richtext.RichTextObject
:param `level`:
:type `level`: int
:rtype: `bool`
.. method:: ImportXML(self, buffer, obj, node)
Recursively imports an object.
:param `buffer`:
:type `buffer`: wx.richtext.RichTextBuffer
:param `obj`:
:type `obj`: wx.richtext.RichTextObject
:param `node`:
:type `node`: wx.xml.XmlNode
:rtype: `bool`
.. staticmethod:: RegisterNodeName(nodeName, className)
Call with ``XML`` node name, C++ class name so that ``RTC`` can read in the node.
If you add a custom object, call this.
:param `nodeName`:
:type `nodeName`: string
:param `className`:
:type `className`: string
|
