fixed another return FALSE in a function returning a pointer (patch 545046)

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

diff --git a/docs/latex/wx/sngchdlg.tex b/docs/latex/wx/sngchdlg.tex
index e5206ecd37852649d9b20ada93ff0c719aa555a9..dcb28e65991c3cba318c187a42b1a660dca86543 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}
@@ -21,14 +25,14 @@ 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{char**}{ clientData = NULL}, \param{long }{style = wxOK \pipe wxCANCEL \pipe wxCENTRE},\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{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.
@@ -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 parametes {\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}