no changes, just come cleanup and more comments

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

diff --git a/docs/latex/wx/sngchdlg.tex b/docs/latex/wx/sngchdlg.tex
index 38670320d31821441a579438f9649b2aa3a46fa3..3b0e3a5928dac688bc6bcdcdc4dc70ea55b66c74 100644 (file)
--- a/docs/latex/wx/sngchdlg.tex
+++ b/docs/latex/wx/sngchdlg.tex
@@ -1,37 +1,41 @@
 \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}
 
 \helpref{wxDialog}{wxdialog}\\
+\helpref{wxTopLevelWindow}{wxtoplevelwindow}\\
 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/choicdlg.h>
+
 \wxheading{See also}
 
-\helpref{wxSingleChoiceDialog overview}{wxsinglechoicedialogoverview}
+\helpref{wxSingleChoiceDialog overview}{wxsinglechoicedialogoverview},
+\helpref{wxMultiChoiceDialog}{wxmultichoicedialog}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxSingleChoiceDialog::wxSingleChoiceDialog}\label{wxsinglechoicedialogconstr}
+\membersection{wxSingleChoiceDialog::wxSingleChoiceDialog}\label{wxsinglechoicedialogctor}
 
 \func{}{wxSingleChoiceDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message},\rtfsp
-\param{const wxString\& }{caption}, \param{const int }{n}, \param{const wxString* }{choices},\rtfsp
-\param{char**}{ clientData = NULL}, \param{long }{style = wxOK \pipe wxCANCEL \pipe wxCENTRE},\rtfsp
+\param{const wxString\& }{caption}, \param{int }{n}, \param{const wxString* }{choices},\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 wxStringList\& }{choices},\rtfsp
-\param{char**}{ clientData = NULL}, \param{long }{style = wxOK \pipe wxCANCEL \pipe wxCENTRE},\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}}
 
-Constructor, taking a string list and optional client data.
+Constructor, taking an array of wxString choices and optional client data.
 
 \wxheading{Parameters}
 
@@ -45,7 +49,11 @@ Constructor, taking a string list 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}
@@ -53,6 +61,7 @@ Constructor, taking a string list 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.}
@@ -61,31 +70,38 @@ Constructor, taking a string list and optional client data.
 
 Use \helpref{wxSingleChoiceDialog::ShowModal}{wxsinglechoicedialogshowmodal} to show the dialog.
 
+\pythonnote{For Python the two parameters {\tt n} and {\tt choices} are collapsed
+into a single parameter {\tt choices} which is expected to be a Python
+list of strings.}
 
-\membersection{wxSingleChoiceDialog::\destruct{wxSingleChoiceDialog}}
+\perlnote{In wxPerl there is just an array reference in place of {\tt n}
+and {\tt choices}, and the client data array, if present, must have the
+same length as the choices array.}
 
-\func{}{\destruct{wxSingleChoiceDialog}}{\void}
-
-Destructor.
-
-\membersection{wxSingleChoiceDialog::GetSelection}
+\membersection{wxSingleChoiceDialog::GetSelection}\label{wxsinglechoicedialoggetselection}
 
 \constfunc{int}{GetSelection}{\void}
 
 Returns the index of selected item.
 
-\membersection{wxSingleChoiceDialog::GetSelectionClientData}
+\membersection{wxSingleChoiceDialog::GetSelectionClientData}\label{wxsinglechoicedialoggetselectionclientdata}
 
 \constfunc{char*}{GetSelectionClientData}{\void}
 
 Returns the client data associated with the selection.
 
-\membersection{wxSingleChoiceDialog::GetStringSelection}
+\membersection{wxSingleChoiceDialog::GetStringSelection}\label{wxsinglechoicedialoggetstringselection}
 
 \constfunc{wxString}{GetStringSelection}{\void}
 
 Returns the selected string.
 
+\membersection{wxSingleChoiceDialog::SetSelection}\label{wxsinglechoicedialogsetselection}
+
+\constfunc{void}{SetSelection}{\param{int}{ selection}}
+
+Sets the index of the initially selected item.
+
 \membersection{wxSingleChoiceDialog::ShowModal}\label{wxsinglechoicedialogshowmodal}
 
 \func{int}{ShowModal}{\void}