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{void}{PreviewFile}{\param{const wxString\& }{htmlfile}}
	45
	46	Previews HTML file.
	47
	48	\membersection{wxHtmlEasyPrinting::PreviewText}\label{wxhtmleasyprintingpreviewtext}
	49
	50	\func{void}{PreviewText}{\param{const wxString\& }{htmltext}, \param{const wxString\& }{basepath = wxEmptyString}}
	51
	52	Previews HTML text (not file!).
	53
	54	\wxheading{Parameters}
	55
	56	\docparam{htmltext}{HTML text.}
	57
	58	\docparam{basepath}{base directory (html string would be stored there if it was in
	59	file). It is used to determine path for loading images, for example.}
	60
	61	\membersection{wxHtmlEasyPrinting::PrintFile}\label{wxhtmleasyprintingprintfile}
	62
	63	\func{void}{PrintFile}{\param{const wxString\& }{htmlfile}}
	64
	65	Prints HTML file.
	66
	67	\membersection{wxHtmlEasyPrinting::PrintText}\label{wxhtmleasyprintingprinttext}
	68
	69	\func{void}{PrintText}{\param{const wxString\& }{htmltext}, \param{const wxString\& }{basepath = wxEmptyString}}
	70
	71	Prints HTML text (not file!).
	72
	73	\wxheading{Parameters}
	74
	75	\docparam{htmltext}{HTML text.}
	76
	77	\docparam{basepath}{base directory (html string would be stored there if it was in
	78	file). It is used to determine path for loading images, for example.}
	79
	80	\membersection{wxHtmlEasyPrinting::PrinterSetup}\label{wxhtmleasyprintingprintersetup}
	81
	82	\func{void}{PrinterSetup}{\void}
	83
	84	Displays printer setup dialog and allows the user to modify settings.
	85
	86	\membersection{wxHtmlEasyPrinting::PageSetup}\label{wxhtmleasyprintingpagesetup}
	87
	88	\func{void}{PageSetup}{\void}
	89
	90	Displays page setup dialog and allows the user to modify settings.
	91
	92	\membersection{wxHtmlEasyPrinting::SetHeader}\label{wxhtmleasyprintingsetheader}
	93
	94	\func{void}{SetHeader}{\param{const wxString\& }{header}, \param{int }{pg = wxPAGE\_ALL}}
	95
	96	Sets page header.
	97
	98	\wxheading{Parameters}
	99
	100	\docparam{header}{HTML text to be used as header. You can use macros in it:
	101
	102	\begin{itemize}\itemsep=0pt
	103	\item @PAGENUM@ is replaced by page number
	104	\item @PAGESCNT@ is replaced by total number of pages
	105	\end{itemize}
	106	}
	107
	108	\docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
	109
	110	\membersection{wxHtmlEasyPrinting::SetFooter}\label{wxhtmleasyprintingsetfooter}
	111
	112	\func{void}{SetFooter}{\param{const wxString\& }{footer}, \param{int }{pg = wxPAGE\_ALL}}
	113
	114	Sets page footer.
	115
	116	\wxheading{Parameters}
	117
	118	\docparam{footer}{HTML text to be used as footer. You can use macros in it:
	119
	120	\begin{itemize}\itemsep=0pt
	121	\item @PAGENUM@ is replaced by page number
	122	\item @PAGESCNT@ is replaced by total number of pages
	123	\end{itemize}
	124	}
	125
	126	\docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
	127
	128	\membersection{wxHtmlEasyPrinting::GetPrintData}\label{wxhtmleasyprintinggetprintdata}
	129
	130	\func{wxPrintData*}{GetPrintData}{\void}
	131
	132	Returns pointer to \helpref{wxPrintData}{wxprintdata} instance used by this class. You can
	133	set its parameters (via SetXXXX methods).
	134
	135	\membersection{wxHtmlEasyPrinting::GetPageSetupData}\label{wxhtmleasyprintinggetpagesetupdata}
	136
	137	\func{wxPageSetupDialogData*}{GetPageSetupData}{\void}
	138
	139	Returns a pointer to \helpref{wxPageSetupDialogData}{wxpagesetupdialogdata} instance used by
	140	this class. You can set its parameters (via SetXXXX methods).
	141