X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4eecf1150d4954e389f49c402756f2381915dd10..180b5b4827d08f1ac13bbb5eca03f775ab35a0b1:/docs/latex/wx/hteasypr.tex diff --git a/docs/latex/wx/hteasypr.tex b/docs/latex/wx/hteasypr.tex index 3f7b7e5949..887dc808d1 100644 --- a/docs/latex/wx/hteasypr.tex +++ b/docs/latex/wx/hteasypr.tex @@ -23,21 +23,44 @@ this class stores various settings in it. +\wxheading{Library} + +\helpref{wxHtml}{librarieslist} + \latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxHtmlEasyPrinting::wxHtmlEasyPrinting}\label{wxhtmleasyprintingwxhtmleasyprinting} -\func{}{wxHtmlEasyPrinting}{\param{const wxString\& }{name = "Printing"}, \param{wxFrame* }{parent\_frame = NULL}} +\func{}{wxHtmlEasyPrinting}{\param{const wxString\& }{name = "Printing"}, \param{wxWindow* }{parentWindow = NULL}} Constructor. \wxheading{Parameters} -\docparam{name}{Name of the printing. Used by preview frames and setup dialogs.} +\docparam{name}{Name of the printing object. Used by preview frames and setup dialogs.} + +\docparam{parentWindow}{pointer to the window that will own the preview frame and setup dialogs. May be NULL.} + +\membersection{wxHtmlEasyPrinting::GetParentWindow}\label{wxhtmleasyprintinggetparentwindow} + +\constfunc{wxWindow*}{GetParentWindow}{\void} -\docparam{parent\_frame}{pointer to the frame that will own preview frame and setup dialogs. May be NULL.} +Gets the parent window for dialogs. + +\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). \membersection{wxHtmlEasyPrinting::PreviewFile}\label{wxhtmleasyprintingpreviewfile} @@ -94,12 +117,6 @@ information about the kind of the error. \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} - -Display printer setup dialog and allows the user to modify settings. - \membersection{wxHtmlEasyPrinting::PageSetup}\label{wxhtmleasyprintingpagesetup} \func{void}{PageSetup}{\void} @@ -108,7 +125,7 @@ Display page setup dialog and allows the user to modify settings. \membersection{wxHtmlEasyPrinting::SetFonts}\label{wxhtmleasyprintingsetfonts} -\func{void}{SetFonts}{\param{wxString }{normal\_face}, \param{wxString }{fixed\_face}, \param{const int }{*sizes = NULL}} +\func{void}{SetFonts}{\param{const wxString\& }{normal\_face}, \param{const wxString\& }{fixed\_face}, \param{const int }{*sizes = NULL}} Sets fonts. See \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts} for detailed description. @@ -117,17 +134,12 @@ detailed description. \func{void}{SetHeader}{\param{const wxString\& }{header}, \param{int }{pg = wxPAGE\_ALL}} -Set page header. +Set page header. The following macros can be used inside it: +\input htprintmacros.inc \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{header}{HTML text to be used as header.} \docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.} @@ -135,31 +147,18 @@ Set page header. \func{void}{SetFooter}{\param{const wxString\& }{footer}, \param{int }{pg = wxPAGE\_ALL}} -Set page footer. +Set page footer. The following macros can be used inside it: +\input htprintmacros.inc \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{footer}{HTML text to be used as footer.} \docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.} -\membersection{wxHtmlEasyPrinting::GetPrintData}\label{wxhtmleasyprintinggetprintdata} +\membersection{wxHtmlEasyPrinting::SetParentWindow}\label{wxhtmleasyprintingsetparentwindow} -\func{wxPrintData*}{GetPrintData}{\void} +\func{void}{SetParentWindow}{\param{wxWindow*}{ window}} -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). +Sets the parent window for dialogs.