wxWindowMSW now eats EVT_CHAR if the key was handled in EVT_KEY_DOWN

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

diff --git a/docs/latex/wx/print.tex b/docs/latex/wx/print.tex
index 96af356c348921dc4adb955f1584cead9bfe4d81..8fa5bdd5a502661c94db1d0272503d4a92492704 100644 (file)
--- a/docs/latex/wx/print.tex
+++ b/docs/latex/wx/print.tex
@@ -16,12 +16,12 @@ between the print dialogs and the application.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxPrintDialog}{wxprintdialog},
-\helpref{wxPageSetupDialog}{wxpagesetupdialog},
-\helpref{wxPrintDialogData}{wxprintdialogdata},
-\helpref{wxPageSetupDialogData}{wxpagesetupdialogdata},
-\helpref{wxPrintDialog Overview}{wxprintdialogoverview},
-\helpref{wxPrinterDC}{wxprinterdc},
+\helpref{wxPrintDialog}{wxprintdialog}, 
+\helpref{wxPageSetupDialog}{wxpagesetupdialog}, 
+\helpref{wxPrintDialogData}{wxprintdialogdata}, 
+\helpref{wxPageSetupDialogData}{wxpagesetupdialogdata}, 
+\helpref{wxPrintDialog Overview}{wxprintdialogoverview}, 
+\helpref{wxPrinterDC}{wxprinterdc}, 

 \helpref{wxPostScriptDC}{wxpostscriptdc}
 
 \wxheading{Remarks}
 \helpref{wxPostScriptDC}{wxpostscriptdc}
 
 \wxheading{Remarks}


@@ -125,10 +125,10 @@ Returns the current print quality. This can be a positive integer, denoting the
 one of the following identifiers:
 
 \begin{verbatim}
 one of the following identifiers:
 
 \begin{verbatim}

-wxPRINT\_QUALITY\_HIGH
-wxPRINT\_QUALITY\_MEDIUM
-wxPRINT\_QUALITY\_LOW
-wxPRINT\_QUALITY\_DRAFT
+wxPRINT_QUALITY_HIGH
+wxPRINT_QUALITY_MEDIUM
+wxPRINT_QUALITY_LOW
+wxPRINT_QUALITY_DRAFT

 \end{verbatim}
 
 On input you should pass one of these identifiers, but on return you may get back a positive integer
 \end{verbatim}
 
 On input you should pass one of these identifiers, but on return you may get back a positive integer


@@ -262,10 +262,10 @@ Sets the desired print quality. This can be a positive integer, denoting the num
 one of the following identifiers:
 
 \begin{verbatim}
 one of the following identifiers:
 
 \begin{verbatim}

-wxPRINT\_QUALITY\_HIGH
-wxPRINT\_QUALITY\_MEDIUM
-wxPRINT\_QUALITY\_LOW
-wxPRINT\_QUALITY\_DRAFT
+wxPRINT_QUALITY_HIGH
+wxPRINT_QUALITY_MEDIUM
+wxPRINT_QUALITY_LOW
+wxPRINT_QUALITY_DRAFT

 \end{verbatim}
 
 On input you should pass one of these identifiers, but on return you may get back a positive integer
 \end{verbatim}
 
 On input you should pass one of these identifiers, but on return you may get back a positive integer


@@ -457,6 +457,13 @@ Returns a reference to the internal wxPrintData object.
 
 Returns TRUE if the user has selected printing to a file.
 
 
 Returns TRUE if the user has selected printing to a file.
 

+\membersection{wxPrintDialogData::GetSelection}\label{wxprintdialogdatagetselection}
+
+\constfunc{bool}{GetSelection}{\void}
+
+Returns TRUE if the user requested that the selection be printed (where 'selection' is
+a concept specific to the application).
+

 \membersection{wxPrintDialogData::GetToPage}\label{wxprintdialogdatagettopage}
 
 \constfunc{int}{GetToPage}{\void}
 \membersection{wxPrintDialogData::GetToPage}\label{wxprintdialogdatagettopage}
 
 \constfunc{int}{GetToPage}{\void}


@@ -505,6 +512,13 @@ Sets the internal wxPrintData.
 
 Sets the 'Print to file' checkbox to TRUE or FALSE.
 
 
 Sets the 'Print to file' checkbox to TRUE or FALSE.
 

+\membersection{wxPrintDialogData::SetSelection}\label{wxprintdialogdatasetselection}
+
+\func{void}{SetSelection}{\param{bool}{ flag}}
+
+Selects the 'Selection' radio button. The effect of printing the selection depends on how the application
+implements this command, if at all.
+

 \membersection{wxPrintDialogData::SetSetupDialog}\label{wxprintdialogdatasetsetupdialog}
 
 \func{void}{SetSetupDialog}{\param{bool }{flag}}
 \membersection{wxPrintDialogData::SetSetupDialog}\label{wxprintdialogdatasetsetupdialog}
 
 \func{void}{SetSetupDialog}{\param{bool }{flag}}


@@ -584,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}
 
 \func{wxPrintDialogData\&}{GetPrintDialogData}{\void}
 \membersection{wxPrinter::GetPrintDialogData}\label{wxprintergetprintdialogdata}
 
 \func{wxPrintDialogData\&}{GetPrintDialogData}{\void}


@@ -598,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.
 
 Print could return FALSE if there was a problem initializing the printer device context
 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

-(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}
 


@@ -606,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
 and no error occurred), a suitable device context will be returned
 
 Invokes the print dialog. If successful (the user did not press Cancel
 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.
 


@@ -691,7 +729,8 @@ wxPrintPreview object to initiate printing or previewing.
 
 \func{}{wxPrintout}{\param{const wxString\& }{title = "Printout"}}
 
 
 \func{}{wxPrintout}{\param{const wxString\& }{title = "Printout"}}
 

-Constructor. Pass an optional title argument (currently unused).
+Constructor. Pass an optional title argument - the curent filename would be a good idea. This will appear in the printing list
+(at least in MSW)

 
 \membersection{wxPrintout::\destruct{wxPrintout}}
 
 
 \membersection{wxPrintout::\destruct{wxPrintout}}
 


@@ -722,6 +761,10 @@ it should be designed to take no parameters (other than the self
 reference) and to return a tuple of four integers.
 }
 
 reference) and to return a tuple of four integers.
 }
 

+\perlnote{When this method is overridden in a derived class,
+it must not take any parameters, an return a 4-element list.
+}
+

 \membersection{wxPrintout::GetPageSizeMM}\label{wxprintoutgetpagesizemm}
 
 \func{void}{GetPageSizeMM}{\param{int *}{w}, \param{int *}{h}}
 \membersection{wxPrintout::GetPageSizeMM}\label{wxprintoutgetpagesizemm}
 
 \func{void}{GetPageSizeMM}{\param{int *}{w}, \param{int *}{h}}


@@ -730,6 +773,9 @@ Returns the size of the printer page in millimetres.
 
 \pythonnote{This method returns the output-only parameters as a tuple.}
 
 
 \pythonnote{This method returns the output-only parameters as a tuple.}
 

+\perlnote{In wxPerl this method takes no arguments and returns a
+2-element list {\tt ( w, h )}}
+

 \membersection{wxPrintout::GetPageSizePixels}\label{wxprintoutgetpagesizepixels}
 
 \func{void}{GetPageSizePixels}{\param{int *}{w}, \param{int *}{h}}
 \membersection{wxPrintout::GetPageSizePixels}\label{wxprintoutgetpagesizepixels}
 
 \func{void}{GetPageSizePixels}{\param{int *}{w}, \param{int *}{h}}


@@ -743,6 +789,9 @@ previewing is to be supported.
 
 \pythonnote{This method returns the output-only parameters as a tuple.}
 
 
 \pythonnote{This method returns the output-only parameters as a tuple.}
 

+\perlnote{In wxPerl this method takes no arguments and returns a
+2-element list {\tt ( w, h )}}
+

 \membersection{wxPrintout::GetPPIPrinter}\label{wxprintoutgetppiprinter}
 
 \func{void}{GetPPIPrinter}{\param{int *}{w}, \param{int *}{h}}
 \membersection{wxPrintout::GetPPIPrinter}\label{wxprintoutgetppiprinter}
 
 \func{void}{GetPPIPrinter}{\param{int *}{w}, \param{int *}{h}}


@@ -754,6 +803,9 @@ this by a scaling factor to take the preview DC size into account.
 
 \pythonnote{This method returns the output-only parameters as a tuple.}
 
 
 \pythonnote{This method returns the output-only parameters as a tuple.}
 

+\perlnote{In wxPerl this method takes no arguments and returns a
+2-element list {\tt ( w, h )}}
+

 \membersection{wxPrintout::GetPPIScreen}\label{wxprintoutgetppiscreen}
 
 \func{void}{GetPPIScreen}{\param{int *}{w}, \param{int *}{h}}
 \membersection{wxPrintout::GetPPIScreen}\label{wxprintoutgetppiscreen}
 
 \func{void}{GetPPIScreen}{\param{int *}{w}, \param{int *}{h}}


@@ -763,13 +815,22 @@ Dividing the printer PPI by the screen PPI can give a suitable scaling
 factor for drawing text onto the printer. Remember to multiply
 this by a scaling factor to take the preview DC size into account.
 
 factor for drawing text onto the printer. Remember to multiply
 this by a scaling factor to take the preview DC size into account.
 

+\membersection{wxPrintout::GetTitle}\label{wxprintoutgettitle}
+
+\func{wxString}{GetTitle}{\void}
+
+Returns the title of the printout
+

 \pythonnote{This method returns the output-only parameters as a tuple.}
 
 \pythonnote{This method returns the output-only parameters as a tuple.}
 

+\perlnote{In wxPerl this method takes no arguments and returns a
+2-element list {\tt ( w, h )}}
+

 \membersection{wxPrintout::HasPage}\label{wxprintouthaspage}
 
 \func{bool}{HasPage}{\param{int}{ pageNum}}
 
 \membersection{wxPrintout::HasPage}\label{wxprintouthaspage}
 
 \func{bool}{HasPage}{\param{int}{ pageNum}}
 

-Should be overriden to return TRUE if the document has this page, or FALSE
+Should be overridden to return TRUE if the document has this page, or FALSE

 if not. Returning FALSE signifies the end of the document. By default,
 HasPage behaves as if the document has only one page.
 
 if not. Returning FALSE signifies the end of the document. By default,
 HasPage behaves as if the document has only one page.
 


@@ -788,11 +849,11 @@ this function cancels the print job. OnBeginDocument is called once for every
 copy printed.
 
 The base wxPrintout::OnBeginDocument {\it must} be called (and the return value
 copy printed.
 
 The base wxPrintout::OnBeginDocument {\it must} be called (and the return value

-checked) from within the overriden function, since it calls wxDC::StartDoc.
+checked) from within the overridden function, since it calls wxDC::StartDoc.

 
 

-\pythonnote{If this method is overriden in a Python class then the
+\pythonnote{If this method is overridden in a Python class then the

 base class version can be called by using the method
 base class version can be called by using the method

-\tt{base_OnBeginDocument(startPage, endPage)}. }
+{\tt base\_OnBeginDocument(startPage, endPage)}. }

 
 \membersection{wxPrintout::OnEndDocument}\label{wxprintoutonenddocument}
 
 
 \membersection{wxPrintout::OnEndDocument}\label{wxprintoutonenddocument}
 


@@ -802,7 +863,7 @@ Called by the framework at the end of document printing. OnEndDocument
 is called once for every copy printed.
 
 The base wxPrintout::OnEndDocument {\it must} be called
 is called once for every copy printed.
 
 The base wxPrintout::OnEndDocument {\it must} be called

-from within the overriden function, since it calls wxDC::EndDoc.
+from within the overridden function, since it calls wxDC::EndDoc.

 
 \membersection{wxPrintout::OnBeginPrinting}\label{wxprintoutonbeginprinting}
 
 
 \membersection{wxPrintout::OnBeginPrinting}\label{wxprintoutonbeginprinting}
 


@@ -836,8 +897,6 @@ context to draw on.
 
 \section{\class{wxPrintPreview}}\label{wxprintpreview}
 
 
 \section{\class{wxPrintPreview}}\label{wxprintpreview}
 

-\overview{Printing framework overview}{printingoverview}
-

 Objects of this class manage the print preview process. The object is passed
 a wxPrintout object, and the wxPrintPreview object itself is passed to
 a wxPreviewFrame object. Previewing is started by initializing and showing
 Objects of this class manage the print preview process. The object is passed
 a wxPrintout object, and the wxPrintPreview object itself is passed to
 a wxPreviewFrame object. Previewing is started by initializing and showing


@@ -972,6 +1031,10 @@ supplied in the wxPrintPreview constructor.
 Will normally be called by the {\bf Print...} panel item on the
 preview frame's control bar.
 
 Will normally be called by the {\bf Print...} panel item on the
 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}
 
 \func{bool}{RenderPage}{\param{int }{pageNum}}
 \membersection{wxPrintPreview::RenderPage}\label{wxprintpreviewrenderpage}
 
 \func{bool}{RenderPage}{\param{int }{pageNum}}