new VC++ workspace file for wxBase

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

diff --git a/docs/latex/wx/choice.tex b/docs/latex/wx/choice.tex
index 9610d3fc274a00931b50953571b04a58d9853861..bcf44741866d27bf686c82070529f5e0d7a9f25e 100644 (file)
--- a/docs/latex/wx/choice.tex
+++ b/docs/latex/wx/choice.tex
@@ -11,15 +11,28 @@ menu of choices.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/choice.h>
+

 \wxheading{Window styles}
 
 There are no special styles for wxChoice.
 
 See also \helpref{window styles overview}{windowstyles}.
 
 \wxheading{Window styles}
 
 There are no special styles for wxChoice.
 
 See also \helpref{window styles overview}{windowstyles}.
 

+\wxheading{Event handling}
+
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf EVT\_CHOICE(id, func)}}{Process a wxEVT\_COMMAND\_CHOICE\_SELECTED event,
+when an item on the list is selected.}
+\end{twocollist}
+

 \wxheading{See also}
 
 \wxheading{See also}
 

-\helpref{wxListBox}{wxlistbox}
+\helpref{wxListBox}{wxlistbox}, \helpref{wxComboBox}{wxcombobox},
+\rtfsp\helpref{wxCommandEvent}{wxcommandevent}

 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 


@@ -29,10 +42,10 @@ See also \helpref{window styles overview}{windowstyles}.
 
 Default constructor.
 
 
 Default constructor.
 

-\func{}{wxChoice}{\param{wxWindow *}{parent}, \param{const wxWindowID}{ id},\rtfsp
+\func{}{wxChoice}{\param{wxWindow *}{parent}, \param{wxWindowID}{ id},\rtfsp

 \param{const wxPoint\& }{pos}, \param{const wxSize\&}{ size},\rtfsp
 \param{const wxPoint\& }{pos}, \param{const wxSize\&}{ size},\rtfsp

-\param{const int}{ n}, \param{const wxString }{choices[]},\rtfsp
-\param{const long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``choice"}}
+\param{int}{ n}, \param{const wxString }{choices[]},\rtfsp
+\param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``choice"}}

 
 Constructor, creating and showing a choice.
 
 
 Constructor, creating and showing a choice.
 


@@ -61,6 +74,13 @@ appropriately.}
 
 \helpref{wxChoice::Create}{wxchoicecreate}, \helpref{wxValidator}{wxvalidator}
 
 
 \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}
 \membersection{wxChoice::\destruct{wxChoice}}
 
 \func{}{\destruct{wxChoice}}{\void}


@@ -73,10 +93,17 @@ Destructor, destroying the choice item.
 
 Adds the item to the end of the choice control.
 
 
 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.}
 
 \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}
 \membersection{wxChoice::Clear}\label{wxchoiceclear}
 
 \func{void}{Clear}{\void}


@@ -85,10 +112,10 @@ Clears the strings from the choice item.
 
 \membersection{wxChoice::Create}\label{wxchoicecreate}
 
 
 \membersection{wxChoice::Create}\label{wxchoicecreate}
 

-\func{bool}{Create}{\param{wxWindow *}{parent}, \param{const wxWindowID}{ id},\rtfsp
+\func{bool}{Create}{\param{wxWindow *}{parent}, \param{wxWindowID}{ id},\rtfsp

 \param{const wxPoint\& }{pos}, \param{const wxSize\&}{ size},\rtfsp
 \param{const wxPoint\& }{pos}, \param{const wxSize\&}{ size},\rtfsp

-\param{const int}{ n}, \param{const wxString }{choices[]},\rtfsp
-\param{const long}{ style = 0}, \param{const wxString\& }{name = ``choice"}}
+\param{int}{ n}, \param{const wxString }{choices[]},\rtfsp
+\param{long}{ style = 0}, \param{const wxString\& }{name = ``choice"}}

 
 Creates the choice for two-step construction. See \helpref{wxChoice::wxChoice}{wxchoiceconstr}.
 
 
 Creates the choice for two-step construction. See \helpref{wxChoice::wxChoice}{wxchoiceconstr}.
 


@@ -116,6 +143,20 @@ Gets the number of columns in this choice item.
 
 This is implemented for Motif only.
 
 
 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}
 \membersection{wxChoice::GetSelection}\label{wxchoicegetselection}
 
 \constfunc{int}{GetSelection}{\void}


@@ -124,7 +165,7 @@ Gets the id (position) of the selected string, or -1 if there is no selection.
 
 \membersection{wxChoice::GetString}\label{wxchoicegetstring}
 
 
 \membersection{wxChoice::GetString}\label{wxchoicegetstring}
 

-\constfunc{wxString}{GetString}{\param{const int}{ n}}
+\constfunc{wxString}{GetString}{\param{int}{ n}}

 
 Returns the string at the given position.
 
 
 Returns the string at the given position.
 


@@ -148,9 +189,21 @@ Gets the selected string, or the empty string if no string is selected.
 
 Returns the number of strings in the choice control.
 
 
 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}
 
 \membersection{wxChoice::SetColumns}\label{wxchoicesetcolumns}
 

-\func{void}{SetColumns}{\param{const int}{ n = 1}}
+\func{void}{SetColumns}{\param{int}{ n = 1}}

 
 Sets the number of columns in this choice item.
 
 
 Sets the number of columns in this choice item.
 


@@ -164,9 +217,10 @@ This is implemented for Motif only.
 
 \membersection{wxChoice::SetSelection}\label{wxchoicesetselection}
 
 
 \membersection{wxChoice::SetSelection}\label{wxchoicesetselection}
 

-\func{void}{SetSelection}{\param{const int}{ n}}
+\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}
 
 
 \wxheading{Parameters}
 


@@ -180,7 +234,8 @@ Sets the choice by passing the desired string position.
 
 \func{void}{SetStringSelection}{\param{const wxString\& }{ string}}
 
 
 \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}
 
 
 \wxheading{Parameters}