Fix problems with GetSelection() documentation

Move wxListBox-specific part to wxListBox documentation, it doesn't
apply to the other controls, such as wxRadioBox.

Also improve the documentation of wxRadioBox::GetSelection() to mention
that it always returns a valid value.

Closes #18968.
This commit is contained in:
Vadim Zeitlin 2020-11-10 13:12:37 +01:00
parent 1cf7c47934
commit 7fe7ebd5e4
3 changed files with 19 additions and 4 deletions

View File

@ -113,10 +113,6 @@ public:
@return The position of the current selection.
@remarks This method can be used with single selection list boxes only,
you should use wxListBox::GetSelections() for the list
boxes with wxLB_MULTIPLE style.
@see SetSelection(), GetStringSelection()
*/
virtual int GetSelection() const = 0;

View File

@ -174,6 +174,18 @@ public:
virtual void SetSelection(int n);
/**
Returns the index of the selected item or @c wxNOT_FOUND if no item is
selected.
@return The position of the current selection.
@remarks This method can be used with single selection list boxes only,
you must use wxListBox::GetSelections() for the list
boxes with wxLB_MULTIPLE style.
@see SetSelection(), GetStringSelection()
*/
virtual int GetSelection() const;
virtual bool SetStringSelection(const wxString& s, bool select);

View File

@ -317,6 +317,13 @@ public:
virtual unsigned int GetCount() const;
virtual wxString GetString(unsigned int n) const;
virtual void SetString(unsigned int n, const wxString& string);
/**
Returns the index of the selected item.
As radio boxes always have a selected item, the return value is never
@c wxNOT_FOUND for this class.
*/
virtual int GetSelection() const;
};