X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c91108763b1621be54af24e24b2fab590db87325..4f7202dd939538bc4bb0655ad6f746848fd2aabf:/docs/latex/wx/choice.tex?ds=sidebyside diff --git a/docs/latex/wx/choice.tex b/docs/latex/wx/choice.tex index e70287e75d..7f909cc8ae 100644 --- a/docs/latex/wx/choice.tex +++ b/docs/latex/wx/choice.tex @@ -78,6 +78,9 @@ appropriately.} and {\tt choices} arguments are to a single argument, which is a list of strings.} +\perlnote{In wxPerl there is just an array reference in place of {\tt n} +and {\tt choices}.} + \membersection{wxChoice::\destruct{wxChoice}} \func{}{\destruct{wxChoice}}{\void} @@ -116,6 +119,16 @@ Clears the strings from the choice item. Creates the choice for two-step construction. See \helpref{wxChoice::wxChoice}{wxchoiceconstr}. +\membersection{wxChoice::Delete}\label{wxchoicedelete} + +\func{void}{Delete}{\param{int }{n}} + +Deletes the item with the given index from the control. + +\wxheading{Parameters} + +\docparam{n}{The item to delete.} + \membersection{wxChoice::FindString}\label{wxchoicefindstring} \constfunc{int}{FindString}{\param{const wxString\& }{string}} @@ -154,6 +167,12 @@ Returns a pointer to the client data associated with the given item (if any). A pointer to the client data, or NULL if the item was not found. +\membersection{wxChoice::GetCount}\label{wxchoicegetcount} + +\constfunc{int}{GetCount}{\void} + +Returns the number of items in the choice. + \membersection{wxChoice::GetSelection}\label{wxchoicegetselection} \constfunc{int}{GetSelection}{\void} @@ -184,6 +203,12 @@ Gets the selected string, or the empty string if no string is selected. \constfunc{int}{Number}{\void} +{\bf Obsolescence note:} This method is obsolete and was replaced with +\helpref{GetCount}{wxchoicegetcount}, please use the new method in the new +code. This method is only available if wxWindows was compiled with +{\tt WXWIN\_COMPATIBILITY\_2\_2} defined and will disappear completely in +future versions. + Returns the number of strings in the choice control. \membersection{wxChoice::SetClientData}\label{wxchoicesetclientdata} @@ -225,6 +250,20 @@ a wxEVT\_COMMAND\_CHOICE\_SELECTED event to get emitted. \wxheading{See also} +\membersection{wxChoice::SetString}\label{wxchoicesetstring} + +\func{void}{SetString}{\param{int }{n}, \param{const wxString\& }{text}} + +Replaces the specified string in the control with another one. + +\wxheading{Parameters} + +\docparam{n}{The zero-based index of the string to replace} + +\docparam{text}{The new value for this item} + +{\bf NB:} This method is currently not implemented in wxGTK. + \helpref{wxChoice::SetStringSelection}{wxchoicesetstringselection} \membersection{wxChoice::SetStringSelection}\label{wxchoicesetstringselection}