X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b236c10f77e9ed0bc3c16d1cceb4a62f7048b4f9..65baafba0e8cd74f2264b7e2f7625ff5bea84864:/docs/latex/wx/dialog.tex diff --git a/docs/latex/wx/dialog.tex b/docs/latex/wx/dialog.tex index cca1f238b8..4107a01362 100644 --- a/docs/latex/wx/dialog.tex +++ b/docs/latex/wx/dialog.tex @@ -55,7 +55,7 @@ below: } \end{verbatim} -An application can define an \helpref{wxCloseEvent}{wxcloseevent} handler for +An application can define a \helpref{wxCloseEvent}{wxcloseevent} handler for the dialog to respond to system close events. \wxheading{Window styles} @@ -70,7 +70,7 @@ the dialog to respond to system close events. \twocolitem{\windowstyle{wxMAXIMIZE\_BOX}}{Displays a maximize box on the dialog.} \twocolitem{\windowstyle{wxMINIMIZE\_BOX}}{Displays a minimize box on the dialog.} \twocolitem{\windowstyle{wxTHICK\_FRAME}}{Display a thick frame around the window.} -\twocolitem{\windowstyle{wxSTAY\_ON\_TOP}}{The dialog stays on top of all other windows (Windows only).} +\twocolitem{\windowstyle{wxSTAY\_ON\_TOP}}{The dialog stays on top of all other windows.} \twocolitem{\windowstyle{wxNO\_3D}}{Under Windows, specifies that the child controls should not have 3D borders unless specified in the control.} \twocolitem{\windowstyle{wxDIALOG\_NO\_PARENT}}{By default, a dialog created @@ -81,6 +81,7 @@ style to prevent this from happening and create an orphan dialog. This is not re caption. When pressed, Windows will go into a context-sensitive help mode and wxWidgets will send a wxEVT\_HELP event if the user clicked on an application window. {\it Note}\ that this is an extended style and must be set by calling \helpref{SetExtraStyle}{wxwindowsetextrastyle} before Create is called (two-step construction).} +\twocolitem{\windowstyle{wxDIALOG\_EX\_METAL}}{On Mac OS X, frames with this style will be shown with a metallic look. This is an {\it extra} style.} \end{twocollist} Under Unix or Linux, MWM (the Motif Window Manager) or other window managers @@ -96,6 +97,7 @@ See also \helpref{Generic window styles}{windowstyles}. \latexignore{\rtfignore{\wxheading{Members}}} + \membersection{wxDialog::wxDialog}\label{wxdialogctor} \func{}{wxDialog}{\void} @@ -135,12 +137,14 @@ individual dialog boxes.} \helpref{wxDialog::Create}{wxdialogcreate} + \membersection{wxDialog::\destruct{wxDialog}}\label{wxdialogdtor} \func{}{\destruct{wxDialog}}{\void} Destructor. Deletes any child windows before deleting the physical window. + \membersection{wxDialog::Centre}\label{wxdialogcentre} \func{void}{Centre}{\param{int}{ direction = wxBOTH}} @@ -151,6 +155,7 @@ Centres the dialog box on the display. \docparam{direction}{May be {\tt wxHORIZONTAL}, {\tt wxVERTICAL} or {\tt wxBOTH}.} + \membersection{wxDialog::Create}\label{wxdialogcreate} \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp @@ -163,6 +168,39 @@ Centres the dialog box on the display. Used for two-step dialog box construction. See \helpref{wxDialog::wxDialog}{wxdialogctor}\rtfsp for details. + +\membersection{wxDialog::CreateButtonSizer}\label{wxdialogcreatebuttonsizer} + +\func{wxSizer*}{CreateButtonSizer}{\param{long}{ flags}} + +Creates a sizer with standard buttons. {\it flags} is a bit list +of the following flags: wxOK, wxCANCEL, wxYES, wxNO, wxHELP, wxNO\_DEFAULT. + +The sizer lays out the buttons in a manner appropriate to the platform. + +This function simply calls \helpref{CreateStdDialogButtonSizer}{wxdialogcreatestddialogbuttonsizer}. + + +\membersection{wxDialog::CreateStdDialogButtonSizer}\label{wxdialogcreatestddialogbuttonsizer} + +\func{wxStdDialogButtonSizer*}{CreateStdDialogButtonSizer}{\param{long}{ flags}} + +Creates a \helpref{wxStdDialogButtonSizer}{wxstddialogbuttonsizer} with standard buttons. {\it flags} is a bit list +of the following flags: wxOK, wxCANCEL, wxYES, wxNO, wxHELP, wxNO\_DEFAULT. + +The sizer lays out the buttons in a manner appropriate to the platform. + + +\membersection{wxDialog::DoOK}\label{wxdialogdook} + +\func{virtual bool}{DoOK}{\void} + +This function is called when the titlebar OK button is pressed (PocketPC only). +A command event for the identifier returned by GetAffirmativeId is sent by +default. You can override this function. If the function returns false, wxWidgets +will call Close() for the dialog. + + \membersection{wxDialog::EndModal}\label{wxdialogendmodal} \func{void}{EndModal}{\param{int }{retCode}} @@ -180,6 +218,30 @@ invocation. \helpref{wxDialog::GetReturnCode}{wxdialoggetreturncode},\rtfsp \helpref{wxDialog::SetReturnCode}{wxdialogsetreturncode} + +\membersection{wxDialog::GetAffirmativeId}\label{wxdialoggetaffirmativeid} + +\constfunc{int}{GetAffirmativeId}{\void} + +Gets the identifier to be used when the user presses an OK button in a PocketPC titlebar. + +\wxheading{See also} + +\helpref{wxDialog::SetAffirmativeId}{wxdialogsetaffirmativeid} + + +\membersection{wxDialog::GetEscapeId}\label{wxdialoggetescapeid} + +\constfunc{int}{GetEscapeId}{\void} + +Gets the identifier of the button to map presses of \texttt{\textsc{ESC}} +button to. + +\wxheading{See also} + +\helpref{wxDialog::SetEscapeId}{wxdialogsetescapeid} + + \membersection{wxDialog::GetReturnCode}\label{wxdialoggetreturncode} \func{int}{GetReturnCode}{\void} @@ -196,12 +258,25 @@ a code to the application. \helpref{wxDialog::SetReturnCode}{wxdialogsetreturncode}, \helpref{wxDialog::ShowModal}{wxdialogshowmodal},\rtfsp \helpref{wxDialog::EndModal}{wxdialogendmodal} + \membersection{wxDialog::GetTitle}\label{wxdialoggettitle} \constfunc{wxString}{GetTitle}{\void} Returns the title of the dialog box. + +\membersection{wxDialog::GetToolBar}\label{wxdialoggettoolbar} + +\constfunc{wxToolBar*}{GetToolBar}{\void} + +On PocketPC, a dialog is automatically provided with an empty toolbar. GetToolBar +allows you to access the toolbar and add tools to it. Removing tools and adding +arbitrary controls are not currently supported. + +This function is not available on any other platform. + + \membersection{wxDialog::Iconize}\label{wxdialogiconized} \func{void}{Iconize}{\param{const bool}{ iconize}} @@ -220,6 +295,7 @@ boxes under Motif which have user-iconizable frames, and under Windows calling {\tt Iconize(false)} will bring the window to the front, as does \rtfsp{\tt Show(true)}. + \membersection{wxDialog::IsIconized}\label{wxdialogisiconized} \constfunc{bool}{IsIconized}{\void} @@ -230,25 +306,13 @@ Returns true if the dialog box is iconized. Windows only. Always returns false under Windows since dialogs cannot be iconized. + \membersection{wxDialog::IsModal}\label{wxdialogismodal} \constfunc{bool}{IsModal}{\void} Returns true if the dialog box is modal, false otherwise. -\membersection{wxDialog::OnCharHook}\label{wxdialogoncharhook} - -\func{void}{OnCharHook}{\param{wxKeyEvent\&}{ event}} - -This member is called to allow the window to intercept keyboard events -before they are processed by child windows. - -%For more information, see \helpref{wxWindow::OnCharHook}{wxwindowoncharhook} - -\wxheading{Remarks} - -wxDialog implements this handler to fake a cancel command if the escape key has been -pressed. This will dismiss the dialog. \membersection{wxDialog::OnApply}\label{wxdialogonapply} @@ -264,6 +328,7 @@ This function calls \helpref{wxWindow::Validate}{wxwindowvalidate} and \helpref{ \helpref{wxDialog::OnOK}{wxdialogonok}, \helpref{wxDialog::OnCancel}{wxdialogoncancel} + \membersection{wxDialog::OnCancel}\label{wxdialogoncancel} \func{void}{OnCancel}{\param{wxCommandEvent\& }{event}} @@ -279,6 +344,7 @@ sets the return value to wxID\_CANCEL and calls {\bf Show(false)} if the dialog \helpref{wxDialog::OnOK}{wxdialogonok}, \helpref{wxDialog::OnApply}{wxdialogonapply} + \membersection{wxDialog::OnOK}\label{wxdialogonok} \func{void}{OnOK}{\param{wxCommandEvent\& }{event}} @@ -296,6 +362,7 @@ sets the return value to wxID\_OK and calls {\bf Show(false)} if the dialog is m \helpref{wxDialog::OnCancel}{wxdialogoncancel}, \helpref{wxDialog::OnApply}{wxdialogonapply} + \membersection{wxDialog::OnSysColourChanged}\label{wxdialogonsyscolourchanged} \func{void}{OnSysColourChanged}{\param{wxSysColourChangedEvent\& }{event}} @@ -318,6 +385,32 @@ propagate the notification to child windows and controls. \helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent} + +\membersection{wxDialog::SetAffirmativeId}\label{wxdialogsetaffirmativeid} + +\func{void}{SetAffirmativeId}{\param{int }{id}} + +Sets the identifier to be used when the user presses an OK button in a PocketPC titlebar. +By default, this is wxID\_OK. + +\wxheading{See also} + +\helpref{wxDialog::GetAffirmativeId}{wxdialoggetaffirmativeid} + + +\membersection{wxDialog::SetEscapeId}\label{wxdialogsetescapeid} + +\func{void}{SetEscapeId}{\param{int }{id}} + +Sets the identifier to be used when the user presses \texttt{\textsc{ESC}} +button in the dialog. By default, this is \texttt{wxID\_ANY} meaning that +the first suitable button is used: if there a \texttt{wxID\_CANCEL} button, it +is activated, otherwise \texttt{wxID\_OK} button is activated if present. +Another possible special value for \arg{id} is \texttt{wxID\_NONE} meaning that +\texttt{\textsc{ESC}} presses should be ignored. If another value is given, it +is interpreted as the id of the button to map the escape key to. + + \membersection{wxDialog::SetIcon}\label{wxdialogseticon} \func{void}{SetIcon}{\param{const wxIcon\& }{icon}} @@ -330,6 +423,7 @@ Sets the icon for this dialog. See also \helpref{wxIcon}{wxicon}. + \membersection{wxDialog::SetIcons}\label{wxdialogseticons} \func{void}{SetIcons}{\param{const wxIconBundle\& }{icons}} @@ -342,6 +436,7 @@ Sets the icons for this dialog. See also \helpref{wxIconBundle}{wxiconbundle}. + \membersection{wxDialog::SetModal}\label{wxdialogsetmodal} \func{void}{SetModal}{\param{const bool}{ flag}} @@ -356,6 +451,7 @@ until the dialog is hidden) or modeless (control returns immediately). \docparam{flag}{If true, the dialog will be modal, otherwise it will be modeless.} + \membersection{wxDialog::SetReturnCode}\label{wxdialogsetreturncode} \func{void}{SetReturnCode}{\param{int }{retCode}} @@ -376,6 +472,7 @@ a code to the application. The function \helpref{wxDialog::EndModal}{wxdialogend \helpref{wxDialog::GetReturnCode}{wxdialoggetreturncode}, \helpref{wxDialog::ShowModal}{wxdialogshowmodal},\rtfsp \helpref{wxDialog::EndModal}{wxdialogendmodal} + \membersection{wxDialog::SetTitle}\label{wxdialogsettitle} \func{void}{SetTitle}{\param{const wxString\& }{ title}} @@ -386,6 +483,7 @@ Sets the title of the dialog box. \docparam{title}{The dialog box title.} + \membersection{wxDialog::Show}\label{wxdialogshow} \func{bool}{Show}{\param{const bool}{ show}} @@ -402,6 +500,7 @@ modal, control is returned to the calling program.} The preferred way of dismissing a modal dialog is to use \helpref{wxDialog::EndModal}{wxdialogendmodal}. + \membersection{wxDialog::ShowModal}\label{wxdialogshowmodal} \func{int}{ShowModal}{\void}