corrected order of parameters in ctor (closes 1304320)

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

diff --git a/docs/latex/wx/pagedlg.tex b/docs/latex/wx/pagedlg.tex
index 7cd42caf5fd36a9a0298c16153153ac46b015957..ba223977e33721b068ccd636c091d321d14c5081 100644 (file)
--- a/docs/latex/wx/pagedlg.tex
+++ b/docs/latex/wx/pagedlg.tex
@@ -1,3 +1,70 @@
+\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 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.
+
+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}
+
+\helpref{wxDialog}{wxdialog}\\
+\helpref{wxWindow}{wxwindow}\\
+\helpref{wxEvtHandler}{wxevthandler}\\
+\helpref{wxObject}{wxobject}
+
+\wxheading{Include files}
+
+<wx/printdlg.h>
+
+\wxheading{See also}
+
+\helpref{wxPrintDialog}{wxprintdialog}, \helpref{wxPageSetupDialogData}{wxpagesetupdialogdata}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\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.
+
+\membersection{wxPageSetupDialog::\destruct{wxPageSetupDialog}}\label{wxpagesetupdialogdtor}
+
+\func{}{\destruct{wxPageSetupDialog}}{\void}
+
+Destructor.
+
+\membersection{wxPageSetupDialog::GetPageSetupData}\label{wxpagesetupdialoggetpagesetupdata}
+
+\func{wxPageSetupDialogData\&}{GetPageSetupData}{\void}
+
+Returns the \helpref{page setup data}{wxpagesetupdialogdata} associated with the dialog.
+
+%\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}
+
+\func{int}{ShowModal}{\void}
+
+Shows the dialog, returning wxID\_OK if the user pressed OK, and wxID\_CANCEL
+otherwise.
+

 \section{\class{wxPageSetupDialogData}}\label{wxpagesetupdialogdata}
 
 This class holds a variety of information related to \helpref{wxPageSetupDialog}{wxpagesetupdialog}.
 \section{\class{wxPageSetupDialogData}}\label{wxpagesetupdialogdata}
 
 This class holds a variety of information related to \helpref{wxPageSetupDialog}{wxpagesetupdialog}.


@@ -19,7 +86,7 @@ user-interface configuration settings stored by wxPageSetupDialogData).
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

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

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


@@ -29,11 +96,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}
 


@@ -73,69 +140,71 @@ 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}
 
 \constfunc{wxPoint}{GetMarginTopLeft}{\void}
 
 instead of showing a dialog. Windows only.
 
 \membersection{wxPageSetupDialogData::GetMarginTopLeft}\label{wxpagesetupdialogdatagetmargintopleft}
 
 \constfunc{wxPoint}{GetMarginTopLeft}{\void}
 

-Returns the left (x) and top (y) margins.
+Returns the left (x) and top (y) margins in millimetres.

 
 \membersection{wxPageSetupDialogData::GetMarginBottomRight}\label{wxpagesetupdialogdatagetmarginbottomright}
 
 \constfunc{wxPoint}{GetMarginBottomRight}{\void}
 
 
 \membersection{wxPageSetupDialogData::GetMarginBottomRight}\label{wxpagesetupdialogdatagetmarginbottomright}
 
 \constfunc{wxPoint}{GetMarginBottomRight}{\void}
 

-Returns the right (x) and bottom (y) margins.
+Returns the right (x) and bottom (y) margins in millimetres.

 
 \membersection{wxPageSetupDialogData::GetMinMarginTopLeft}\label{wxpagesetupdialogdatagetminmargintopleft}
 
 \constfunc{wxPoint}{GetMinMarginTopLeft}{\void}
 
 
 \membersection{wxPageSetupDialogData::GetMinMarginTopLeft}\label{wxpagesetupdialogdatagetminmargintopleft}
 
 \constfunc{wxPoint}{GetMinMarginTopLeft}{\void}
 

-Returns the left (x) and top (y) minimum margins the user can enter (Windows only).
+Returns the left (x) and top (y) minimum margins the user can enter (Windows only). Units
+are in millimetres

 
 \membersection{wxPageSetupDialogData::GetMinMarginBottomRight}\label{wxpagesetupdialogdatagetminmarginbottomright}
 
 \constfunc{wxPoint}{GetMinMarginBottomRight}{\void}
 
 
 \membersection{wxPageSetupDialogData::GetMinMarginBottomRight}\label{wxpagesetupdialogdatagetminmarginbottomright}
 
 \constfunc{wxPoint}{GetMinMarginBottomRight}{\void}
 

-Returns the right (x) and bottom (y) minimum margins the user can enter (Windows only).
+Returns the right (x) and bottom (y) minimum margins the user can enter (Windows only). Units
+are in millimetres

 
 \membersection{wxPageSetupDialogData::GetPaperId}\label{wxpagesetupdialogdatagetpaperid}
 
 
 \membersection{wxPageSetupDialogData::GetPaperId}\label{wxpagesetupdialogdatagetpaperid}
 


@@ -157,43 +226,53 @@ 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::IsOk}\label{wxpagesetupdialogdataisok}
+
+\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{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
-selected printer properties. Windows only.
+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}
 
 
 \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.
+Sets the left (x) and top (y) margins in millimetres.

 
 \membersection{wxPageSetupDialogData::SetMarginBottomRight}\label{wxpagesetupdialogdatasetmarginbottomright}
 
 \func{void}{SetMarginBottomRight}{\param{const wxPoint\& }{pt}}
 
 
 \membersection{wxPageSetupDialogData::SetMarginBottomRight}\label{wxpagesetupdialogdatasetmarginbottomright}
 
 \func{void}{SetMarginBottomRight}{\param{const wxPoint\& }{pt}}
 

-Sets the right (x) and bottom (y) margins.
+Sets the right (x) and bottom (y) margins in millimetres.

 
 \membersection{wxPageSetupDialogData::SetMinMarginTopLeft}\label{wxpagesetupdialogdatasetminmargintopleft}
 
 \func{void}{SetMinMarginTopLeft}{\param{const wxPoint\& }{pt}}
 
 
 \membersection{wxPageSetupDialogData::SetMinMarginTopLeft}\label{wxpagesetupdialogdatasetminmargintopleft}
 
 \func{void}{SetMinMarginTopLeft}{\param{const wxPoint\& }{pt}}
 

-Sets the left (x) and top (y) minimum margins the user can enter (Windows only).
+Sets the left (x) and top (y) minimum margins the user can enter (Windows only). Units are
+in millimetres.

 
 \membersection{wxPageSetupDialogData::SetMinMarginBottomRight}\label{wxpagesetupdialogdatasetminmarginbottomright}
 
 \func{void}{SetMinMarginBottomRight}{\param{const wxPoint\& }{pt}}
 
 
 \membersection{wxPageSetupDialogData::SetMinMarginBottomRight}\label{wxpagesetupdialogdatasetminmarginbottomright}
 
 \func{void}{SetMinMarginBottomRight}{\param{const wxPoint\& }{pt}}
 

-Sets the right (x) and bottom (y) minimum margins the user can enter (Windows only).
+Sets the right (x) and bottom (y) minimum margins the user can enter (Windows only). Units are
+in millimetres.

 
 \membersection{wxPageSetupDialogData::SetPaperId}\label{wxpagesetupdialogdatasetpaperid}
 
 
 \membersection{wxPageSetupDialogData::SetPaperId}\label{wxpagesetupdialogdatasetpaperid}
 


@@ -226,63 +305,3 @@ Assigns print data to this object.
 
 Assigns page setup data to this object.
 
 
 Assigns page setup data to this object.
 

-\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.
-
-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.
-
-Note that the OK and Cancel buttons do not destroy the dialog; this must be done by the
-application.
-
-\wxheading{Derived from}
-
-\helpref{wxDialog}{wxdialog}\\
-\helpref{wxWindow}{wxwindow}\\
-\helpref{wxEvtHandler}{wxevthandler}\\
-\helpref{wxObject}{wxobject}
-
-\wxheading{Include files}
-
-<wx/printdlg.h>
-
-\wxheading{See also}
-
-\helpref{wxPrintDialog}{wxprintdialog}, \helpref{wxPageSetupDialogData}{wxpagesetupdialogdata}
-
-\latexignore{\rtfignore{\wxheading{Members}}}
-
-\membersection{wxPageSetupDialog::wxPageSetupDialog}
-
-\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}}
-
-\func{}{\destruct{wxPageSetupDialog}}{\void}
-
-Destructor.
-
-\membersection{wxPageSetupDialog::GetPageSetupData}\label{wxpagesetupdialoggetpagesetupdata}
-
-\func{wxPageSetupDialogData\&}{GetPageSetupData}{\void}
-
-Returns the \helpref{page setup data}{wxpagesetupdialogdata} associated with the dialog.
-
-\membersection{wxPageSetupDialog::ShowModal}\label{wxpagesetupdialogshowmodal}
-
-\func{int}{ShowModal}{\void}
-
-Shows the dialog, returning wxID\_OK if the user pressed OK, and wxID\_CANCEL
-otherwise.
-
-