git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	1	%
	2	% automatically generated by HelpGen from
	3	% htmprint.h at 17/Oct/99 12:48:02
	4	%
	5
	6
	7	\section{\class{wxHtmlPrintout}}\label{wxhtmlprintout}
	8
	9	This class serves as printout class for HTML documents.
	10
	11	\wxheading{Derived from}
	12
	13	\helpref{wxPrintout}{wxprintout}
	14
	15
	16	\wxheading{Include files}
	17
	18	<wx/html/htmprint.h>
	19
	20	\latexignore{\rtfignore{\wxheading{Members}}}
	21
	22
	23	\membersection{wxHtmlPrintout::wxHtmlPrintout}\label{wxhtmlprintoutwxhtmlprintout}
	24
	25	\func{}{wxHtmlPrintout}{\param{const wxString\& }{title = "Printout"}}
	26
	27	Constructor.
	28
	29
	30
	31	\membersection{wxHtmlPrintout::SetFooter}\label{wxhtmlprintoutsetfooter}
	32
	33	\func{void}{SetFooter}{\param{const wxString\& }{footer}, \param{int }{pg = wxPAGE\_ALL}}
	34
	35	Sets page footer.
	36
	37	\wxheading{Parameters}
	38
	39	\docparam{footer}{HTML text to be used as footer. You can use macros in it:
	40	\begin{itemize}
	41	\item @PAGENUM@ is replaced by page number
	42	\item @PAGESCNT@ is replaced by total number of pages
	43	\end{itemize}
	44	}
	45
	46	\docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
	47
	48
	49	\membersection{wxHtmlPrintout::SetHeader}\label{wxhtmlprintoutsetheader}
	50
	51	\func{void}{SetHeader}{\param{const wxString\& }{header}, \param{int }{pg = wxPAGE\_ALL}}
	52
	53	Sets page header.
	54
	55	\wxheading{Parameters}
	56
	57	\docparam{header}{HTML text to be used as header. You can use macros in it:
	58	\begin{itemize}
	59	\item @PAGENUM@ is replaced by page number
	60	\item @PAGESCNT@ is replaced by total number of pages
	61	\end{itemize}
	62	}
	63
	64	\docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
	65
	66
	67	\membersection{wxHtmlPrintout::SetHtmlFile}\label{wxhtmlprintoutsethtmlfile}
	68
	69	\func{void}{SetHtmlFile}{\param{const wxString\& }{htmlfile}}
	70
	71	Prepare the class for printing this HTML {\bf file}. The file may be located on
	72	any virtual file system or it may be normal file.
	73
	74
	75
	76	\membersection{wxHtmlPrintout::SetHtmlText}\label{wxhtmlprintoutsethtmltext}
	77
	78	\func{void}{SetHtmlText}{\param{const wxString\& }{html}, \param{const wxString\& }{basepath = wxEmptyString}, \param{bool }{isdir = TRUE}}
	79
	80	Prepare the class for printing this HTML text.
	81
	82	\wxheading{Parameters}
	83
	84	\docparam{html}{HTML text. (NOT file!)}
	85
	86	\docparam{basepath}{base directory (html string would be stored there if it was in
	87	file). It is used to determine path for loading images, for example.}
	88
	89	\docparam{isdir}{FALSE if basepath is filename, TRUE if it is directory name
	90	(see \helpref{wxFileSystem}{wxfilesystem} for detailed explanation)}
	91
	92
	93
	94	\membersection{wxHtmlPrintout::SetMargins}\label{wxhtmlprintoutsetmargins}
	95
	96	\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}}
	97
	98	Sets margins in millimeters. Defaults to 1 inch for margins and 0.5cm for space
	99	between text and header and/or footer
	100