wxRichTextHTMLHandler

Handles HTML output (only) for wxRichTextCtrl content.

The most flexible way to use this class is to create a temporary object and call its functions directly, rather than use wxRichTextBuffer::SaveFile or wxRichTextCtrl::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 wxRICHTEXT_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 wxHTML compatibility, you will need to use wxRICHTEXT_HANDLER_SAVE_IMAGES_TO_MEMORY or wxRICHTEXT_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.

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:

Derived from

wxRichTextFileHandler

Include files

<wx/richtext/richtexthtml.h>

Data structures

Members

wxRichTextHTMLHandler::wxRichTextHTMLHandler
wxRichTextHTMLHandler::ClearTemporaryImageLocations
wxRichTextHTMLHandler::DeleteTemporaryImages
wxRichTextHTMLHandler::DoSaveFile
wxRichTextHTMLHandler::GetFontSizeMapping
wxRichTextHTMLHandler::GetTempDir
wxRichTextHTMLHandler::GetTemporaryImageLocations
wxRichTextHTMLHandler::SetFileCounter
wxRichTextHTMLHandler::SetFontSizeMapping
wxRichTextHTMLHandler::SetTempDir
wxRichTextHTMLHandler::SetTemporaryImageLocations

wxRichTextHTMLHandler::wxRichTextHTMLHandler

wxRichTextHTMLHandler(const wxString& name = wxT("HTML"), const wxString& ext = wxT("html"), int type = wxRICHTEXT_TYPE_HTML)

Constructor.

wxRichTextHTMLHandler::ClearTemporaryImageLocations

void ClearTemporaryImageLocations()

Clears the image locations generated by the last operation.

wxRichTextHTMLHandler::DeleteTemporaryImages

bool DeleteTemporaryImages()

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

bool DeleteTemporaryImages(int flags, const wxArrayString& 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.

wxRichTextHTMLHandler::DoSaveFile

bool DoSaveFile(wxRichTextBuffer* buffer, wxOutputStream& stream)

Saves the buffer content to the HTML stream.

wxRichTextHTMLHandler::GetFontSizeMapping

wxArrayInt GetFontSizeMapping()

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

wxRichTextHTMLHandler::GetTempDir

const wxString& GetTempDir() const

Returns the directory used to store temporary image files.

wxRichTextHTMLHandler::GetTemporaryImageLocations

const wxArrayString& GetTemporaryImageLocations() const

Returns the image locations for the last operation.

wxRichTextHTMLHandler::SetFileCounter

void SetFileCounter(int counter)

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

wxRichTextHTMLHandler::SetFontSizeMapping

void SetFontSizeMapping(const wxArrayInt& 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:

    wxArrayInt fontSizeMapping;
    fontSizeMapping.Add(7);
    fontSizeMapping.Add(9);
    fontSizeMapping.Add(11);
    fontSizeMapping.Add(12);
    fontSizeMapping.Add(14);
    fontSizeMapping.Add(22);
    fontSizeMapping.Add(100);
    
    htmlHandler.SetFontSizeMapping(fontSizeMapping);

wxRichTextHTMLHandler::SetTempDir

void SetTempDir(const wxString& tempDir)

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

wxRichTextHTMLHandler::SetTemporaryImageLocations

void SetTemporaryImageLocations(const wxArrayString& locations)

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