X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/06d20283afba5439c8a2c1b3b7cd3390541da52d..8b6e6947fc8fb946391740d66b140413eccb6b6c:/docs/latex/wx/choice.tex diff --git a/docs/latex/wx/choice.tex b/docs/latex/wx/choice.tex index 7a505b8118..bcf4474186 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,20 @@ 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::GetSelection}\label{wxchoicegetselection} \constfunc{int}{GetSelection}{\void} @@ -165,6 +189,18 @@ Gets the selected string, or the empty string if no string is selected. 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}} @@ -183,7 +219,8 @@ This is implemented for Motif only. \func{void}{SetSelection}{\param{int}{ n}} -Sets the choice by passing the desired string position. +Sets the choice by passing the desired string position. This does not cause +a wxEVT\_COMMAND\_CHOICE\_SELECTED event to get emitted. \wxheading{Parameters} @@ -197,7 +234,8 @@ Sets the choice by passing the desired string position. \func{void}{SetStringSelection}{\param{const wxString\& }{ string}} -Sets the choice by passing the desired string. +Sets the choice by passing the desired string. This does not cause +a wxEVT\_COMMAND\_CHOICE\_SELECTED event to get emitted. \wxheading{Parameters}