From b70b68a9ba62320a6a667f510b316219c7029d90 Mon Sep 17 00:00:00 2001
From: =?utf8?q?V=C3=A1clav=20Slav=C3=ADk?= <vslavik@fastmail.fm>
Date: Wed, 30 Jun 2004 12:32:21 +0000
Subject: [PATCH] wxXXChoiceDialog documentation fixes

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@28099 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
 docs/latex/wx/mltchdlg.tex | 68 +++++++++++++++++++++++++++++++++++++-
 docs/latex/wx/sngchdlg.tex | 38 ++++++++++-----------
 2 files changed, 85 insertions(+), 21 deletions(-)

diff --git a/docs/latex/wx/mltchdlg.tex b/docs/latex/wx/mltchdlg.tex
index e4ad19bb79..e8175b2829 100644
--- a/docs/latex/wx/mltchdlg.tex
+++ b/docs/latex/wx/mltchdlg.tex
@@ -16,7 +16,73 @@ the user to select one or more.
 
 \wxheading{See also}
 
-\helpref{wxMultiChoiceDialog overview}{wxmultichoicedialogoverview}
+\helpref{wxMultiChoiceDialog overview}{wxmultichoicedialogoverview},
+\helpref{wxSingleChoiceDialog}{wxsinglechoicedialog}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
+\membersection{wxMultiChoiceDialog::wxMultiChoiceDialog}\label{wxmultichoicedialogconstr}
+
+\func{}{wxMultiChoiceDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message},\rtfsp
+\param{const wxString\& }{caption}, \param{int }{n}, \param{const wxString* }{choices}, \param{long }{style = wxCHOICEDLG\_STYLE},\rtfsp
+\param{const wxPoint\& }{pos = wxDefaultPosition}}
+
+\func{}{wxMultiChoiceDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message},\rtfsp
+\param{const wxString\& }{caption}, \param{const wxArrayString\& }{choices}, \param{long }{style = wxCHOICEDLG\_STYLE},\rtfsp
+\param{const wxPoint\& }{pos = wxDefaultPosition}}
+
+Constructor, taking an array of wxString choices and optional client data.
+
+\wxheading{Parameters}
+
+\docparam{parent}{Parent window.}
+
+\docparam{message}{Message to show on the dialog.}
+
+\docparam{caption}{The dialog caption.}
+
+\docparam{n}{The number of choices.}
+
+\docparam{choices}{An array of strings, or a string list, containing the choices.}
+
+\docparam{style}{A dialog style (bitlist) containing flags chosen from standard
+dialog styles and the following:
+
+\twocolwidtha{5cm}
+\begin{twocollist}
+\twocolitem{{\bf wxOK}}{Show an OK button.}
+\twocolitem{{\bf wxCANCEL}}{Show a Cancel button.}
+\twocolitem{{\bf wxCENTRE}}{Centre the message. Not Windows.}
+\end{twocollist}
+The default value is equivalent to {\bf wxDEFAULT\_DIALOG\_STYLE \pipe wxRESIZE\_BORDER \pipe wxOK \pipe wxCANCEL \pipe wxCENTRE}.
+}
+
+\docparam{pos}{Dialog position. Not Windows.}
+
+\wxheading{Remarks}
+
+Use \helpref{wxMultiChoiceDialog::ShowModal}{wxmultichoicedialogshowmodal} to show the dialog.
+
+\pythonnote{For Python the two parameters {\tt n} and {\tt choices} are collapsed
+into a multi parameter {\tt choices} which is expected to be a Python
+list of strings.}
+
+\perlnote{In wxPerl there is just an array reference in place of {\tt n}.}
+
+\membersection{wxMultiChoiceDialog::GetSelections}
+
+\constfunc{wxArrayInt}{GetSelection}{\void}
+
+Returns array with indexes of selected items.
+
+\membersection{wxMultiChoiceDialog::SetSelections}
+
+\constfunc{void}{SetSelections}{\param{const wxArrayInt\&}{ selections}}
+
+Sets selected items from the array of selected items' indexes.
+
+\membersection{wxMultiChoiceDialog::ShowModal}\label{wxmultichoicedialogshowmodal}
+
+\func{int}{ShowModal}{\void}
+
+Shows the dialog, returning either wxID\_OK or wxID\_CANCEL.
diff --git a/docs/latex/wx/sngchdlg.tex b/docs/latex/wx/sngchdlg.tex
index dc20408a68..67a3426939 100644
--- a/docs/latex/wx/sngchdlg.tex
+++ b/docs/latex/wx/sngchdlg.tex
@@ -1,8 +1,8 @@
 \section{\class{wxSingleChoiceDialog}}\label{wxsinglechoicedialog}
 
-This class represents a dialog that shows a list of strings, and allows
-the user to select one. Double-clicking on a list item is equivalent to single-clicking
-and then pressing OK.
+This class represents a dialog that shows a list of strings, and allows the
+user to select one. Double-clicking on a list item is equivalent to
+single-clicking and then pressing OK.
 
 \wxheading{Derived from}
 
@@ -17,7 +17,8 @@ and then pressing OK.
 
 \wxheading{See also}
 
-\helpref{wxSingleChoiceDialog overview}{wxsinglechoicedialogoverview}
+\helpref{wxSingleChoiceDialog overview}{wxsinglechoicedialogoverview},
+\helpref{wxMultiChoiceDialog}{wxmultichoicedialog}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
@@ -25,17 +26,15 @@ and then pressing OK.
 
 \func{}{wxSingleChoiceDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message},\rtfsp
 \param{const wxString\& }{caption}, \param{int }{n}, \param{const wxString* }{choices},\rtfsp
-\param{void**}{ clientData = NULL}, \param{long }{style = wxOK \pipe wxCANCEL \pipe wxCENTRE},\rtfsp
+\param{void**}{ clientData = NULL}, \param{long }{style = wxCHOICEDLG\_STYLE},\rtfsp
 \param{const wxPoint\& }{pos = wxDefaultPosition}}
 
-Constructor, taking an array of wxString choices and optional client data.
+\func{}{wxSingleChoiceDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message},\rtfsp
+\param{const wxString\& }{caption}, \param{const wxArrayString\& }{choices},\rtfsp
+\param{void**}{ clientData = NULL}, \param{long }{style = wxCHOICEDLG\_STYLE},\rtfsp
+\param{const wxPoint\& }{pos = wxDefaultPosition}}
 
-%\func{}{wxSingleChoiceDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message},\rtfsp
-%\param{const wxString\& }{caption}, \param{const wxStringList\& }{choices},\rtfsp
-%\param{void**}{ clientData = NULL}, \param{long }{style = wxOK \pipe wxCANCEL \pipe wxCENTRE},\rtfsp
-%\param{const wxPoint\& }{pos = wxDefaultPosition}}
-%
-%Constructor, taking a string list and optional client data.
+Constructor, taking an array of wxString choices and optional client data.
 
 \wxheading{Parameters}
 
@@ -49,7 +48,11 @@ Constructor, taking an array of wxString choices and optional client data.
 
 \docparam{choices}{An array of strings, or a string list, containing the choices.}
 
-\docparam{style}{A dialog style (bitlist) containing flags chosen from the following:
+\docparam{clientData}{An array of client data to be associated with the items.
+See \helpref{GetSelectionClientData}{wxsinglechoicedialoggetselectionclientdata}.}
+
+\docparam{style}{A dialog style (bitlist) containing flags chosen from standard
+dialog styles and the following:
 
 \twocolwidtha{5cm}
 \begin{twocollist}
@@ -57,6 +60,7 @@ Constructor, taking an array of wxString choices and optional client data.
 \twocolitem{{\bf wxCANCEL}}{Show a Cancel button.}
 \twocolitem{{\bf wxCENTRE}}{Centre the message. Not Windows.}
 \end{twocollist}
+The default value is equivalent to {\bf wxDEFAULT\_DIALOG\_STYLE \pipe wxRESIZE\_BORDER \pipe wxOK \pipe wxCANCEL \pipe wxCENTRE}.
 }
 
 \docparam{pos}{Dialog position. Not Windows.}
@@ -73,19 +77,13 @@ list of strings.}
 and {\tt choices}, and the client data array, if present, must have the
 same length as the choices array.}
 
-\membersection{wxSingleChoiceDialog::\destruct{wxSingleChoiceDialog}}
-
-\func{}{\destruct{wxSingleChoiceDialog}}{\void}
-
-Destructor.
-
 \membersection{wxSingleChoiceDialog::GetSelection}
 
 \constfunc{int}{GetSelection}{\void}
 
 Returns the index of selected item.
 
-\membersection{wxSingleChoiceDialog::GetSelectionClientData}
+\membersection{wxSingleChoiceDialog::GetSelectionClientData}\label{wxsinglechoicedialoggetselectionclientdata}
 
 \constfunc{char*}{GetSelectionClientData}{\void}
 
-- 
2.50.0

