docs/latex/wx/richtexthtmlhandler.tex

   1 \section{\class{wxRichTextHTMLHandler}}\label{wxrichtexthtmlhandler}
   2
   3 Handles HTML output (only) for \helpref{wxRichTextCtrl}{wxrichtextctrl} content.
   4
   5 The most flexible way to use this class is to create a temporary object and call
   6 its functions directly, rather than use \helpref{wxRichTextBuffer::SaveFile}{wxrichtextbuffersavefile} or\rtfsp
   7 \helpref{wxRichTextCtrl::SaveFile}{wxrichtextctrlsavefile}.
   8
   9 Image handling requires a little extra work from the application, to choose an
  10 appropriate image format for the target HTML viewer and to clean up the temporary images
  11 later. If you are planning to load the HTML into a standard web browser, you can
  12 specify the handler flag wxRICHTEXT\_HANDLER\_SAVE\_IMAGES\_TO\_BASE64 (the default)
  13 and no extra work is required: the images will be written with the HTML.
  14
  15 However, if you want wxHTML compatibility, you will need to use wxRICHTEXT\_HANDLER\_SAVE\_IMAGES\_TO\_MEMORY
  16 or wxRICHTEXT\_HANDLER\_SAVE\_IMAGES\_TO\_FILES. In this case, you must either call \helpref{DeleteTemporaryImages}{wxrichtexthtmlhandlerdeletetemporaryimages} before
  17 the next load operation, or you must store the image
  18 locations and delete them yourself when appropriate. You can call \helpref{GetTemporaryImageLocations}{wxrichtexthtmlhandlergettemporaryimagelocations} to
  19 get the array of temporary image names.
  20
  21 \wxheading{Handler flags}
  22
  23 The following flags can be used with this handler, via
  24 the handler's SetFlags function or the buffer or control's
  25 SetHandlerFlags function:
  26
  27 \twocolwidtha{7cm}
  28 \begin{twocollist}\itemsep=0pt
  29 \twocolitem{\windowstyle{wxRICHTEXT\_HANDLER\_SAVE\_IMAGES\_TO\_MEMORY}}{Images are saved to the memory filesystem: suitable for showing wxHTML windows.}
  30 \twocolitem{\windowstyle{wxRICHTEXT\_HANDLER\_SAVE\_IMAGES\_TO\_FILES}}{Images are saved to temporary files: suitable for showing in wxHTML windows.}
  31 \twocolitem{\windowstyle{wxRICHTEXT\_HANDLER\_SAVE\_IMAGES\_TO\_BASE64}}{Images are written with the HTML files in Base 64 format: suitable for showing in web browsers.}
  32 \twocolitem{\windowstyle{wxRICHTEXT\_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.}
  33 \end{twocollist}
  34
  35 \wxheading{Derived from}
  36
  37 \helpref{wxRichTextFileHandler}{wxrichtextfilehandler}
  38
  39 \wxheading{Include files}
  40
  41 <wx/richtext/richtexthtml.h>
  42
  43 \wxheading{Library}
  44
  45 \helpref{wxRichtext}{librarieslist}
  46
  47 \wxheading{Data structures}
  48
  49 \latexignore{\rtfignore{\wxheading{Members}}}
  50
  51 \membersection{wxRichTextHTMLHandler::wxRichTextHTMLHandler}\label{wxrichtexthtmlhandlerwxrichtexthtmlhandler}
  52
  53 \func{}{wxRichTextHTMLHandler}{\param{const wxString\& }{name = wxT("HTML")}, \param{const wxString\& }{ext = wxT("html")}, \param{int }{type = wxRICHTEXT\_TYPE\_HTML}}
  54
  55 Constructor.
  56
  57 \membersection{wxRichTextHTMLHandler::ClearTemporaryImageLocations}\label{wxrichtexthtmlhandlercleartemporaryimagelocations}
  58
  59 \func{void}{ClearTemporaryImageLocations}{\void}
  60
  61 Clears the image locations generated by the last operation.
  62
  63 \membersection{wxRichTextHTMLHandler::DeleteTemporaryImages}\label{wxrichtexthtmlhandlerdeletetemporaryimages}
  64
  65 \func{bool}{DeleteTemporaryImages}{\void}
  66
  67 Deletes the in-memory or temporary files generated by the last operation.
  68
  69 \func{bool}{DeleteTemporaryImages}{\param{int }{flags}, \param{const wxArrayString\& }{imageLocations}}
  70
  71 Delete the in-memory or temporary files generated by the last operation. This is a static
  72 function that can be used to delete the saved locations from an earlier operation,
  73 for example after the user has viewed the HTML file.
  74
  75 \membersection{wxRichTextHTMLHandler::DoSaveFile}\label{wxrichtexthtmlhandlerdosavefile}
  76
  77 \func{bool}{DoSaveFile}{\param{wxRichTextBuffer* }{buffer}, \param{wxOutputStream\& }{stream}}
  78
  79 Saves the buffer content to the HTML stream.
  80
  81 \membersection{wxRichTextHTMLHandler::GetFontSizeMapping}\label{wxrichtexthtmlhandlergetfontsizemapping}
  82
  83 \func{wxArrayInt}{GetFontSizeMapping}{\void}
  84
  85 Returns the mapping for converting point sizes to HTML font sizes.
  86
  87 \membersection{wxRichTextHTMLHandler::GetTempDir}\label{wxrichtexthtmlhandlergettempdir}
  88
  89 \constfunc{const wxString\&}{GetTempDir}{\void}
  90
  91 Returns the directory used to store temporary image files.
  92
  93 \membersection{wxRichTextHTMLHandler::GetTemporaryImageLocations}\label{wxrichtexthtmlhandlergettemporaryimagelocations}
  94
  95 \constfunc{const wxArrayString\&}{GetTemporaryImageLocations}{\void}
  96
  97 Returns the image locations for the last operation.
  98
  99 \membersection{wxRichTextHTMLHandler::SetFileCounter}\label{wxrichtexthtmlhandlersetfilecounter}
 100
 101 \func{void}{SetFileCounter}{\param{int }{counter}}
 102
 103 Reset the file counter, in case, for example, the same names are required each time
 104
 105 \membersection{wxRichTextHTMLHandler::SetFontSizeMapping}\label{wxrichtexthtmlhandlersetfontsizemapping}
 106
 107 \func{void}{SetFontSizeMapping}{\param{const wxArrayInt\& }{fontSizeMapping}}
 108
 109 Sets the mapping for converting point sizes to HTML font sizes.
 110 There should be 7 elements, one for each HTML font size, each element specifying the maximum point size for that
 111 HTML font size.
 112
 113 For example:
 114
 115 \begin{verbatim}
 116     wxArrayInt fontSizeMapping;
 117     fontSizeMapping.Add(7);
 118     fontSizeMapping.Add(9);
 119     fontSizeMapping.Add(11);
 120     fontSizeMapping.Add(12);
 121     fontSizeMapping.Add(14);
 122     fontSizeMapping.Add(22);
 123     fontSizeMapping.Add(100);
 124
 125     htmlHandler.SetFontSizeMapping(fontSizeMapping);
 126 \end{verbatim}
 127
 128 \membersection{wxRichTextHTMLHandler::SetTempDir}\label{wxrichtexthtmlhandlersettempdir}
 129
 130 \func{void}{SetTempDir}{\param{const wxString\& }{tempDir}}
 131
 132 Sets the directory for storing temporary files. If empty, the system
 133 temporary directory will be used.
 134
 135 \membersection{wxRichTextHTMLHandler::SetTemporaryImageLocations}\label{wxrichtexthtmlhandlersettemporaryimagelocations}
 136
 137 \func{void}{SetTemporaryImageLocations}{\param{const wxArrayString\& }{locations}}
 138
 139 Sets the list of image locations generated by the last operation.
 140