Added a couple of wxPerl notes.

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

diff --git a/docs/latex/wx/print.tex b/docs/latex/wx/print.tex
index b498836b50cba8bef7cb51e4bb3fd46af1177801..e87acae4b51b30dddad56d6cb779b643b938e762 100644 (file)
--- a/docs/latex/wx/print.tex
+++ b/docs/latex/wx/print.tex
@@ -78,13 +78,13 @@ Destructor.
 
 \constfunc{bool}{GetCollate}{\void}
 
 
 \constfunc{bool}{GetCollate}{\void}
 

-Returns TRUE if collation is on.
+Returns true if collation is on.

 
 \membersection{wxPrintData::GetColour}\label{wxprintdatagetcolour}
 
 \constfunc{bool}{GetColour}{\void}
 
 
 \membersection{wxPrintData::GetColour}\label{wxprintdatagetcolour}
 
 \constfunc{bool}{GetColour}{\void}
 

-Returns TRUE if colour printing is on.
+Returns true if colour printing is on.

 
 \membersection{wxPrintData::GetDuplex}\label{wxprintdatagetduplex}
 
 
 \membersection{wxPrintData::GetDuplex}\label{wxprintdatagetduplex}
 


@@ -119,7 +119,7 @@ printer should be used.
 
 \membersection{wxPrintData::GetQuality}\label{wxprintdatagetquality}
 
 
 \membersection{wxPrintData::GetQuality}\label{wxprintdatagetquality}
 

-\constfunc{wxPaperQuality}{GetQuality}{\void}
+\constfunc{wxPrintQuality}{GetQuality}{\void}

 
 Returns the current print quality. This can be a positive integer, denoting the number of dots per inch, or
 one of the following identifiers:
 
 Returns the current print quality. This can be a positive integer, denoting the number of dots per inch, or
 one of the following identifiers:


@@ -134,6 +134,14 @@ wxPRINT_QUALITY_DRAFT
 On input you should pass one of these identifiers, but on return you may get back a positive integer
 indicating the current resolution setting.
 
 On input you should pass one of these identifiers, but on return you may get back a positive integer
 indicating the current resolution setting.
 

+\membersection{wxPrintData::Ok}\label{wxprintdataok}
+
+\constfunc{bool}{Ok}{\void}
+
+Returns true if the print data is valid for using in print dialogs.
+This can return false on Windows if the current printer is not set, for example.
+On all other platforms, it returns true.
+

 \membersection{wxPrintData::SetCollate}\label{wxprintdatasetcollate}
 
 \func{void}{SetCollate}{\param{bool }{flag}}
 \membersection{wxPrintData::SetCollate}\label{wxprintdatasetcollate}
 
 \func{void}{SetCollate}{\param{bool }{flag}}


@@ -256,7 +264,7 @@ printer should be used.
 
 \membersection{wxPrintData::SetQuality}\label{wxprintdatasetquality}
 
 
 \membersection{wxPrintData::SetQuality}\label{wxprintdatasetquality}
 

-\func{void}{SetQuality}{\param{wxPaperQuality}{ quality}}
+\func{void}{SetQuality}{\param{wxPrintQuality}{ quality}}

 
 Sets the desired print quality. This can be a positive integer, denoting the number of dots per inch, or
 one of the following identifiers:
 
 Sets the desired print quality. This can be a positive integer, denoting the number of dots per inch, or
 one of the following identifiers:


@@ -338,6 +346,14 @@ When this function has been called, the ownership of the device context
 is transferred to the application, so it must then be deleted
 explicitly.
 
 is transferred to the application, so it must then be deleted
 explicitly.
 

+\membersection{wxPrintDialog::Ok}\label{wxprintdialogok}
+
+\constfunc{bool}{Ok}{\void}
+
+Returns true if the print data associated with the dialog is valid.
+This can return false on Windows if the current printer is not set, for example.
+On all other platforms, it returns true.
+

 \membersection{wxPrintDialog::ShowModal}\label{wxprintdialogshowmodal}
 
 \func{int}{ShowModal}{\void}
 \membersection{wxPrintDialog::ShowModal}\label{wxprintdialogshowmodal}
 
 \func{int}{ShowModal}{\void}


@@ -413,13 +429,13 @@ Enables or disables the `Selection' radio button.
 
 \constfunc{bool}{GetAllPages}{\void}
 
 
 \constfunc{bool}{GetAllPages}{\void}
 

-Returns TRUE if the user requested that all pages be printed.
+Returns true if the user requested that all pages be printed.

 
 \membersection{wxPrintDialogData::GetCollate}\label{wxprintdialogdatagetcollate}
 
 \constfunc{bool}{GetCollate}{\void}
 
 
 \membersection{wxPrintDialogData::GetCollate}\label{wxprintdialogdatagetcollate}
 
 \constfunc{bool}{GetCollate}{\void}
 

-Returns TRUE if the user requested that the document(s) be collated.
+Returns true if the user requested that the document(s) be collated.

 
 \membersection{wxPrintDialogData::GetFromPage}\label{wxprintdialogdatagetfrompage}
 
 
 \membersection{wxPrintDialogData::GetFromPage}\label{wxprintdialogdatagetfrompage}
 


@@ -455,13 +471,13 @@ Returns a reference to the internal wxPrintData object.
 
 \constfunc{bool}{GetPrintToFile}{\void}
 
 
 \constfunc{bool}{GetPrintToFile}{\void}
 

-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}
 
 
 \membersection{wxPrintDialogData::GetSelection}\label{wxprintdialogdatagetselection}
 
 \constfunc{bool}{GetSelection}{\void}
 

-Returns TRUE if the user requested that the selection be printed (where 'selection' is
+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}
 a concept specific to the application).
 
 \membersection{wxPrintDialogData::GetToPage}\label{wxprintdialogdatagettopage}


@@ -470,11 +486,19 @@ a concept specific to the application).
 
 Returns the {\it to} page number, as entered by the user.
 
 
 Returns the {\it to} page number, as entered by the user.
 

+\membersection{wxPrintDialogData::Ok}\label{wxprintdialogdataok}
+
+\constfunc{bool}{Ok}{\void}
+
+Returns true if the print data is valid for using in print dialogs.
+This can return false on Windows if the current printer is not set, for example.
+On all other platforms, it returns true.
+

 \membersection{wxPrintDialogData::SetCollate}\label{wxprintdialogdatasetcollate}
 
 \func{void}{SetCollate}{\param{bool }{flag}}
 
 \membersection{wxPrintDialogData::SetCollate}\label{wxprintdialogdatasetcollate}
 
 \func{void}{SetCollate}{\param{bool }{flag}}
 

-Sets the 'Collate' checkbox to TRUE or FALSE.
+Sets the 'Collate' checkbox to true or false.

 
 \membersection{wxPrintDialogData::SetFromPage}\label{wxprintdialogdatasetfrompage}
 
 
 \membersection{wxPrintDialogData::SetFromPage}\label{wxprintdialogdatasetfrompage}
 


@@ -510,7 +534,7 @@ Sets the internal wxPrintData.
 
 \func{void}{SetPrintToFile}{\param{bool }{flag}}
 
 
 \func{void}{SetPrintToFile}{\param{bool }{flag}}
 

-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}
 
 
 \membersection{wxPrintDialogData::SetSelection}\label{wxprintdialogdatasetselection}
 


@@ -524,7 +548,7 @@ implements this command, if at all.
 \func{void}{SetSetupDialog}{\param{bool }{flag}}
 
 Determines whether the dialog to be shown will be the Print dialog
 \func{void}{SetSetupDialog}{\param{bool }{flag}}
 
 Determines whether the dialog to be shown will be the Print dialog

-(pass FALSE) or Print Setup dialog (pass TRUE).
+(pass false) or Print Setup dialog (pass true).

 
 Note that the setup dialog is (according to Microsoft) obsolete from
 Windows 95, though retained for backward compatibility.
 
 Note that the setup dialog is (according to Microsoft) obsolete from
 Windows 95, though retained for backward compatibility.


@@ -590,7 +614,7 @@ Destructor.
 
 \func{bool}{Abort}{\void}
 
 
 \func{bool}{Abort}{\void}
 

-Returns TRUE if the user has aborted the print job.
+Returns true if the user has aborted the print job.

 
 \membersection{wxPrinter::CreateAbortWindow}\label{wxprintercreateabortwindow}
 
 
 \membersection{wxPrinter::CreateAbortWindow}\label{wxprintercreateabortwindow}
 


@@ -626,12 +650,12 @@ Returns the \helpref{print data}{wxprintdata} associated with the printer object
 
 \membersection{wxPrinter::Print}\label{wxprinterprint}
 
 
 \membersection{wxPrinter::Print}\label{wxprinterprint}
 

-\func{bool}{Print}{\param{wxWindow *}{parent}, \param{wxPrintout *}{printout}, \param{bool }{prompt=TRUE}}
+\func{bool}{Print}{\param{wxWindow *}{parent}, \param{wxPrintout *}{printout}, \param{bool }{prompt=true}}

 
 Starts the printing process. Provide a parent window, a user-defined wxPrintout object which controls
 the printing of a document, and whether the print dialog should be invoked first.
 
 
 Starts the printing process. Provide a parent window, a user-defined wxPrintout object which controls
 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) or the user cancelled printing. Call
 \helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed
 information about the kind of the error.
 (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.


@@ -692,13 +716,13 @@ necessary for setting up a suitable printer device context. This
 is the recommended way to construct a wxPrinterDC.
 
 \func{}{wxPrinterDC}{\param{const wxString\& }{driver}, \param{const wxString\& }{device}, \param{const wxString\& }{output},
 is the recommended way to construct a wxPrinterDC.
 
 \func{}{wxPrinterDC}{\param{const wxString\& }{driver}, \param{const wxString\& }{device}, \param{const wxString\& }{output},

- \param{const bool }{interactive = TRUE}, \param{int }{orientation = wxPORTRAIT}}
+ \param{const bool }{interactive = true}, \param{int }{orientation = wxPORTRAIT}}

 
 Constructor. With empty strings for the first three arguments, the default printer dialog is
 displayed. {\it device} indicates the type of printer and {\it output}
 is an optional file for printing to. The {\it driver} parameter is
 currently unused.  Use the {\it Ok} member to test whether the
 
 Constructor. With empty strings for the first three arguments, the default printer dialog is
 displayed. {\it device} indicates the type of printer and {\it output}
 is an optional file for printing to. The {\it driver} parameter is
 currently unused.  Use the {\it Ok} member to test whether the

-constructor was successful in creating a useable device context.
+constructor was successful in creating a usable device context.

 
 This constructor is deprecated and retained only for backward compatibility.
 
 
 This constructor is deprecated and retained only for backward compatibility.
 


@@ -729,7 +753,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 current 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}}
 


@@ -761,7 +786,7 @@ reference) and to return a tuple of four integers.
 }
 
 \perlnote{When this method is overridden in a derived class,
 }
 
 \perlnote{When this method is overridden in a derived class,

-it must not take any parameters, an return a 4-element list.
+it must not take any parameters, and returns a 4-element list.

 }
 
 \membersection{wxPrintout::GetPageSizeMM}\label{wxprintoutgetpagesizemm}
 }
 
 \membersection{wxPrintout::GetPageSizeMM}\label{wxprintoutgetpagesizemm}


@@ -814,6 +839,12 @@ 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.}
 
 \perlnote{In wxPerl this method takes no arguments and returns a
 \pythonnote{This method returns the output-only parameters as a tuple.}
 
 \perlnote{In wxPerl this method takes no arguments and returns a


@@ -823,21 +854,21 @@ this by a scaling factor to take the preview DC size into account.
 
 \func{bool}{HasPage}{\param{int}{ pageNum}}
 
 
 \func{bool}{HasPage}{\param{int}{ pageNum}}
 

-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,
+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.
 
 \membersection{wxPrintout::IsPreview}\label{wxprintoutispreview}
 
 \func{bool}{IsPreview}{\void}
 
 HasPage behaves as if the document has only one page.
 
 \membersection{wxPrintout::IsPreview}\label{wxprintoutispreview}
 
 \func{bool}{IsPreview}{\void}
 

-Returns TRUE if the printout is currently being used for previewing.
+Returns true if the printout is currently being used for previewing.

 
 \membersection{wxPrintout::OnBeginDocument}\label{wxprintoutonbegindocument}
 
 \func{bool}{OnBeginDocument}{\param{int}{ startPage}, \param{int}{ endPage}}
 
 
 \membersection{wxPrintout::OnBeginDocument}\label{wxprintoutonbegindocument}
 
 \func{bool}{OnBeginDocument}{\param{int}{ startPage}, \param{int}{ endPage}}
 

-Called by the framework at the start of document printing. Return FALSE from
+Called by the framework at the start of document printing. Return false from

 this function cancels the print job. OnBeginDocument is called once for every
 copy printed.
 
 this function cancels the print job. OnBeginDocument is called once for every
 copy printed.
 


@@ -884,7 +915,7 @@ number of pages in the document, for example.
 
 \func{bool}{OnPrintPage}{\param{int}{ pageNum}}
 
 
 \func{bool}{OnPrintPage}{\param{int}{ pageNum}}
 

-Called by the framework when a page should be printed. Returning FALSE cancels
+Called by the framework when a page should be printed. Returning false cancels

 the print job. The application can use wxPrintout::GetDC to obtain a device
 context to draw on.
 
 the print job. The application can use wxPrintout::GetDC to obtain a device
 context to draw on.
 


@@ -931,7 +962,7 @@ called, since they will be deleted in the wxPrintPreview constructor.
 The same does not apply to the {\it data} argument.
 
 Test the Ok member to check whether the wxPrintPreview object was created correctly.
 The same does not apply to the {\it data} argument.
 
 Test the Ok member to check whether the wxPrintPreview object was created correctly.

-Ok could return FALSE if there was a problem initializing the printer device context
+Ok could return false if there was a problem initializing the printer device context

 (current printer not set, for example).
 
 \membersection{wxPrintPreview::\destruct{wxPrintPreview}}
 (current printer not set, for example).
 
 \membersection{wxPrintPreview::\destruct{wxPrintPreview}}


@@ -950,7 +981,7 @@ internally.
 
 \membersection{wxPrintPreview::GetCanvas}\label{wxprintpreviewgetcanvas}
 
 
 \membersection{wxPrintPreview::GetCanvas}\label{wxprintpreviewgetcanvas}
 

-\func{wxWindow* }{GetCanvas}{\void}
+\func{wxPreviewCanvas* }{GetCanvas}{\void}

 
 Gets the preview window used for displaying the print preview image.
 
 
 Gets the preview window used for displaying the print preview image.
 


@@ -1002,7 +1033,7 @@ or NULL if none exists.
 
 \func{bool}{Ok}{\void}
 
 
 \func{bool}{Ok}{\void}
 

-Returns TRUE if the wxPrintPreview is valid, FALSE otherwise. It could return FALSE if there was a
+Returns true if the wxPrintPreview is valid, false otherwise. It could return false if there was a

 problem initializing the printer device context (current printer not set, for example).
 
 \membersection{wxPrintPreview::PaintPage}\label{wxprintpreviewpaintpage}
 problem initializing the printer device context (current printer not set, for example).
 
 \membersection{wxPrintPreview::PaintPage}\label{wxprintpreviewpaintpage}


@@ -1024,7 +1055,7 @@ 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
+Returns false in case of error -- call

 \helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed
 information about the kind of the error.
 
 \helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed
 information about the kind of the error.
 


@@ -1036,7 +1067,7 @@ Renders a page into a wxMemoryDC. Used internally by wxPrintPreview.
 
 \membersection{wxPrintPreview::SetCanvas}\label{wxprintpreviewsetcanvas}
 
 
 \membersection{wxPrintPreview::SetCanvas}\label{wxprintpreviewsetcanvas}
 

-\func{void}{SetCanvas}{\param{wxWindow* }{window}}
+\func{void}{SetCanvas}{\param{wxPreviewCanvas** }{window}}

 
 Sets the window to be used for displaying the print preview image.
 
 
 Sets the window to be used for displaying the print preview image.