X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9704b2509ac4fd7b9fccd5299e0b377accb2b59e..d86c187031547bd2f0604adddef273deedea7907:/docs/latex/wx/hteasypr.tex diff --git a/docs/latex/wx/hteasypr.tex b/docs/latex/wx/hteasypr.tex index 03e8875f4c..887dc808d1 100644 --- a/docs/latex/wx/hteasypr.tex +++ b/docs/latex/wx/hteasypr.tex @@ -23,33 +23,65 @@ 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} + +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} -\docparam{parent\_frame}{pointer to the frame that will own preview frame and setup dialogs. May be NULL.} +\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} -\func{void}{PreviewFile}{\param{const wxString\& }{htmlfile}} +\func{bool}{PreviewFile}{\param{const wxString\& }{htmlfile}} + +Preview HTML file. + +Returns false in case of error -- call +\helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed +information about the kind of the error. -Previews HTML file. \membersection{wxHtmlEasyPrinting::PreviewText}\label{wxhtmleasyprintingpreviewtext} -\func{void}{PreviewText}{\param{const wxString\& }{htmltext}, \param{const wxString\& }{basepath = wxEmptyString}} +\func{bool}{PreviewText}{\param{const wxString\& }{htmltext}, \param{const wxString\& }{basepath = wxEmptyString}} -Previews HTML text (not file!). +Preview HTML text (not file!). + +Returns false in case of error -- call +\helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed +information about the kind of the error. \wxheading{Parameters} @@ -60,15 +92,23 @@ file). It is used to determine path for loading images, for example.} \membersection{wxHtmlEasyPrinting::PrintFile}\label{wxhtmleasyprintingprintfile} -\func{void}{PrintFile}{\param{const wxString\& }{htmlfile}} +\func{bool}{PrintFile}{\param{const wxString\& }{htmlfile}} + +Print HTML file. -Prints HTML file. +Returns false in case of error -- call +\helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed +information about the kind of the error. \membersection{wxHtmlEasyPrinting::PrintText}\label{wxhtmleasyprintingprinttext} -\func{void}{PrintText}{\param{const wxString\& }{htmltext}, \param{const wxString\& }{basepath = wxEmptyString}} +\func{bool}{PrintText}{\param{const wxString\& }{htmltext}, \param{const wxString\& }{basepath = wxEmptyString}} + +Print HTML text (not file!). -Prints HTML text (not file!). +Returns false in case of error -- call +\helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed +information about the kind of the error. \wxheading{Parameters} @@ -77,33 +117,29 @@ Prints HTML text (not file!). \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} +\membersection{wxHtmlEasyPrinting::PageSetup}\label{wxhtmleasyprintingpagesetup} -\func{void}{PrinterSetup}{\void} +\func{void}{PageSetup}{\void} -Displays printer setup dialog and allows the user to modify settings. +Display page setup dialog and allows the user to modify settings. -\membersection{wxHtmlEasyPrinting::PageSetup}\label{wxhtmleasyprintingpagesetup} +\membersection{wxHtmlEasyPrinting::SetFonts}\label{wxhtmleasyprintingsetfonts} -\func{void}{PageSetup}{\void} +\func{void}{SetFonts}{\param{const wxString\& }{normal\_face}, \param{const wxString\& }{fixed\_face}, \param{const int }{*sizes = NULL}} -Displays page setup dialog and allows the user to modify settings. +Sets fonts. See \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts} for +detailed description. \membersection{wxHtmlEasyPrinting::SetHeader}\label{wxhtmleasyprintingsetheader} \func{void}{SetHeader}{\param{const wxString\& }{header}, \param{int }{pg = wxPAGE\_ALL}} -Sets 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.} @@ -111,31 +147,18 @@ Sets page header. \func{void}{SetFooter}{\param{const wxString\& }{footer}, \param{int }{pg = wxPAGE\_ALL}} -Sets 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} - -\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} +\membersection{wxHtmlEasyPrinting::SetParentWindow}\label{wxhtmleasyprintingsetparentwindow} -\func{wxPageSetupDialogData*}{GetPageSetupData}{\void} +\func{void}{SetParentWindow}{\param{wxWindow*}{ window}} -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.