X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/953704c1c76cfb9cfb7b91f0e81f98c30d27eb56..0472ece753aa3c018dd2cc9816d3cd755f28efe8:/docs/latex/wx/choice.tex diff --git a/docs/latex/wx/choice.tex b/docs/latex/wx/choice.tex index 11f02c3b5f..d09ec492a4 100644 --- a/docs/latex/wx/choice.tex +++ b/docs/latex/wx/choice.tex @@ -74,10 +74,13 @@ appropriately.} \helpref{wxChoice::Create}{wxchoicecreate}, \helpref{wxValidator}{wxvalidator} -\pythonnote{The wxChoice constructor in wxPython reduces the \tt{n} -and \tt{choices} arguments are to a single argument, which is +\pythonnote{The wxChoice constructor in wxPython reduces the {\tt n} +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} @@ -90,10 +93,17 @@ Destructor, destroying the choice item. Adds the item to the end of the choice control. +\func{void}{Append}{\param{const wxString\& }{ item}, \param{void* }{clientData}} + +Adds the item to the end of the combobox, associating the given data +with the item. + \wxheading{Parameters} \docparam{item}{String to add.} +\docparam{clientData}{Client data to associate with the item.} + \membersection{wxChoice::Clear}\label{wxchoiceclear} \func{void}{Clear}{\void} @@ -133,6 +143,26 @@ Gets the number of columns in this choice item. This is implemented for Motif only. +\membersection{wxChoice::GetClientData}\label{wxchoicegetclientdata} + +\constfunc{void*}{GetClientData}{\param{int}{ n}} + +Returns a pointer to the client data associated with the given item (if any). + +\wxheading{Parameters} + +\docparam{n}{An item, starting from zero.} + +\wxheading{Return value} + +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} @@ -163,8 +193,26 @@ 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} + +\func{void}{SetClientData}{\param{int}{ n}, \param{void* }{data}} + +Associates the given client data pointer with the given item. + +\wxheading{Parameters} + +\docparam{n}{The zero-based item.} + +\docparam{data}{The client data.} + \membersection{wxChoice::SetColumns}\label{wxchoicesetcolumns} \func{void}{SetColumns}{\param{int}{ n = 1}} @@ -192,6 +240,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}