]>
git.saurik.com Git - wxWidgets.git/blob - interface/wx/richtext/richtexthtml.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: richtext/richtexthtml.h
3 // Purpose: interface of wxRichTextHTMLHandler
4 // Author: wxWidgets team
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
10 @class wxRichTextHTMLHandler
12 Handles HTML output (only) for wxRichTextCtrl content.
14 The most flexible way to use this class is to create a temporary object and call
15 its functions directly, rather than use wxRichTextBuffer::SaveFile or
16 wxRichTextCtrl::SaveFile.
18 Image handling requires a little extra work from the application, to choose an
19 appropriate image format for the target HTML viewer and to clean up the temporary
21 If you are planning to load the HTML into a standard web browser, you can
22 specify the handler flag wxRICHTEXT_HANDLER_SAVE_IMAGES_TO_BASE64 (the default)
23 and no extra work is required: the images will be written with the HTML.
25 However, if you want wxHTML compatibility, you will need to use
26 @c wxRICHTEXT_HANDLER_SAVE_IMAGES_TO_MEMORY or
27 @c wxRICHTEXT_HANDLER_SAVE_IMAGES_TO_FILES.
29 In this case, you must either call wxRichTextHTMLHandler::DeleteTemporaryImages
30 before the next load operation, or you must store the image locations and
31 delete them yourself when appropriate.
33 You can call wxRichTextHTMLHandler::GetTemporaryImageLocations to
34 get the array of temporary image names.
37 @section richtexthtmlhandler_flags Handler flags
39 The following flags can be used with this handler, via the handler's SetFlags()
40 function or the buffer or control's SetHandlerFlags() function:
42 - wxRICHTEXT_HANDLER_SAVE_IMAGES_TO_MEMORY
43 Images are saved to the memory filesystem: suitable for showing wxHTML windows.
44 - wxRICHTEXT_HANDLER_SAVE_IMAGES_TO_FILES
45 Images are saved to temporary files: suitable for showing in wxHTML windows.
46 - wxRICHTEXT_HANDLER_SAVE_IMAGES_TO_BASE64
47 Images are written with the HTML files in Base 64 format: suitable for showing
49 - wxRICHTEXT_HANDLER_NO_HEADER_FOOTER
50 Don't include header and footer tags (HTML, HEAD, BODY), so that the HTML
51 can be used as part of a larger document.
57 class wxRichTextHTMLHandler
: public wxRichTextFileHandler
63 wxRichTextHTMLHandler(const wxString
& name
= wxT("HTML"),
64 const wxString
& ext
= wxT("html"),
65 int type
= wxRICHTEXT_TYPE_HTML
);
68 Clears the image locations generated by the last operation.
70 void ClearTemporaryImageLocations();
73 Deletes the in-memory or temporary files generated by the last operation.
75 bool DeleteTemporaryImages();
78 Delete the in-memory or temporary files generated by the last operation.
79 This is a static function that can be used to delete the saved locations
80 from an earlier operation, for example after the user has viewed the HTML file.
82 static bool DeleteTemporaryImages(int flags
,
83 const wxArrayString
& imageLocations
);
86 Saves the buffer content to the HTML stream.
88 virtual bool DoSaveFile(wxRichTextBuffer
* buffer
, wxOutputStream
& stream
);
91 Returns the mapping for converting point sizes to HTML font sizes.
93 wxArrayInt
GetFontSizeMapping() const;
96 Returns the directory used to store temporary image files.
98 const wxString
GetTempDir() const;
101 Returns the image locations for the last operation.
103 const wxArrayString
GetTemporaryImageLocations() const;
106 Reset the file counter, in case, for example, the same names are required each
109 static void SetFileCounter(int counter
);
112 Sets the mapping for converting point sizes to HTML font sizes.
114 There should be 7 elements, one for each HTML font size, each element
115 specifying the maximum point size for that HTML font size.
118 wxArrayInt fontSizeMapping;
119 fontSizeMapping.Add(7);
120 fontSizeMapping.Add(9);
121 fontSizeMapping.Add(11);
122 fontSizeMapping.Add(12);
123 fontSizeMapping.Add(14);
124 fontSizeMapping.Add(22);
125 fontSizeMapping.Add(100);
127 htmlHandler.SetFontSizeMapping(fontSizeMapping);
130 void SetFontSizeMapping(const wxArrayInt
& fontSizeMapping
);
133 Sets the directory for storing temporary files.
134 If empty, the system temporary directory will be used.
136 void SetTempDir(const wxString
& tempDir
);
139 Sets the list of image locations generated by the last operation.
141 void SetTemporaryImageLocations(const wxArrayString
& locations
);