Finished initial review of [ca*-ch*] interface headers.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53019 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -11,7 +11,7 @@
|
||||
@wxheader{choice.h}
|
||||
|
||||
A choice item is used to select one of a list of strings. Unlike a
|
||||
listbox, only the selection is visible until the user pulls down the
|
||||
wxListBox, only the selection is visible until the user pulls down the
|
||||
menu of choices.
|
||||
|
||||
@beginStyleTable
|
||||
@@ -27,13 +27,20 @@
|
||||
|
||||
@library{wxcore}
|
||||
@category{ctrl}
|
||||
@appearance{choice.png}
|
||||
<!-- @appearance{choice.png} -->
|
||||
|
||||
@see wxListBox, wxComboBox, wxCommandEvent
|
||||
*/
|
||||
class wxChoice : public wxControlWithItems
|
||||
{
|
||||
public:
|
||||
/**
|
||||
Default constructor.
|
||||
|
||||
@see Create(), wxValidator
|
||||
*/
|
||||
wxChoice();
|
||||
|
||||
//@{
|
||||
/**
|
||||
Constructor, creating and showing a choice.
|
||||
@@ -45,8 +52,7 @@ public:
|
||||
@param pos
|
||||
Window position.
|
||||
@param size
|
||||
Window size. If wxDefaultSize is specified then the choice is
|
||||
sized
|
||||
Window size. If wxDefaultSize is specified then the choice is sized
|
||||
appropriately.
|
||||
@param n
|
||||
Number of strings with which to initialise the choice control.
|
||||
@@ -60,8 +66,14 @@ public:
|
||||
Window name.
|
||||
|
||||
@see Create(), wxValidator
|
||||
|
||||
@beginWxPythonOnly
|
||||
|
||||
The wxChoice constructor in wxPython reduces the @a n and @a choices
|
||||
arguments to a single argument, which is a list of strings.
|
||||
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
wxChoice();
|
||||
wxChoice(wxWindow* parent, wxWindowID id,
|
||||
const wxPoint& pos,
|
||||
const wxSize& size, int n,
|
||||
@@ -105,22 +117,22 @@ public:
|
||||
/**
|
||||
Gets the number of columns in this choice item.
|
||||
|
||||
@remarks This is implemented for Motif only and always returns 1 for the
|
||||
other platforms.
|
||||
@remarks This is implemented for Motif only and always returns 1 for
|
||||
the other platforms.
|
||||
*/
|
||||
int GetColumns() const;
|
||||
|
||||
/**
|
||||
Unlike wxControlWithItems::GetSelection 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.
|
||||
Unlike wxControlWithItems::GetSelection() 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.
|
||||
|
||||
@wxsince{2.6.2} (before this version
|
||||
wxControlWithItems::GetSelection itself behaved like
|
||||
this).
|
||||
@wxsince{2.6.2} (before this version,
|
||||
wxControlWithItems::GetSelection() itself behaved like
|
||||
this).
|
||||
*/
|
||||
int GetCurrentSelection() const;
|
||||
|
||||
@@ -129,6 +141,9 @@ public:
|
||||
|
||||
@param n
|
||||
Number of columns.
|
||||
|
||||
@remarks This is implemented for Motif only and doesn’t do anything
|
||||
under other platforms.
|
||||
*/
|
||||
void SetColumns(int n = 1);
|
||||
};
|
||||
|
Reference in New Issue
Block a user