X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/954b8ae60391d18b87a604e7919c87c0c6ae208b..8e458bb53997706d4432d2dc0b9b516320709389:/docs/latex/wx/pagedlg.tex?ds=inline diff --git a/docs/latex/wx/pagedlg.tex b/docs/latex/wx/pagedlg.tex index f02df12794..ba223977e3 100644 --- a/docs/latex/wx/pagedlg.tex +++ b/docs/latex/wx/pagedlg.tex @@ -1,7 +1,77 @@ -\section{\class{wxPageSetupData}}\label{wxpagesetupdata} +\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} + + + +\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}. +It contains a \helpref{wxPrintData}{wxprintdata} member which is used to hold basic printer configuration data (as opposed to the +user-interface configuration settings stored by wxPageSetupDialogData). + \wxheading{Derived from} \helpref{wxObject}{wxobject} @@ -16,235 +86,222 @@ This class holds a variety of information related to \helpref{wxPageSetupDialog} \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxPageSetupData::wxPageSetupData} +\membersection{wxPageSetupDialogData::wxPageSetupDialogData}\label{wxpagesetupdialogdatactor} + +\func{}{wxPageSetupDialogData}{\void} + +Default constructor. -\func{}{wxPageSetupData}{\void} +\func{}{wxPageSetupDialogData}{\param{wxPageSetupDialogData\&}{ data}} -Constructor. +Copy constructor. -\membersection{wxPageSetupData::\destruct{wxPageSetupData}} +\func{}{wxPageSetupDialogData}{\param{wxPrintData\&}{ printData}} -\func{}{\destruct{wxPageSetupData}}{\void} +Construct an object from a print data object. + +\membersection{wxPageSetupDialogData::\destruct{wxPageSetupDialogData}}\label{wxpagesetupdialogdatadtor} + +\func{}{\destruct{wxPageSetupDialogData}}{\void} Destructor. -\membersection{wxPageSetupData::EnableHelp}\label{wxpagesetupdataenablehelp} +\membersection{wxPageSetupDialogData::EnableHelp}\label{wxpagesetupdialogdataenablehelp} \func{void}{EnableHelp}{\param{bool }{flag}} Enables or disables the `Help' button (Windows only). -\membersection{wxPageSetupData::EnableMargins}\label{wxpagesetupdataenablemargins} +\membersection{wxPageSetupDialogData::EnableMargins}\label{wxpagesetupdialogdataenablemargins} \func{void}{EnableMargins}{\param{bool }{flag}} Enables or disables the margin controls (Windows only). -\membersection{wxPageSetupData::EnableOrientation}\label{wxpagesetupdataenableorientation} +\membersection{wxPageSetupDialogData::EnableOrientation}\label{wxpagesetupdialogdataenableorientation} \func{void}{EnableOrientation}{\param{bool }{flag}} Enables or disables the orientation control (Windows only). -\membersection{wxPageSetupData::EnablePaper}\label{wxpagesetupdataenablepaper} +\membersection{wxPageSetupDialogData::EnablePaper}\label{wxpagesetupdialogdataenablepaper} \func{void}{EnablePaper}{\param{bool }{flag}} Enables or disables the paper size control (Windows only). -\membersection{wxPageSetupData::EnablePrinter}\label{wxpagesetupdataenableprinter} +\membersection{wxPageSetupDialogData::EnablePrinter}\label{wxpagesetupdialogdataenableprinter} \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} +\membersection{wxPageSetupDialogData::GetDefaultMinMargins}\label{wxpagesetupdialogdatagetdefaultminmargins} -Returns the left (x) and top (y) margins. +\constfunc{bool}{GetDefaultMinMargins}{\void} -\membersection{wxPageSetupData::GetMarginBottomRight}\label{wxpagesetupdatagetmarginbottomright} - -\func{wxPoint}{GetMarginBottomRight}{\void} - -Returns the right (x) and bottom (y) margins. +Returns true if the page setup dialog will take its minimum margin values from the currently +selected printer properties. Windows only. -\membersection{wxPageSetupData::GetMinMarginTopLeft}\label{wxpagesetupdatagetminmargintopleft} +\membersection{wxPageSetupDialogData::GetEnableMargins}\label{wxpagesetupdialogdatagetenablemargins} -\func{wxPoint}{GetMinMarginTopLeft}{\void} +\constfunc{bool}{GetEnableMargins}{\void} -Returns the left (x) and top (y) minimum margins the user can enter (Windows only). +Returns true if the margin controls are enabled (Windows only). -\membersection{wxPageSetupData::GetMinMarginBottomRight}\label{wxpagesetupdatagetminmarginbottomright} +\membersection{wxPageSetupDialogData::GetEnableOrientation}\label{wxpagesetupdialogdatagetenableorientation} -\func{wxPoint}{GetMinMarginBottomRight}{\void} +\constfunc{bool}{GetEnableOrientation}{\void} -Returns the right (x) and bottom (y) minimum margins the user can enter (Windows only). +Returns true if the orientation control is enabled (Windows only). -\membersection{wxPageSetupData::GetOrientation}\label{wxpagesetupdatagetorientation} +\membersection{wxPageSetupDialogData::GetEnablePaper}\label{wxpagesetupdialogdatagetenablepaper} -\func{int}{GetOrientation}{\void} +\constfunc{bool}{GetEnablePaper}{\void} -Returns the orientation, which can be wxPORTRAIT or wxLANDSCAPE. +Returns true if the paper size control is enabled (Windows only). -\membersection{wxPageSetupData::GetDefaultMinMargins}\label{wxpagesetupdatagetdefaultminmargins} +\membersection{wxPageSetupDialogData::GetEnablePrinter}\label{wxpagesetupdialogdatagetenableprinter} -\func{bool}{GetDefaultMinMargins}{\void} +\constfunc{bool}{GetEnablePrinter}{\void} -Returns TRUE if the page setup dialog will take its minimum margin values from the currently -selected printer properties. Windows only. +Returns true if the printer setup button is enabled. -\membersection{wxPageSetupData::GetEnableMargins}\label{wxpagesetupdatagetenablemargins} +\membersection{wxPageSetupDialogData::GetEnableHelp}\label{wxpagesetupdialogdatagetenablehelp} -\func{bool}{GetEnableMargins}{\void} +\constfunc{bool}{GetEnableHelp}{\void} -Returns TRUE if the margin controls are enabled (Windows only). +Returns true if the printer setup button is enabled. -\membersection{wxPageSetupData::GetEnableOrientation}\label{wxpagesetupdatagetenableorientation} +\membersection{wxPageSetupDialogData::GetDefaultInfo}\label{wxpagesetupdialogdatagetdefaultinfo} -\func{bool}{GetEnableOrientation}{\void} +\constfunc{bool}{GetDefaultInfo}{\void} -Returns TRUE if the orientation control is enabled (Windows only). - -\membersection{wxPageSetupData::GetEnablePaper}\label{wxpagesetupdatagetenablepaper} +Returns true if the dialog will simply return default printer information (such as orientation) +instead of showing a dialog. Windows only. -\func{bool}{GetEnablePaper}{\void} +\membersection{wxPageSetupDialogData::GetMarginTopLeft}\label{wxpagesetupdialogdatagetmargintopleft} -Returns TRUE if the paper size control is enabled (Windows only). +\constfunc{wxPoint}{GetMarginTopLeft}{\void} -\membersection{wxPageSetupData::GetEnablePrinter}\label{wxpagesetupdatagetenableprinter} +Returns the left (x) and top (y) margins in millimetres. -\func{bool}{GetEnablePrinter}{\void} +\membersection{wxPageSetupDialogData::GetMarginBottomRight}\label{wxpagesetupdialogdatagetmarginbottomright} -Returns TRUE if the printer setup button is enabled. +\constfunc{wxPoint}{GetMarginBottomRight}{\void} -\membersection{wxPageSetupData::GetEnableHelp}\label{wxpagesetupdatagetenablehelp} +Returns the right (x) and bottom (y) margins in millimetres. -\func{bool}{GetEnableHelp}{\void} +\membersection{wxPageSetupDialogData::GetMinMarginTopLeft}\label{wxpagesetupdialogdatagetminmargintopleft} -Returns TRUE if the printer setup button is enabled. +\constfunc{wxPoint}{GetMinMarginTopLeft}{\void} -\membersection{wxPageSetupData::GetDefaultInfo}\label{wxpagesetupdatagetdefaultinfo} +Returns the left (x) and top (y) minimum margins the user can enter (Windows only). Units +are in millimetres -\func{bool}{GetDefaultInfo}{\void} +\membersection{wxPageSetupDialogData::GetMinMarginBottomRight}\label{wxpagesetupdialogdatagetminmarginbottomright} -Returns TRUE if the dialog will simply return default printer information (such as orientation) -instead of showing a dialog. Windows only. +\constfunc{wxPoint}{GetMinMarginBottomRight}{\void} -\membersection{wxPageSetupData::SetPaperSize}\label{wxpagesetupdatasetpapersize} +Returns the right (x) and bottom (y) minimum margins the user can enter (Windows only). Units +are in millimetres -\func{void}{SetPaperSize}{\param{const wxPoint\& }{size}} +\membersection{wxPageSetupDialogData::GetPaperId}\label{wxpagesetupdialogdatagetpaperid} -Sets the paper size in millimetres. +\constfunc{wxPaperSize}{GetPaperId}{\void} -\membersection{wxPageSetupData::SetMarginTopLeft}\label{wxpagesetupdatasetmargintopleft} +Returns the paper id (stored in the internal wxPrintData object). -\func{void}{GetMarginTopLeft}{\param{const wxPoint\& }{pt}} +For further information, see \helpref{wxPrintData::SetPaperId}{wxprintdatasetpaperid}. -Sets the left (x) and top (y) margins. +\membersection{wxPageSetupDialogData::GetPaperSize}\label{wxpagesetupdialogdatagetpapersize} -\membersection{wxPageSetupData::SetMarginBottomRight}\label{wxpagesetupdatasetmarginbottomright} +\constfunc{wxSize}{GetPaperSize}{\void} -\func{void}{SetMarginBottomRight}{\param{const wxPoint\& }{pt}} +Returns the paper size in millimetres. -Sets the right (x) and bottom (y) margins. +\membersection{wxPageSetupDialogData::GetPrintData}\label{wxpagesetupdialogdatagetprintdata} -\membersection{wxPageSetupData::SetMinMarginTopLeft}\label{wxpagesetupdatasetminmargintopleft} +\func{wxPrintData\&}{GetPrintData}{\void} -\func{void}{SetMinMarginTopLeft}{\param{const wxPoint\& }{pt}} +Returns a reference to the \helpref{print data}{wxprintdata} associated with this object. -Sets the left (x) and top (y) minimum margins the user can enter (Windows only). +\membersection{wxPageSetupDialogData::IsOk}\label{wxpagesetupdialogdataisok} -\membersection{wxPageSetupData::SetMinMarginBottomRight}\label{wxpagesetupdatasetminmarginbottomright} +\constfunc{bool}{IsOk}{\void} -\func{void}{SetMinMarginBottomRight}{\param{const wxPoint\& }{pt}} +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. -Sets the right (x) and bottom (y) minimum margins the user can enter (Windows only). +\membersection{wxPageSetupDialogData::SetDefaultInfo}\label{wxpagesetupdialogdatasetdefaultinfo} -\membersection{wxPageSetupData::SetOrientation}\label{wxpagesetupdatasetorientation} - -\func{void}{SetOrientation}{\param{int }{orientation}} +\func{void}{SetDefaultInfo}{\param{bool}{ flag}} -Sets the orientation, which can be wxPORTRAIT or wxLANDSCAPE. +Pass true if the dialog will simply return default printer information (such as orientation) +instead of showing a dialog. Windows only. -\membersection{wxPageSetupData::SetDefaultMinMargins}\label{wxpagesetupdatasetdefaultminmargins} +\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{wxPageSetupData::SetDefaultInfo}\label{wxpagesetupdatasetdefaultinfo} +\membersection{wxPageSetupDialogData::SetMarginTopLeft}\label{wxpagesetupdialogdatasetmargintopleft} -\func{void}{SetDefaultInfo}{\param{bool}{ flag}} +\func{void}{SetMarginTopLeft}{\param{const wxPoint\& }{pt}} -Pass TRUE if the dialog will simply return default printer information (such as orientation) -instead of showing a dialog. Windows only. +Sets the left (x) and top (y) margins in millimetres. -\section{\class{wxPageSetupDialog}}\label{wxpagesetupdialog} +\membersection{wxPageSetupDialogData::SetMarginBottomRight}\label{wxpagesetupdialogdatasetmarginbottomright} -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. +\func{void}{SetMarginBottomRight}{\param{const wxPoint\& }{pt}} -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. +Sets the right (x) and bottom (y) margins in millimetres. -Note that the OK and Cancel buttons do not destroy the dialog; this must be done by the -application. +\membersection{wxPageSetupDialogData::SetMinMarginTopLeft}\label{wxpagesetupdialogdatasetminmargintopleft} -\wxheading{Derived from} +\func{void}{SetMinMarginTopLeft}{\param{const wxPoint\& }{pt}} -\helpref{wxDialog}{wxdialog}\\ -\helpref{wxWindow}{wxwindow}\\ -\helpref{wxEvtHandler}{wxevthandler}\\ -\helpref{wxObject}{wxobject} +Sets the left (x) and top (y) minimum margins the user can enter (Windows only). Units are +in millimetres. -\wxheading{Include files} +\membersection{wxPageSetupDialogData::SetMinMarginBottomRight}\label{wxpagesetupdialogdatasetminmarginbottomright} - +\func{void}{SetMinMarginBottomRight}{\param{const wxPoint\& }{pt}} -\wxheading{See also} +Sets the right (x) and bottom (y) minimum margins the user can enter (Windows only). Units are +in millimetres. -\helpref{wxPrintDialog}{wxprintdialog}, \helpref{wxPageSetupData}{wxpagesetupdata} +\membersection{wxPageSetupDialogData::SetPaperId}\label{wxpagesetupdialogdatasetpaperid} -\latexignore{\rtfignore{\wxheading{Members}}} +\func{void}{SetPaperId}{\param{wxPaperSize\& }{id}} -\membersection{wxPageSetupDialog::wxPageSetupDialog} +Sets the paper size id. For further information, see \helpref{wxPrintData::SetPaperId}{wxprintdatasetpaperid}. -\func{}{wxPageSetupDialog}{\param{wxWindow* }{parent}, \param{wxPageSetupData* }{data = NULL}} +Calling this function overrides the explicit paper dimensions passed in \helpref{wxPageSetupDialogData::SetPaperSize}{wxpagesetupdialogdatasetpapersize}. -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{wxPageSetupDialogData::SetPaperSize}\label{wxpagesetupdialogdatasetpapersize} -\membersection{wxPageSetupDialog::\destruct{wxPageSetupDialog}} +\func{void}{SetPaperSize}{\param{const wxSize\& }{size}} -\func{}{\destruct{wxPageSetupDialog}}{\void} +Sets the paper size in millimetres. If a corresponding paper id is found, it will be set in the +internal wxPrintData object, otherwise the paper size overrides the paper id. -Destructor. +\membersection{wxPageSetupDialogData::SetPrintData}\label{wxpagesetupdialogdatasetprintdata} -\membersection{wxPageSetupDialog::GetPageSetupData}\label{wxpagesetupdialoggetpagesetupdata} +\func{void}{SetPrintData}{\param{const wxPrintData\&}{ printData}} -\func{wxPageSetupData\&}{GetPageSetupData}{\void} +Sets the \helpref{print data}{wxprintdata} associated with this object. -Returns the \helpref{page setup data}{wxpagesetupdata} associated with the dialog. +\membersection{wxPageSetupDialogData::operator $=$}\label{wxpagesetupdialogdataassign} -\membersection{wxPageSetupDialog::ShowModal}\label{wxpagesetupdialogshowmodal} +\func{void}{operator $=$}{\param{const wxPrintData\&}{ data}} -\func{int}{ShowModal}{\void} +Assigns print data to this object. -Shows the dialog, returning wxID\_OK if the user pressed OK, and wxID\_CANCEL -otherwise. +\func{void}{operator $=$}{\param{const wxPageSetupDialogData\&}{ data}} +Assigns page setup data to this object.