[wxWidgets.git] / docs / latex / wx / hteasypr.tex

%
% automatically generated by HelpGen from
% htmprint.h at 17/Oct/99 12:48:02
%

\section{\class{wxHtmlEasyPrinting}}\label{wxhtmleasyprinting}

This class provides very simple interface to printing 
architecture. It allows you to print HTML documents using
only a few commands. 

\wxheading{Note}

Do not create this class on the stack only. You should create an instance on app 
startup and use this instance for all printing operations. The reason is that
this class stores various settings in it.

\wxheading{Derived from}

\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/html/htmprint.h>


\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxHtmlEasyPrinting::wxHtmlEasyPrinting}\label{wxhtmleasyprintingwxhtmleasyprinting}

\func{}{wxHtmlEasyPrinting}{\param{const wxString\& }{name = "Printing"}, \param{wxFrame* }{parent\_frame = NULL}}

Constructor.

\wxheading{Parameters}

\docparam{name}{Name of the printing. Used by preview frames and setup dialogs.}

\docparam{parent\_frame}{pointer to the frame that will own preview frame and setup dialogs. May be NULL.}


\membersection{wxHtmlEasyPrinting::PreviewFile}\label{wxhtmleasyprintingpreviewfile}

\func{void}{PreviewFile}{\param{const wxString\& }{htmlfile}}

Previews HTML file. 

\membersection{wxHtmlEasyPrinting::PreviewText}\label{wxhtmleasyprintingpreviewtext}

\func{void}{PreviewText}{\param{const wxString\& }{htmltext}, \param{const wxString\& }{basepath = wxEmptyString}}

Previews HTML text (not file!). 

\wxheading{Parameters}

\docparam{htmltext}{HTML text.}

\docparam{basepath}{base directory (html string would be stored there if it was in
file). It is used to determine path for loading images, for example.}

\membersection{wxHtmlEasyPrinting::PrintFile}\label{wxhtmleasyprintingprintfile}

\func{void}{PrintFile}{\param{const wxString\& }{htmlfile}}

Prints HTML file.

\membersection{wxHtmlEasyPrinting::PrintText}\label{wxhtmleasyprintingprinttext}

\func{void}{PrintText}{\param{const wxString\& }{htmltext}, \param{const wxString\& }{basepath = wxEmptyString}}

Prints HTML text (not file!). 

\wxheading{Parameters}

\docparam{htmltext}{HTML text.}

\docparam{basepath}{base directory (html string would be stored there if it was in
file). It is used to determine path for loading images, for example.}

\membersection{wxHtmlEasyPrinting::PrinterSetup}\label{wxhtmleasyprintingprintersetup}

\func{void}{PrinterSetup}{\void}

Displays printer setup dialog and allows the user to modify settings. 

\membersection{wxHtmlEasyPrinting::PageSetup}\label{wxhtmleasyprintingpagesetup}

\func{void}{PageSetup}{\void}

Displays page setup dialog and allows the user to modify settings. 

\membersection{wxHtmlEasyPrinting::SetHeader}\label{wxhtmleasyprintingsetheader}

\func{void}{SetHeader}{\param{const wxString\& }{header}, \param{int }{pg = wxPAGE\_ALL}}

Sets page header.

\wxheading{Parameters}

\docparam{header}{HTML text to be used as header. You can use macros in it:

\begin{itemize}\itemsep=0pt
\item @PAGENUM@ is replaced by page number
\item @PAGESCNT@ is replaced by total number of pages
\end{itemize}
}

\docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}

\membersection{wxHtmlEasyPrinting::SetFooter}\label{wxhtmleasyprintingsetfooter}

\func{void}{SetFooter}{\param{const wxString\& }{footer}, \param{int }{pg = wxPAGE\_ALL}}

Sets page footer.

\wxheading{Parameters}

\docparam{footer}{HTML text to be used as footer. You can use macros in it:

\begin{itemize}\itemsep=0pt
\item @PAGENUM@ is replaced by page number
\item @PAGESCNT@ is replaced by total number of pages
\end{itemize}
}

\docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}

\membersection{wxHtmlEasyPrinting::GetPrintData}\label{wxhtmleasyprintinggetprintdata}

\func{wxPrintData*}{GetPrintData}{\void}

Returns pointer to \helpref{wxPrintData}{wxprintdata} instance used by this class. You can
set its parameters (via SetXXXX methods).

\membersection{wxHtmlEasyPrinting::GetPageSetupData}\label{wxhtmleasyprintinggetpagesetupdata}

\func{wxPageSetupDialogData*}{GetPageSetupData}{\void}

Returns a pointer to \helpref{wxPageSetupDialogData}{wxpagesetupdialogdata} instance used by 
this class. You can set its parameters (via SetXXXX methods).
Commit	Line	Data
3ce369e6 VS	1	%
	2	% automatically generated by HelpGen from
	3	% htmprint.h at 17/Oct/99 12:48:02
	4	%
	5
3ce369e6 VS	6	\section{\class{wxHtmlEasyPrinting}}\label{wxhtmleasyprinting}
3ce369e6 VS	7
3ce369e6	8	This class provides very simple interface to printing
448af9a4 JS	9	architecture. It allows you to print HTML documents using
448af9a4 JS	10	only a few commands.
3ce369e6 VS	11
3ce369e6 VS	12	\wxheading{Note}
448af9a4 JS	13
448af9a4 JS	14	Do not create this class on the stack only. You should create an instance on app
3ce369e6 VS	15	startup and use this instance for all printing operations. The reason is that
	16	this class stores various settings in it.
	17
3ce369e6 VS	18	\wxheading{Derived from}
	19
	20	\helpref{wxObject}{wxobject}
	21
9704b250 VS	22	\wxheading{Include files}
	23
	24	<wx/html/htmprint.h>
	25
	26
3ce369e6 VS	27	\latexignore{\rtfignore{\wxheading{Members}}}
3ce369e6 VS	28
3ce369e6 VS	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
3ce369e6 VS	42	\membersection{wxHtmlEasyPrinting::PreviewFile}\label{wxhtmleasyprintingpreviewfile}
	43
	44	\func{void}{PreviewFile}{\param{const wxString\& }{htmlfile}}
	45
	46	Previews HTML file.
	47
3ce369e6 VS	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
3ce369e6 VS	61	\membersection{wxHtmlEasyPrinting::PrintFile}\label{wxhtmleasyprintingprintfile}
	62
	63	\func{void}{PrintFile}{\param{const wxString\& }{htmlfile}}
	64
	65	Prints HTML file.
	66
3ce369e6 VS	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
3ce369e6 VS	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
3ce369e6 VS	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
3ce369e6 VS	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:
448af9a4 JS	101
448af9a4 JS	102	\begin{itemize}\itemsep=0pt
3ce369e6 VS	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
3ce369e6 VS	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:
448af9a4 JS	119
448af9a4 JS	120	\begin{itemize}\itemsep=0pt
3ce369e6 VS	121	\item @PAGENUM@ is replaced by page number
	122	\item @PAGESCNT@ is replaced by total number of pages
	123	\end{itemize}
	124	}
	125
3ce369e6 VS	126	\docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
3ce369e6 VS	127
3ce369e6 VS	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
448af9a4	139	Returns a pointer to \helpref{wxPageSetupDialogData}{wxpagesetupdialogdata} instance used by
3ce369e6	140	this class. You can set its parameters (via SetXXXX methods).
448af9a4	141