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