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	\section{\class{wxHtmlEasyPrinting}}\label{wxhtmleasyprinting}
	7
	8	This class provides very simple interface to printing
	9	architecture. It allows you to print HTML documents using
	10	only a few commands.
	11
	12	\wxheading{Note}
	13
	14	Do not create this class on the stack only. You should create an instance on app
	15	startup and use this instance for all printing operations. The reason is that
	16	this class stores various settings in it.
	17
	18	\wxheading{Derived from}
	19
	20	\helpref{wxObject}{wxobject}
	21
	22	\wxheading{Include files}
	23
	24	<wx/html/htmprint.h>
	25
	26
	27	\latexignore{\rtfignore{\wxheading{Members}}}
	28
	29	\membersection{wxHtmlEasyPrinting::wxHtmlEasyPrinting}\label{wxhtmleasyprintingwxhtmleasyprinting}
	30
	31	\func{}{wxHtmlEasyPrinting}{\param{const wxString\& }{name = "Printing"}, \param{wxWindow* }{parentWindow = NULL}}
	32
	33	Constructor.
	34
	35	\wxheading{Parameters}
	36
	37	\docparam{name}{Name of the printing object. Used by preview frames and setup dialogs.}
	38
	39	\docparam{parentWindow}{pointer to the window that will own the preview frame and setup dialogs. May be NULL.}
	40
	41	\membersection{wxHtmlEasyPrinting::PreviewFile}\label{wxhtmleasyprintingpreviewfile}
	42
	43	\func{bool}{PreviewFile}{\param{const wxString\& }{htmlfile}}
	44
	45	Preview HTML file.
	46
	47	Returns false in case of error -- call
	48	\helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed
	49	information about the kind of the error.
	50
	51
	52	\membersection{wxHtmlEasyPrinting::PreviewText}\label{wxhtmleasyprintingpreviewtext}
	53
	54	\func{bool}{PreviewText}{\param{const wxString\& }{htmltext}, \param{const wxString\& }{basepath = wxEmptyString}}
	55
	56	Preview HTML text (not file!).
	57
	58	Returns false in case of error -- call
	59	\helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed
	60	information about the kind of the error.
	61
	62	\wxheading{Parameters}
	63
	64	\docparam{htmltext}{HTML text.}
	65
	66	\docparam{basepath}{base directory (html string would be stored there if it was in
	67	file). It is used to determine path for loading images, for example.}
	68
	69	\membersection{wxHtmlEasyPrinting::PrintFile}\label{wxhtmleasyprintingprintfile}
	70
	71	\func{bool}{PrintFile}{\param{const wxString\& }{htmlfile}}
	72
	73	Print HTML file.
	74
	75	Returns false in case of error -- call
	76	\helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed
	77	information about the kind of the error.
	78
	79	\membersection{wxHtmlEasyPrinting::PrintText}\label{wxhtmleasyprintingprinttext}
	80
	81	\func{bool}{PrintText}{\param{const wxString\& }{htmltext}, \param{const wxString\& }{basepath = wxEmptyString}}
	82
	83	Print HTML text (not file!).
	84
	85	Returns false in case of error -- call
	86	\helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed
	87	information about the kind of the error.
	88
	89	\wxheading{Parameters}
	90
	91	\docparam{htmltext}{HTML text.}
	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	\membersection{wxHtmlEasyPrinting::PageSetup}\label{wxhtmleasyprintingpagesetup}
	97
	98	\func{void}{PageSetup}{\void}
	99
	100	Display page setup dialog and allows the user to modify settings.
	101
	102	\membersection{wxHtmlEasyPrinting::SetFonts}\label{wxhtmleasyprintingsetfonts}
	103
	104	\func{void}{SetFonts}{\param{const wxString\& }{normal\_face}, \param{const wxString\& }{fixed\_face}, \param{const int }{*sizes = NULL}}
	105
	106	Sets fonts. See \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts} for
	107	detailed description.
	108
	109	\membersection{wxHtmlEasyPrinting::SetHeader}\label{wxhtmleasyprintingsetheader}
	110
	111	\func{void}{SetHeader}{\param{const wxString\& }{header}, \param{int }{pg = wxPAGE\_ALL}}
	112
	113	Set page header. The following macros can be used inside it:
	114	\input htprintmacros.inc
	115
	116	\wxheading{Parameters}
	117
	118	\docparam{header}{HTML text to be used as header.}
	119
	120	\docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
	121
	122	\membersection{wxHtmlEasyPrinting::SetFooter}\label{wxhtmleasyprintingsetfooter}
	123
	124	\func{void}{SetFooter}{\param{const wxString\& }{footer}, \param{int }{pg = wxPAGE\_ALL}}
	125
	126	Set page footer. The following macros can be used inside it:
	127	\input htprintmacros.inc
	128
	129	\wxheading{Parameters}
	130
	131	\docparam{footer}{HTML text to be used as footer.}
	132
	133	\docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
	134
	135	\membersection{wxHtmlEasyPrinting::GetPrintData}\label{wxhtmleasyprintinggetprintdata}
	136
	137	\func{wxPrintData*}{GetPrintData}{\void}
	138
	139	Returns pointer to \helpref{wxPrintData}{wxprintdata} instance used by this class. You can
	140	set its parameters (via SetXXXX methods).
	141
	142	\membersection{wxHtmlEasyPrinting::GetPageSetupData}\label{wxhtmleasyprintinggetpagesetupdata}
	143
	144	\func{wxPageSetupDialogData*}{GetPageSetupData}{\void}
	145
	146	Returns a pointer to \helpref{wxPageSetupDialogData}{wxpagesetupdialogdata} instance used by
	147	this class. You can set its parameters (via SetXXXX methods).
	148