wxItemContainer defines an interface which is implemented by all controls which have string subitems each of which may be selected.
It is decomposed in wxItemContainerImmutable which omits all methods adding/removing items and is used by wxRadioBox and wxItemContainer itself.
Note that this is not a control, it's a mixin interface that classes have to derive from in addition to wxControl or wxWindow.
Examples: wxListBox, wxCheckListBox, wxChoice and wxComboBox (which implements an extended interface deriving from this one)
<>< =''>:</>&;&;< =''>\ </></>
- See also
- wxControlWithItems, wxItemContainer
|
| wxItemContainerImmutable () |
| Constructor.
|
|
virtual unsigned int | GetCount () const =0 |
| Returns the number of items in the control.
|
|
bool | IsEmpty () const |
| Returns true if the control is empty or false if it has some items.
|
|
virtual wxString | GetString (unsigned int n) const =0 |
| Returns the label of the item with the given index.
|
|
wxArrayString | GetStrings () const |
| Returns the array of the labels of all items in the control.
|
|
virtual void | SetString (unsigned int n, const wxString &string)=0 |
| Sets the label for the given item.
|
|
virtual int | FindString (const wxString &string, bool caseSensitive=false) const |
| Finds an item whose label matches the given string.
|
|
|
virtual void | SetSelection (int n)=0 |
| Sets the selection to the given item n or removes the selection entirely if n == wxNOT_FOUND .
|
|
virtual int | GetSelection () const =0 |
| Returns the index of the selected item or wxNOT_FOUND if no item is selected.
|
|
bool | SetStringSelection (const wxString &string) |
| Selects the item with the specified string in the control.
|
|
virtual wxString | GetStringSelection () const |
| Returns the label of the selected item or an empty string if no item is selected.
|
|
void | Select (int n) |
| This is the same as SetSelection() and exists only because it is slightly more natural for controls which support multiple selection.
|
|
bool wxItemContainerImmutable::SetStringSelection |
( |
const wxString & |
string | ) |
|
Selects the item with the specified string in the control.
This method doesn't cause any command events to be emitted.
Notice that this method is case-insensitive, i.e. the string is compared with all the elements of the control case-insensitively and the first matching entry is selected, even if it doesn't have exactly the same case as this string and there is an exact match afterwards.
- Parameters
-
string | The string to select. |
- Returns
- true if the specified string has been selected, false if it wasn't found in the control.