wxWidgets/docs/latex/wx/msgdlg.tex
2002-07-17 23:36:53 +00:00

72 lines
2.5 KiB
TeX

\section{\class{wxMessageDialog}}\label{wxmessagedialog}
This class represents a dialog that shows a single or multi-line message,
with a choice of OK, Yes, No and Cancel buttons.
\wxheading{Derived from}
\helpref{wxDialog}{wxdialog}\\
\helpref{wxWindow}{wxwindow}\\
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/msgdlg.h>
\wxheading{See also}
\helpref{wxMessageDialog overview}{wxmessagedialogoverview}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxMessageDialog::wxMessageDialog}\label{wxmessagedialogconstr}
\func{}{wxMessageDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message},\rtfsp
\param{const wxString\& }{caption = "Message box"}, \param{long }{style = wxOK \pipe wxCANCEL \pipe wxCENTRE},\rtfsp
\param{const wxPoint\& }{pos = wxDefaultPosition}}
Constructor. Use \helpref{wxMessageDialog::ShowModal}{wxmessagedialogshowmodal} to show the dialog.
\wxheading{Parameters}
\docparam{parent}{Parent window.}
\docparam{message}{Message to show on the dialog.}
\docparam{caption}{The dialog caption.}
\docparam{style}{A dialog style (bitlist) containing flags chosen from the following:
\twocolwidtha{5cm}
\begin{twocollist}
\twocolitem{{\bf wxOK}}{Show an OK button.}
\twocolitem{{\bf wxCANCEL}}{Show a Cancel button.}
\twocolitem{{\bf wxYES\_NO}}{Show Yes and No buttons.}
\twocolitem{{\bf wxYES\_DEFAULT}}{Used with {\bf wxYES\_NO}, makes {\bf Yes} button the default - which is the default behaviour.}
\twocolitem{{\bf wxNO\_DEFAULT}}{Used with {\bf wxYES\_NO}, makes {\bf No} button the default.}
\twocolitem{{\bf wxCENTRE}}{Centre the message. Not Windows.}
\twocolitem{{\bf wxICON\_EXCLAMATION}}{Shows an exclamation mark icon.}
\twocolitem{{\bf wxICON\_HAND}}{Shows an error icon.}
\twocolitem{{\bf wxICON\_ERROR}}{Shows an error icon - the same as wxICON\_HAND.}
\twocolitem{{\bf wxICON\_QUESTION}}{Shows a question mark icon.}
\twocolitem{{\bf wxICON\_INFORMATION}}{Shows an information (i) icon.}
\twocolitem{{\bf wxSTAY\_ON\_TOP}}{The message box stays on top of all other window, even those of the other applications (Windows only).}
\end{twocollist}
}
\docparam{pos}{Dialog position. Not Windows.}
\membersection{wxMessageDialog::\destruct{wxMessageDialog}}
\func{}{\destruct{wxMessageDialog}}{\void}
Destructor.
\membersection{wxMessageDialog::ShowModal}\label{wxmessagedialogshowmodal}
\func{int}{ShowModal}{\void}
Shows the dialog, returning one of wxID\_OK, wxID\_CANCEL, wxID\_YES, wxID\_NO.