another patch bring the docs more up to date (patch 1717776)

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

diff --git a/docs/latex/wx/pagedlg.tex b/docs/latex/wx/pagedlg.tex
index f02df12794c9a32c630e6b2ba03bd3893a852870..b7d9cbafff74ce06b52f4ec21553b0963fcde6c0 100644 (file)
--- a/docs/latex/wx/pagedlg.tex
+++ b/docs/latex/wx/pagedlg.tex
@@ -1,7 +1,87 @@
-\section{\class{wxPageSetupData}}\label{wxpagesetupdata}
+\section{\class{wxPageSetupDialog}}\label{wxpagesetupdialog}
+
+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.
+
+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.
+
+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{wxWindow}{wxwindow}\\
+\helpref{wxEvtHandler}{wxevthandler}\\
+\helpref{wxObject}{wxobject}
+
+\wxheading{Include files}
+
+<wx/printdlg.h>
+
+\wxheading{See also}
+
+\helpref{Printing framework overview}{printingoverview}, 
+\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}.
 
 
 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}
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}


@@ -12,239 +92,227 @@ This class holds a variety of information related to \helpref{wxPageSetupDialog}
 
 \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{wxPageSetupData::wxPageSetupData}
+\membersection{wxPageSetupDialogData::wxPageSetupDialogData}\label{wxpagesetupdialogdatactor}
+
+\func{}{wxPageSetupDialogData}{\void}

 
 

-\func{}{wxPageSetupData}{\void}
+Default constructor.

 
 

-Constructor.
+\func{}{wxPageSetupDialogData}{\param{wxPageSetupDialogData\&}{ data}}

 
 

-\membersection{wxPageSetupData::\destruct{wxPageSetupData}}
+Copy constructor.

 
 

-\func{}{\destruct{wxPageSetupData}}{\void}
+\func{}{wxPageSetupDialogData}{\param{wxPrintData\&}{ printData}}
+
+Construct an object from a print data object.
+
+\membersection{wxPageSetupDialogData::\destruct{wxPageSetupDialogData}}\label{wxpagesetupdialogdatadtor}
+
+\func{}{\destruct{wxPageSetupDialogData}}{\void}

 
 Destructor.
 
 
 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).
 
 
 \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).
 
 
 \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).
 
 
 \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).
 
 
 \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.
 
 
 \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{wxPageSetupDialogData::GetDefaultMinMargins}\label{wxpagesetupdialogdatagetdefaultminmargins}

 
 

-\membersection{wxPageSetupData::GetMinMarginTopLeft}\label{wxpagesetupdatagetminmargintopleft}
+\constfunc{bool}{GetDefaultMinMargins}{\void}

 
 

-\func{wxPoint}{GetMinMarginTopLeft}{\void}
+Returns true if the page setup dialog will take its minimum margin values from the currently
+selected printer properties. Windows only.

 
 

-Returns the left (x) and top (y) minimum margins the user can enter (Windows only).
+\membersection{wxPageSetupDialogData::GetEnableMargins}\label{wxpagesetupdialogdatagetenablemargins}

 
 

-\membersection{wxPageSetupData::GetMinMarginBottomRight}\label{wxpagesetupdatagetminmarginbottomright}
+\constfunc{bool}{GetEnableMargins}{\void}

 
 

-\func{wxPoint}{GetMinMarginBottomRight}{\void}
+Returns true if the margin controls are enabled (Windows only).

 
 

-Returns the right (x) and bottom (y) minimum margins the user can enter (Windows only).
+\membersection{wxPageSetupDialogData::GetEnableOrientation}\label{wxpagesetupdialogdatagetenableorientation}

 
 

-\membersection{wxPageSetupData::GetOrientation}\label{wxpagesetupdatagetorientation}
+\constfunc{bool}{GetEnableOrientation}{\void}

 
 

-\func{int}{GetOrientation}{\void}
+Returns true if the orientation control is enabled (Windows only).

 
 

-Returns the orientation, which can be wxPORTRAIT or wxLANDSCAPE.
+\membersection{wxPageSetupDialogData::GetEnablePaper}\label{wxpagesetupdialogdatagetenablepaper}

 
 

-\membersection{wxPageSetupData::GetDefaultMinMargins}\label{wxpagesetupdatagetdefaultminmargins}
+\constfunc{bool}{GetEnablePaper}{\void}

 
 

-\func{bool}{GetDefaultMinMargins}{\void}
+Returns true if the paper size control is enabled (Windows only).

 
 

-Returns TRUE if the page setup dialog will take its minimum margin values from the currently
-selected printer properties. Windows only.
+\membersection{wxPageSetupDialogData::GetEnablePrinter}\label{wxpagesetupdialogdatagetenableprinter}

 
 

-\membersection{wxPageSetupData::GetEnableMargins}\label{wxpagesetupdatagetenablemargins}
+\constfunc{bool}{GetEnablePrinter}{\void}

 
 

-\func{bool}{GetEnableMargins}{\void}
+Returns true if the printer setup button is enabled.

 
 

-Returns TRUE if the margin controls are enabled (Windows only).
+\membersection{wxPageSetupDialogData::GetEnableHelp}\label{wxpagesetupdialogdatagetenablehelp}

 
 

-\membersection{wxPageSetupData::GetEnableOrientation}\label{wxpagesetupdatagetenableorientation}
+\constfunc{bool}{GetEnableHelp}{\void}

 
 

-\func{bool}{GetEnableOrientation}{\void}
+Returns true if the printer setup button is enabled.

 
 

-Returns TRUE if the orientation control is enabled (Windows only).
+\membersection{wxPageSetupDialogData::GetDefaultInfo}\label{wxpagesetupdialogdatagetdefaultinfo}

 
 

-\membersection{wxPageSetupData::GetEnablePaper}\label{wxpagesetupdatagetenablepaper}
+\constfunc{bool}{GetDefaultInfo}{\void}

 
 

-\func{bool}{GetEnablePaper}{\void}
+Returns true if the dialog will simply return default printer information (such as orientation)
+instead of showing a dialog. Windows only.

 
 

-Returns TRUE if the paper size control is enabled (Windows only).
+\membersection{wxPageSetupDialogData::GetMarginTopLeft}\label{wxpagesetupdialogdatagetmargintopleft}

 
 

-\membersection{wxPageSetupData::GetEnablePrinter}\label{wxpagesetupdatagetenableprinter}
+\constfunc{wxPoint}{GetMarginTopLeft}{\void}

 
 

-\func{bool}{GetEnablePrinter}{\void}
+Returns the left (x) and top (y) margins in millimetres.

 
 

-Returns TRUE if the printer setup button is enabled.
+\membersection{wxPageSetupDialogData::GetMarginBottomRight}\label{wxpagesetupdialogdatagetmarginbottomright}

 
 

-\membersection{wxPageSetupData::GetEnableHelp}\label{wxpagesetupdatagetenablehelp}
+\constfunc{wxPoint}{GetMarginBottomRight}{\void}

 
 

-\func{bool}{GetEnableHelp}{\void}
+Returns the right (x) and bottom (y) margins in millimetres.

 
 

-Returns TRUE if the printer setup button is enabled.
+\membersection{wxPageSetupDialogData::GetMinMarginTopLeft}\label{wxpagesetupdialogdatagetminmargintopleft}

 
 

-\membersection{wxPageSetupData::GetDefaultInfo}\label{wxpagesetupdatagetdefaultinfo}
+\constfunc{wxPoint}{GetMinMarginTopLeft}{\void}

 
 

-\func{bool}{GetDefaultInfo}{\void}
+Returns the left (x) and top (y) minimum margins the user can enter (Windows only). Units
+are in millimetres

 
 

-Returns TRUE if the dialog will simply return default printer information (such as orientation)
-instead of showing a dialog. Windows only.
+\membersection{wxPageSetupDialogData::GetMinMarginBottomRight}\label{wxpagesetupdialogdatagetminmarginbottomright}

 
 

-\membersection{wxPageSetupData::SetPaperSize}\label{wxpagesetupdatasetpapersize}
+\constfunc{wxPoint}{GetMinMarginBottomRight}{\void}

 
 

-\func{void}{SetPaperSize}{\param{const wxPoint\& }{size}}
+Returns the right (x) and bottom (y) minimum margins the user can enter (Windows only). Units
+are in millimetres

 
 

-Sets the paper size in millimetres.
+\membersection{wxPageSetupDialogData::GetPaperId}\label{wxpagesetupdialogdatagetpaperid}

 
 

-\membersection{wxPageSetupData::SetMarginTopLeft}\label{wxpagesetupdatasetmargintopleft}
+\constfunc{wxPaperSize}{GetPaperId}{\void}

 
 

-\func{void}{GetMarginTopLeft}{\param{const wxPoint\& }{pt}}
+Returns the paper id (stored in the internal wxPrintData object).

 
 

-Sets the left (x) and top (y) margins.
+For further information, see \helpref{wxPrintData::SetPaperId}{wxprintdatasetpaperid}.

 
 

-\membersection{wxPageSetupData::SetMarginBottomRight}\label{wxpagesetupdatasetmarginbottomright}
+\membersection{wxPageSetupDialogData::GetPaperSize}\label{wxpagesetupdialogdatagetpapersize}

 
 

-\func{void}{SetMarginBottomRight}{\param{const wxPoint\& }{pt}}
+\constfunc{wxSize}{GetPaperSize}{\void}

 
 

-Sets the right (x) and bottom (y) margins.
+Returns the paper size in millimetres.

 
 

-\membersection{wxPageSetupData::SetMinMarginTopLeft}\label{wxpagesetupdatasetminmargintopleft}
+\membersection{wxPageSetupDialogData::GetPrintData}\label{wxpagesetupdialogdatagetprintdata}

 
 

-\func{void}{SetMinMarginTopLeft}{\param{const wxPoint\& }{pt}}
+\func{wxPrintData\&}{GetPrintData}{\void}

 
 

-Sets the left (x) and top (y) minimum margins the user can enter (Windows only).
+Returns a reference to the \helpref{print data}{wxprintdata} associated with this object.

 
 

-\membersection{wxPageSetupData::SetMinMarginBottomRight}\label{wxpagesetupdatasetminmarginbottomright}
+\membersection{wxPageSetupDialogData::IsOk}\label{wxpagesetupdialogdataisok}

 
 

-\func{void}{SetMinMarginBottomRight}{\param{const wxPoint\& }{pt}}
+\constfunc{bool}{IsOk}{\void}

 
 

-Sets the right (x) and bottom (y) minimum margins the user can enter (Windows only).
+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{wxPageSetupData::SetOrientation}\label{wxpagesetupdatasetorientation}
+\membersection{wxPageSetupDialogData::SetDefaultInfo}\label{wxpagesetupdialogdatasetdefaultinfo}

 
 

-\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}}
 
 
 \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}

 
 

-<wx/printdlg.h>
+\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.