]>
git.saurik.com Git - wxWidgets.git/blob - interface/richtext/richtexthtml.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: richtext/richtexthtml.h
3 // Purpose: documentation for wxRichTextHTMLHandler class
4 // Author: wxWidgets team
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
10 @class wxRichTextHTMLHandler
11 @headerfile richtexthtml.h wx/richtext/richtexthtml.h
13 Handles HTML output (only) for wxRichTextCtrl content.
15 The most flexible way to use this class is to create a temporary object and call
16 its functions directly, rather than use wxRichTextBuffer::SaveFile or
17 wxRichTextCtrl::SaveFile.
19 Image handling requires a little extra work from the application, to choose an
20 appropriate image format for the target HTML viewer and to clean up the
22 later. If you are planning to load the HTML into a standard web browser, you can
23 specify the handler flag wxRICHTEXT_HANDLER_SAVE_IMAGES_TO_BASE64 (the default)
24 and no extra work is required: the images will be written with the HTML.
26 However, if you want wxHTML compatibility, you will need to use
27 wxRICHTEXT_HANDLER_SAVE_IMAGES_TO_MEMORY
28 or wxRICHTEXT_HANDLER_SAVE_IMAGES_TO_FILES. In this case, you must either call
29 wxRichTextHTMLHandler::DeleteTemporaryImages before
30 the next load operation, or you must store the image
31 locations and delete them yourself when appropriate. You can call
32 wxRichTextHTMLHandler::GetTemporaryImageLocations to
33 get the array of temporary image names.
38 class wxRichTextHTMLHandler
: public wxRichTextFileHandler
42 , @b const wxString&@e ext = wxT("html"), @b int@e type = wxRICHTEXT_TYPE_HTML)
46 wxRichTextHTMLHandler();
49 Clears the image locations generated by the last operation.
51 void ClearTemporaryImageLocations();
55 Delete the in-memory or temporary files generated by the last operation. This
57 function that can be used to delete the saved locations from an earlier
59 for example after the user has viewed the HTML file.
61 bool DeleteTemporaryImages();
62 bool DeleteTemporaryImages(int flags
,
63 const wxArrayString
& imageLocations
);
67 Saves the buffer content to the HTML stream.
69 bool DoSaveFile(wxRichTextBuffer
* buffer
, wxOutputStream
& stream
);
72 Returns the mapping for converting point sizes to HTML font sizes.
74 wxArrayInt
GetFontSizeMapping();
77 Returns the directory used to store temporary image files.
79 const wxString
GetTempDir();
82 Returns the image locations for the last operation.
84 const wxArrayString
GetTemporaryImageLocations();
87 Reset the file counter, in case, for example, the same names are required each
90 void SetFileCounter(int counter
);
93 Sets the mapping for converting point sizes to HTML font sizes.
94 There should be 7 elements, one for each HTML font size, each element
95 specifying the maximum point size for that
100 void SetFontSizeMapping(const wxArrayInt
& fontSizeMapping
);
103 Sets the directory for storing temporary files. If empty, the system
104 temporary directory will be used.
106 void SetTempDir(const wxString
& tempDir
);
109 Sets the list of image locations generated by the last operation.
111 void SetTemporaryImageLocations(const wxArrayString
& locations
);