Several changes and updates

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

diff --git a/docs/latex/wx/print.tex b/docs/latex/wx/print.tex
index ba16f85b955d2869417e54d0e85df154062acda1..c8510ba8d011148593326ad0520376d429915b85 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}


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


@@ -563,7 +577,7 @@ dialog data, which will be copied to the printer object's local data.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxPrintDialogData}{wxprintdialogdata}, 
+\helpref{wxPrintDialogData}{wxprintdialogdata},

 \helpref{wxPrintData}{wxprintdata}
 
 \membersection{wxPrinter::\destruct{wxPrinter}}
 \helpref{wxPrintData}{wxprintdata}
 
 \membersection{wxPrinter::\destruct{wxPrinter}}


@@ -717,12 +731,19 @@ returns 1, 32000 for the page minimum and maximum values, and 1, 1 for the requi
 
 If {\it minPage} is zero, the page number controls in the print dialog will be disabled.
 
 
 If {\it minPage} is zero, the page number controls in the print dialog will be disabled.
 

+\pythonnote{When this method is implemented in a derived Python class,
+it should be designed to take no parameters (other than the self
+reference) and to return a tuple of four integers.
+}
+

 \membersection{wxPrintout::GetPageSizeMM}\label{wxprintoutgetpagesizemm}
 
 \func{void}{GetPageSizeMM}{\param{int *}{w}, \param{int *}{h}}
 
 Returns the size of the printer page in millimetres.
 
 \membersection{wxPrintout::GetPageSizeMM}\label{wxprintoutgetpagesizemm}
 
 \func{void}{GetPageSizeMM}{\param{int *}{w}, \param{int *}{h}}
 
 Returns the size of the printer page in millimetres.
 

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

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


@@ -734,6 +755,8 @@ memory device context is used, using a bitmap size reflecting the current
 preview zoom. The application must take this discrepancy into account if
 previewing is to be supported.
 
 preview zoom. The application must take this discrepancy into account if
 previewing is to be supported.
 

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

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


@@ -743,6 +766,8 @@ 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.
 

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

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


@@ -752,6 +777,8 @@ 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.
 

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

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


@@ -777,6 +804,10 @@ 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.
 
 The base wxPrintout::OnBeginDocument {\it must} be called (and the return value
 checked) from within the overriden function, since it calls wxDC::StartDoc.
 

+\pythonnote{If this method is overriden in a Python class then the
+base class version can be called by using the method
+\tt{base_OnBeginDocument(startPage, endPage)}. }
+

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