added TGA handler (somewhat modified patch 1393912)

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

diff --git a/docs/latex/wx/pagedlg.tex b/docs/latex/wx/pagedlg.tex
index b68a9ffeb61c3a524e0393e926163c36ed687ff8..b7d9cbafff74ce06b52f4ec21553b0963fcde6c0 100644 (file)
--- a/docs/latex/wx/pagedlg.tex
+++ b/docs/latex/wx/pagedlg.tex
@@ -1,18 +1,26 @@
 \section{\class{wxPageSetupDialog}}\label{wxpagesetupdialog}
 
 \section{\class{wxPageSetupDialog}}\label{wxpagesetupdialog}
 

-This class represents the page setup common dialog. The page setup dialog is standard from
-Windows 95 on, replacing the print setup dialog (which is retained in Windows and wxWindows
-for backward compatibility). On Windows 95 and NT 4.0 and above, the page setup dialog is
-native to the windowing system, otherwise it is emulated.
+This class represents the page setup common dialog. In MSW, the page setup
+dialog is standard from Windows 95 on, replacing the print setup dialog (which
+is retained in Windows and wxWidgets for backward compatibility). On Windows 95
+and NT 4.0 and above, the page setup dialog is native to the windowing system,
+otherwise it is emulated.

 
 

-The page setup dialog contains controls for paper size (A4, A5 etc.), orientation (landscape
-or portrait), and controls for setting left, top, right and bottom margin sizes in millimetres.
+The page setup dialog contains controls for paper size (A4, A5 etc.),
+orientation (landscape or portrait), and controls for setting left, top, right
+and bottom margin sizes in millimetres.

 
 

-When the dialog has been closed, you need to query the \helpref{wxPageSetupDialogData}{wxpagesetupdialogdata} object
-associated with the dialog.
+On Macintosh, the native page setup dialog is used, which lets you select paper
+size and orientation but it does not let you change the page margins.

 
 

-Note that the OK and Cancel buttons do not destroy the dialog; this must be done by the
-application.
+On other platforms, a generic dialog is used.
+
+When the dialog has been closed, you need to query the
+\helpref{wxPageSetupDialogData}{wxpagesetupdialogdata} object associated with
+the dialog.
+
+Note that the OK and Cancel buttons do not destroy the dialog; this must be done
+by the application.

 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 


@@ -27,18 +35,20 @@ application.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxPrintDialog}{wxprintdialog}, \helpref{wxPageSetupDialogData}{wxpagesetupdialogdata}
+\helpref{Printing framework overview}{printingoverview}, 
+\helpref{wxPrintDialog}{wxprintdialog}, 
+\helpref{wxPageSetupDialogData}{wxpagesetupdialogdata}

 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxPageSetupDialog::wxPageSetupDialog}
+\membersection{wxPageSetupDialog::wxPageSetupDialog}\label{wxpagesetupdialogctor}

 
 \func{}{wxPageSetupDialog}{\param{wxWindow* }{parent}, \param{wxPageSetupDialogData* }{data = NULL}}
 
 Constructor. Pass a parent window, and optionally a pointer to a block of page setup
 data, which will be copied to the print dialog's internal data.
 
 
 \func{}{wxPageSetupDialog}{\param{wxWindow* }{parent}, \param{wxPageSetupDialogData* }{data = NULL}}
 
 Constructor. Pass a parent window, and optionally a pointer to a block of page setup
 data, which will be copied to the print dialog's internal data.
 

-\membersection{wxPageSetupDialog::\destruct{wxPageSetupDialog}}
+\membersection{wxPageSetupDialog::\destruct{wxPageSetupDialog}}\label{wxpagesetupdialogdtor}

 
 \func{}{\destruct{wxPageSetupDialog}}{\void}
 
 
 \func{}{\destruct{wxPageSetupDialog}}{\void}
 


@@ -50,13 +60,13 @@ Destructor.
 
 Returns the \helpref{page setup data}{wxpagesetupdialogdata} associated with the dialog.
 
 
 Returns the \helpref{page setup data}{wxpagesetupdialogdata} associated with the dialog.
 

-\membersection{wxPageSetupDialog::Ok}\label{wxpagesetupdialogok}
-
-\constfunc{bool}{Ok}{\void}
-
-Returns TRUE if the print data associated with the dialog data 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{wxPageSetupDialog::IsOk}\label{wxpagesetupdialogisok}
+%
+%\constfunc{bool}{IsOk}{\void}
+%
+%Returns true if the print data associated with the dialog data 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{wxPageSetupDialog::ShowModal}\label{wxpagesetupdialogshowmodal}
 
 
 \membersection{wxPageSetupDialog::ShowModal}\label{wxpagesetupdialogshowmodal}
 


@@ -82,11 +92,12 @@ user-interface configuration settings stored by wxPageSetupDialogData).
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

+\helpref{Printing framework overview}{printingoverview}, 

 \helpref{wxPageSetupDialog}{wxpagesetupdialog}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \helpref{wxPageSetupDialog}{wxpagesetupdialog}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxPageSetupDialogData::wxPageSetupDialogData}
+\membersection{wxPageSetupDialogData::wxPageSetupDialogData}\label{wxpagesetupdialogdatactor}

 
 \func{}{wxPageSetupDialogData}{\void}
 
 
 \func{}{wxPageSetupDialogData}{\void}
 


@@ -96,11 +107,11 @@ Default constructor.
 
 Copy constructor.
 
 
 Copy constructor.
 

-\func{}{wxPrintDialogData}{\param{wxPrintData\&}{ printData}}
+\func{}{wxPageSetupDialogData}{\param{wxPrintData\&}{ printData}}

 
 

-Construct an object from a print dialog data object.
+Construct an object from a print data object.

 
 

-\membersection{wxPageSetupDialogData::\destruct{wxPageSetupDialogData}}
+\membersection{wxPageSetupDialogData::\destruct{wxPageSetupDialogData}}\label{wxpagesetupdialogdatadtor}

 
 \func{}{\destruct{wxPageSetupDialogData}}{\void}
 
 
 \func{}{\destruct{wxPageSetupDialogData}}{\void}
 


@@ -140,44 +151,44 @@ Enables or disables the {\bf Printer} button, which invokes a printer setup dial
 
 \constfunc{bool}{GetDefaultMinMargins}{\void}
 
 
 \constfunc{bool}{GetDefaultMinMargins}{\void}
 

-Returns TRUE if the page setup dialog will take its minimum margin values from the currently
+Returns true if the page setup dialog will take its minimum margin values from the currently

 selected printer properties. Windows only.
 
 \membersection{wxPageSetupDialogData::GetEnableMargins}\label{wxpagesetupdialogdatagetenablemargins}
 
 \constfunc{bool}{GetEnableMargins}{\void}
 
 selected printer properties. Windows only.
 
 \membersection{wxPageSetupDialogData::GetEnableMargins}\label{wxpagesetupdialogdatagetenablemargins}
 
 \constfunc{bool}{GetEnableMargins}{\void}
 

-Returns TRUE if the margin controls are enabled (Windows only).
+Returns true if the margin controls are enabled (Windows only).

 
 \membersection{wxPageSetupDialogData::GetEnableOrientation}\label{wxpagesetupdialogdatagetenableorientation}
 
 \constfunc{bool}{GetEnableOrientation}{\void}
 
 
 \membersection{wxPageSetupDialogData::GetEnableOrientation}\label{wxpagesetupdialogdatagetenableorientation}
 
 \constfunc{bool}{GetEnableOrientation}{\void}
 

-Returns TRUE if the orientation control is enabled (Windows only).
+Returns true if the orientation control is enabled (Windows only).

 
 \membersection{wxPageSetupDialogData::GetEnablePaper}\label{wxpagesetupdialogdatagetenablepaper}
 
 \constfunc{bool}{GetEnablePaper}{\void}
 
 
 \membersection{wxPageSetupDialogData::GetEnablePaper}\label{wxpagesetupdialogdatagetenablepaper}
 
 \constfunc{bool}{GetEnablePaper}{\void}
 

-Returns TRUE if the paper size control is enabled (Windows only).
+Returns true if the paper size control is enabled (Windows only).

 
 \membersection{wxPageSetupDialogData::GetEnablePrinter}\label{wxpagesetupdialogdatagetenableprinter}
 
 \constfunc{bool}{GetEnablePrinter}{\void}
 
 
 \membersection{wxPageSetupDialogData::GetEnablePrinter}\label{wxpagesetupdialogdatagetenableprinter}
 
 \constfunc{bool}{GetEnablePrinter}{\void}
 

-Returns TRUE if the printer setup button is enabled.
+Returns true if the printer setup button is enabled.

 
 \membersection{wxPageSetupDialogData::GetEnableHelp}\label{wxpagesetupdialogdatagetenablehelp}
 
 \constfunc{bool}{GetEnableHelp}{\void}
 
 
 \membersection{wxPageSetupDialogData::GetEnableHelp}\label{wxpagesetupdialogdatagetenablehelp}
 
 \constfunc{bool}{GetEnableHelp}{\void}
 

-Returns TRUE if the printer setup button is enabled.
+Returns true if the printer setup button is enabled.

 
 \membersection{wxPageSetupDialogData::GetDefaultInfo}\label{wxpagesetupdialogdatagetdefaultinfo}
 
 \constfunc{bool}{GetDefaultInfo}{\void}
 
 
 \membersection{wxPageSetupDialogData::GetDefaultInfo}\label{wxpagesetupdialogdatagetdefaultinfo}
 
 \constfunc{bool}{GetDefaultInfo}{\void}
 

-Returns TRUE if the dialog will simply return default printer information (such as orientation)
+Returns true if the dialog will simply return default printer information (such as orientation)

 instead of showing a dialog. Windows only.
 
 \membersection{wxPageSetupDialogData::GetMarginTopLeft}\label{wxpagesetupdialogdatagetmargintopleft}
 instead of showing a dialog. Windows only.
 
 \membersection{wxPageSetupDialogData::GetMarginTopLeft}\label{wxpagesetupdialogdatagetmargintopleft}


@@ -226,31 +237,31 @@ Returns the paper size in millimetres.
 
 Returns a reference to the \helpref{print data}{wxprintdata} associated with this object.
 
 
 Returns a reference to the \helpref{print data}{wxprintdata} associated with this object.
 

-\membersection{wxPageSetupDialogData::Ok}\label{wxpagesetupdialogdataok}
+\membersection{wxPageSetupDialogData::IsOk}\label{wxpagesetupdialogdataisok}

 
 

-\constfunc{bool}{Ok}{\void}
+\constfunc{bool}{IsOk}{\void}

 
 

-Returns TRUE if the print data associated with the dialog data is valid.
-This can return FALSE on Windows if the current printer is not set, for example.
-On all other platforms, it returns TRUE.
+Returns true if the print data associated with the dialog data 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{wxPageSetupDialogData::SetDefaultInfo}\label{wxpagesetupdialogdatasetdefaultinfo}
 
 \func{void}{SetDefaultInfo}{\param{bool}{ flag}}
 
 
 \membersection{wxPageSetupDialogData::SetDefaultInfo}\label{wxpagesetupdialogdatasetdefaultinfo}
 
 \func{void}{SetDefaultInfo}{\param{bool}{ flag}}
 

-Pass TRUE if the dialog will simply return default printer information (such as orientation)
+Pass true if the dialog will simply return default printer information (such as orientation)

 instead of showing a dialog. Windows only.
 
 \membersection{wxPageSetupDialogData::SetDefaultMinMargins}\label{wxpagesetupdialogdatasetdefaultminmargins}
 
 \func{void}{SetDefaultMinMargins}{\param{bool}{ flag}}
 
 instead of showing a dialog. Windows only.
 
 \membersection{wxPageSetupDialogData::SetDefaultMinMargins}\label{wxpagesetupdialogdatasetdefaultminmargins}
 
 \func{void}{SetDefaultMinMargins}{\param{bool}{ flag}}
 

-Pass TRUE if the page setup dialog will take its minimum margin values from the currently
+Pass true if the page setup dialog will take its minimum margin values from the currently

 selected printer properties. Windows only. Units are in millimetres
 
 \membersection{wxPageSetupDialogData::SetMarginTopLeft}\label{wxpagesetupdialogdatasetmargintopleft}
 
 selected printer properties. Windows only. Units are in millimetres
 
 \membersection{wxPageSetupDialogData::SetMarginTopLeft}\label{wxpagesetupdialogdatasetmargintopleft}
 

-\func{void}{GetMarginTopLeft}{\param{const wxPoint\& }{pt}}
+\func{void}{SetMarginTopLeft}{\param{const wxPoint\& }{pt}}

 
 Sets the left (x) and top (y) margins in millimetres.
 
 
 Sets the left (x) and top (y) margins in millimetres.