/////////////////////////////////////////////////////////////////////////////
// Name: choice.h
-// Purpose: documentation for wxChoice class
+// Purpose: interface of wxChoice
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@category{ctrl}
@appearance{choice.png}
- @seealso
- wxListBox, wxComboBox, wxCommandEvent
+ @see wxListBox, wxComboBox, wxCommandEvent
*/
class wxChoice : public wxControlWithItems
{
//@{
/**
Constructor, creating and showing a choice.
-
+
@param parent
Parent window. Must not be @NULL.
@param id
Window validator.
@param name
Window name.
-
+
@see Create(), wxValidator
*/
wxChoice();
/**
Gets the number of columns in this choice item.
-
+
@remarks This is implemented for Motif only and always returns 1 for the
other platforms.
*/
- int GetColumns();
+ int GetColumns() const;
/**
Unlike wxControlWithItems::GetSelection which only
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.
- This function is new since wxWidgets version 2.6.2 (before this version
+
+ @wxsince{2.6.2} (before this version
wxControlWithItems::GetSelection itself behaved like
this).
*/
- int GetCurrentSelection();
+ int GetCurrentSelection() const;
/**
Sets the number of columns in this choice item.
-
+
@param n
Number of columns.
*/
void SetColumns(int n = 1);
};
+