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::PrinterSetup}\label{wxhtmleasyprintingprintersetup}
	97
	98	\func{void}{PrinterSetup}{\void}
	99
	100	Display printer setup dialog and allows the user to modify settings.
	101
	102	\membersection{wxHtmlEasyPrinting::PageSetup}\label{wxhtmleasyprintingpagesetup}
	103
	104	\func{void}{PageSetup}{\void}
	105
	106	Display page setup dialog and allows the user to modify settings.
	107
	108	\membersection{wxHtmlEasyPrinting::SetFonts}\label{wxhtmleasyprintingsetfonts}
	109
	110	\func{void}{SetFonts}{\param{wxString }{normal\_face}, \param{wxString }{fixed\_face}, \param{const int }{*sizes = NULL}}
	111
	112	Sets fonts. See \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts} for
	113	detailed description.
	114
	115	\membersection{wxHtmlEasyPrinting::SetHeader}\label{wxhtmleasyprintingsetheader}
	116
	117	\func{void}{SetHeader}{\param{const wxString\& }{header}, \param{int }{pg = wxPAGE\_ALL}}
	118
	119	Set page header.
	120
	121	\wxheading{Parameters}
	122
	123	\docparam{header}{HTML text to be used as header. You can use macros in it:
	124
	125	\begin{itemize}\itemsep=0pt
	126	\item @PAGENUM@ is replaced by page number
	127	\item @PAGESCNT@ is replaced by total number of pages
	128	\end{itemize}
	129	}
	130
	131	\docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
	132
	133	\membersection{wxHtmlEasyPrinting::SetFooter}\label{wxhtmleasyprintingsetfooter}
	134
	135	\func{void}{SetFooter}{\param{const wxString\& }{footer}, \param{int }{pg = wxPAGE\_ALL}}
	136
	137	Set page footer.
	138
	139	\wxheading{Parameters}
	140
	141	\docparam{footer}{HTML text to be used as footer. You can use macros in it:
	142
	143	\begin{itemize}\itemsep=0pt
	144	\item @PAGENUM@ is replaced by page number
	145	\item @PAGESCNT@ is replaced by total number of pages
	146	\end{itemize}
	147	}
	148
	149	\docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
	150
	151	\membersection{wxHtmlEasyPrinting::GetPrintData}\label{wxhtmleasyprintinggetprintdata}
	152
	153	\func{wxPrintData*}{GetPrintData}{\void}
	154
	155	Returns pointer to \helpref{wxPrintData}{wxprintdata} instance used by this class. You can
	156	set its parameters (via SetXXXX methods).
	157
	158	\membersection{wxHtmlEasyPrinting::GetPageSetupData}\label{wxhtmleasyprintinggetpagesetupdata}
	159
	160	\func{wxPageSetupDialogData*}{GetPageSetupData}{\void}
	161
	162	Returns a pointer to \helpref{wxPageSetupDialogData}{wxpagesetupdialogdata} instance used by
	163	this class. You can set its parameters (via SetXXXX methods).
	164