Added a couple of wxPerl notes.

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

diff --git a/docs/latex/wx/sngchdlg.tex b/docs/latex/wx/sngchdlg.tex
index 38670320d31821441a579438f9649b2aa3a46fa3..dc20408a6869d7111e5c5897bb586d9f73b0ed43 100644 (file)
--- a/docs/latex/wx/sngchdlg.tex
+++ b/docs/latex/wx/sngchdlg.tex
@@ -11,6 +11,10 @@ and then pressing OK.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/choicdlg.h>
+
 \wxheading{See also}
 
 \helpref{wxSingleChoiceDialog overview}{wxsinglechoicedialogoverview}
@@ -20,18 +24,18 @@ and then pressing OK.
 \membersection{wxSingleChoiceDialog::wxSingleChoiceDialog}\label{wxsinglechoicedialogconstr}
 
 \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 = wxOK \pipe wxCANCEL \pipe wxCENTRE},\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 wxPoint\& }{pos = wxDefaultPosition}}
-
-Constructor, taking a string list and optional client data.
+%\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.
 
 \wxheading{Parameters}
 
@@ -61,6 +65,13 @@ 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.}
+
+\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.}
 
 \membersection{wxSingleChoiceDialog::\destruct{wxSingleChoiceDialog}}
 
@@ -86,6 +97,12 @@ Returns the client data associated with the selection.
 
 Returns the selected string.
 
+\membersection{wxSingleChoiceDialog::SetSelection}
+
+\constfunc{void}{SetSelection}{\param{int}{ selection}}
+
+Sets the index of the initially selected item.
+
 \membersection{wxSingleChoiceDialog::ShowModal}\label{wxsinglechoicedialogshowmodal}
 
 \func{int}{ShowModal}{\void}