| 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{Include files} |
| 14 | |
| 15 | <wx/msgdlg.h> |
| 16 | |
| 17 | \wxheading{See also} |
| 18 | |
| 19 | \helpref{wxMessageDialog overview}{wxmessagedialogoverview} |
| 20 | |
| 21 | \latexignore{\rtfignore{\wxheading{Members}}} |
| 22 | |
| 23 | \membersection{wxMessageDialog::wxMessageDialog}\label{wxmessagedialogctor} |
| 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},\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.} |
| 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.} |
| 48 | \twocolitem{{\bf wxICON\_EXCLAMATION}}{Shows an exclamation mark icon.} |
| 49 | \twocolitem{{\bf wxICON\_HAND}}{Shows an error icon.} |
| 50 | \twocolitem{{\bf wxICON\_ERROR}}{Shows an error icon - the same as wxICON\_HAND.} |
| 51 | \twocolitem{{\bf wxICON\_QUESTION}}{Shows a question mark icon.} |
| 52 | \twocolitem{{\bf wxICON\_INFORMATION}}{Shows an information (i) icon.} |
| 53 | \twocolitem{{\bf wxSTAY\_ON\_TOP}}{The message box stays on top of all other window, even those of the other applications (Windows only).} |
| 54 | \end{twocollist} |
| 55 | } |
| 56 | |
| 57 | \docparam{pos}{Dialog position. Not Windows.} |
| 58 | |
| 59 | \membersection{wxMessageDialog::\destruct{wxMessageDialog}}\label{wxmessagedialogdtor} |
| 60 | |
| 61 | \func{}{\destruct{wxMessageDialog}}{\void} |
| 62 | |
| 63 | Destructor. |
| 64 | |
| 65 | \membersection{wxMessageDialog::ShowModal}\label{wxmessagedialogshowmodal} |
| 66 | |
| 67 | \func{int}{ShowModal}{\void} |
| 68 | |
| 69 | Shows the dialog, returning one of wxID\_OK, wxID\_CANCEL, wxID\_YES, wxID\_NO. |
| 70 | |