projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| a660d684 KB |
1 | \section{\class{wxMessageDialog}}\label{wxmessagedialog} |
| 2 | ||
| 3 | This class represents a dialog that shows a single or multi-line message, | |
| 4 | with a choice of OK, Yes, No and Cancel buttons. | |
| 5 | ||
| 6 | \wxheading{Derived from} | |
| 7 | ||
| 8 | \helpref{wxDialog}{wxdialog}\\ | |
| 9 | \helpref{wxWindow}{wxwindow}\\ | |
| 10 | \helpref{wxEvtHandler}{wxevthandler}\\ | |
| 11 | \helpref{wxObject}{wxobject} | |
| 12 | ||
| 13 | \wxheading{See also} | |
| 14 | ||
| 15 | \helpref{wxMessageDialog overview}{wxmessagedialogoverview} | |
| 16 | ||
| 17 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 18 | ||
| 19 | \membersection{wxMessageDialog::wxMessageDialog}\label{wxmessagedialogconstr} | |
| 20 | ||
| 21 | \func{}{wxMessageDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message},\rtfsp | |
| 22 | \param{const wxString\& }{caption = "Message box"}, \param{long }{style = wxOK \pipe wxCANCEL \pipe wxCENTRE},\rtfsp | |
| 23 | \param{const wxPoint\& }{pos = wxDefaultPosition}} | |
| 24 | ||
| 25 | Constructor. Use \helpref{wxMessageDialog::ShowModal}{wxmessagedialogshowmodal} to show the dialog. | |
| 26 | ||
| 27 | \wxheading{Parameters} | |
| 28 | ||
| 29 | \docparam{parent}{Parent window.} | |
| 30 | ||
| 31 | \docparam{message}{Message to show on the dialog.} | |
| 32 | ||
| 33 | \docparam{caption}{The dialog caption.} | |
| 34 | ||
| 35 | \docparam{style}{A dialog style (bitlist) containing flags chosen from the following: | |
| 36 | ||
| 37 | \twocolwidtha{5cm} | |
| 38 | \begin{twocollist} | |
| 39 | \twocolitem{{\bf wxOK}}{Show an OK button.} | |
| 40 | \twocolitem{{\bf wxCANCEL}}{Show a Cancel button.} | |
| 41 | \twocolitem{{\bf wxYES\_NO}}{Show Yes and No buttons.} | |
| 42 | \twocolitem{{\bf wxCENTRE}}{Centre the message. Not Windows.} | |
| 43 | \twocolitem{{\bf wxICON\_EXCLAMATION}}{Shows an exclamation mark icon. Windows only.} | |
| 44 | \twocolitem{{\bf wxICON\_HAND}}{Shows a hand icon. Windows only.} | |
| 45 | \twocolitem{{\bf wxICON\_QUESTION}}{Shows a question mark icon. Windows only.} | |
| 46 | \twocolitem{{\bf wxICON\_INFORMATION}}{Shows an information (i) icon. Windows only.} | |
| 47 | \end{twocollist} | |
| 48 | } | |
| 49 | ||
| 50 | \docparam{pos}{Dialog position. Not Windows.} | |
| 51 | ||
| 52 | \membersection{wxMessageDialog::\destruct{wxMessageDialog}} | |
| 53 | ||
| 54 | \func{}{\destruct{wxMessageDialog}}{\void} | |
| 55 | ||
| 56 | Destructor. | |
| 57 | ||
| 58 | \membersection{wxMessageDialog::ShowModal}\label{wxmessagedialogshowmodal} | |
| 59 | ||
| 60 | \func{int}{ShowModal}{\void} | |
| 61 | ||
| 62 | Shows the dialog, returning one of wxID\_OK, wxID\_CANCEL, wxID\_YES, wxID\_NO. | |
| 63 |