]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/choice.tex
Added wxRect::Intersect() documentation (patch 1868322 from Laurent Humbertclaude).
[wxWidgets.git] / docs / latex / wx / choice.tex
index 7ef251b0851bcda1124081c7159589c9acc46695..ba7a6f982028ecadca632551cff58b2e7dde354f 100644 (file)
@@ -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.
 
 <wx/choice.h>
 
+\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,6 +54,7 @@ when an item on the list is selected.}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
+
 \membersection{wxChoice::wxChoice}\label{wxchoicector}
 
 \func{}{wxChoice}{\void}
@@ -87,12 +105,14 @@ 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}}\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
@@ -109,15 +129,6 @@ Destructor, destroying the choice item.
 
 Creates the choice for two-step construction. See \helpref{wxChoice::wxChoice}{wxchoicector}.
 
-\membersection{wxChoice::Delete}\label{wxchoicedelete}
-
-\func{void}{Delete}{\param{int }{n}}
-
-Deletes the item with the given index from the control.
-
-\wxheading{Parameters}
-
-\docparam{n}{The item to delete.}
 
 \membersection{wxChoice::GetColumns}\label{wxchoicegetcolumns}
 
@@ -130,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}}