Inheritance diagram for wx.richtext.RichTextHTMLHandler:
Handles HTML output (only) for 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 wx.richtext.RichTextBuffer.SaveFile or 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 wx.HTML compatibility, you will need to use wx.richtext.RICHTEXT_HANDLER_SAVE_IMAGES_TO_MEMORY or wx.richtext.RICHTEXT_HANDLER_SAVE_IMAGES_TO_FILES. In this case, you must either call DeleteTemporaryImages before the next load operation, or you must store the image locations and delete them yourself when appropriate. You can call GetTemporaryImageLocations to get the array of temporary image names.
The following flags can be used with this handler, via the handler’s SetFlags function or the buffer or control’s SetHandlerFlags function (these are all are members of wx.richtext subpackage, so the wx.richtext string in front of the RICHTEXT is omitted for brevity):
| Handler Flags | Description |
|---|---|
| RICHTEXT_HANDLER_SAVE_IMAGES_TO_MEMORY | Images are saved to the memory filesystem: suitable for showing wxHTML windows. |
| RICHTEXT_HANDLER_SAVE_IMAGES_TO_FILES | Images are saved to temporary files: suitable for showing in wxHTML windows. |
| RICHTEXT_HANDLER_SAVE_IMAGES_TO_BASE64 | Images are written with the HTML files in Base 64 format: suitable for showing in web browsers. |
| 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. |
Constructor.
Parameters:
Returns:
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.
Returns:
bool
Returns the mapping for converting point sizes to HTML font sizes.
Returns:
list of integers
Returns the directory used to store temporary image files.
Returns:
string
Returns the image locations for the last operation.
Returns:
list of strings
Reset the file counter, in case, for example, the same names are required each time
Parameters:
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 = []
fontSizeMapping.append(7)
fontSizeMapping.append(9)
fontSizeMapping.append(11)
fontSizeMapping.append(12)
fontSizeMapping.append(14)
fontSizeMapping.append(22)
fontSizeMapping.append(100)
htmlHandler.SetFontSizeMapping(fontSizeMapping)
Parameters:
Sets the directory for storing temporary files. If empty, the system temporary directory will be used.
Parameters:
Sets the list of image locations generated by the last operation.
Parameters:
