X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f9db2cdaffdf81838762dbab6ee7676fde287d76..9e967d5417d49764276cf121a32c35d5770b1332:/docs/latex/wx/dialog.tex?ds=sidebyside diff --git a/docs/latex/wx/dialog.tex b/docs/latex/wx/dialog.tex index b7cbbe7a93..31818d2c9b 100644 --- a/docs/latex/wx/dialog.tex +++ b/docs/latex/wx/dialog.tex @@ -16,6 +16,23 @@ can be moved around the screen. It can contain controls and other windows and is often used to allow the user to make some choice or to answer a question. +\wxheading{Dialog Buttons} + +The dialog usually contains either a single button allowing to close the +dialog or two buttons, one accepting the changes and the other one discarding +them (such button, if present, is automatically activated if the user presses +the \texttt{"Esc"} key). By default, buttons with the standard \texttt{wxID\_OK} +and \texttt{wxID\_CANCEL} identifiers behave as expected. Starting with +wxWidgets 2.7 it is also possible to use a button with a different identifier +instead, see \helpref{SetAffirmativeId}{wxdialogsetaffirmativeid} and +\helpref{SetEscapeId}{wxdialogsetescapeid}. + +Also notice that the \helpref{CreateButtonSizer()}{wxdialogcreatebuttonsizer} +should be used to create the buttons appropriate for the current platform and +positioned correctly (including their order which is platform-dependent). + + + \wxheading{Derived from} \helpref{wxTopLevelWindow}{wxtoplevelwindow}\\ @@ -27,7 +44,11 @@ is often used to allow the user to make some choice or to answer a question. -\wxheading{Remarks} +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + +\wxheading{Modal and modeless dialogs} There are two kinds of dialog -- {\it modal}\ and {\it modeless}. A modal dialog blocks program flow and user input on other windows until it is dismissed, @@ -186,7 +207,8 @@ for details. \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. +of the following flags: wxOK, wxCANCEL, wxYES, wxNO, wxAPPLY, wxCLOSE, +wxHELP, wxNO\_DEFAULT. The sizer lays out the buttons in a manner appropriate to the platform. @@ -214,7 +236,8 @@ if no buttons were created. \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. +of the following flags: wxOK, wxCANCEL, wxYES, wxNO, wxAPPLY, wxCLOSE, +wxHELP, wxNO\_DEFAULT. The sizer lays out the buttons in a manner appropriate to the platform. @@ -301,7 +324,7 @@ This function is not available on any other platform. \membersection{wxDialog::Iconize}\label{wxdialogiconized} -\func{void}{Iconize}{\param{const bool}{ iconize}} +\func{void}{Iconize}{\param{bool}{ iconize}} Iconizes or restores the dialog. Windows only. @@ -427,7 +450,7 @@ See also \helpref{wxIconBundle}{wxiconbundle}. \membersection{wxDialog::SetModal}\label{wxdialogsetmodal} -\func{void}{SetModal}{\param{const bool}{ flag}} +\func{void}{SetModal}{\param{bool}{ flag}} {\bf NB:} This function is deprecated and doesn't work for all ports, just use \helpref{ShowModal}{wxdialogshowmodal} to show a modal dialog instead. @@ -463,7 +486,7 @@ a code to the application. The function \helpref{wxDialog::EndModal}{wxdialogend \membersection{wxDialog::Show}\label{wxdialogshow} -\func{bool}{Show}{\param{const bool}{ show}} +\func{bool}{Show}{\param{bool}{ show}} Hides or shows the dialog.