Applied patch for Forty, print patch and wxHTML book patch

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

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

\section{\class{wxHtmlEasyPrinting}}\label{wxhtmleasyprinting}

This class provides very simple interface to printing 
architecture. It allows you to print HTML documents using
only a few commands. 

\wxheading{Note}

Do not create this class on the stack only. You should create an instance on app 
startup and use this instance for all printing operations. The reason is that
this class stores various settings in it.

\wxheading{Derived from}

\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/html/htmprint.h>


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

\membersection{wxHtmlEasyPrinting::wxHtmlEasyPrinting}\label{wxhtmleasyprintingwxhtmleasyprinting}

\func{}{wxHtmlEasyPrinting}{\param{const wxString\& }{name = "Printing"}, \param{wxFrame* }{parent\_frame = NULL}}

Constructor.

\wxheading{Parameters}

\docparam{name}{Name of the printing. Used by preview frames and setup dialogs.}

\docparam{parent\_frame}{pointer to the frame that will own preview frame and setup dialogs. May be NULL.}


\membersection{wxHtmlEasyPrinting::PreviewFile}\label{wxhtmleasyprintingpreviewfile}

\func{bool}{PreviewFile}{\param{const wxString\& }{htmlfile}}

Preview HTML file. 

Returns FALSE in case of error -- call
\helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed
information about the kind of the error.


\membersection{wxHtmlEasyPrinting::PreviewText}\label{wxhtmleasyprintingpreviewtext}

\func{bool}{PreviewText}{\param{const wxString\& }{htmltext}, \param{const wxString\& }{basepath = wxEmptyString}}

Preview HTML text (not file!). 

Returns FALSE in case of error -- call
\helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed
information about the kind of the error.

\wxheading{Parameters}

\docparam{htmltext}{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.}

\membersection{wxHtmlEasyPrinting::PrintFile}\label{wxhtmleasyprintingprintfile}

\func{bool}{PrintFile}{\param{const wxString\& }{htmlfile}}

Print HTML file.

Returns FALSE in case of error -- call
\helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed
information about the kind of the error.

\membersection{wxHtmlEasyPrinting::PrintText}\label{wxhtmleasyprintingprinttext}

\func{bool}{PrintText}{\param{const wxString\& }{htmltext}, \param{const wxString\& }{basepath = wxEmptyString}}

Print HTML text (not file!). 

Returns FALSE in case of error -- call
\helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed
information about the kind of the error.

\wxheading{Parameters}

\docparam{htmltext}{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.}

\membersection{wxHtmlEasyPrinting::PrinterSetup}\label{wxhtmleasyprintingprintersetup}

\func{void}{PrinterSetup}{\void}

Display printer setup dialog and allows the user to modify settings. 

\membersection{wxHtmlEasyPrinting::PageSetup}\label{wxhtmleasyprintingpagesetup}

\func{void}{PageSetup}{\void}

Display page setup dialog and allows the user to modify settings. 

\membersection{wxHtmlEasyPrinting::SetHeader}\label{wxhtmleasyprintingsetheader}

\func{void}{SetHeader}{\param{const wxString\& }{header}, \param{int }{pg = wxPAGE\_ALL}}

Set page header.

\wxheading{Parameters}

\docparam{header}{HTML text to be used as header. You can use macros in it:

\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{wxHtmlEasyPrinting::SetFooter}\label{wxhtmleasyprintingsetfooter}

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

Set page footer.

\wxheading{Parameters}

\docparam{footer}{HTML text to be used as footer. You can use macros in it:

\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{wxHtmlEasyPrinting::GetPrintData}\label{wxhtmleasyprintinggetprintdata}

\func{wxPrintData*}{GetPrintData}{\void}

Returns pointer to \helpref{wxPrintData}{wxprintdata} instance used by this class. You can
set its parameters (via SetXXXX methods).

\membersection{wxHtmlEasyPrinting::GetPageSetupData}\label{wxhtmleasyprintinggetpagesetupdata}

\func{wxPageSetupDialogData*}{GetPageSetupData}{\void}

Returns a pointer to \helpref{wxPageSetupDialogData}{wxpagesetupdialogdata} instance used by 
this class. You can set its parameters (via SetXXXX methods).