X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/bed5584e2a93de909120d3eed5710f48d590a2a8..3cc305b2b4a0674c56c84d7088cfd70676b850f0:/docs/latex/wx/choice.tex diff --git a/docs/latex/wx/choice.tex b/docs/latex/wx/choice.tex index 09209f4b0d..ba7a6f9820 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 @@ -16,9 +27,15 @@ menu of choices. +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \wxheading{Window styles} -There are no special styles for wxChoice. +\begin{twocollist}\itemsep=0pt +\twocolitem{\windowstyle{wxCB\_SORT}}{Sorts the entries alphabetically.} +\end{twocollist} See also \helpref{window styles overview}{windowstyles}. @@ -37,7 +54,8 @@ 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} @@ -48,6 +66,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} @@ -82,30 +105,30 @@ 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}} + +\membersection{wxChoice::\destruct{wxChoice}}\label{wxchoicedtor} \func{}{\destruct{wxChoice}}{\void} Destructor, destroying the choice item. + \membersection{wxChoice::Create}\label{wxchoicecreate} \func{bool}{Create}{\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 wxString\& }{name = ``choice"}} +\param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp +\param{const wxString\& }{name = ``choice"}} -Creates the choice for two-step construction. See \helpref{wxChoice::wxChoice}{wxchoiceconstr}. - -\membersection{wxChoice::Delete}\label{wxchoicedelete} - -\func{void}{Delete}{\param{int }{n}} - -Deletes the item with the given index from the control. +\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{Parameters} +Creates the choice for two-step construction. See \helpref{wxChoice::wxChoice}{wxchoicector}. -\docparam{n}{The item to delete.} \membersection{wxChoice::GetColumns}\label{wxchoicegetcolumns} @@ -118,6 +141,23 @@ Gets the number of columns in this choice item. This is implemented for Motif only and always returns $1$ for the other platforms. + +\membersection{wxChoice::GetCurrentSelection}\label{wxchoicegetcurrentselection} + +\constfunc{int}{GetCurrentSelection}{\void} + +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. + +\newsince{2.6.2} (before this version +\helpref{GetSelection}{wxcontrolwithitemsgetselection} itself behaved like +this). + + \membersection{wxChoice::SetColumns}\label{wxchoicesetcolumns} \func{void}{SetColumns}{\param{int}{ n = 1}}