documented wxPrinter::GetLastError

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_2_2_BRANCH@7682 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Václav Slavík
2000-07-03 20:23:41 +00:00
parent d506e640af
commit 7eec402f36

View File

@@ -598,6 +598,26 @@ Returns TRUE if the user has aborted the print job.
Creates the default printing abort window, with a cancel button. Creates the default printing abort window, with a cancel button.
\membersection{wxPrinter::GetLastError}\label{wxprintergetlasterror}
\func{static wxPrinterError}{GetLastError}{\void}
Return last error. Valid after calling \helpref{Print}{wxprinterprint},
\helpref{PrintDialog}{wxprinterprintdialog} or
\helpref{wxPrintPreview::Print}{wxprintpreviewprint}. These functions
set last error to {\bf wxPRINTER\_NO\_ERROR} if no error happened.
Returned value is one of the following:
\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf wxPRINTER\_NO\_ERROR}}{No error happened.}
\twocolitem{{\bf wxPRINTER\_CANCELLED}}{The user cancelled printing.}
\twocolitem{{\bf wxPRINTER\_ERROR}}{There was an error during printing.}
\end{twocollist}
\membersection{wxPrinter::GetPrintDialogData}\label{wxprintergetprintdialogdata} \membersection{wxPrinter::GetPrintDialogData}\label{wxprintergetprintdialogdata}
\func{wxPrintDialogData\&}{GetPrintDialogData}{\void} \func{wxPrintDialogData\&}{GetPrintDialogData}{\void}
@@ -612,7 +632,9 @@ Starts the printing process. Provide a parent window, a user-defined wxPrintout
the printing of a document, and whether the print dialog should be invoked first. the printing of a document, and whether the print dialog should be invoked first.
Print could return FALSE if there was a problem initializing the printer device context Print could return FALSE if there was a problem initializing the printer device context
(current printer not set, for example). (current printer not set, for example) or the user cancelled printing. Call
\helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed
information about the kind of the error.
\membersection{wxPrinter::PrintDialog}\label{wxprinterprintdialog} \membersection{wxPrinter::PrintDialog}\label{wxprinterprintdialog}
@@ -620,7 +642,9 @@ Print could return FALSE if there was a problem initializing the printer device
Invokes the print dialog. If successful (the user did not press Cancel Invokes the print dialog. If successful (the user did not press Cancel
and no error occurred), a suitable device context will be returned and no error occurred), a suitable device context will be returned
(otherwise NULL is returned). (otherwise NULL is returned -- call
\helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed
information about the kind of the error).
The application must delete this device context to avoid a memory leak. The application must delete this device context to avoid a memory leak.
@@ -984,6 +1008,10 @@ supplied in the wxPrintPreview constructor.
Will normally be called by the {\bf Print...} panel item on the Will normally be called by the {\bf Print...} panel item on the
preview frame's control bar. preview frame's control bar.
Returns FALSE in case of error -- call
\helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed
information about the kind of the error.
\membersection{wxPrintPreview::RenderPage}\label{wxprintpreviewrenderpage} \membersection{wxPrintPreview::RenderPage}\label{wxprintpreviewrenderpage}
\func{bool}{RenderPage}{\param{int }{pageNum}} \func{bool}{RenderPage}{\param{int }{pageNum}}