Cleaned up SetMenuStrings, factoring out redo and undo label accessors at the same...

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

diff --git a/docs/latex/wx/pagedlg.tex b/docs/latex/wx/pagedlg.tex
index 7cd42caf5fd36a9a0298c16153153ac46b015957..b68a9ffeb61c3a524e0393e926163c36ed687ff8 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 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::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::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}.


@@ -117,25 +184,27 @@ instead of showing a dialog. Windows only.
 
 \constfunc{wxPoint}{GetMarginTopLeft}{\void}
 
 
 \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,6 +226,14 @@ 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}
+
+\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{wxPageSetupDialogData::SetDefaultInfo}\label{wxpagesetupdialogdatasetdefaultinfo}
 
 \func{void}{SetDefaultInfo}{\param{bool}{ flag}}
 \membersection{wxPageSetupDialogData::SetDefaultInfo}\label{wxpagesetupdialogdatasetdefaultinfo}
 
 \func{void}{SetDefaultInfo}{\param{bool}{ flag}}


@@ -169,31 +246,33 @@ instead of showing a dialog. Windows only.
 \func{void}{SetDefaultMinMargins}{\param{bool}{ flag}}
 
 Pass TRUE if the page setup dialog will take its minimum margin values from the currently
 \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.
+selected printer properties. Windows only. Units are in millimetres

 
 \membersection{wxPageSetupDialogData::SetMarginTopLeft}\label{wxpagesetupdialogdatasetmargintopleft}
 
 \func{void}{GetMarginTopLeft}{\param{const wxPoint\& }{pt}}
 
 
 \membersection{wxPageSetupDialogData::SetMarginTopLeft}\label{wxpagesetupdialogdatasetmargintopleft}
 
 \func{void}{GetMarginTopLeft}{\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.
-
-