Added project files for STC; fixed wxStringList memory leaks; small doc changes;

[wxWidgets.git] / docs / latex / wx / htprint.tex

%
% automatically generated by HelpGen from
% htmprint.h at 17/Oct/99 12:48:02
%


\section{\class{wxHtmlPrintout}}\label{wxhtmlprintout}

This class serves as printout class for HTML documents.

\wxheading{Derived from}

\helpref{wxPrintout}{wxprintout}


\wxheading{Include files}

<wx/html/htmprint.h>

\latexignore{\rtfignore{\wxheading{Members}}}


\membersection{wxHtmlPrintout::wxHtmlPrintout}\label{wxhtmlprintoutwxhtmlprintout}

\func{}{wxHtmlPrintout}{\param{const wxString\& }{title = "Printout"}}

Constructor. 



\membersection{wxHtmlPrintout::SetFooter}\label{wxhtmlprintoutsetfooter}

\func{void}{SetFooter}{\param{const wxString\& }{footer}, \param{int }{pg = wxPAGE\_ALL}}

Sets page footer.

\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{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.

\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{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}


\membersection{wxHtmlPrintout::SetHtmlFile}\label{wxhtmlprintoutsethtmlfile}

\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}

\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{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)}



\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
between text and header and/or footer