243 lines
7.9 KiB
TeX
243 lines
7.9 KiB
TeX
|
\section{\class{wxPageSetupData}}\label{wxpagesetupdata}
|
||
|
|
|
||
|
|
This class holds a variety of information related to \helpref{wxPageSetupDialog}{wxpagesetupdialog}.
|
||
|
|
|
||
|
|
\wxheading{Derived from}
|
||
|
|
|
||
|
|
\helpref{wxObject}{wxobject}
|
||
|
|
|
||
|
|
\wxheading{See also}
|
||
|
|
|
||
|
|
\helpref{wxPageSetupDialog}{wxpagesetupdialog}
|
||
|
|
|
||
|
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
||
|
|
|
||
|
|
\membersection{wxPageSetupData::wxPageSetupData}
|
||
|
|
|
||
|
|
\func{}{wxPageSetupData}{\void}
|
||
|
|
|
||
|
|
Constructor.
|
||
|
|
|
||
|
|
\membersection{wxPageSetupData::\destruct{wxPageSetupData}}
|
||
|
|
|
||
|
|
\func{}{\destruct{wxPageSetupData}}{\void}
|
||
|
|
|
||
|
|
Destructor.
|
||
|
|
|
||
|
|
\membersection{wxPageSetupData::EnableHelp}\label{wxpagesetupdataenablehelp}
|
||
|
|
|
||
|
|
\func{void}{EnableHelp}{\param{bool }{flag}}
|
||
|
|
|
||
|
|
Enables or disables the `Help' button (Windows only).
|
||
|
|
|
||
|
|
\membersection{wxPageSetupData::EnableMargins}\label{wxpagesetupdataenablemargins}
|
||
|
|
|
||
|
|
\func{void}{EnableMargins}{\param{bool }{flag}}
|
||
|
|
|
||
|
|
Enables or disables the margin controls (Windows only).
|
||
|
|
|
||
|
|
\membersection{wxPageSetupData::EnableOrientation}\label{wxpagesetupdataenableorientation}
|
||
|
|
|
||
|
|
\func{void}{EnableOrientation}{\param{bool }{flag}}
|
||
|
|
|
||
|
|
Enables or disables the orientation control (Windows only).
|
||
|
|
|
||
|
|
\membersection{wxPageSetupData::EnablePaper}\label{wxpagesetupdataenablepaper}
|
||
|
|
|
||
|
|
\func{void}{EnablePaper}{\param{bool }{flag}}
|
||
|
|
|
||
|
|
Enables or disables the paper size control (Windows only).
|
||
|
|
|
||
|
|
\membersection{wxPageSetupData::EnablePrinter}\label{wxpagesetupdataenableprinter}
|
||
|
|
|
||
|
|
\func{void}{EnablePrinter}{\param{bool }{flag}}
|
||
|
|
|
||
|
|
Enables or disables the {\bf Printer} button, which invokes a printer setup dialog.
|
||
|
|
|
||
|
|
\membersection{wxPageSetupData::GetPaperSize}\label{wxpagesetupdatagetpapersize}
|
||
|
|
|
||
|
|
\func{wxPoint}{GetPaperSize}{\void}
|
||
|
|
|
||
|
|
Returns the paper size in millimetres.
|
||
|
|
|
||
|
|
\membersection{wxPageSetupData::GetMarginTopLeft}\label{wxpagesetupdatagetmargintopleft}
|
||
|
|
|
||
|
|
\func{wxPoint}{GetMarginTopLeft}{\void}
|
||
|
|
|
||
|
|
Returns the left (x) and top (y) margins.
|
||
|
|
|
||
|
|
\membersection{wxPageSetupData::GetMarginBottomRight}\label{wxpagesetupdatagetmarginbottomright}
|
||
|
|
|
||
|
|
\func{wxPoint}{GetMarginBottomRight}{\void}
|
||
|
|
|
||
|
|
Returns the right (x) and bottom (y) margins.
|
||
|
|
|
||
|
|
\membersection{wxPageSetupData::GetMinMarginTopLeft}\label{wxpagesetupdatagetminmargintopleft}
|
||
|
|
|
||
|
|
\func{wxPoint}{GetMinMarginTopLeft}{\void}
|
||
|
|
|
||
|
|
Returns the left (x) and top (y) minimum margins the user can enter (Windows only).
|
||
|
|
|
||
|
|
\membersection{wxPageSetupData::GetMinMarginBottomRight}\label{wxpagesetupdatagetminmarginbottomright}
|
||
|
|
|
||
|
|
\func{wxPoint}{GetMinMarginBottomRight}{\void}
|
||
|
|
|
||
|
|
Returns the right (x) and bottom (y) minimum margins the user can enter (Windows only).
|
||
|
|
|
||
|
|
\membersection{wxPageSetupData::GetOrientation}\label{wxpagesetupdatagetorientation}
|
||
|
|
|
||
|
|
\func{int}{GetOrientation}{\void}
|
||
|
|
|
||
|
|
Returns the orientation, which can be wxPORTRAIT or wxLANDSCAPE.
|
||
|
|
|
||
|
|
\membersection{wxPageSetupData::GetDefaultMinMargins}\label{wxpagesetupdatagetdefaultminmargins}
|
||
|
|
|
||
|
|
\func{bool}{GetDefaultMinMargins}{\void}
|
||
|
|
|
||
|
|
Returns TRUE if the page setup dialog will take its minimum margin values from the currently
|
||
|
|
selected printer properties. Windows only.
|
||
|
|
|
||
|
|
\membersection{wxPageSetupData::GetEnableMargins}\label{wxpagesetupdatagetenablemargins}
|
||
|
|
|
||
|
|
\func{bool}{GetEnableMargins}{\void}
|
||
|
|
|
||
|
|
Returns TRUE if the margin controls are enabled (Windows only).
|
||
|
|
|
||
|
|
\membersection{wxPageSetupData::GetEnableOrientation}\label{wxpagesetupdatagetenableorientation}
|
||
|
|
|
||
|
|
\func{bool}{GetEnableOrientation}{\void}
|
||
|
|
|
||
|
|
Returns TRUE if the orientation control is enabled (Windows only).
|
||
|
|
|
||
|
|
\membersection{wxPageSetupData::GetEnablePaper}\label{wxpagesetupdatagetenablepaper}
|
||
|
|
|
||
|
|
\func{bool}{GetEnablePaper}{\void}
|
||
|
|
|
||
|
|
Returns TRUE if the paper size control is enabled (Windows only).
|
||
|
|
|
||
|
|
\membersection{wxPageSetupData::GetEnablePrinter}\label{wxpagesetupdatagetenableprinter}
|
||
|
|
|
||
|
|
\func{bool}{GetEnablePrinter}{\void}
|
||
|
|
|
||
|
|
Returns TRUE if the printer setup button is enabled.
|
||
|
|
|
||
|
|
\membersection{wxPageSetupData::GetEnableHelp}\label{wxpagesetupdatagetenablehelp}
|
||
|
|
|
||
|
|
\func{bool}{GetEnableHelp}{\void}
|
||
|
|
|
||
|
|
Returns TRUE if the printer setup button is enabled.
|
||
|
|
|
||
|
|
\membersection{wxPageSetupData::GetDefaultInfo}\label{wxpagesetupdatagetdefaultinfo}
|
||
|
|
|
||
|
|
\func{bool}{GetDefaultInfo}{\void}
|
||
|
|
|
||
|
|
Returns TRUE if the dialog will simply return default printer information (such as orientation)
|
||
|
|
instead of showing a dialog. Windows only.
|
||
|
|
|
||
|
|
\membersection{wxPageSetupData::SetPaperSize}\label{wxpagesetupdatasetpapersize}
|
||
|
|
|
||
|
|
\func{void}{SetPaperSize}{\param{const wxPoint\& }{size}}
|
||
|
|
|
||
|
|
Sets the paper size in millimetres.
|
||
|
|
|
||
|
|
\membersection{wxPageSetupData::SetMarginTopLeft}\label{wxpagesetupdatasetmargintopleft}
|
||
|
|
|
||
|
|
\func{void}{GetMarginTopLeft}{\param{const wxPoint\& }{pt}}
|
||
|
|
|
||
|
|
Sets the left (x) and top (y) margins.
|
||
|
|
|
||
|
|
\membersection{wxPageSetupData::SetMarginBottomRight}\label{wxpagesetupdatasetmarginbottomright}
|
||
|
|
|
||
|
|
\func{void}{SetMarginBottomRight}{\param{const wxPoint\& }{pt}}
|
||
|
|
|
||
|
|
Sets the right (x) and bottom (y) margins.
|
||
|
|
|
||
|
|
\membersection{wxPageSetupData::SetMinMarginTopLeft}\label{wxpagesetupdatasetminmargintopleft}
|
||
|
|
|
||
|
|
\func{void}{SetMinMarginTopLeft}{\param{const wxPoint\& }{pt}}
|
||
|
|
|
||
|
|
Sets the left (x) and top (y) minimum margins the user can enter (Windows only).
|
||
|
|
|
||
|
|
\membersection{wxPageSetupData::SetMinMarginBottomRight}\label{wxpagesetupdatasetminmarginbottomright}
|
||
|
|
|
||
|
|
\func{void}{SetMinMarginBottomRight}{\param{const wxPoint\& }{pt}}
|
||
|
|
|
||
|
|
Sets the right (x) and bottom (y) minimum margins the user can enter (Windows only).
|
||
|
|
|
||
|
|
\membersection{wxPageSetupData::SetOrientation}\label{wxpagesetupdatasetorientation}
|
||
|
|
|
||
|
|
\func{void}{SetOrientation}{\param{int }{orientation}}
|
||
|
|
|
||
|
|
Sets the orientation, which can be wxPORTRAIT or wxLANDSCAPE.
|
||
|
|
|
||
|
|
\membersection{wxPageSetupData::SetDefaultMinMargins}\label{wxpagesetupdatasetdefaultminmargins}
|
||
|
|
|
||
|
|
\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.
|
||
|
|
|
||
|
|
\membersection{wxPageSetupData::SetDefaultInfo}\label{wxpagesetupdatasetdefaultinfo}
|
||
|
|
|
||
|
|
\func{void}{SetDefaultInfo}{\param{bool}{ flag}}
|
||
|
|
|
||
|
|
Pass TRUE if the dialog will simply return default printer information (such as orientation)
|
||
|
|
instead of showing a dialog. Windows only.
|
||
|
|
|
||
|
|
\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.
|
||
|
|
The page setup dialog does not set any global information (the exception being orientation
|
||
|
|
for PostScript printing) so you need to query the \helpref{wxPageSetupData}{wxpagesetupdata} 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{See also}
|
||
|
|
|
||
|
|
\helpref{wxPrintDialog}{wxprintdialog}, \helpref{wxPageSetupData}{wxpagesetupdata}
|
||
|
|
|
||
|
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
||
|
|
|
||
|
|
\membersection{wxPageSetupDialog::wxPageSetupDialog}
|
||
|
|
|
||
|
|
\func{}{wxPageSetupDialog}{\param{wxWindow* }{parent}, \param{wxPageSetupData* }{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{wxPageSetupData\&}{GetPageSetupData}{\void}
|
||
|
|
|
||
|
|
Returns the \helpref{page setup data}{wxpagesetupdata} 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.
|
||
|
|
|
||
|
|
|