Document that index must be valid in wxChoice::GetString()
This is now the case in all ports, and not just in wxOSX, so document this behaviour and also document that it has changed compared to 3.0.
This commit is contained in:
parent
1ddf2ee303
commit
4a7b6d7e8f
@ -107,6 +107,8 @@ Changes in behaviour not resulting in compilation errors
|
||||
|
||||
- wxGetInstallPrefix() now returns wxString.
|
||||
|
||||
- wxChoice::GetString() now consistently asserts when passed an invalid index.
|
||||
|
||||
|
||||
Changes in behaviour which may result in build errors
|
||||
-----------------------------------------------------
|
||||
|
@ -51,11 +51,14 @@ public:
|
||||
/**
|
||||
Returns the label of the item with the given index.
|
||||
|
||||
The index must be valid, i.e. less than the value returned by
|
||||
GetCount(), otherwise an assert is triggered. Notably, this function
|
||||
can't be called if the control is empty.
|
||||
|
||||
@param n
|
||||
The zero-based index.
|
||||
|
||||
@return The label of the item or an empty string if the position was
|
||||
invalid.
|
||||
@return The label of the item.
|
||||
*/
|
||||
virtual wxString GetString(unsigned int n) const = 0;
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user