new wxWindow::FindWindowByXXX() methods replacing the old global functions

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

diff --git a/docs/latex/wx/pagedlg.tex b/docs/latex/wx/pagedlg.tex
index 082970f2c0ce907d63d0c009d18e397e0c0f18a0..b68a9ffeb61c3a524e0393e926163c36ed687ff8 100644 (file)
--- a/docs/latex/wx/pagedlg.tex
+++ b/docs/latex/wx/pagedlg.tex
@@ -1,242 +1,307 @@
-\section{\class{wxPageSetupData}}\label{wxpagesetupdata}
+\section{\class{wxPageSetupDialog}}\label{wxpagesetupdialog}

 
 

-This class holds a variety of information related to \helpref{wxPageSetupDialog}{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.
+
+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}
 
 
 \wxheading{Derived from}
 

+\helpref{wxDialog}{wxdialog}\\
+\helpref{wxWindow}{wxwindow}\\
+\helpref{wxEvtHandler}{wxevthandler}\\

 \helpref{wxObject}{wxobject}
 
 \helpref{wxObject}{wxobject}
 

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

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

-\helpref{wxPageSetupDialog}{wxpagesetupdialog}
+\helpref{wxPrintDialog}{wxprintdialog}, \helpref{wxPageSetupDialogData}{wxpagesetupdialogdata}

 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxPageSetupData::wxPageSetupData}
+\membersection{wxPageSetupDialog::wxPageSetupDialog}

 
 

-\func{}{wxPageSetupData}{\void}
+\func{}{wxPageSetupDialog}{\param{wxWindow* }{parent}, \param{wxPageSetupDialogData* }{data = NULL}}

 
 

-Constructor.
+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{wxPageSetupData::\destruct{wxPageSetupData}}
+\membersection{wxPageSetupDialog::\destruct{wxPageSetupDialog}}

 
 

-\func{}{\destruct{wxPageSetupData}}{\void}
+\func{}{\destruct{wxPageSetupDialog}}{\void}

 
 Destructor.
 
 
 Destructor.
 

-\membersection{wxPageSetupData::EnableHelp}\label{wxpagesetupdataenablehelp}
+\membersection{wxPageSetupDialog::GetPageSetupData}\label{wxpagesetupdialoggetpagesetupdata}

 
 

-\func{void}{EnableHelp}{\param{bool }{flag}}
+\func{wxPageSetupDialogData\&}{GetPageSetupData}{\void}

 
 

-Enables or disables the `Help' button (Windows only).
+Returns the \helpref{page setup data}{wxpagesetupdialogdata} associated with the dialog.

 
 

-\membersection{wxPageSetupData::EnableMargins}\label{wxpagesetupdataenablemargins}
+\membersection{wxPageSetupDialog::Ok}\label{wxpagesetupdialogok}

 
 

-\func{void}{EnableMargins}{\param{bool }{flag}}
+\constfunc{bool}{Ok}{\void}

 
 

-Enables or disables the margin controls (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{wxPageSetupDialog::ShowModal}\label{wxpagesetupdialogshowmodal}

 
 

-\membersection{wxPageSetupData::EnableOrientation}\label{wxpagesetupdataenableorientation}
+\func{int}{ShowModal}{\void}

 
 

-\func{void}{EnableOrientation}{\param{bool }{flag}}
+Shows the dialog, returning wxID\_OK if the user pressed OK, and wxID\_CANCEL
+otherwise.

 
 

-Enables or disables the orientation control (Windows only).
+\section{\class{wxPageSetupDialogData}}\label{wxpagesetupdialogdata}

 
 

-\membersection{wxPageSetupData::EnablePaper}\label{wxpagesetupdataenablepaper}
+This class holds a variety of information related to \helpref{wxPageSetupDialog}{wxpagesetupdialog}.

 
 

-\func{void}{EnablePaper}{\param{bool }{flag}}
+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).

 
 

-Enables or disables the paper size control (Windows only).
+\wxheading{Derived from}

 
 

-\membersection{wxPageSetupData::EnablePrinter}\label{wxpagesetupdataenableprinter}
+\helpref{wxObject}{wxobject}

 
 

-\func{void}{EnablePrinter}{\param{bool }{flag}}
+\wxheading{Include files}

 
 

-Enables or disables the {\bf Printer} button, which invokes a printer setup dialog.
+<wx/cmndata.h>

 
 

-\membersection{wxPageSetupData::GetPaperSize}\label{wxpagesetupdatagetpapersize}
+\wxheading{See also}

 
 

-\func{wxPoint}{GetPaperSize}{\void}
+\helpref{wxPageSetupDialog}{wxpagesetupdialog}

 
 

-Returns the paper size in millimetres.
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxPageSetupDialogData::wxPageSetupDialogData}

 
 

-\membersection{wxPageSetupData::GetMarginTopLeft}\label{wxpagesetupdatagetmargintopleft}
+\func{}{wxPageSetupDialogData}{\void}

 
 

-\func{wxPoint}{GetMarginTopLeft}{\void}
+Default constructor.

 
 

-Returns the left (x) and top (y) margins.
+\func{}{wxPageSetupDialogData}{\param{wxPageSetupDialogData\&}{ data}}

 
 

-\membersection{wxPageSetupData::GetMarginBottomRight}\label{wxpagesetupdatagetmarginbottomright}
+Copy constructor.

 
 

-\func{wxPoint}{GetMarginBottomRight}{\void}
+\func{}{wxPrintDialogData}{\param{wxPrintData\&}{ printData}}

 
 

-Returns the right (x) and bottom (y) margins.
+Construct an object from a print dialog data object.

 
 

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

 
 

-\func{wxPoint}{GetMinMarginTopLeft}{\void}
+\func{}{\destruct{wxPageSetupDialogData}}{\void}

 
 

-Returns the left (x) and top (y) minimum margins the user can enter (Windows only).
+Destructor.

 
 

-\membersection{wxPageSetupData::GetMinMarginBottomRight}\label{wxpagesetupdatagetminmarginbottomright}
+\membersection{wxPageSetupDialogData::EnableHelp}\label{wxpagesetupdialogdataenablehelp}

 
 

-\func{wxPoint}{GetMinMarginBottomRight}{\void}
+\func{void}{EnableHelp}{\param{bool }{flag}}

 
 

-Returns the right (x) and bottom (y) minimum margins the user can enter (Windows only).
+Enables or disables the `Help' button (Windows only).

 
 

-\membersection{wxPageSetupData::GetOrientation}\label{wxpagesetupdatagetorientation}
+\membersection{wxPageSetupDialogData::EnableMargins}\label{wxpagesetupdialogdataenablemargins}

 
 

-\func{int}{GetOrientation}{\void}
+\func{void}{EnableMargins}{\param{bool }{flag}}

 
 

-Returns the orientation, which can be wxPORTRAIT or wxLANDSCAPE.
+Enables or disables the margin controls (Windows only).

 
 

-\membersection{wxPageSetupData::GetDefaultMinMargins}\label{wxpagesetupdatagetdefaultminmargins}
+\membersection{wxPageSetupDialogData::EnableOrientation}\label{wxpagesetupdialogdataenableorientation}

 
 

-\func{bool}{GetDefaultMinMargins}{\void}
+\func{void}{EnableOrientation}{\param{bool }{flag}}
+
+Enables or disables the orientation control (Windows only).
+
+\membersection{wxPageSetupDialogData::EnablePaper}\label{wxpagesetupdialogdataenablepaper}
+
+\func{void}{EnablePaper}{\param{bool }{flag}}
+
+Enables or disables the paper size control (Windows only).
+
+\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{wxPageSetupDialogData::GetDefaultMinMargins}\label{wxpagesetupdialogdatagetdefaultminmargins}
+
+\constfunc{bool}{GetDefaultMinMargins}{\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 page setup dialog will take its minimum margin values from the currently
 selected printer properties. Windows only.
 

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

 
 

-\func{bool}{GetEnableMargins}{\void}
+\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{wxPageSetupData::GetEnableOrientation}\label{wxpagesetupdatagetenableorientation}
+\membersection{wxPageSetupDialogData::GetEnableOrientation}\label{wxpagesetupdialogdatagetenableorientation}

 
 

-\func{bool}{GetEnableOrientation}{\void}
+\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{wxPageSetupData::GetEnablePaper}\label{wxpagesetupdatagetenablepaper}
+\membersection{wxPageSetupDialogData::GetEnablePaper}\label{wxpagesetupdialogdatagetenablepaper}

 
 

-\func{bool}{GetEnablePaper}{\void}
+\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{wxPageSetupData::GetEnablePrinter}\label{wxpagesetupdatagetenableprinter}
+\membersection{wxPageSetupDialogData::GetEnablePrinter}\label{wxpagesetupdialogdatagetenableprinter}

 
 

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

 
 Returns TRUE if the printer setup button is enabled.
 
 
 Returns TRUE if the printer setup button is enabled.
 

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

 
 

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

 
 Returns TRUE if the printer setup button is enabled.
 
 
 Returns TRUE if the printer setup button is enabled.
 

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

 
 

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

-\membersection{wxPageSetupData::SetPaperSize}\label{wxpagesetupdatasetpapersize}
+\membersection{wxPageSetupDialogData::GetMarginTopLeft}\label{wxpagesetupdialogdatagetmargintopleft}

 
 

-\func{void}{SetPaperSize}{\param{const wxPoint\& }{size}}
+\constfunc{wxPoint}{GetMarginTopLeft}{\void}

 
 

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

 
 

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

 
 

-\func{void}{GetMarginTopLeft}{\param{const wxPoint\& }{pt}}
+\constfunc{wxPoint}{GetMarginBottomRight}{\void}

 
 

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

 
 

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

 
 

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

 
 

-Sets the right (x) and bottom (y) margins.
+Returns the left (x) and top (y) minimum margins the user can enter (Windows only). Units
+are in millimetres

 
 

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

 
 

-\func{void}{SetMinMarginTopLeft}{\param{const wxPoint\& }{pt}}
+\constfunc{wxPoint}{GetMinMarginBottomRight}{\void}

 
 

-Sets the left (x) and top (y) minimum margins the user can enter (Windows only).
+Returns the right (x) and bottom (y) minimum margins the user can enter (Windows only). Units
+are in millimetres

 
 

-\membersection{wxPageSetupData::SetMinMarginBottomRight}\label{wxpagesetupdatasetminmarginbottomright}
+\membersection{wxPageSetupDialogData::GetPaperId}\label{wxpagesetupdialogdatagetpaperid}

 
 

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

 
 

-Sets the right (x) and bottom (y) minimum margins the user can enter (Windows only).
+For further information, see \helpref{wxPrintData::SetPaperId}{wxprintdatasetpaperid}.

 
 

-\membersection{wxPageSetupData::SetOrientation}\label{wxpagesetupdatasetorientation}
+\membersection{wxPageSetupDialogData::GetPaperSize}\label{wxpagesetupdialogdatagetpapersize}

 
 

-\func{void}{SetOrientation}{\param{int }{orientation}}
+\constfunc{wxSize}{GetPaperSize}{\void}

 
 

-Sets the orientation, which can be wxPORTRAIT or wxLANDSCAPE.
+Returns the paper size in millimetres.

 
 

-\membersection{wxPageSetupData::SetDefaultMinMargins}\label{wxpagesetupdatasetdefaultminmargins}
+\membersection{wxPageSetupDialogData::GetPrintData}\label{wxpagesetupdialogdatagetprintdata}

 
 

-\func{void}{SetDefaultMinMargins}{\param{bool}{ flag}}
+\func{wxPrintData\&}{GetPrintData}{\void}

 
 

-Pass TRUE if the page setup dialog will take its minimum margin values from the currently
-selected printer properties. Windows only.
+Returns a reference to the \helpref{print data}{wxprintdata} associated with this object.

 
 

-\membersection{wxPageSetupData::SetDefaultInfo}\label{wxpagesetupdatasetdefaultinfo}
+\membersection{wxPageSetupDialogData::Ok}\label{wxpagesetupdialogdataok}
+
+\constfunc{bool}{Ok}{\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)
 instead of showing a dialog. Windows only.
 
 
 \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}
+\membersection{wxPageSetupDialogData::SetDefaultMinMargins}\label{wxpagesetupdialogdatasetdefaultminmargins}

 
 

-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}{SetDefaultMinMargins}{\param{bool}{ flag}}

 
 

-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.
+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

 
 

-Note that the OK and Cancel buttons do not destroy the dialog; this must be done by the
-application.
+\membersection{wxPageSetupDialogData::SetMarginTopLeft}\label{wxpagesetupdialogdatasetmargintopleft}

 
 

-\wxheading{Derived from}
+\func{void}{GetMarginTopLeft}{\param{const wxPoint\& }{pt}}

 
 

-\helpref{wxDialog}{wxdialog}\\
-\helpref{wxWindow}{wxwindow}\\
-\helpref{wxEvtHandler}{wxevthandler}\\
-\helpref{wxObject}{wxobject}
+Sets the left (x) and top (y) margins in millimetres.

 
 

-\wxheading{See also}
+\membersection{wxPageSetupDialogData::SetMarginBottomRight}\label{wxpagesetupdialogdatasetmarginbottomright}

 
 

-\helpref{wxPrintDialog}{wxprintdialog}, \helpref{wxPageSetupData}{wxpagesetupdata}
+\func{void}{SetMarginBottomRight}{\param{const wxPoint\& }{pt}}

 
 

-\latexignore{\rtfignore{\wxheading{Members}}}
+Sets the right (x) and bottom (y) margins in millimetres.

 
 

-\membersection{wxPageSetupDialog::wxPageSetupDialog}
+\membersection{wxPageSetupDialogData::SetMinMarginTopLeft}\label{wxpagesetupdialogdatasetminmargintopleft}

 
 

-\func{}{wxPageSetupDialog}{\param{wxWindow* }{parent}, \param{wxPageSetupData* }{data = NULL}}
+\func{void}{SetMinMarginTopLeft}{\param{const wxPoint\& }{pt}}

 
 

-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.
+Sets the left (x) and top (y) minimum margins the user can enter (Windows only). Units are
+in millimetres.

 
 

-\membersection{wxPageSetupDialog::\destruct{wxPageSetupDialog}}
+\membersection{wxPageSetupDialogData::SetMinMarginBottomRight}\label{wxpagesetupdialogdatasetminmarginbottomright}

 
 

-\func{}{\destruct{wxPageSetupDialog}}{\void}
+\func{void}{SetMinMarginBottomRight}{\param{const wxPoint\& }{pt}}

 
 

-Destructor.
+Sets the right (x) and bottom (y) minimum margins the user can enter (Windows only). Units are
+in millimetres.

 
 

-\membersection{wxPageSetupDialog::GetPageSetupData}\label{wxpagesetupdialoggetpagesetupdata}
+\membersection{wxPageSetupDialogData::SetPaperId}\label{wxpagesetupdialogdatasetpaperid}

 
 

-\func{wxPageSetupData\&}{GetPageSetupData}{\void}
+\func{void}{SetPaperId}{\param{wxPaperSize\& }{id}}

 
 

-Returns the \helpref{page setup data}{wxpagesetupdata} associated with the dialog.
+Sets the paper size id. For further information, see \helpref{wxPrintData::SetPaperId}{wxprintdatasetpaperid}.

 
 

-\membersection{wxPageSetupDialog::ShowModal}\label{wxpagesetupdialogshowmodal}
+Calling this function overrides the explicit paper dimensions passed in \helpref{wxPageSetupDialogData::SetPaperSize}{wxpagesetupdialogdatasetpapersize}.

 
 

-\func{int}{ShowModal}{\void}
+\membersection{wxPageSetupDialogData::SetPaperSize}\label{wxpagesetupdialogdatasetpapersize}

 
 

-Shows the dialog, returning wxID\_OK if the user pressed OK, and wxID\_CANCEL
-otherwise.
+\func{void}{SetPaperSize}{\param{const wxSize\& }{size}}
+
+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.
+
+\membersection{wxPageSetupDialogData::SetPrintData}\label{wxpagesetupdialogdatasetprintdata}
+
+\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.