]>
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 | ||
954b8ae6 JS |
13 | \wxheading{Include files} |
14 | ||
15 | <wx/msgdlg.h> | |
16 | ||
a660d684 KB |
17 | \wxheading{See also} |
18 | ||
19 | \helpref{wxMessageDialog overview}{wxmessagedialogoverview} | |
20 | ||
21 | \latexignore{\rtfignore{\wxheading{Members}}} | |
22 | ||
23 | \membersection{wxMessageDialog::wxMessageDialog}\label{wxmessagedialogconstr} | |
24 | ||
25 | \func{}{wxMessageDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message},\rtfsp | |
26 | \param{const wxString\& }{caption = "Message box"}, \param{long }{style = wxOK \pipe wxCANCEL \pipe wxCENTRE},\rtfsp | |
27 | \param{const wxPoint\& }{pos = wxDefaultPosition}} | |
28 | ||
29 | Constructor. Use \helpref{wxMessageDialog::ShowModal}{wxmessagedialogshowmodal} to show the dialog. | |
30 | ||
31 | \wxheading{Parameters} | |
32 | ||
33 | \docparam{parent}{Parent window.} | |
34 | ||
35 | \docparam{message}{Message to show on the dialog.} | |
36 | ||
37 | \docparam{caption}{The dialog caption.} | |
38 | ||
39 | \docparam{style}{A dialog style (bitlist) containing flags chosen from the following: | |
40 | ||
41 | \twocolwidtha{5cm} | |
42 | \begin{twocollist} | |
43 | \twocolitem{{\bf wxOK}}{Show an OK button.} | |
44 | \twocolitem{{\bf wxCANCEL}}{Show a Cancel button.} | |
45 | \twocolitem{{\bf wxYES\_NO}}{Show Yes and No buttons.} | |
f6bcfd97 BP |
46 | \twocolitem{{\bf wxYES\_DEFAULT}}{Used with {\bf wxYES\_NO}, makes {\bf Yes} button the default - which is the default behaviour.} |
47 | \twocolitem{{\bf wxNO\_DEFAULT}}{Used with {\bf wxYES\_NO}, makes {\bf No} button the default.} | |
a660d684 | 48 | \twocolitem{{\bf wxCENTRE}}{Centre the message. Not Windows.} |
330d6fd0 RR |
49 | \twocolitem{{\bf wxICON\_EXCLAMATION}}{Shows an exclamation mark icon.} |
50 | \twocolitem{{\bf wxICON\_HAND}}{Shows a hand icon.} | |
51 | \twocolitem{{\bf wxICON\_QUESTION}}{Shows a question mark icon.} | |
52 | \twocolitem{{\bf wxICON\_INFORMATION}}{Shows an information (i) icon.} | |
a660d684 KB |
53 | \end{twocollist} |
54 | } | |
55 | ||
56 | \docparam{pos}{Dialog position. Not Windows.} | |
57 | ||
58 | \membersection{wxMessageDialog::\destruct{wxMessageDialog}} | |
59 | ||
60 | \func{}{\destruct{wxMessageDialog}}{\void} | |
61 | ||
62 | Destructor. | |
63 | ||
64 | \membersection{wxMessageDialog::ShowModal}\label{wxmessagedialogshowmodal} | |
65 | ||
66 | \func{int}{ShowModal}{\void} | |
67 | ||
68 | Shows the dialog, returning one of wxID\_OK, wxID\_CANCEL, wxID\_YES, wxID\_NO. | |
69 |