]> git.saurik.com Git - wxWidgets.git/blame - interface/wx/richtext/richtexthtml.h
undo the last change as it results in buildbot configuration error
[wxWidgets.git] / interface / wx / richtext / richtexthtml.h
CommitLineData
23324ae1
FM
1/////////////////////////////////////////////////////////////////////////////
2// Name: richtext/richtexthtml.h
21b447dc 3// Purpose: interface of wxRichTextHTMLHandler
23324ae1
FM
4// Author: wxWidgets team
5// RCS-ID: $Id$
6// Licence: wxWindows license
7/////////////////////////////////////////////////////////////////////////////
8
9/**
10 @class wxRichTextHTMLHandler
7c913512 11
23324ae1 12 Handles HTML output (only) for wxRichTextCtrl content.
7c913512 13
23324ae1
FM
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.
7c913512 17
23324ae1 18 Image handling requires a little extra work from the application, to choose an
9e7ad1ca
FM
19 appropriate image format for the target HTML viewer and to clean up the temporary
20 images later.
21 If you are planning to load the HTML into a standard web browser, you can
23324ae1
FM
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.
7c913512 24
23324ae1 25 However, if you want wxHTML compatibility, you will need to use
9e7ad1ca
FM
26 @c wxRICHTEXT_HANDLER_SAVE_IMAGES_TO_MEMORY or
27 @c wxRICHTEXT_HANDLER_SAVE_IMAGES_TO_FILES.
28
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.
32
33 You can call wxRichTextHTMLHandler::GetTemporaryImageLocations to
23324ae1 34 get the array of temporary image names.
7c913512 35
9e7ad1ca
FM
36
37 @section richtexthtmlhandler_flags Handler flags
38
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:
41
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
48 in web browsers.
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.
52
53
23324ae1 54 @library{wxrichtext}
21b447dc 55 @category{richtext}
23324ae1
FM
56*/
57class wxRichTextHTMLHandler : public wxRichTextFileHandler
58{
59public:
60 /**
23324ae1
FM
61 Constructor.
62 */
f8ebb70d
FM
63 wxRichTextHTMLHandler(const wxString& name = "HTML",
64 const wxString& ext = "html",
9e7ad1ca 65 int type = wxRICHTEXT_TYPE_HTML);
23324ae1
FM
66
67 /**
68 Clears the image locations generated by the last operation.
69 */
70 void ClearTemporaryImageLocations();
71
23324ae1 72 /**
9e7ad1ca 73 Deletes the in-memory or temporary files generated by the last operation.
23324ae1
FM
74 */
75 bool DeleteTemporaryImages();
9e7ad1ca
FM
76
77 /**
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.
81 */
fadc2df6
FM
82 static bool DeleteTemporaryImages(int flags,
83 const wxArrayString& imageLocations);
23324ae1 84
23324ae1
FM
85 /**
86 Returns the mapping for converting point sizes to HTML font sizes.
87 */
adaaa686 88 wxArrayInt GetFontSizeMapping() const;
23324ae1
FM
89
90 /**
91 Returns the directory used to store temporary image files.
92 */
5267aefd 93 const wxString& GetTempDir() const;
23324ae1
FM
94
95 /**
96 Returns the image locations for the last operation.
97 */
5267aefd 98 const wxArrayString& GetTemporaryImageLocations() const;
23324ae1
FM
99
100 /**
101 Reset the file counter, in case, for example, the same names are required each
9e7ad1ca 102 time.
23324ae1 103 */
adaaa686 104 static void SetFileCounter(int counter);
23324ae1
FM
105
106 /**
107 Sets the mapping for converting point sizes to HTML font sizes.
9e7ad1ca 108
23324ae1 109 There should be 7 elements, one for each HTML font size, each element
9e7ad1ca 110 specifying the maximum point size for that HTML font size.
23324ae1 111 For example:
9e7ad1ca
FM
112 @code
113 wxArrayInt fontSizeMapping;
114 fontSizeMapping.Add(7);
115 fontSizeMapping.Add(9);
116 fontSizeMapping.Add(11);
117 fontSizeMapping.Add(12);
118 fontSizeMapping.Add(14);
119 fontSizeMapping.Add(22);
120 fontSizeMapping.Add(100);
121
122 htmlHandler.SetFontSizeMapping(fontSizeMapping);
123 @endcode
23324ae1
FM
124 */
125 void SetFontSizeMapping(const wxArrayInt& fontSizeMapping);
126
127 /**
9e7ad1ca
FM
128 Sets the directory for storing temporary files.
129 If empty, the system temporary directory will be used.
23324ae1
FM
130 */
131 void SetTempDir(const wxString& tempDir);
132
133 /**
134 Sets the list of image locations generated by the last operation.
135 */
136 void SetTemporaryImageLocations(const wxArrayString& locations);
5e6e278d
FM
137
138protected:
139 /**
140 Saves the buffer content to the HTML stream.
141 */
142 virtual bool DoSaveFile(wxRichTextBuffer* buffer, wxOutputStream& stream);
23324ae1 143};
e54c96f1 144