X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..ee0a94cfc2f71e8b770eedda5197a1f4bd62b5cb:/docs/latex/wx/choice.tex?ds=inline diff --git a/docs/latex/wx/choice.tex b/docs/latex/wx/choice.tex index 9610d3fc27..43ec4d0ae6 100644 --- a/docs/latex/wx/choice.tex +++ b/docs/latex/wx/choice.tex @@ -1,3 +1,14 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Name: treectrl.tex +%% Purpose: wxChoice documentation +%% Author: wxWidgets Team +%% Modified by: +%% Created: +%% RCS-ID: $Id$ +%% Copyright: (c) wxWidgets Team +%% License: wxWindows license +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + \section{\class{wxChoice}}\label{wxchoice} A choice item is used to select one of a list of strings. Unlike a @@ -6,33 +17,53 @@ menu of choices. \wxheading{Derived from} +\helpref{wxControlWithItems}{wxcontrolwithitems}\\ \helpref{wxControl}{wxcontrol}\\ \helpref{wxWindow}{wxwindow}\\ \helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \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} -\helpref{wxListBox}{wxlistbox} +\helpref{wxListBox}{wxlistbox}, \helpref{wxComboBox}{wxcombobox}, +\rtfsp\helpref{wxCommandEvent}{wxcommandevent} \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxChoice::wxChoice}\label{wxchoiceconstr} + +\membersection{wxChoice::wxChoice}\label{wxchoicector} \func{}{wxChoice}{\void} 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{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 int}{ n}, \param{const wxString }{choices[]},\rtfsp -\param{const long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``choice"}} +\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. @@ -61,50 +92,37 @@ 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}} +\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.} -Adds the item to the end of the choice control. +\perlnote{In wxPerl there is just an array reference in place of {\tt n} +and {\tt choices}.} -\wxheading{Parameters} -\docparam{item}{String to add.} +\membersection{wxChoice::\destruct{wxChoice}}\label{wxchoicedtor} -\membersection{wxChoice::Clear}\label{wxchoiceclear} +\func{}{\destruct{wxChoice}}{\void} -\func{void}{Clear}{\void} +Destructor, destroying the choice item. -Clears the strings from the choice item. \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 int}{ n}, \param{const wxString }{choices[]},\rtfsp -\param{const 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} - -\constfunc{int}{FindString}{\param{const wxString\& }{string}} - -Finds a choice matching the given string. +\param{int}{ n}, \param{const wxString }{choices[]},\rtfsp +\param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp +\param{const wxString\& }{name = ``choice"}} -\wxheading{Parameters} - -\docparam{string}{String to find.} +\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 wxValidator\& }{validator = wxDefaultValidator},\rtfsp +\param{const wxString\& }{name = ``choice"}} -\wxheading{Return value} +Creates the choice for two-step construction. See \helpref{wxChoice::wxChoice}{wxchoicector}. -Returns the position if found, or -1 if not found. \membersection{wxChoice::GetColumns}\label{wxchoicegetcolumns} @@ -114,43 +132,29 @@ Gets the number of columns in this choice item. \wxheading{Remarks} -This is implemented for Motif only. - -\membersection{wxChoice::GetSelection}\label{wxchoicegetselection} +This is implemented for Motif only and always returns $1$ for the other +platforms. -\constfunc{int}{GetSelection}{\void} -Gets the id (position) of the selected string, or -1 if there is no selection. +\membersection{wxChoice::GetCurrentSelection}\label{wxchoicegetcurrentselection} -\membersection{wxChoice::GetString}\label{wxchoicegetstring} +\constfunc{int}{GetCurrentSelection}{\void} -\constfunc{wxString}{GetString}{\param{const int}{ n}} - -Returns the string at the given position. - -\wxheading{Parameters} +Unlike \helpref{GetSelection}{wxcontrolwithitemsgetselection} which only +returns the accepted selection value, i.e. the selection in the control once +the user closes the dropdown list, this function returns the current selection. +That is, while the dropdown list is shown, it returns the currently selected +item in it. When it is not shown, its result is the same as for the other +function. -\docparam{n}{The zero-based position.} +\newsince{2.6.2} (before this version +\helpref{GetSelection}{wxcontrolwithitemsgetselection} itself behaved like +this). -\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. \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. @@ -160,34 +164,5 @@ 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{const 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.