wxRuby Documentation Home


Handles HTML output (only) for RichTextCtrl content.

The most flexible way to use this class is to create a temporary object and call its functions directly, rather than use RichTextBuffer#save_file or RichTextCtrl#save_file.

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 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 delete_temporary_images before the next load operation, or you must store the image locations and delete them yourself when appropriate. You can call get_temporary_image_locations 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:

RICHTEXT_HANDLER_SAVE_IMAGES_TO_MEMORY Images are saved to the memory filesystem: suitable for showing HTML windows.
RICHTEXT_HANDLER_SAVE_IMAGES_TO_FILES Images are saved to temporary files: suitable for showing in HTML 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.

Derived from


Data structures



RichTextHTMLHandler.new(String name = T("HTML"),  String ext = T("html"), 
                        Integer type = RICHTEXT_TYPE_HTML)




Clears the image locations generated by the last operation.


Boolean delete_temporary_images()

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

Boolean delete_temporary_images(Integer flags, 
                                ArrayString 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.


Boolean do_save_file(RichTextBuffer buffer, 
                     OutputStream stream)

Saves the buffer content to the HTML stream.


ArrayInt get_font_size_mapping()

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


String get_temp_dir()

Returns the directory used to store temporary image files.


ArrayString get_temporary_image_locations()

Returns the image locations for the last operation.


set_file_counter(Integer counter)

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


set_font_size_mapping(ArrayInt 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:

ArrayInt fontSizeMapping;


set_temp_dir(String tempDir)

Sets the directory for storing temporary files. If empty, the system temporary directory will be used.


set_temporary_image_locations(ArrayString locations)

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

[This page automatically generated from the Textile source at Wed Sep 09 02:21:22 +0100 2009]