GetMenuCount() returns size_t, not int

[wxWidgets.git] / docs / latex / wx / msgdlg.tex

diff --git a/docs/latex/wx/msgdlg.tex b/docs/latex/wx/msgdlg.tex
index 2a6874cdb45988acb6d02573a07bbc4bfdc58266..ef51c0940cf5d738449052ff9ffa866299f9a000 100644 (file)
--- a/docs/latex/wx/msgdlg.tex
+++ b/docs/latex/wx/msgdlg.tex
@@ -20,10 +20,11 @@ with a choice of OK, Yes, No and Cancel buttons.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxMessageDialog::wxMessageDialog}\label{wxmessagedialogconstr}
+
+\membersection{wxMessageDialog::wxMessageDialog}\label{wxmessagedialogctor}

 
 \func{}{wxMessageDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message},\rtfsp
 
 \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 wxString\& }{caption = "Message box"}, \param{long }{style = wxOK \pipe wxCANCEL},\rtfsp

 \param{const wxPoint\& }{pos = wxDefaultPosition}}
 
 Constructor. Use \helpref{wxMessageDialog::ShowModal}{wxmessagedialogshowmodal} to show the dialog.
 \param{const wxPoint\& }{pos = wxDefaultPosition}}
 
 Constructor. Use \helpref{wxMessageDialog::ShowModal}{wxmessagedialogshowmodal} to show the dialog.


@@ -43,25 +44,99 @@ Constructor. Use \helpref{wxMessageDialog::ShowModal}{wxmessagedialogshowmodal}
 \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 wxOK}}{Show an OK button.}
 \twocolitem{{\bf wxCANCEL}}{Show a Cancel button.}
 \twocolitem{{\bf wxYES\_NO}}{Show Yes and No buttons.}

-\twocolitem{{\bf wxCENTRE}}{Centre the message. Not Windows.}
-\twocolitem{{\bf wxICON\_EXCLAMATION}}{Shows an exclamation mark icon. Windows only.}
-\twocolitem{{\bf wxICON\_HAND}}{Shows a hand icon. Windows only.}
-\twocolitem{{\bf wxICON\_QUESTION}}{Shows a question mark icon. Windows only.}
-\twocolitem{{\bf wxICON\_INFORMATION}}{Shows an information (i) icon. Windows only.}
+\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 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.}
 
 \end{twocollist}
 }
 
 \docparam{pos}{Dialog position. Not Windows.}
 

-\membersection{wxMessageDialog::\destruct{wxMessageDialog}}
+
+\membersection{wxMessageDialog::\destruct{wxMessageDialog}}\label{wxmessagedialogdtor}

 
 \func{}{\destruct{wxMessageDialog}}{\void}
 
 Destructor.
 
 
 \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.
 
 \membersection{wxMessageDialog::ShowModal}\label{wxmessagedialogshowmodal}
 
 \func{int}{ShowModal}{\void}
 
 Shows the dialog, returning one of wxID\_OK, wxID\_CANCEL, wxID\_YES, wxID\_NO.
 

+
+\membersection{wxMessageDialog::SetYesNoLabels}\label{wxmessagedialogsetyesnolabels}
+
+\func{bool}{SetYesNoLabels}{\param{const wxString&}{yes},\param{const wxString&}{no}}
+
+Overrides the default labels of the Yes and No buttons.
+
+Notice that this function is not currently available on all platforms, so it
+may return \false to indicate that the labels couldn't be changed. If it
+returns \true (currently only under wxMac), the labels were set successfully.
+Typically, if the function was used successfully, the main dialog message may
+need to be changed, e.g.:
+\begin{verbatim}
+    wxMessageDialog dlg(...);
+    if ( dlg.SetYesNoLabels(_("&Quit"), _("&Don't quit")) )
+        dlg.SetMessage(_("What do you want to do?"));
+    else // buttons have standard "Yes"/"No" values, so rephrase the question
+        dlg.SetMessage(_("Do you really want to quit?"));
+\end{verbatim}
+
+
+\membersection{wxMessageDialog::SetYesNoCancelLabels}\label{wxmessagedialogsetyesnocancellabels}
+
+\func{bool}{SetYesNoCancelLabels}{\param{const wxString&}{yes},\param{const wxString&}{no},\param{const wxString&}{cancel}}
+
+Overrides the default labels of the Yes, No and Cancel buttons.
+
+Please see the remarks in 
+\helpref{SetYesNoLabels}{wxmessagedialogsetyesnolabels} documentation.
+
+
+\membersection{wxMessageDialog::SetOKLabel}\label{wxmessagedialogsetyesoklabel}
+
+\func{bool}{SetOKLabel}{\param{const wxString&}{ok}}
+
+Overrides the default label of the OK button.
+
+Please see the remarks in 
+\helpref{SetYesNoLabels}{wxmessagedialogsetyesnolabels} documentation.
+
+
+\membersection{wxMessageDialog::SetOKCancelLabels}\label{wxmessagedialogsetokcancellabels}
+
+\func{bool}{SetOKCancelLabels}{\param{const wxString&}{ok},\param{const wxString&}{cancel}}
+
+Overrides the default labels of the OK and Cancel buttons.
+
+Please see the remarks in 
+\helpref{SetYesNoLabels}{wxmessagedialogsetyesnolabels} documentation.
+
+
+\membersection{wxMessageDialog::SetMessage}\label{wxmessagedialogsetmessage}
+
+\func{void}{SetMessage}{\param{const wxString&}{msg}}
+
+Sets the message shown by the dialog.
+
+
+\membersection{wxMessageDialog::SetExtendedMessage}\label{wxmessagedialogsetextendedmessage}
+
+\func{void}{SetExtendedMessage}{\param{const wxString&}{exMsg}
+
+Sets the extended message for the dialog: this message is usually an extension
+of the short message specified in the constructor or set with 
+\helpref{SetMessage}{wxmessagedialogsetmessage}. If it is set, the main message
+appears highlighted -- if supported -- and this message appears beneath it in
+normal font. On the platforms which don't support extended messages, it is
+simply appended to the normal message with a new line separating them.
+