X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f3845e889c7ccfe03d034a0aa79b4f4d19fbcb06..3694bb76c11d1ed1518f20a42f8907c948e190bd:/docs/latex/wx/pagedlg.tex?ds=sidebyside diff --git a/docs/latex/wx/pagedlg.tex b/docs/latex/wx/pagedlg.tex index ab02ba67b2..961f58da45 100644 --- a/docs/latex/wx/pagedlg.tex +++ b/docs/latex/wx/pagedlg.tex @@ -1,22 +1,31 @@ \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}\\ +\helpref{wxTopLevelWindow}{wxtoplevelwindow}\\ \helpref{wxWindow}{wxwindow}\\ \helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxObject}{wxobject} @@ -25,20 +34,26 @@ application. +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \wxheading{See also} -\helpref{wxPrintDialog}{wxprintdialog}, \helpref{wxPageSetupDialogData}{wxpagesetupdialogdata} +\helpref{Printing framework overview}{printingoverview}, +\helpref{wxPrintDialog}{wxprintdialog}, +\helpref{wxPageSetupDialogData}{wxpagesetupdialogdata} \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. -\membersection{wxPageSetupDialog::\destruct{wxPageSetupDialog}} +\membersection{wxPageSetupDialog::\destruct{wxPageSetupDialog}}\label{wxpagesetupdialogdtor} \func{}{\destruct{wxPageSetupDialog}}{\void} @@ -50,6 +65,14 @@ Destructor. 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} @@ -72,13 +95,18 @@ user-interface configuration settings stored by wxPageSetupDialogData). +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \wxheading{See also} +\helpref{Printing framework overview}{printingoverview}, \helpref{wxPageSetupDialog}{wxpagesetupdialog} \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxPageSetupDialogData::wxPageSetupDialogData} +\membersection{wxPageSetupDialogData::wxPageSetupDialogData}\label{wxpagesetupdialogdatactor} \func{}{wxPageSetupDialogData}{\void} @@ -88,11 +116,11 @@ Default 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} @@ -132,44 +160,44 @@ Enables or disables the {\bf Printer} button, which invokes a printer setup dial \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} -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} -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} -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} -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} -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} -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} @@ -218,23 +246,31 @@ Returns the paper size in millimetres. 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}} -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}} -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} -\func{void}{GetMarginTopLeft}{\param{const wxPoint\& }{pt}} +\func{void}{SetMarginTopLeft}{\param{const wxPoint\& }{pt}} Sets the left (x) and top (y) margins in millimetres.