X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/448af9a46eb58ae17616a4d5e76884dc519f5523..8e72b8b51770b59a83eb32f4d766b89f6c4dc615:/docs/latex/wx/htprint.tex diff --git a/docs/latex/wx/htprint.tex b/docs/latex/wx/htprint.tex index 262cee2815..9527dcf687 100644 --- a/docs/latex/wx/htprint.tex +++ b/docs/latex/wx/htprint.tex @@ -3,44 +3,48 @@ % htmprint.h at 17/Oct/99 12:48:02 % + \section{\class{wxHtmlPrintout}}\label{wxhtmlprintout} -This class serves as a printout class for HTML documents. +This class serves as printout class for HTML documents. \wxheading{Derived from} \helpref{wxPrintout}{wxprintout} + +\wxheading{Include files} + + + \latexignore{\rtfignore{\wxheading{Members}}} + \membersection{wxHtmlPrintout::wxHtmlPrintout}\label{wxhtmlprintoutwxhtmlprintout} \func{}{wxHtmlPrintout}{\param{const wxString\& }{title = "Printout"}} Constructor. -\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. - -\wxheading{Parameters} +\membersection{wxHtmlPrintout::SetFooter}\label{wxhtmlprintoutsetfooter} -\docparam{html}{HTML text. (NOT file!)} +\func{void}{SetFooter}{\param{const wxString\& }{footer}, \param{int }{pg = wxPAGE\_ALL}} -\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.} +Sets page footer. -\docparam{isdir}{FALSE if basepath is filename, TRUE if it is directory name -(see \helpref{wxFileSystem}{wxfilesystem} for detailed explanation)} +\wxheading{Parameters} -\membersection{wxHtmlPrintout::SetHtmlFile}\label{wxhtmlprintoutsethtmlfile} +\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} +} -\func{void}{SetHtmlFile}{\param{const wxString\& }{htmlfile}} +\docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.} -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::SetHeader}\label{wxhtmlprintoutsetheader} @@ -51,8 +55,7 @@ Sets page header. \wxheading{Parameters} \docparam{header}{HTML text to be used as header. You can use macros in it: - -\begin{itemize}\itemsep=0pt +\begin{itemize} \item @PAGENUM@ is replaced by page number \item @PAGESCNT@ is replaced by total number of pages \end{itemize} @@ -61,23 +64,32 @@ Sets page 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}} -Sets page footer. +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} + +\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: +\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)} -\begin{itemize}\itemsep=0pt -\item @PAGENUM@ is replaced by page number -\item @PAGESCNT@ is replaced by total number of pages -\end{itemize} -} -\docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.} \membersection{wxHtmlPrintout::SetMargins}\label{wxhtmlprintoutsetmargins}