diff options
author | Stephen Kelly <stephen.kelly@kdab.com> | 2012-08-16 14:55:29 +0200 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-08-20 21:10:02 +0200 |
commit | eb0e960e74da6b799c4d8f95cb6a22412c4c9466 (patch) | |
tree | d5e2240655eb2e2755c76aba06e1c064a9ae3266 /src/corelib/itemmodels | |
parent | fe0a6e57a045b9db7ad812025ed65a6ba011c68d (diff) |
Fix the doc errors in itemmodels and itemviews.
Other errors remain, but they appear to be due to missing links
to QtCore documentation (a generic error not specific to itemviews).
Change-Id: I7b83380c3754c26d3d42be9ef0c0721ce3127562
Reviewed-by: Shawn Rutledge <shawn.rutledge@nokia.com>
Reviewed-by: Stephen Kelly <stephen.kelly@kdab.com>
Diffstat (limited to 'src/corelib/itemmodels')
-rw-r--r-- | src/corelib/itemmodels/qabstractitemmodel.cpp | 36 | ||||
-rw-r--r-- | src/corelib/itemmodels/qabstractproxymodel.cpp | 6 | ||||
-rw-r--r-- | src/corelib/itemmodels/qitemselectionmodel.cpp | 12 |
3 files changed, 51 insertions, 3 deletions
diff --git a/src/corelib/itemmodels/qabstractitemmodel.cpp b/src/corelib/itemmodels/qabstractitemmodel.cpp index 9a630383b7..4b82b2bb8e 100644 --- a/src/corelib/itemmodels/qabstractitemmodel.cpp +++ b/src/corelib/itemmodels/qabstractitemmodel.cpp @@ -1276,6 +1276,31 @@ void QAbstractItemModelPrivate::columnsRemoved(const QModelIndex &parent, */ /*! + \fn bool QAbstractItemModel::moveRow(const QModelIndex &sourceParent, int sourceColumn, const QModelIndex &destinationParent, int destinationChild) + + On models that support this, moves \a sourceColumn from \a sourceParent to \a destinationChild under + \a destinationParent. + + Returns true if the columns were successfully moved; otherwise returns + false. + + \sa moveRows(), moveColumn() +*/ + +/*! + \fn bool QAbstractItemModel::moveColumn(const QModelIndex &sourceParent, int sourceColumn, const QModelIndex &destinationParent, int destinationChild) + + On models that support this, moves \a sourceColumn from \a sourceParent to \a destinationChild under + \a destinationParent. + + Returns true if the columns were successfully moved; otherwise returns + false. + + \sa moveColumns(), moveRow() +*/ + + +/*! \fn void QAbstractItemModel::headerDataChanged(Qt::Orientation orientation, int first, int last) This signal is emitted whenever a header is changed. The \a orientation @@ -1303,7 +1328,7 @@ void QAbstractItemModelPrivate::columnsRemoved(const QModelIndex &parent, Subclasses should update any persistent model indexes after emitting layoutAboutToBeChanged(). - The optional @p parents parameter is used to give a more specific notification + The optional \a parents parameter is used to give a more specific notification about what parts of the layout of the model are changing. An empty list indicates a change to the layout of the entire model. @@ -1323,7 +1348,7 @@ void QAbstractItemModelPrivate::columnsRemoved(const QModelIndex &parent, altering the structure of the data you expose to views, and emit layoutChanged() after changing the layout. - The optional @p parents parameter is used to give a more specific notification + The optional \a parents parameter is used to give a more specific notification about what parts of the layout of the model are changing. An empty list indicates a change to the layout of the entire model. @@ -1746,7 +1771,8 @@ QMimeData *QAbstractItemModel::mimeData(const QModelIndexList &indexes) const This can be used to indicate whether a drop of certain data is allowed, for example by using a 'forbidden' emblem on a mouse cursor during a drag operation. - This method returns true by default. + This method returns true by default. Reimplementations can return whether the + \a data can be dropped at \a row, \a column, \a parent with \a action. \sa dropMimeData(), {Using drag and drop with item views} */ @@ -3501,6 +3527,10 @@ bool QAbstractListModel::dropMimeData(const QMimeData *data, Qt::DropAction acti Returns true if this model index is smaller than the \a other model index; otherwise returns false. + + The less than calculation is not directly useful to developers - the way that indexes + with different parents compare is not defined. This operator only exists so that the + class can be used with QMap. */ /*! diff --git a/src/corelib/itemmodels/qabstractproxymodel.cpp b/src/corelib/itemmodels/qabstractproxymodel.cpp index 063bb0de8c..61ad3b0f71 100644 --- a/src/corelib/itemmodels/qabstractproxymodel.cpp +++ b/src/corelib/itemmodels/qabstractproxymodel.cpp @@ -82,6 +82,12 @@ QT_BEGIN_NAMESPACE \sa QSortFilterProxyModel, QAbstractItemModel, {Model/View Programming} */ +/*! + \property QAbstractProxyModel::sourceModel + + \brief the source model this proxy model. +*/ + //detects the deletion of the source model void QAbstractProxyModelPrivate::_q_sourceModelDestroyed() { diff --git a/src/corelib/itemmodels/qitemselectionmodel.cpp b/src/corelib/itemmodels/qitemselectionmodel.cpp index a7aa404f8c..f5bfff083e 100644 --- a/src/corelib/itemmodels/qitemselectionmodel.cpp +++ b/src/corelib/itemmodels/qitemselectionmodel.cpp @@ -266,6 +266,18 @@ QItemSelectionRange QItemSelectionRange::intersected(const QItemSelectionRange & */ /*! + \fn bool QItemSelectionRange::operator<(const QItemSelectionRange &other) const + + Returns true if the selection range is less than the \a other + range given; otherwise returns false. + + The less than calculation is not directly useful to developers - the way that ranges + with different parents compare is not defined. This operator only exists so that the + class can be used with QMap. + +*/ + +/*! \fn bool QItemSelectionRange::isValid() const Returns true if the selection range is valid; otherwise returns false. |