removed small as otherwise the code was apparently unreadable in HTML docs

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

diff --git a/docs/latex/wx/choice.tex b/docs/latex/wx/choice.tex
index 04dc877fc3f50b84e9d81590da64a03055ca6d07..bcf44741866d27bf686c82070529f5e0d7a9f25e 100644 (file)
--- a/docs/latex/wx/choice.tex
+++ b/docs/latex/wx/choice.tex
@@ -11,6 +11,10 @@ menu of choices.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/choice.h>
+
 \wxheading{Window styles}
 
 There are no special styles for wxChoice.
@@ -70,6 +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
+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}
@@ -82,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}
@@ -125,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}
@@ -157,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}}
@@ -175,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}
 
@@ -189,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}