Bug 1099143 and more occurences of the same set vs. get mistakes.

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

diff --git a/docs/latex/wx/choice.tex b/docs/latex/wx/choice.tex
index 04dc877fc3f50b84e9d81590da64a03055ca6d07..211283659c86031c841e0b26e1111ef9e7aa6a33 100644 (file)
--- a/docs/latex/wx/choice.tex
+++ b/docs/latex/wx/choice.tex
@@ -6,11 +6,16 @@ menu of choices.
 
 \wxheading{Derived from}
 
+\helpref{wxControlWithItems}{wxcontrolwithitems}\\
 \helpref{wxControl}{wxcontrol}\\
 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/choice.h>
+
 \wxheading{Window styles}
 
 There are no special styles for wxChoice.
@@ -32,7 +37,7 @@ when an item on the list is selected.}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxChoice::wxChoice}\label{wxchoiceconstr}
+\membersection{wxChoice::wxChoice}\label{wxchoicector}
 
 \func{}{wxChoice}{\void}
 
@@ -43,6 +48,11 @@ Default constructor.
 \param{int}{ n}, \param{const wxString }{choices[]},\rtfsp
 \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``choice"}}
 
+\func{}{wxChoice}{\param{wxWindow *}{parent}, \param{wxWindowID}{ id},\rtfsp
+\param{const wxPoint\& }{pos}, \param{const wxSize\&}{ size},\rtfsp
+\param{const wxArrayString\& }{choices},\rtfsp
+\param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``choice"}}
+
 Constructor, creating and showing a choice.
 
 \wxheading{Parameters}
@@ -70,27 +80,18 @@ appropriately.}
 
 \helpref{wxChoice::Create}{wxchoicecreate}, \helpref{wxValidator}{wxvalidator}
 
-\membersection{wxChoice::\destruct{wxChoice}}
-
-\func{}{\destruct{wxChoice}}{\void}
-
-Destructor, destroying the choice item.
-
-\membersection{wxChoice::Append}\label{wxchoiceappend}
-
-\func{void}{Append}{\param{const wxString\& }{ item}}
-
-Adds the item to the end of the choice control.
-
-\wxheading{Parameters}
+\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.}
 
-\docparam{item}{String to add.}
+\perlnote{In wxPerl there is just an array reference in place of {\tt n}
+and {\tt choices}.}
 
-\membersection{wxChoice::Clear}\label{wxchoiceclear}
+\membersection{wxChoice::\destruct{wxChoice}}\label{wxchoicedtor}
 
-\func{void}{Clear}{\void}
+\func{}{\destruct{wxChoice}}{\void}
 
-Clears the strings from the choice item.
+Destructor, destroying the choice item.
 
 \membersection{wxChoice::Create}\label{wxchoicecreate}
 
@@ -99,21 +100,22 @@ Clears the strings from the choice item.
 \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}.
-
-\membersection{wxChoice::FindString}\label{wxchoicefindstring}
+\func{bool}{Create}{\param{wxWindow *}{parent}, \param{wxWindowID}{ id},\rtfsp
+\param{const wxPoint\& }{pos}, \param{const wxSize\&}{ size},\rtfsp
+\param{const wxArrayString\& }{choices},\rtfsp
+\param{long}{ style = 0}, \param{const wxString\& }{name = ``choice"}}
 
-\constfunc{int}{FindString}{\param{const wxString\& }{string}}
+Creates the choice for two-step construction. See \helpref{wxChoice::wxChoice}{wxchoicector}.
 
-Finds a choice matching the given string.
+\membersection{wxChoice::Delete}\label{wxchoicedelete}
 
-\wxheading{Parameters}
+\func{void}{Delete}{\param{int }{n}}
 
-\docparam{string}{String to find.}
+Deletes the item with the given index from the control.
 
-\wxheading{Return value}
+\wxheading{Parameters}
 
-Returns the position if found, or -1 if not found.
+\docparam{n}{The item to delete.}
 
 \membersection{wxChoice::GetColumns}\label{wxchoicegetcolumns}
 
@@ -123,39 +125,8 @@ Gets the number of columns in this choice item.
 
 \wxheading{Remarks}
 
-This is implemented for Motif only.
-
-\membersection{wxChoice::GetSelection}\label{wxchoicegetselection}
-
-\constfunc{int}{GetSelection}{\void}
-
-Gets the id (position) of the selected string, or -1 if there is no selection.
-
-\membersection{wxChoice::GetString}\label{wxchoicegetstring}
-
-\constfunc{wxString}{GetString}{\param{int}{ n}}
-
-Returns the string at the given position.
-
-\wxheading{Parameters}
-
-\docparam{n}{The zero-based position.}
-
-\wxheading{Return value}
-
-The string at the given position, or the empty string if {\it n} is invalid.
-
-\membersection{wxChoice::GetStringSelection}\label{wxchoicegetstringselection}
-
-\constfunc{wxString}{GetStringSelection}{\void}
-
-Gets the selected string, or the empty string if no string is selected.
-
-\membersection{wxChoice::Number}\label{wxchoicenumber}
-
-\constfunc{int}{Number}{\void}
-
-Returns the number of strings in the choice control.
+This is implemented for Motif only and always returns $1$ for the other
+platforms.
 
 \membersection{wxChoice::SetColumns}\label{wxchoicesetcolumns}
 
@@ -169,34 +140,6 @@ Sets the number of columns in this choice item.
 
 \wxheading{Remarks}
 
-This is implemented for Motif only.
-
-\membersection{wxChoice::SetSelection}\label{wxchoicesetselection}
-
-\func{void}{SetSelection}{\param{int}{ n}}
-
-Sets the choice by passing the desired string position.
-
-\wxheading{Parameters}
-
-\docparam{n}{The string position to select, starting from zero.}
-
-\wxheading{See also}
-
-\helpref{wxChoice::SetStringSelection}{wxchoicesetstringselection}
-
-\membersection{wxChoice::SetStringSelection}\label{wxchoicesetstringselection}
-
-\func{void}{SetStringSelection}{\param{const wxString\& }{ string}}
-
-Sets the choice by passing the desired string.
-
-\wxheading{Parameters}
-
-\docparam{string}{The string to select.}
-
-\wxheading{See also}
-
-\helpref{wxChoice::SetSelection}{wxchoicesetselection}
-
+This is implemented for Motif only and doesn't do anything under other
+platforms.