added (and documented) wxSafeShowMessage, use it in wxLogFatalError instead of wxMess...

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

diff --git a/docs/latex/wx/print.tex b/docs/latex/wx/print.tex
index c2eb9f3114c440924c0e1dd9e1ac6d004c83b62b..cc4df2a635e54229bb4fbe2fc77cc4369b5ba1ca 100644 (file)
--- a/docs/latex/wx/print.tex
+++ b/docs/latex/wx/print.tex
@@ -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}}


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


@@ -470,6 +486,14 @@ 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}}


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


@@ -760,6 +785,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}}


@@ -768,6 +797,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}}


@@ -781,6 +813,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}}


@@ -792,6 +827,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}}


@@ -801,8 +839,17 @@ 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}}


@@ -830,7 +877,7 @@ checked) from within the overridden function, since it calls wxDC::StartDoc.
 
 \pythonnote{If this method is overridden in a Python class then the
 base class version can be called by using the method
 
 \pythonnote{If this method is overridden in a Python class then the
 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}