]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/pagedlg.tex
escape underscores introduced by the last change
[wxWidgets.git] / docs / latex / wx / pagedlg.tex
index 26c79a4df161dc58829dc086b11be76508673dd1..961f58da452bef73a114e93596906116e92b9456 100644 (file)
@@ -1,22 +1,31 @@
 \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}
 
 \helpref{wxDialog}{wxdialog}\\
 
 \wxheading{Derived from}
 
 \helpref{wxDialog}{wxdialog}\\
+\helpref{wxTopLevelWindow}{wxtoplevelwindow}\\
 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
@@ -25,20 +34,26 @@ application.
 
 <wx/printdlg.h>
 
 
 <wx/printdlg.h>
 
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 \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 +65,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}
 
@@ -80,13 +95,18 @@ user-interface configuration settings stored by wxPageSetupDialogData).
 
 <wx/cmndata.h>
 
 
 <wx/cmndata.h>
 
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 \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 +116,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}
 
@@ -226,9 +246,9 @@ 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.
 
 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.
@@ -250,7 +270,7 @@ 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 in millimetres.
 
 
 Sets the left (x) and top (y) margins in millimetres.