Document wxDataViewModelNotifier callbacks return values.

It doesn't make sense to return anything other than true here, as
failure from one of several notifiers cannot be handled sanely, so just
document that.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@69500 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Václav Slavík 2011-10-21 16:51:00 +00:00
parent 60d6c7fd37
commit 63e55c0ae6

View File

@ -1268,34 +1268,46 @@ public:
/** /**
Called by owning model. Called by owning model.
@return Always return @true from this function in derived classes.
*/ */
virtual bool ItemAdded(const wxDataViewItem& parent, virtual bool ItemAdded(const wxDataViewItem& parent,
const wxDataViewItem& item) = 0; const wxDataViewItem& item) = 0;
/** /**
Called by owning model. Called by owning model.
@return Always return @true from this function in derived classes.
*/ */
virtual bool ItemChanged(const wxDataViewItem& item) = 0; virtual bool ItemChanged(const wxDataViewItem& item) = 0;
/** /**
Called by owning model. Called by owning model.
@return Always return @true from this function in derived classes.
*/ */
virtual bool ItemDeleted(const wxDataViewItem& parent, virtual bool ItemDeleted(const wxDataViewItem& parent,
const wxDataViewItem& item) = 0; const wxDataViewItem& item) = 0;
/** /**
Called by owning model. Called by owning model.
@return Always return @true from this function in derived classes.
*/ */
virtual bool ItemsAdded(const wxDataViewItem& parent, virtual bool ItemsAdded(const wxDataViewItem& parent,
const wxDataViewItemArray& items); const wxDataViewItemArray& items);
/** /**
Called by owning model. Called by owning model.
@return Always return @true from this function in derived classes.
*/ */
virtual bool ItemsChanged(const wxDataViewItemArray& items); virtual bool ItemsChanged(const wxDataViewItemArray& items);
/** /**
Called by owning model. Called by owning model.
@return Always return @true from this function in derived classes.
*/ */
virtual bool ItemsDeleted(const wxDataViewItem& parent, virtual bool ItemsDeleted(const wxDataViewItem& parent,
const wxDataViewItemArray& items); const wxDataViewItemArray& items);
@ -1312,6 +1324,8 @@ public:
/** /**
Called by owning model. Called by owning model.
@return Always return @true from this function in derived classes.
*/ */
virtual bool ValueChanged(const wxDataViewItem& item, unsigned int col) = 0; virtual bool ValueChanged(const wxDataViewItem& item, unsigned int col) = 0;
}; };