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 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 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 wx.richtext.RichTextHTMLHandler.GetTemporaryImageLocations to get the array of temporary image names.

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_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.
wx.richtext.RICHTEXT_HANDLER_USE_CSS Use CSS where possible, otherwise use workarounds that will show in wx.html.HtmlWindow.

Class Hierarchy¶

Inheritance diagram for class RichTextHTMLHandler:

Inheritance diagram of RichTextHTMLHandler

Methods Summary¶

`__init__`	Constructor.
`ClearTemporaryImageLocations`	Clears the image locations generated by the last operation.
`DeleteTemporaryImages`	Deletes the in-memory or temporary files generated by the last operation.
`GetFontSizeMapping`	Returns the mapping for converting point sizes to HTML font sizes.
`GetTempDir`	Returns the directory used to store temporary image files.
`GetTemporaryImageLocations`	Returns the image locations for the last operation.
`SetFileCounter`	Reset the file counter, in case, for example, the same names are required each time.
`SetFontSizeMapping`	Sets the mapping for converting point sizes to HTML font sizes.
`SetTempDir`	Sets the directory for storing temporary files.
`SetTemporaryImageLocations`	Sets the list of image locations generated by the last operation.

Properties Summary¶

`FontSizeMapping`	See `GetFontSizeMapping` and `SetFontSizeMapping`
`TempDir`	See `GetTempDir` and `SetTempDir`
`TemporaryImageLocations`	See `GetTemporaryImageLocations` and `SetTemporaryImageLocations`

Class API¶

class wx.richtext.RichTextHTMLHandler(RichTextFileHandler)¶

Possible constructors:

RichTextHTMLHandler(name="HTML", ext="html", type=RICHTEXT_TYPE_HTML) ->
                    None

Handles HTML output (only) for RichTextCtrl content.

Methods¶

__init__(self, name='HTML', ext='html', type=RICHTEXT_TYPE_HTML)¶

Constructor.

Parameters:

name (string)
ext (string)
type (int)

Return type:

None

ClearTemporaryImageLocations(self)¶

Clears the image locations generated by the last operation.

Return type:: None

DeleteTemporaryImages(self, *args, **kw)¶

Overloaded Implementations:

DeleteTemporaryImages (self)

Deletes the in-memory or temporary files generated by the last operation.

Return type:: 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.

Parameters:

flags (int)
imageLocations (list of strings)

Return type:

bool

GetFontSizeMapping(self)¶

Returns the mapping for converting point sizes to HTML font sizes.

Return type:: List[int]

GetTempDir(self)¶

Returns the directory used to store temporary image files.

Return type:: str

GetTemporaryImageLocations(self)¶

Returns the image locations for the last operation.

Return type:: List[str]

static SetFileCounter(counter)¶

Reset the file counter, in case, for example, the same names are required each time.

Parameters:: counter (int)
Return type:: None

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)

Parameters:: fontSizeMapping (list of integers)
Return type:: None

SetTempDir(self, tempDir)¶

Sets the directory for storing temporary files.

If empty, the system temporary directory will be used.

Parameters:: tempDir (string)
Return type:: None

SetTemporaryImageLocations(self, locations)¶

Sets the list of image locations generated by the last operation.

Parameters:: locations (list of strings)
Return type:: None

Properties¶

FontSizeMapping¶: See GetFontSizeMapping and SetFontSizeMapping

TempDir¶: See GetTempDir and SetTempDir

TemporaryImageLocations¶: See GetTemporaryImageLocations and SetTemporaryImageLocations