X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3ce369e6876c49ad7a101ad222048bd5446b7125..81c882b613b5d99ddb1e5ab69fcd7ebccc287025:/docs/latex/wx/htprint.tex?ds=sidebyside diff --git a/docs/latex/wx/htprint.tex b/docs/latex/wx/htprint.tex index a3bb4b60e2..0889db67be 100644 --- a/docs/latex/wx/htprint.tex +++ b/docs/latex/wx/htprint.tex @@ -13,6 +13,10 @@ This class serves as printout class for HTML documents. \helpref{wxPrintout}{wxprintout} +\wxheading{Include files} + + + \latexignore{\rtfignore{\wxheading{Members}}} @@ -23,74 +27,79 @@ This class serves as printout class for HTML documents. Constructor. +\membersection{wxHtmlPrintout::AddFilter}\label{wxhtmlprintoutaddfilter} -\membersection{wxHtmlPrintout::SetHtmlText}\label{wxhtmlprintoutsethtmltext} - -\func{void}{SetHtmlText}{\param{const wxString\& }{html}, \param{const wxString\& }{basepath = wxEmptyString}, \param{bool }{isdir = TRUE}} - -Prepare the class for printing this HTML text. +\func{static void}{AddFilter}{\param{wxHtmlFilter* }{filter}} -\wxheading{Parameters} +Adds a filter to the static list of filters for wxHtmlPrintout. See \helpref{wxHtmlFilter}{wxhtmlfilter} for +further information. -\docparam{html}{HTML text. (NOT file!)} +\membersection{wxHtmlPrintout::SetFonts}\label{wxhtmlprintoutsetfonts} -\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.} +\func{void}{SetFonts}{\param{const wxString\& }{normal\_face}, \param{const wxString\& }{fixed\_face}, \param{const int }{*sizes = NULL}} -\docparam{isdir}{FALSE if basepath is filename, TRUE if it is directory name -(see \helpref{wxFileSystem}{wxfilesystem} for detailed explanation)} +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}} -\membersection{wxHtmlPrintout::SetHtmlFile}\label{wxhtmlprintoutsethtmlfile} +Set page footer. The following macros can be used inside it: +\input htprintmacros.inc -\func{void}{SetHtmlFile}{\param{const wxString\& }{htmlfile}} +\wxheading{Parameters} -Prepare the class for printing this HTML {\bf file}. The file may be located on -any virtual file system or it may be normal file. +\docparam{footer}{HTML text to be used as footer.} +\docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.} \membersection{wxHtmlPrintout::SetHeader}\label{wxhtmlprintoutsetheader} \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.} -\membersection{wxHtmlPrintout::SetFooter}\label{wxhtmlprintoutsetfooter} +\membersection{wxHtmlPrintout::SetHtmlFile}\label{wxhtmlprintoutsethtmlfile} -\func{void}{SetFooter}{\param{const wxString\& }{footer}, \param{int }{pg = wxPAGE\_ALL}} +\func{void}{SetHtmlFile}{\param{const wxString\& }{htmlfile}} + +Prepare the class for printing this HTML {\bf file}. The file may be located on +any virtual file system or it may be normal file. + + + +\membersection{wxHtmlPrintout::SetHtmlText}\label{wxhtmlprintoutsethtmltext} -Sets page footer. +\func{void}{SetHtmlText}{\param{const wxString\& }{html}, \param{const wxString\& }{basepath = wxEmptyString}, \param{bool }{isdir = true}} + +Prepare the class for printing this HTML text. \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{html}{HTML text. (NOT file!)} + +\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 +(see \helpref{wxFileSystem}{wxfilesystem} for detailed explanation)} -\docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.} \membersection{wxHtmlPrintout::SetMargins}\label{wxhtmlprintoutsetmargins} \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