X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9704b2509ac4fd7b9fccd5299e0b377accb2b59e..c266eff98c5e44012647f54f38a1e29ecabd8759:/docs/latex/wx/htprint.tex diff --git a/docs/latex/wx/htprint.tex b/docs/latex/wx/htprint.tex index 9527dcf687..48235aa9d4 100644 --- a/docs/latex/wx/htprint.tex +++ b/docs/latex/wx/htprint.tex @@ -10,13 +10,18 @@ This class serves as printout class for HTML documents. \wxheading{Derived from} -\helpref{wxPrintout}{wxprintout} +\helpref{wxPrintout}{wxprintout}\\ +\helpref{wxObject}{wxobject} \wxheading{Include files} +\wxheading{Library} + +\helpref{wxHtml}{librarieslist} + \latexignore{\rtfignore{\wxheading{Members}}} @@ -27,21 +32,30 @@ This class serves as printout class for HTML documents. Constructor. +\membersection{wxHtmlPrintout::AddFilter}\label{wxhtmlprintoutaddfilter} + +\func{static void}{AddFilter}{\param{wxHtmlFilter* }{filter}} + +Adds a filter to the static list of filters for wxHtmlPrintout. See \helpref{wxHtmlFilter}{wxhtmlfilter} for +further information. + +\membersection{wxHtmlPrintout::SetFonts}\label{wxhtmlprintoutsetfonts} + +\func{void}{SetFonts}{\param{const wxString\& }{normal\_face}, \param{const wxString\& }{fixed\_face}, \param{const int }{*sizes = NULL}} + +Sets fonts. See \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts} for +detailed description. \membersection{wxHtmlPrintout::SetFooter}\label{wxhtmlprintoutsetfooter} \func{void}{SetFooter}{\param{const wxString\& }{footer}, \param{int }{pg = wxPAGE\_ALL}} -Sets page footer. +Set page footer. The following macros can be used inside it: +\input htprintmacros.inc \wxheading{Parameters} -\docparam{footer}{HTML text to be used as footer. You can use macros in it: -\begin{itemize} -\item @PAGENUM@ is replaced by page number -\item @PAGESCNT@ is replaced by total number of pages -\end{itemize} -} +\docparam{footer}{HTML text to be used as footer.} \docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.} @@ -50,16 +64,12 @@ Sets page footer. \func{void}{SetHeader}{\param{const wxString\& }{header}, \param{int }{pg = wxPAGE\_ALL}} -Sets page header. +Set page header. The following macros can be used inside it: +\input htprintmacros.inc \wxheading{Parameters} -\docparam{header}{HTML text to be used as header. You can use macros in it: -\begin{itemize} -\item @PAGENUM@ is replaced by page number -\item @PAGESCNT@ is replaced by total number of pages -\end{itemize} -} +\docparam{header}{HTML text to be used as header.} \docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.} @@ -75,7 +85,7 @@ any virtual file system or it may be normal file. \membersection{wxHtmlPrintout::SetHtmlText}\label{wxhtmlprintoutsethtmltext} -\func{void}{SetHtmlText}{\param{const wxString\& }{html}, \param{const wxString\& }{basepath = wxEmptyString}, \param{bool }{isdir = TRUE}} +\func{void}{SetHtmlText}{\param{const wxString\& }{html}, \param{const wxString\& }{basepath = wxEmptyString}, \param{bool }{isdir = true}} Prepare the class for printing this HTML text. @@ -86,7 +96,7 @@ Prepare the class for printing this HTML text. \docparam{basepath}{base directory (html string would be stored there if it was in file). It is used to determine path for loading images, for example.} -\docparam{isdir}{FALSE if basepath is filename, TRUE if it is directory name +\docparam{isdir}{false if basepath is filename, true if it is directory name (see \helpref{wxFileSystem}{wxfilesystem} for detailed explanation)} @@ -95,6 +105,6 @@ file). It is used to determine path for loading images, for example.} \func{void}{SetMargins}{\param{float }{top = 25.2}, \param{float }{bottom = 25.2}, \param{float }{left = 25.2}, \param{float }{right = 25.2}, \param{float }{spaces = 5}} -Sets margins in milimeters. Defaults to 1 inch for margins and 0.5cm for space +Sets margins in millimeters. Defaults to 1 inch for margins and 0.5cm for space between text and header and/or footer