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{wxFrame* }{parent\_frame = NULL}}
	32
	33	Constructor.
	34
	35	\wxheading{Parameters}
	36
	37	\docparam{name}{Name of the printing. Used by preview frames and setup dialogs.}
	38
	39	\docparam{parent\_frame}{pointer to the frame that will own preview frame and setup dialogs. May be NULL.}
	40
	41
	42	\membersection{wxHtmlEasyPrinting::PreviewFile}\label{wxhtmleasyprintingpreviewfile}
	43
	44	\func{bool}{PreviewFile}{\param{const wxString\& }{htmlfile}}
	45
	46	Preview HTML file.
	47
	48	Returns false in case of error -- call
	49	\helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed
	50	information about the kind of the error.
	51
	52
	53	\membersection{wxHtmlEasyPrinting::PreviewText}\label{wxhtmleasyprintingpreviewtext}
	54
	55	\func{bool}{PreviewText}{\param{const wxString\& }{htmltext}, \param{const wxString\& }{basepath = wxEmptyString}}
	56
	57	Preview HTML text (not file!).
	58
	59	Returns false in case of error -- call
	60	\helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed
	61	information about the kind of the error.
	62
	63	\wxheading{Parameters}
	64
	65	\docparam{htmltext}{HTML text.}
	66
	67	\docparam{basepath}{base directory (html string would be stored there if it was in
	68	file). It is used to determine path for loading images, for example.}
	69
	70	\membersection{wxHtmlEasyPrinting::PrintFile}\label{wxhtmleasyprintingprintfile}
	71
	72	\func{bool}{PrintFile}{\param{const wxString\& }{htmlfile}}
	73
	74	Print HTML file.
	75
	76	Returns false in case of error -- call
	77	\helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed
	78	information about the kind of the error.
	79
	80	\membersection{wxHtmlEasyPrinting::PrintText}\label{wxhtmleasyprintingprinttext}
	81
	82	\func{bool}{PrintText}{\param{const wxString\& }{htmltext}, \param{const wxString\& }{basepath = wxEmptyString}}
	83
	84	Print HTML text (not file!).
	85
	86	Returns false in case of error -- call
	87	\helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed
	88	information about the kind of the error.
	89
	90	\wxheading{Parameters}
	91
	92	\docparam{htmltext}{HTML text.}
	93
	94	\docparam{basepath}{base directory (html string would be stored there if it was in
	95	file). It is used to determine path for loading images, for example.}
	96
	97	\membersection{wxHtmlEasyPrinting::PrinterSetup}\label{wxhtmleasyprintingprintersetup}
	98
	99	\func{void}{PrinterSetup}{\void}
	100
	101	Display printer setup dialog and allows the user to modify settings.
	102
	103	\membersection{wxHtmlEasyPrinting::PageSetup}\label{wxhtmleasyprintingpagesetup}
	104
	105	\func{void}{PageSetup}{\void}
	106
	107	Display page setup dialog and allows the user to modify settings.
	108
	109	\membersection{wxHtmlEasyPrinting::SetFonts}\label{wxhtmleasyprintingsetfonts}
	110
	111	\func{void}{SetFonts}{\param{wxString }{normal\_face}, \param{wxString }{fixed\_face}, \param{const int }{*sizes = NULL}}
	112
	113	Sets fonts. See \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts} for
	114	detailed description.
	115
	116	\membersection{wxHtmlEasyPrinting::SetHeader}\label{wxhtmleasyprintingsetheader}
	117
	118	\func{void}{SetHeader}{\param{const wxString\& }{header}, \param{int }{pg = wxPAGE\_ALL}}
	119
	120	Set page header.
	121
	122	\wxheading{Parameters}
	123
	124	\docparam{header}{HTML text to be used as header. You can use macros in it:
	125
	126	\begin{itemize}\itemsep=0pt
	127	\item @PAGENUM@ is replaced by page number
	128	\item @PAGESCNT@ is replaced by total number of pages
	129	\end{itemize}
	130	}
	131
	132	\docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
	133
	134	\membersection{wxHtmlEasyPrinting::SetFooter}\label{wxhtmleasyprintingsetfooter}
	135
	136	\func{void}{SetFooter}{\param{const wxString\& }{footer}, \param{int }{pg = wxPAGE\_ALL}}
	137
	138	Set page footer.
	139
	140	\wxheading{Parameters}
	141
	142	\docparam{footer}{HTML text to be used as footer. You can use macros in it:
	143
	144	\begin{itemize}\itemsep=0pt
	145	\item @PAGENUM@ is replaced by page number
	146	\item @PAGESCNT@ is replaced by total number of pages
	147	\end{itemize}
	148	}
	149
	150	\docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
	151
	152	\membersection{wxHtmlEasyPrinting::GetPrintData}\label{wxhtmleasyprintinggetprintdata}
	153
	154	\func{wxPrintData*}{GetPrintData}{\void}
	155
	156	Returns pointer to \helpref{wxPrintData}{wxprintdata} instance used by this class. You can
	157	set its parameters (via SetXXXX methods).
	158
	159	\membersection{wxHtmlEasyPrinting::GetPageSetupData}\label{wxhtmleasyprintinggetpagesetupdata}
	160
	161	\func{wxPageSetupDialogData*}{GetPageSetupData}{\void}
	162
	163	Returns a pointer to \helpref{wxPageSetupDialogData}{wxpagesetupdialogdata} instance used by
	164	this class. You can set its parameters (via SetXXXX methods).
	165