Document wxDataViewChoiceByIndexRenderer.

At least briefly document this class too and not only its parent
wxDataViewChoiceRenderer one.

Closes #14265.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@71346 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin 2012-05-03 10:17:19 +00:00
parent 2ebef6d174
commit df8cd0bd5e

View File

@ -1690,12 +1690,15 @@ public:
/**
@class wxDataViewChoiceRenderer
A wxDataViewCtrl renderer using wxChoice control and values of strings in
it.
This class is used by wxDataViewCtrl to render choice controls.
It stores a string so that SetValue() and GetValue() operate
on a variant holding a string.
@see wxDataViewChoiceByIndexRenderer
@library{wxadv}
@category{dvc}
*/
@ -1714,7 +1717,7 @@ public:
Returns the choice referred to by index.
*/
wxString GetChoice(size_t index) const;
/**
Returns all choices.
*/
@ -1722,6 +1725,28 @@ public:
};
/**
A wxDataViewCtrl renderer using wxChoice control and indexes into it.
Unlike its base wxDataViewChoiceRenderer class, this one stores the choice
index, i.e. an @c int, in the variant used by its SetValue() and
GetValue().
@library{wxadv}
@category{dvc}
*/
class wxDataViewChoiceByIndexRenderer : public wxDataViewChoiceRenderer
{
public:
/**
The ctor.
*/
wxDataViewChoiceByIndexRenderer( const wxArrayString &choices,
wxDataViewCellMode mode = wxDATAVIEW_CELL_EDITABLE,
int alignment = wxDVR_DEFAULT_ALIGNMENT );
};
/**
@class wxDataViewDateRenderer