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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
|
.. 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.RichTextHTMLHandler:
==========================================================================================================================================
|phoenix_title| **wx.richtext.RichTextHTMLHandler**
==========================================================================================================================================
Handles HTML output (only) for :ref:`wx.richtext.RichTextCtrl` content.
The most flexible way to use this class is to create a temporary object and call its functions directly, rather than use :meth:`wx.richtext.RichTextBuffer.SaveFile` or :meth:`wx.richtext.RichTextCtrl.SaveFile` .
Image handling requires a little extra work from the application, to choose an appropriate image format for the target HTML viewer and to clean up the temporary images later. If you are planning to load the HTML into a standard web browser, you can specify the handler flag ``wx.richtext.RICHTEXT_HANDLER_SAVE_IMAGES_TO_BASE64`` (the default) and no extra work is required: the images will be written with the HTML.
However, if you want HTML compatibility, you will need to use ``RICHTEXT_HANDLER_SAVE_IMAGES_TO_MEMORY`` or ``RICHTEXT_HANDLER_SAVE_IMAGES_TO_FILES`` .
In this case, you must either call :meth:`wx.richtext.RichTextHTMLHandler.DeleteTemporaryImages` before the next load operation, or you must store the image locations and delete them yourself when appropriate.
You can call :meth:`wx.richtext.RichTextHTMLHandler.GetTemporaryImageLocations` to get the array of temporary image names.
|phoenix_title| Handler flags
=============================
The following flags can be used with this handler, via the handler's :meth:`~wx.richtext.RichTextHTMLHandler.SetFlags` function or the buffer or control's SetHandlerFlags() function:
- ``wx.richtext.RICHTEXT_HANDLER_SAVE_IMAGES_TO_MEMORY`` Images are saved to the memory filesystem: suitable for showing HTML windows.
- ``wx.richtext.RICHTEXT_HANDLER_SAVE_IMAGES_TO_FILES`` Images are saved to temporary files: suitable for showing in HTML windows.
- ``wx.richtext.RICHTEXT_HANDLER_SAVE_IMAGES_TO_BASE64`` Images are written with the HTML files in Base 64 format: suitable for showing in web browsers.
- ``wx.richtext.RICHTEXT_HANDLER_NO_HEADER_FOOTER`` Don't include header and footer tags (HTML, ``HEAD``, ``BODY``), so that the HTML can be used as part of a larger document.
- ``RICHTEXT_HANDLER_USE_CSS`` Use CSS where possible, otherwise use workarounds that will show in :ref:`wx.html.HtmlWindow`.
|
|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>RichTextHTMLHandler</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.RichTextHTMLHandler_inheritance.png" alt="Inheritance diagram of RichTextHTMLHandler" 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="79,5,160,35"/> <area shape="rect" id="node2" href="wx.richtext.RichTextFileHandler.html" title="wx.richtext.RichTextFileHandler" alt="" coords="13,83,227,112"/> <area shape="rect" id="node3" href="wx.richtext.RichTextHTMLHandler.html" title="wx.richtext.RichTextHTMLHandler" alt="" coords="5,160,235,189"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.richtext.RichTextHTMLHandler.__init__` Constructor.
:meth:`~wx.richtext.RichTextHTMLHandler.ClearTemporaryImageLocations` Clears the image locations generated by the last operation.
:meth:`~wx.richtext.RichTextHTMLHandler.DeleteTemporaryImages` Deletes the in-memory or temporary files generated by the last operation.
:meth:`~wx.richtext.RichTextHTMLHandler.GetFontSizeMapping` Returns the mapping for converting point sizes to HTML font sizes.
:meth:`~wx.richtext.RichTextHTMLHandler.GetTempDir` Returns the directory used to store temporary image files.
:meth:`~wx.richtext.RichTextHTMLHandler.GetTemporaryImageLocations` Returns the image locations for the last operation.
:meth:`~wx.richtext.RichTextHTMLHandler.SetFileCounter` Reset the file counter, in case, for example, the same names are required each time.
:meth:`~wx.richtext.RichTextHTMLHandler.SetFontSizeMapping` Sets the mapping for converting point sizes to HTML font sizes.
:meth:`~wx.richtext.RichTextHTMLHandler.SetTempDir` Sets the directory for storing temporary files.
:meth:`~wx.richtext.RichTextHTMLHandler.SetTemporaryImageLocations` Sets the list of image locations generated by the last operation.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.richtext.RichTextHTMLHandler.FontSizeMapping` See :meth:`~wx.richtext.RichTextHTMLHandler.GetFontSizeMapping` and :meth:`~wx.richtext.RichTextHTMLHandler.SetFontSizeMapping`
:attr:`~wx.richtext.RichTextHTMLHandler.TempDir` See :meth:`~wx.richtext.RichTextHTMLHandler.GetTempDir` and :meth:`~wx.richtext.RichTextHTMLHandler.SetTempDir`
:attr:`~wx.richtext.RichTextHTMLHandler.TemporaryImageLocations` See :meth:`~wx.richtext.RichTextHTMLHandler.GetTemporaryImageLocations` and :meth:`~wx.richtext.RichTextHTMLHandler.SetTemporaryImageLocations`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.richtext.RichTextHTMLHandler(RichTextFileHandler)
**Possible constructors**::
RichTextHTMLHandler(name="HTML", ext="html", type=RICHTEXT_TYPE_HTML)
Handles HTML output (only) for RichTextCtrl content.
.. method:: __init__(self, name="HTML", ext="html", type=RICHTEXT_TYPE_HTML)
Constructor.
:param `name`:
:type `name`: string
:param `ext`:
:type `ext`: string
:param `type`:
:type `type`: int
.. method:: ClearTemporaryImageLocations(self)
Clears the image locations generated by the last operation.
.. method:: DeleteTemporaryImages(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**DeleteTemporaryImages** `(self)`
Deletes the in-memory or temporary files generated by the last operation.
:rtype: `bool`
**~~~**
**DeleteTemporaryImages** `(flags, imageLocations)`
Delete the in-memory or temporary files generated by the last operation.
This is a static function that can be used to delete the saved locations from an earlier operation, for example after the user has viewed the HTML file.
:param `flags`:
:type `flags`: int
:param `imageLocations`:
:type `imageLocations`: list of strings
:rtype: `bool`
**~~~**
.. method:: GetFontSizeMapping(self)
Returns the mapping for converting point sizes to HTML font sizes.
:rtype: `list of integers`
.. method:: GetTempDir(self)
Returns the directory used to store temporary image files.
:rtype: `string`
.. method:: GetTemporaryImageLocations(self)
Returns the image locations for the last operation.
:rtype: `list of strings`
.. staticmethod:: SetFileCounter(counter)
Reset the file counter, in case, for example, the same names are required each time.
:param `counter`:
:type `counter`: int
.. method:: SetFontSizeMapping(self, fontSizeMapping)
Sets the mapping for converting point sizes to HTML font sizes.
There should be 7 elements, one for each HTML font size, each element specifying the maximum point size for that HTML font size. For example: ::
fontSizeMapping = [7, 9, 11, 12, 14, 22, 100]
htmlHandler.SetFontSizeMapping(fontSizeMapping)
:param `fontSizeMapping`:
:type `fontSizeMapping`: list of integers
.. method:: SetTempDir(self, tempDir)
Sets the directory for storing temporary files.
If empty, the system temporary directory will be used.
:param `tempDir`:
:type `tempDir`: string
.. method:: SetTemporaryImageLocations(self, locations)
Sets the list of image locations generated by the last operation.
:param `locations`:
:type `locations`: list of strings
.. attribute:: FontSizeMapping
See :meth:`~wx.richtext.RichTextHTMLHandler.GetFontSizeMapping` and :meth:`~wx.richtext.RichTextHTMLHandler.SetFontSizeMapping`
.. attribute:: TempDir
See :meth:`~wx.richtext.RichTextHTMLHandler.GetTempDir` and :meth:`~wx.richtext.RichTextHTMLHandler.SetTempDir`
.. attribute:: TemporaryImageLocations
See :meth:`~wx.richtext.RichTextHTMLHandler.GetTemporaryImageLocations` and :meth:`~wx.richtext.RichTextHTMLHandler.SetTemporaryImageLocations`
|
