implemented nested index entries and index entries pointing to multiple documents...

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

diff --git a/docs/latex/wx/htprint.tex b/docs/latex/wx/htprint.tex
index 262cee2815003620c29c1a94bbf76d721b3a56fb..197a57cd3a99b3178c3b633940537cf88e2ab1f4 100644 (file)
--- a/docs/latex/wx/htprint.tex
+++ b/docs/latex/wx/htprint.tex
@@ -3,44 +3,61 @@
 % htmprint.h at 17/Oct/99 12:48:02
 %
 
 % htmprint.h at 17/Oct/99 12:48:02
 %
 

+

 \section{\class{wxHtmlPrintout}}\label{wxhtmlprintout}
 
 \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{Derived from}
 
 \helpref{wxPrintout}{wxprintout}
 

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

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

+

 \membersection{wxHtmlPrintout::wxHtmlPrintout}\label{wxhtmlprintoutwxhtmlprintout}
 
 \func{}{wxHtmlPrintout}{\param{const wxString\& }{title = "Printout"}}
 
 Constructor. 
 
 \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}}
+\membersection{wxHtmlPrintout::AddFilter}\label{wxhtmlprintoutaddfilter}

 
 

-Prepare the class for printing this HTML text.
+\func{static void}{AddFilter}{\param{wxHtmlFilter* }{filter}}

 
 

-\wxheading{Parameters}
+Adds a filter to the static list of filters for wxHtmlPrintout. See \helpref{wxHtmlFilter}{wxhtmlfilter} for
+further information.

 
 

-\docparam{html}{HTML text. (NOT file!)}
+\membersection{wxHtmlPrintout::SetFonts}\label{wxhtmlprintoutsetfonts}

 
 

-\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.}
+\func{void}{SetFonts}{\param{wxString }{normal\_face}, \param{wxString }{fixed\_face}, \param{const int }{*sizes = NULL}}

 
 

-\docparam{isdir}{FALSE if basepath is filename, TRUE if it is directory name
-(see \helpref{wxFileSystem}{wxfilesystem} for detailed explanation)}
+Sets fonts. See \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts} for
+detailed description.

 
 

-\membersection{wxHtmlPrintout::SetHtmlFile}\label{wxhtmlprintoutsethtmlfile}
+\membersection{wxHtmlPrintout::SetFooter}\label{wxhtmlprintoutsetfooter}

 
 

-\func{void}{SetHtmlFile}{\param{const wxString\& }{htmlfile}}
+\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.}

 
 

-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}
 
 
 \membersection{wxHtmlPrintout::SetHeader}\label{wxhtmlprintoutsetheader}
 


@@ -51,8 +68,7 @@ Sets page header.
 \wxheading{Parameters}
 
 \docparam{header}{HTML text to be used as header. You can use macros in it:
 \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}
 \item @PAGENUM@ is replaced by page number
 \item @PAGESCNT@ is replaced by total number of pages
 \end{itemize}


@@ -61,28 +77,37 @@ Sets page 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{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}
 
 
 \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}
 
 \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}}
 
 
 \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
+Sets margins in millimeters. Defaults to 1 inch for margins and 0.5cm for space

 between text and header and/or footer
 
 between text and header and/or footer