Added middle mouse event macros to wxListCtrl doc; added wxCreateGreyedImage

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

diff --git a/docs/latex/wx/pagedlg.tex b/docs/latex/wx/pagedlg.tex
index f02df12794c9a32c630e6b2ba03bd3893a852870..ab02ba67b29acadc76e995d48bd89708a3828c97 100644 (file)
--- a/docs/latex/wx/pagedlg.tex
+++ b/docs/latex/wx/pagedlg.tex
@@ -1,250 +1,291 @@
-\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}
 
 \wxheading{Include files}
 
 \helpref{wxObject}{wxobject}
 
 \wxheading{Include files}
 

-<wx/cmndata.h>
+<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::ShowModal}\label{wxpagesetupdialogshowmodal}

 
 

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

 
 

-Enables or disables the margin controls (Windows only).
+Shows the dialog, returning wxID\_OK if the user pressed OK, and wxID\_CANCEL
+otherwise.

 
 

-\membersection{wxPageSetupData::EnableOrientation}\label{wxpagesetupdataenableorientation}
+\section{\class{wxPageSetupDialogData}}\label{wxpagesetupdialogdata}

 
 

-\func{void}{EnableOrientation}{\param{bool }{flag}}
+This class holds a variety of information related to \helpref{wxPageSetupDialog}{wxpagesetupdialog}.

 
 

-Enables or disables the orientation control (Windows only).
+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).

 
 

-\membersection{wxPageSetupData::EnablePaper}\label{wxpagesetupdataenablepaper}
+\wxheading{Derived from}

 
 

-\func{void}{EnablePaper}{\param{bool }{flag}}
+\helpref{wxObject}{wxobject}

 
 

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

 
 

-\membersection{wxPageSetupData::EnablePrinter}\label{wxpagesetupdataenableprinter}
+<wx/cmndata.h>

 
 

-\func{void}{EnablePrinter}{\param{bool }{flag}}
+\wxheading{See also}

 
 

-Enables or disables the {\bf Printer} button, which invokes a printer setup dialog.
+\helpref{wxPageSetupDialog}{wxpagesetupdialog}

 
 

-\membersection{wxPageSetupData::GetPaperSize}\label{wxpagesetupdatagetpapersize}
+\latexignore{\rtfignore{\wxheading{Members}}}

 
 

-\func{wxPoint}{GetPaperSize}{\void}
+\membersection{wxPageSetupDialogData::wxPageSetupDialogData}

 
 

-Returns the paper size in millimetres.
+\func{}{wxPageSetupDialogData}{\void}

 
 

-\membersection{wxPageSetupData::GetMarginTopLeft}\label{wxpagesetupdatagetmargintopleft}
+Default constructor.

 
 

-\func{wxPoint}{GetMarginTopLeft}{\void}
+\func{}{wxPageSetupDialogData}{\param{wxPageSetupDialogData\&}{ data}}

 
 

-Returns the left (x) and top (y) margins.
+Copy constructor.

 
 

-\membersection{wxPageSetupData::GetMarginBottomRight}\label{wxpagesetupdatagetmarginbottomright}
+\func{}{wxPrintDialogData}{\param{wxPrintData\&}{ printData}}

 
 

-\func{wxPoint}{GetMarginBottomRight}{\void}
+Construct an object from a print dialog data object.

 
 

-Returns the right (x) and bottom (y) margins.
+\membersection{wxPageSetupDialogData::\destruct{wxPageSetupDialogData}}

 
 

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

 
 

-\func{wxPoint}{GetMinMarginTopLeft}{\void}
+Destructor.

 
 

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

 
 

-\membersection{wxPageSetupData::GetMinMarginBottomRight}\label{wxpagesetupdatagetminmarginbottomright}
+\func{void}{EnableHelp}{\param{bool }{flag}}

 
 

-\func{wxPoint}{GetMinMarginBottomRight}{\void}
+Enables or disables the `Help' button (Windows only).

 
 

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

 
 

-\membersection{wxPageSetupData::GetOrientation}\label{wxpagesetupdatagetorientation}
+\func{void}{EnableMargins}{\param{bool }{flag}}

 
 

-\func{int}{GetOrientation}{\void}
+Enables or disables the margin controls (Windows only).
+
+\membersection{wxPageSetupDialogData::EnableOrientation}\label{wxpagesetupdialogdataenableorientation}

 
 

-Returns the orientation, which can be wxPORTRAIT or wxLANDSCAPE.
+\func{void}{EnableOrientation}{\param{bool }{flag}}

 
 

-\membersection{wxPageSetupData::GetDefaultMinMargins}\label{wxpagesetupdatagetdefaultminmargins}
+Enables or disables the orientation control (Windows only).

 
 

-\func{bool}{GetDefaultMinMargins}{\void}
+\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}

 
 

-Sets the right (x) and bottom (y) minimum margins the user can enter (Windows only).
+Returns the paper id (stored in the internal wxPrintData object).

 
 

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

 
 

-\func{void}{SetOrientation}{\param{int }{orientation}}
+\membersection{wxPageSetupDialogData::GetPaperSize}\label{wxpagesetupdialogdatagetpapersize}

 
 

-Sets the orientation, which can be wxPORTRAIT or wxLANDSCAPE.
+\constfunc{wxSize}{GetPaperSize}{\void}

 
 

-\membersection{wxPageSetupData::SetDefaultMinMargins}\label{wxpagesetupdatasetdefaultminmargins}
+Returns the paper size in millimetres.

 
 

-\func{void}{SetDefaultMinMargins}{\param{bool}{ flag}}
+\membersection{wxPageSetupDialogData::GetPrintData}\label{wxpagesetupdialogdatagetprintdata}

 
 

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

 
 

-\membersection{wxPageSetupData::SetDefaultInfo}\label{wxpagesetupdatasetdefaultinfo}
+\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{Include files}
+\membersection{wxPageSetupDialogData::SetMarginBottomRight}\label{wxpagesetupdialogdatasetmarginbottomright}

 
 

-<wx/printdlg.h>
+\func{void}{SetMarginBottomRight}{\param{const wxPoint\& }{pt}}

 
 

-\wxheading{See also}
+Sets the right (x) and bottom (y) margins in millimetres.

 
 

-\helpref{wxPrintDialog}{wxprintdialog}, \helpref{wxPageSetupData}{wxpagesetupdata}
+\membersection{wxPageSetupDialogData::SetMinMarginTopLeft}\label{wxpagesetupdialogdatasetminmargintopleft}

 
 

-\latexignore{\rtfignore{\wxheading{Members}}}
+\func{void}{SetMinMarginTopLeft}{\param{const wxPoint\& }{pt}}

 
 

-\membersection{wxPageSetupDialog::wxPageSetupDialog}
+Sets the left (x) and top (y) minimum margins the user can enter (Windows only). Units are
+in millimetres.

 
 

-\func{}{wxPageSetupDialog}{\param{wxWindow* }{parent}, \param{wxPageSetupData* }{data = NULL}}
+\membersection{wxPageSetupDialogData::SetMinMarginBottomRight}\label{wxpagesetupdialogdatasetminmarginbottomright}

 
 

-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.
+\func{void}{SetMinMarginBottomRight}{\param{const wxPoint\& }{pt}}

 
 

-\membersection{wxPageSetupDialog::\destruct{wxPageSetupDialog}}
+Sets the right (x) and bottom (y) minimum margins the user can enter (Windows only). Units are
+in millimetres.

 
 

-\func{}{\destruct{wxPageSetupDialog}}{\void}
+\membersection{wxPageSetupDialogData::SetPaperId}\label{wxpagesetupdialogdatasetpaperid}

 
 

-Destructor.
+\func{void}{SetPaperId}{\param{wxPaperSize\& }{id}}

 
 

-\membersection{wxPageSetupDialog::GetPageSetupData}\label{wxpagesetupdialoggetpagesetupdata}
+Sets the paper size id. For further information, see \helpref{wxPrintData::SetPaperId}{wxprintdatasetpaperid}.

 
 

-\func{wxPageSetupData\&}{GetPageSetupData}{\void}
+Calling this function overrides the explicit paper dimensions passed in \helpref{wxPageSetupDialogData::SetPaperSize}{wxpagesetupdialogdatasetpapersize}.

 
 

-Returns the \helpref{page setup data}{wxpagesetupdata} associated with the dialog.
+\membersection{wxPageSetupDialogData::SetPaperSize}\label{wxpagesetupdialogdatasetpapersize}

 
 

-\membersection{wxPageSetupDialog::ShowModal}\label{wxpagesetupdialogshowmodal}
+\func{void}{SetPaperSize}{\param{const wxSize\& }{size}}

 
 

-\func{int}{ShowModal}{\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.

 
 

-Shows the dialog, returning wxID\_OK if the user pressed OK, and wxID\_CANCEL
-otherwise.
+\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.