X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9ceeecb94e9b5e4a5d9f3382e91eb4c1aad1d382..cba1c2ca127cbc8ce1aeb87b13b968caff0f995e:/docs/latex/wx/dialog.tex diff --git a/docs/latex/wx/dialog.tex b/docs/latex/wx/dialog.tex index 37da8f7112..1ab082deeb 100644 --- a/docs/latex/wx/dialog.tex +++ b/docs/latex/wx/dialog.tex @@ -1,3 +1,14 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Name: dialog.tex +%% Purpose: wxDialog documentation +%% Author: wxWidgets Team +%% Modified by: +%% Created: +%% RCS-ID: $Id$ +%% Copyright: (c) wxWidgets Team +%% License: wxWindows license +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + \section{\class{wxDialog}}\label{wxdialog} A dialog box is a window with a title bar and sometimes a system menu, which @@ -70,11 +81,11 @@ 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 -with a {\tt NULL} parent window will be given the +with a {\tt NULL} parent window will be given the \helpref{application's top level window}{wxappgettopwindow} as parent. Use this style to prevent this from happening and create an orphan dialog. This is not recommended for modal dialogs.} \twocolitem{\windowstyle{wxDIALOG\_EX\_CONTEXTHELP}}{Under Windows, puts a query button on the @@ -97,6 +108,7 @@ See also \helpref{Generic window styles}{windowstyles}. \latexignore{\rtfignore{\wxheading{Members}}} + \membersection{wxDialog::wxDialog}\label{wxdialogctor} \func{}{wxDialog}{\void} @@ -136,12 +148,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}} @@ -152,6 +166,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 @@ -164,6 +179,7 @@ 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}} @@ -175,6 +191,7 @@ 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}} @@ -184,6 +201,7 @@ 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} @@ -193,6 +211,7 @@ 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}} @@ -210,6 +229,7 @@ invocation. \helpref{wxDialog::GetReturnCode}{wxdialoggetreturncode},\rtfsp \helpref{wxDialog::SetReturnCode}{wxdialogsetreturncode} + \membersection{wxDialog::GetAffirmativeId}\label{wxdialoggetaffirmativeid} \constfunc{int}{GetAffirmativeId}{\void} @@ -220,6 +240,19 @@ Gets the identifier to be used when the user presses an OK button in a PocketPC \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} @@ -236,11 +269,17 @@ 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} +\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. -Returns the title of the dialog box. \membersection{wxDialog::Iconize}\label{wxdialogiconized} @@ -260,6 +299,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} @@ -270,12 +310,14 @@ 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::OnApply}\label{wxdialogonapply} \func{void}{OnApply}{\param{wxCommandEvent\& }{event}} @@ -290,6 +332,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}} @@ -305,6 +348,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}} @@ -322,6 +366,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}} @@ -344,6 +389,7 @@ propagate the notification to child windows and controls. \helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent} + \membersection{wxDialog::SetAffirmativeId}\label{wxdialogsetaffirmativeid} \func{void}{SetAffirmativeId}{\param{int }{id}} @@ -355,6 +401,20 @@ By default, this is wxID\_OK. \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}} @@ -367,6 +427,7 @@ Sets the icon for this dialog. See also \helpref{wxIcon}{wxicon}. + \membersection{wxDialog::SetIcons}\label{wxdialogseticons} \func{void}{SetIcons}{\param{const wxIconBundle\& }{icons}} @@ -379,11 +440,12 @@ Sets the icons for this dialog. See also \helpref{wxIconBundle}{wxiconbundle}. + \membersection{wxDialog::SetModal}\label{wxdialogsetmodal} \func{void}{SetModal}{\param{const bool}{ flag}} -{\bf NB:} This function is deprecated and doesn't work for all ports, just use +{\bf NB:} This function is deprecated and doesn't work for all ports, just use \helpref{ShowModal}{wxdialogshowmodal} to show a modal dialog instead. Allows the programmer to specify whether the dialog box is modal (wxDialog::Show blocks control @@ -393,6 +455,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}} @@ -413,15 +476,6 @@ 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}} - -Sets the title of the dialog box. - -\wxheading{Parameters} - -\docparam{title}{The dialog box title.} \membersection{wxDialog::Show}\label{wxdialogshow} @@ -439,6 +493,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} @@ -455,4 +510,3 @@ The return value is the value set with \helpref{wxDialog::SetReturnCode}{wxdialo \helpref{wxDialog::EndModal}{wxdialogendmodal},\rtfsp \helpref{wxDialog:GetReturnCode}{wxdialoggetreturncode},\rtfsp \helpref{wxDialog::SetReturnCode}{wxdialogsetreturncode} -