quote an underscore

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

diff --git a/docs/latex/wx/hteasypr.tex b/docs/latex/wx/hteasypr.tex
index ceb66dbd3e431627f26b59ba2c61eebd10c3ac49..ea10029f55136e1360dd30d04f8c7a9992eb9e07 100644 (file)
--- a/docs/latex/wx/hteasypr.tex
+++ b/docs/latex/wx/hteasypr.tex
@@ -19,32 +19,45 @@ this class stores various settings in it.
 
 \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}}
+\func{}{wxHtmlEasyPrinting}{\param{const wxString\& }{name = "Printing"}, \param{wxWindow* }{parentWindow = 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.}
+\docparam{name}{Name of the printing object. Used by preview frames and setup dialogs.}
 
+\docparam{parentWindow}{pointer to the window that will own the preview frame and setup dialogs. May be NULL.}
 
 \membersection{wxHtmlEasyPrinting::PreviewFile}\label{wxhtmleasyprintingpreviewfile}
 
-\func{void}{PreviewFile}{\param{const wxString\& }{htmlfile}}
+\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.
 
-Previews HTML file. 
 
 \membersection{wxHtmlEasyPrinting::PreviewText}\label{wxhtmleasyprintingpreviewtext}
 
-\func{void}{PreviewText}{\param{const wxString\& }{htmltext}, \param{const wxString\& }{basepath = wxEmptyString}}
+\func{bool}{PreviewText}{\param{const wxString\& }{htmltext}, \param{const wxString\& }{basepath = wxEmptyString}}
 
-Previews HTML text (not file!). 
+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}
 
@@ -55,15 +68,23 @@ file). It is used to determine path for loading images, for example.}
 
 \membersection{wxHtmlEasyPrinting::PrintFile}\label{wxhtmleasyprintingprintfile}
 
-\func{void}{PrintFile}{\param{const wxString\& }{htmlfile}}
+\func{bool}{PrintFile}{\param{const wxString\& }{htmlfile}}
+
+Print HTML file.
 
-Prints 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{void}{PrintText}{\param{const wxString\& }{htmltext}, \param{const wxString\& }{basepath = wxEmptyString}}
+\func{bool}{PrintText}{\param{const wxString\& }{htmltext}, \param{const wxString\& }{basepath = wxEmptyString}}
 
-Prints HTML text (not file!). 
+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}
 
@@ -72,32 +93,29 @@ Prints 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.}
 
-\membersection{wxHtmlEasyPrinting::PrinterSetup}\label{wxhtmleasyprintingprintersetup}
+\membersection{wxHtmlEasyPrinting::PageSetup}\label{wxhtmleasyprintingpagesetup}
 
-\func{void}{PrinterSetup}{\void}
+\func{void}{PageSetup}{\void}
 
-Displays printer setup dialog and allows the user to modify settings. 
+Display page setup dialog and allows the user to modify settings. 
 
-\membersection{wxHtmlEasyPrinting::PageSetup}\label{wxhtmleasyprintingpagesetup}
+\membersection{wxHtmlEasyPrinting::SetFonts}\label{wxhtmleasyprintingsetfonts}
 
-\func{void}{PageSetup}{\void}
+\func{void}{SetFonts}{\param{const wxString\& }{normal\_face}, \param{const wxString\& }{fixed\_face}, \param{const int }{*sizes = NULL}}
 
-Displays page setup dialog and allows the user to modify settings. 
+Sets fonts. See \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts} for
+detailed description.
 
 \membersection{wxHtmlEasyPrinting::SetHeader}\label{wxhtmleasyprintingsetheader}
 
 \func{void}{SetHeader}{\param{const wxString\& }{header}, \param{int }{pg = wxPAGE\_ALL}}
 
-Sets page header.
+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}
+\input htprintmacros.inc
 }
 
 \docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
@@ -106,16 +124,12 @@ Sets page header.
 
 \func{void}{SetFooter}{\param{const wxString\& }{footer}, \param{int }{pg = wxPAGE\_ALL}}
 
-Sets page footer.
+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}
+\input htprintmacros.inc
 }
 
 \docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}