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	\helpref{wxObject}{wxobject}
	15
	16
	17	\wxheading{Include files}
	18
	19	<wx/html/htmprint.h>
	20
	21	\wxheading{Library}
	22
	23	\helpref{wxHtml}{librarieslist}
	24
	25	\latexignore{\rtfignore{\wxheading{Members}}}
	26
	27
	28	\membersection{wxHtmlPrintout::wxHtmlPrintout}\label{wxhtmlprintoutwxhtmlprintout}
	29
	30	\func{}{wxHtmlPrintout}{\param{const wxString\& }{title = "Printout"}}
	31
	32	Constructor.
	33
	34
	35	\membersection{wxHtmlPrintout::AddFilter}\label{wxhtmlprintoutaddfilter}
	36
	37	\func{static void}{AddFilter}{\param{wxHtmlFilter* }{filter}}
	38
	39	Adds a filter to the static list of filters for wxHtmlPrintout. See \helpref{wxHtmlFilter}{wxhtmlfilter} for
	40	further information.
	41
	42	\membersection{wxHtmlPrintout::SetFonts}\label{wxhtmlprintoutsetfonts}
	43
	44	\func{void}{SetFonts}{\param{const wxString\& }{normal\_face}, \param{const wxString\& }{fixed\_face}, \param{const int }{*sizes = NULL}}
	45
	46	Sets fonts. See \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts} for
	47	detailed description.
	48
	49	\membersection{wxHtmlPrintout::SetFooter}\label{wxhtmlprintoutsetfooter}
	50
	51	\func{void}{SetFooter}{\param{const wxString\& }{footer}, \param{int }{pg = wxPAGE\_ALL}}
	52
	53	Set page footer. The following macros can be used inside it:
	54	\input htprintmacros.inc
	55
	56	\wxheading{Parameters}
	57
	58	\docparam{footer}{HTML text to be used as footer.}
	59
	60	\docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
	61
	62
	63	\membersection{wxHtmlPrintout::SetHeader}\label{wxhtmlprintoutsetheader}
	64
	65	\func{void}{SetHeader}{\param{const wxString\& }{header}, \param{int }{pg = wxPAGE\_ALL}}
	66
	67	Set page header. The following macros can be used inside it:
	68	\input htprintmacros.inc
	69
	70	\wxheading{Parameters}
	71
	72	\docparam{header}{HTML text to be used as header.}
	73
	74	\docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
	75
	76
	77	\membersection{wxHtmlPrintout::SetHtmlFile}\label{wxhtmlprintoutsethtmlfile}
	78
	79	\func{void}{SetHtmlFile}{\param{const wxString\& }{htmlfile}}
	80
	81	Prepare the class for printing this HTML {\bf file}. The file may be located on
	82	any virtual file system or it may be normal file.
	83
	84
	85
	86	\membersection{wxHtmlPrintout::SetHtmlText}\label{wxhtmlprintoutsethtmltext}
	87
	88	\func{void}{SetHtmlText}{\param{const wxString\& }{html}, \param{const wxString\& }{basepath = wxEmptyString}, \param{bool }{isdir = true}}
	89
	90	Prepare the class for printing this HTML text.
	91
	92	\wxheading{Parameters}
	93
	94	\docparam{html}{HTML text. (NOT file!)}
	95
	96	\docparam{basepath}{base directory (html string would be stored there if it was in
	97	file). It is used to determine path for loading images, for example.}
	98
	99	\docparam{isdir}{false if basepath is filename, true if it is directory name
	100	(see \helpref{wxFileSystem}{wxfilesystem} for detailed explanation)}
	101
	102
	103
	104	\membersection{wxHtmlPrintout::SetMargins}\label{wxhtmlprintoutsetmargins}
	105
	106	\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}}
	107
	108	Sets margins in millimeters. Defaults to 1 inch for margins and 0.5cm for space
	109	between text and header and/or footer
	110