add events API to wxHtmlWindow (patch #1504493 by Francesco Montorsi)

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

diff --git a/docs/latex/wx/hteasypr.tex b/docs/latex/wx/hteasypr.tex
index 0b7c4192e4a04a50b3aaca38e2b029b1070b13e0..1bf7789506811228bd8d27d4495717631c8a68b4 100644 (file)
--- a/docs/latex/wx/hteasypr.tex
+++ b/docs/latex/wx/hteasypr.tex
@@ -3,55 +3,61 @@
 % htmprint.h at 17/Oct/99 12:48:02
 %
 
 % htmprint.h at 17/Oct/99 12:48:02
 %
 

-

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

-

 This class provides very simple interface to printing 
 This class provides very simple interface to printing 

-architecture. It allows you to print HTML documents only
-with very few commands. 
-
+architecture. It allows you to print HTML documents using
+only a few commands. 

 
 \wxheading{Note}
 
 \wxheading{Note}

-Do not create this class on stack only. You should create an instance on app 
+
+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.
 
 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{Derived from}
 
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/html/htmprint.h>

 
 

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

 
 

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

 
 \membersection{wxHtmlEasyPrinting::wxHtmlEasyPrinting}\label{wxhtmleasyprintingwxhtmleasyprinting}
 
 
 \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}
 
 
 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}
 
 
 \membersection{wxHtmlEasyPrinting::PreviewFile}\label{wxhtmleasyprintingpreviewfile}
 

-\func{void}{PreviewFile}{\param{const wxString\& }{htmlfile}}
+\func{bool}{PreviewFile}{\param{const wxString\& }{htmlfile}}
+
+Preview HTML file. 

 
 

-Previews 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}
 
 
 
 \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}
 
 
 \wxheading{Parameters}
 


@@ -60,20 +66,25 @@ Previews 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{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}
 
 \membersection{wxHtmlEasyPrinting::PrintFile}\label{wxhtmleasyprintingprintfile}
 

-\func{void}{PrintFile}{\param{const wxString\& }{htmlfile}}
+\func{bool}{PrintFile}{\param{const wxString\& }{htmlfile}}

 
 

-Prints HTML file.
+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}
 
 
 \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}
 
 
 \wxheading{Parameters}
 


@@ -82,60 +93,45 @@ 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.}
 
 \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}
-
-Displays printer setup dialog and allows the user to modify settings. 
-
-

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

-Displays page setup dialog and allows the user to modify settings. 
+Display page setup dialog and allows the user to modify settings. 
+
+\membersection{wxHtmlEasyPrinting::SetFonts}\label{wxhtmleasyprintingsetfonts}

 
 

+\func{void}{SetFonts}{\param{const wxString\& }{normal\_face}, \param{const wxString\& }{fixed\_face}, \param{const int }{*sizes = NULL}}
+
+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}}
 
 
 \membersection{wxHtmlEasyPrinting::SetHeader}\label{wxhtmleasyprintingsetheader}
 
 \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}
 
 
 \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.}
 
 
 \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}}
 
 \membersection{wxHtmlEasyPrinting::SetFooter}\label{wxhtmleasyprintingsetfooter}
 
 \func{void}{SetFooter}{\param{const wxString\& }{footer}, \param{int }{pg = wxPAGE\_ALL}}
 

-Sets page footer.
+Set page footer. The following macros can be used inside it:
+\input htprintmacros.inc

 
 \wxheading{Parameters}
 
 
 \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{footer}{HTML text to be used as footer.}

 
 \docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
 
 
 \docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
 

-
-
-

 \membersection{wxHtmlEasyPrinting::GetPrintData}\label{wxhtmleasyprintinggetprintdata}
 
 \func{wxPrintData*}{GetPrintData}{\void}
 \membersection{wxHtmlEasyPrinting::GetPrintData}\label{wxhtmleasyprintinggetprintdata}
 
 \func{wxPrintData*}{GetPrintData}{\void}


@@ -147,5 +143,6 @@ set its parameters (via SetXXXX methods).
 
 \func{wxPageSetupDialogData*}{GetPageSetupData}{\void}
 
 
 \func{wxPageSetupDialogData*}{GetPageSetupData}{\void}
 

-Returns pointer to \helpref{wxPageSetupDialogData}{wxpagesetupdialogdata} instance used by 
+Returns a pointer to \helpref{wxPageSetupDialogData}{wxpagesetupdialogdata} instance used by 

 this class. You can set its parameters (via SetXXXX methods).
 this class. You can set its parameters (via SetXXXX methods).

+