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