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{Data structures}
  44
  45 \latexignore{\rtfignore{\wxheading{Members}}}
  46
  47 \membersection{wxRichTextHTMLHandler::wxRichTextHTMLHandler}\label{wxrichtexthtmlhandlerwxrichtexthtmlhandler}
  48
  49 \func{}{wxRichTextHTMLHandler}{\param{const wxString\& }{name = wxT("HTML")}, \param{const wxString\& }{ext = wxT("html")}, \param{int }{type = wxRICHTEXT\_TYPE\_HTML}}
  50
  51 Constructor.
  52
  53 \membersection{wxRichTextHTMLHandler::ClearTemporaryImageLocations}\label{wxrichtexthtmlhandlercleartemporaryimagelocations}
  54
  55 \func{void}{ClearTemporaryImageLocations}{\void}
  56
  57 Clears the image locations generated by the last operation.
  58
  59 \membersection{wxRichTextHTMLHandler::DeleteTemporaryImages}\label{wxrichtexthtmlhandlerdeletetemporaryimages}
  60
  61 \func{bool}{DeleteTemporaryImages}{\void}
  62
  63 Deletes the in-memory or temporary files generated by the last operation.
  64
  65 \func{bool}{DeleteTemporaryImages}{\param{int }{flags}, \param{const wxArrayString\& }{imageLocations}}
  66
  67 Delete the in-memory or temporary files generated by the last operation. This is a static
  68 function that can be used to delete the saved locations from an earlier operation,
  69 for example after the user has viewed the HTML file.
  70
  71 \membersection{wxRichTextHTMLHandler::DoSaveFile}\label{wxrichtexthtmlhandlerdosavefile}
  72
  73 \func{bool}{DoSaveFile}{\param{wxRichTextBuffer* }{buffer}, \param{wxOutputStream\& }{stream}}
  74
  75 Saves the buffer content to the HTML stream.
  76
  77 \membersection{wxRichTextHTMLHandler::GetTempDir}\label{wxrichtexthtmlhandlergettempdir}
  78
  79 \constfunc{const wxString\&}{GetTempDir}{\void}
  80
  81 Returns the directory used to store temporary image files.
  82
  83 \membersection{wxRichTextHTMLHandler::GetTemporaryImageLocations}\label{wxrichtexthtmlhandlergettemporaryimagelocations}
  84
  85 \constfunc{const wxArrayString\&}{GetTemporaryImageLocations}{\void}
  86
  87 Returns the image locations for the last operation.
  88
  89 \membersection{wxRichTextHTMLHandler::SetFileCounter}\label{wxrichtexthtmlhandlersetfilecounter}
  90
  91 \func{void}{SetFileCounter}{\param{int }{counter}}
  92
  93 Reset the file counter, in case, for example, the same names are required each time
  94
  95 \membersection{wxRichTextHTMLHandler::SetTempDir}\label{wxrichtexthtmlhandlersettempdir}
  96
  97 \func{void}{SetTempDir}{\param{const wxString\& }{tempDir}}
  98
  99 Sets the directory for storing temporary files. If empty, the system
 100 temporary directory will be used.
 101
 102 \membersection{wxRichTextHTMLHandler::SetTemporaryImageLocations}\label{wxrichtexthtmlhandlersettemporaryimagelocations}
 103
 104 \func{void}{SetTemporaryImageLocations}{\param{const wxArrayString\& }{locations}}
 105
 106 Sets the list of image locations generated by the last operation.
 107