Prep for wxPython 2.1b3 release

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

diff --git a/docs/latex/wx/pagedlg.tex b/docs/latex/wx/pagedlg.tex
index 082970f2c0ce907d63d0c009d18e397e0c0f18a0..7cd42caf5fd36a9a0298c16153153ac46b015957 100644 (file)
--- a/docs/latex/wx/pagedlg.tex
+++ b/docs/latex/wx/pagedlg.tex
@@ -1,188 +1,230 @@
-\section{\class{wxPageSetupData}}\label{wxpagesetupdata}
+\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}
 

+\wxheading{Include files}
+
+<wx/cmndata.h>
+

 \wxheading{See also}
 
 \helpref{wxPageSetupDialog}{wxpagesetupdialog}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \wxheading{See also}
 
 \helpref{wxPageSetupDialog}{wxpagesetupdialog}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxPageSetupData::wxPageSetupData}
+\membersection{wxPageSetupDialogData::wxPageSetupDialogData}
+
+\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{}{wxPrintDialogData}{\param{wxPrintData\&}{ printData}}
+
+Construct an object from a print dialog data object.
+
+\membersection{wxPageSetupDialogData::\destruct{wxPageSetupDialogData}}
+
+\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}
+\membersection{wxPageSetupDialogData::GetDefaultMinMargins}\label{wxpagesetupdialogdatagetdefaultminmargins}

 
 

-\func{wxPoint}{GetPaperSize}{\void}
+\constfunc{bool}{GetDefaultMinMargins}{\void}

 
 

-Returns the paper size in millimetres.
+Returns TRUE if the page setup dialog will take its minimum margin values from the currently
+selected printer properties. Windows only.

 
 

-\membersection{wxPageSetupData::GetMarginTopLeft}\label{wxpagesetupdatagetmargintopleft}
+\membersection{wxPageSetupDialogData::GetEnableMargins}\label{wxpagesetupdialogdatagetenablemargins}

 
 

-\func{wxPoint}{GetMarginTopLeft}{\void}
+\constfunc{bool}{GetEnableMargins}{\void}

 
 

-Returns the left (x) and top (y) margins.
+Returns TRUE if the margin controls are enabled (Windows only).

 
 

-\membersection{wxPageSetupData::GetMarginBottomRight}\label{wxpagesetupdatagetmarginbottomright}
+\membersection{wxPageSetupDialogData::GetEnableOrientation}\label{wxpagesetupdialogdatagetenableorientation}

 
 

-\func{wxPoint}{GetMarginBottomRight}{\void}
+\constfunc{bool}{GetEnableOrientation}{\void}

 
 

-Returns the right (x) and bottom (y) margins.
+Returns TRUE if the orientation control is enabled (Windows only).

 
 

-\membersection{wxPageSetupData::GetMinMarginTopLeft}\label{wxpagesetupdatagetminmargintopleft}
+\membersection{wxPageSetupDialogData::GetEnablePaper}\label{wxpagesetupdialogdatagetenablepaper}

 
 

-\func{wxPoint}{GetMinMarginTopLeft}{\void}
+\constfunc{bool}{GetEnablePaper}{\void}

 
 

-Returns the left (x) and top (y) minimum margins the user can enter (Windows only).
+Returns TRUE if the paper size control is enabled (Windows only).

 
 

-\membersection{wxPageSetupData::GetMinMarginBottomRight}\label{wxpagesetupdatagetminmarginbottomright}
+\membersection{wxPageSetupDialogData::GetEnablePrinter}\label{wxpagesetupdialogdatagetenableprinter}

 
 

-\func{wxPoint}{GetMinMarginBottomRight}{\void}
+\constfunc{bool}{GetEnablePrinter}{\void}

 
 

-Returns the right (x) and bottom (y) minimum margins the user can enter (Windows only).
+Returns TRUE if the printer setup button is enabled.

 
 

-\membersection{wxPageSetupData::GetOrientation}\label{wxpagesetupdatagetorientation}
+\membersection{wxPageSetupDialogData::GetEnableHelp}\label{wxpagesetupdialogdatagetenablehelp}

 
 

-\func{int}{GetOrientation}{\void}
+\constfunc{bool}{GetEnableHelp}{\void}

 
 

-Returns the orientation, which can be wxPORTRAIT or wxLANDSCAPE.
+Returns TRUE if the printer setup button is enabled.

 
 

-\membersection{wxPageSetupData::GetDefaultMinMargins}\label{wxpagesetupdatagetdefaultminmargins}
+\membersection{wxPageSetupDialogData::GetDefaultInfo}\label{wxpagesetupdialogdatagetdefaultinfo}

 
 

-\func{bool}{GetDefaultMinMargins}{\void}
+\constfunc{bool}{GetDefaultInfo}{\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 dialog will simply return default printer information (such as orientation)
+instead of showing a dialog. Windows only.

 
 

-\membersection{wxPageSetupData::GetEnableMargins}\label{wxpagesetupdatagetenablemargins}
+\membersection{wxPageSetupDialogData::GetMarginTopLeft}\label{wxpagesetupdialogdatagetmargintopleft}

 
 

-\func{bool}{GetEnableMargins}{\void}
+\constfunc{wxPoint}{GetMarginTopLeft}{\void}

 
 

-Returns TRUE if the margin controls are enabled (Windows only).
+Returns the left (x) and top (y) margins.

 
 

-\membersection{wxPageSetupData::GetEnableOrientation}\label{wxpagesetupdatagetenableorientation}
+\membersection{wxPageSetupDialogData::GetMarginBottomRight}\label{wxpagesetupdialogdatagetmarginbottomright}

 
 

-\func{bool}{GetEnableOrientation}{\void}
+\constfunc{wxPoint}{GetMarginBottomRight}{\void}

 
 

-Returns TRUE if the orientation control is enabled (Windows only).
+Returns the right (x) and bottom (y) margins.

 
 

-\membersection{wxPageSetupData::GetEnablePaper}\label{wxpagesetupdatagetenablepaper}
+\membersection{wxPageSetupDialogData::GetMinMarginTopLeft}\label{wxpagesetupdialogdatagetminmargintopleft}

 
 

-\func{bool}{GetEnablePaper}{\void}
+\constfunc{wxPoint}{GetMinMarginTopLeft}{\void}

 
 

-Returns TRUE if the paper size control is enabled (Windows only).
+Returns the left (x) and top (y) minimum margins the user can enter (Windows only).

 
 

-\membersection{wxPageSetupData::GetEnablePrinter}\label{wxpagesetupdatagetenableprinter}
+\membersection{wxPageSetupDialogData::GetMinMarginBottomRight}\label{wxpagesetupdialogdatagetminmarginbottomright}

 
 

-\func{bool}{GetEnablePrinter}{\void}
+\constfunc{wxPoint}{GetMinMarginBottomRight}{\void}

 
 

-Returns TRUE if the printer setup button is enabled.
+Returns the right (x) and bottom (y) minimum margins the user can enter (Windows only).

 
 

-\membersection{wxPageSetupData::GetEnableHelp}\label{wxpagesetupdatagetenablehelp}
+\membersection{wxPageSetupDialogData::GetPaperId}\label{wxpagesetupdialogdatagetpaperid}

 
 

-\func{bool}{GetEnableHelp}{\void}
+\constfunc{wxPaperSize}{GetPaperId}{\void}

 
 

-Returns TRUE if the printer setup button is enabled.
+Returns the paper id (stored in the internal wxPrintData object).

 
 

-\membersection{wxPageSetupData::GetDefaultInfo}\label{wxpagesetupdatagetdefaultinfo}
+For further information, see \helpref{wxPrintData::SetPaperId}{wxprintdatasetpaperid}.

 
 

-\func{bool}{GetDefaultInfo}{\void}
+\membersection{wxPageSetupDialogData::GetPaperSize}\label{wxpagesetupdialogdatagetpapersize}

 
 

-Returns TRUE if the dialog will simply return default printer information (such as orientation)
+\constfunc{wxSize}{GetPaperSize}{\void}
+
+Returns the paper size in millimetres.
+
+\membersection{wxPageSetupDialogData::GetPrintData}\label{wxpagesetupdialogdatagetprintdata}
+
+\func{wxPrintData\&}{GetPrintData}{\void}
+
+Returns a reference to the \helpref{print data}{wxprintdata} associated with this object.
+
+\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)

 instead of showing a dialog. Windows only.
 
 instead of showing a dialog. Windows only.
 

-\membersection{wxPageSetupData::SetPaperSize}\label{wxpagesetupdatasetpapersize}
+\membersection{wxPageSetupDialogData::SetDefaultMinMargins}\label{wxpagesetupdialogdatasetdefaultminmargins}

 
 

-\func{void}{SetPaperSize}{\param{const wxPoint\& }{size}}
+\func{void}{SetDefaultMinMargins}{\param{bool}{ flag}}

 
 

-Sets the paper size in millimetres.
+Pass TRUE if the page setup dialog will take its minimum margin values from the currently
+selected printer properties. Windows only.

 
 

-\membersection{wxPageSetupData::SetMarginTopLeft}\label{wxpagesetupdatasetmargintopleft}
+\membersection{wxPageSetupDialogData::SetMarginTopLeft}\label{wxpagesetupdialogdatasetmargintopleft}

 
 \func{void}{GetMarginTopLeft}{\param{const wxPoint\& }{pt}}
 
 Sets the left (x) and top (y) margins.
 
 
 \func{void}{GetMarginTopLeft}{\param{const wxPoint\& }{pt}}
 
 Sets the left (x) and top (y) margins.
 

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

 
 \func{void}{SetMarginBottomRight}{\param{const wxPoint\& }{pt}}
 
 Sets the right (x) and bottom (y) margins.
 
 
 \func{void}{SetMarginBottomRight}{\param{const wxPoint\& }{pt}}
 
 Sets the right (x) and bottom (y) margins.
 

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

 
 \func{void}{SetMinMarginTopLeft}{\param{const wxPoint\& }{pt}}
 
 Sets the left (x) and top (y) minimum margins the user can enter (Windows only).
 
 
 \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}
+\membersection{wxPageSetupDialogData::SetMinMarginBottomRight}\label{wxpagesetupdialogdatasetminmarginbottomright}

 
 \func{void}{SetMinMarginBottomRight}{\param{const wxPoint\& }{pt}}
 
 Sets the right (x) and bottom (y) minimum margins the user can enter (Windows only).
 
 
 \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}
+\membersection{wxPageSetupDialogData::SetPaperId}\label{wxpagesetupdialogdatasetpaperid}

 
 

-\func{void}{SetOrientation}{\param{int }{orientation}}
+\func{void}{SetPaperId}{\param{wxPaperSize\& }{id}}

 
 

-Sets the orientation, which can be wxPORTRAIT or wxLANDSCAPE.
+Sets the paper size id. For further information, see \helpref{wxPrintData::SetPaperId}{wxprintdatasetpaperid}.

 
 

-\membersection{wxPageSetupData::SetDefaultMinMargins}\label{wxpagesetupdatasetdefaultminmargins}
+Calling this function overrides the explicit paper dimensions passed in \helpref{wxPageSetupDialogData::SetPaperSize}{wxpagesetupdialogdatasetpapersize}.

 
 

-\func{void}{SetDefaultMinMargins}{\param{bool}{ flag}}
+\membersection{wxPageSetupDialogData::SetPaperSize}\label{wxpagesetupdialogdatasetpapersize}

 
 

-Pass TRUE if the page setup dialog will take its minimum margin values from the currently
-selected printer properties. Windows only.
+\func{void}{SetPaperSize}{\param{const wxSize\& }{size}}

 
 

-\membersection{wxPageSetupData::SetDefaultInfo}\label{wxpagesetupdatasetdefaultinfo}
+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.

 
 

-\func{void}{SetDefaultInfo}{\param{bool}{ flag}}
+\membersection{wxPageSetupDialogData::SetPrintData}\label{wxpagesetupdialogdatasetprintdata}

 
 

-Pass TRUE if the dialog will simply return default printer information (such as orientation)
-instead of showing a dialog. Windows only.
+\func{void}{SetPrintData}{\param{const wxPrintData\&}{ printData}}
+
+Sets the \helpref{print data}{wxprintdata} associated with this object.
+
+\membersection{wxPageSetupDialogData::operator $=$}\label{wxpagesetupdialogdataassign}
+
+\func{void}{operator $=$}{\param{const wxPrintData\&}{ data}}
+
+Assigns print data to this object.
+
+\func{void}{operator $=$}{\param{const wxPageSetupDialogData\&}{ data}}
+
+Assigns page setup data to this object.

 
 \section{\class{wxPageSetupDialog}}\label{wxpagesetupdialog}
 
 
 \section{\class{wxPageSetupDialog}}\label{wxpagesetupdialog}
 


@@ -193,8 +235,8 @@ 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.

-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
+
+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
 associated with the dialog.
 
 Note that the OK and Cancel buttons do not destroy the dialog; this must be done by the


@@ -207,15 +249,19 @@ application.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/printdlg.h>
+

 \wxheading{See also}
 
 \wxheading{See also}
 

-\helpref{wxPrintDialog}{wxprintdialog}, \helpref{wxPageSetupData}{wxpagesetupdata}
+\helpref{wxPrintDialog}{wxprintdialog}, \helpref{wxPageSetupDialogData}{wxpagesetupdialogdata}

 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxPageSetupDialog::wxPageSetupDialog}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxPageSetupDialog::wxPageSetupDialog}
 

-\func{}{wxPageSetupDialog}{\param{wxWindow* }{parent}, \param{wxPageSetupData* }{data = NULL}}
+\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.
 
 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.


@@ -228,9 +274,9 @@ Destructor.
 
 \membersection{wxPageSetupDialog::GetPageSetupData}\label{wxpagesetupdialoggetpagesetupdata}
 
 
 \membersection{wxPageSetupDialog::GetPageSetupData}\label{wxpagesetupdialoggetpagesetupdata}
 

-\func{wxPageSetupData\&}{GetPageSetupData}{\void}
+\func{wxPageSetupDialogData\&}{GetPageSetupData}{\void}

 
 

-Returns the \helpref{page setup data}{wxpagesetupdata} associated with the dialog.
+Returns the \helpref{page setup data}{wxpagesetupdialogdata} associated with the dialog.

 
 \membersection{wxPageSetupDialog::ShowModal}\label{wxpagesetupdialogshowmodal}
 
 
 \membersection{wxPageSetupDialog::ShowModal}\label{wxpagesetupdialogshowmodal}