aboutsummaryrefslogtreecommitdiffstats
path: root/src/ivicore/qiviabstractfeaturelistmodel.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/ivicore/qiviabstractfeaturelistmodel.cpp')
-rw-r--r--src/ivicore/qiviabstractfeaturelistmodel.cpp31
1 files changed, 22 insertions, 9 deletions
diff --git a/src/ivicore/qiviabstractfeaturelistmodel.cpp b/src/ivicore/qiviabstractfeaturelistmodel.cpp
index 9316286..77a7fb0 100644
--- a/src/ivicore/qiviabstractfeaturelistmodel.cpp
+++ b/src/ivicore/qiviabstractfeaturelistmodel.cpp
@@ -125,14 +125,26 @@ QIviFeatureInterface *QIviAbstractFeatureListModelPrivate::backend() const
\inmodule QtIviCore
\brief The QIviAbstractFeatureListModel is the base class for QtIvi Features which should act as a model.
- See QIviAbstractFeature for more details on how a Feature works. This base class is needed to avoid a diamond
- inheritance from QAbstractListModel and QIviAbstractFeature.
+ This base class is necessary to avoid virtual inheritance from QAbstractListModel and
+ QIviAbstractFeature.
- See the \l{Models} section for more information about all models in QtIvi.
+ For more details on how a Feature works, see QIviAbstractFeature.
+ For more information about models in QtIvi, see \l{Models}.
\section1 Subclassing
- //TODO add docs here.
+ Your QIviAbstractFeatureListModel subclass must provide implementations for all virtual
+ functions from QIviAbstractFeature as well as the virtual functions from QAbstractListModel.
+
+ \list
+ \li For more details on how to integrate with the \l{Dynamic Backend System}, see
+ \l{QIviAbstractFeature::Write a Subclass}{QIviAbstractFeature}.
+ \li For more details on what you need to do to provide the model's required
+ functionality, see \l{QAbstractListModel - Subclassing}.
+ \li For a class that implements all the necessary QIviAbstractFeatureListModel functions
+ to provide pagination functionality, see QIviPagingModel.
+ \endlist
+
*/
/*!
@@ -142,13 +154,14 @@ QIviFeatureInterface *QIviAbstractFeatureListModelPrivate::backend() const
\brief The QIviAbstractFeatureListModel is the base class for QtIvi Features which should act as a model.
- See QIviAbstractFeature for more details on how a Feature works. This base class is needed to avoid a diamond
- inheritance from QAbstractListModel and QIviAbstractFeature.
+ This base class is necessary to avoid virtual inheritance from QAbstractListModel and
+ QIviAbstractFeature.
- This element is not directly accessible from QML. It provides the
- base QML properties for the feature, like autoDiscovery and isValid.
+ This element is not directly accessible from QML. It provides the base QML properties for the
+ feature, like autoDiscovery and isValid.
- See the \l{Models} section for more information about all models in QtIvi.
+ For more details on how a Feature works, see QIviAbstractFeature.
+ For more information about models in QtIvi, see \l{Models}.
\sa AbstractFeature
*/