diff options
author | Casper van Donderen <casper.vandonderen@nokia.com> | 2011-09-20 23:22:36 +0200 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2011-10-03 09:56:09 +0200 |
commit | e86df8cc4b6a522fac909687d48b269c7f5108b6 (patch) | |
tree | 3b3157049b3dabe3432052415237bf1c1765c89b /src/widgets/itemviews | |
parent | 7f57f2912569cb6e728cc14afae71923f83ad663 (diff) |
Move the documentation for the classes to their modules.
All documented classes under src/widgets should now be
under the QtWidgets module in the documentation. The
QtPrintSupport classes should now be under the QtPrintSupport
module in the documentation.
Change-Id: I236b15443b8b93a61578a1d10f52b64dba938f29
Reviewed-on: http://codereview.qt-project.org/5520
Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
Diffstat (limited to 'src/widgets/itemviews')
24 files changed, 37 insertions, 12 deletions
diff --git a/src/widgets/itemviews/qabstractitemdelegate.cpp b/src/widgets/itemviews/qabstractitemdelegate.cpp index 34d3a25623..bdc5d69f56 100644 --- a/src/widgets/itemviews/qabstractitemdelegate.cpp +++ b/src/widgets/itemviews/qabstractitemdelegate.cpp @@ -61,7 +61,7 @@ QT_BEGIN_NAMESPACE data items from a model. \ingroup model-view - + \inmodule QtWidgets A QAbstractItemDelegate provides the interface and common functionality for delegates in the model/view architecture. Delegates display diff --git a/src/widgets/itemviews/qabstractitemview.cpp b/src/widgets/itemviews/qabstractitemview.cpp index d6fbb7c953..115dd24e2f 100644 --- a/src/widgets/itemviews/qabstractitemview.cpp +++ b/src/widgets/itemviews/qabstractitemview.cpp @@ -237,7 +237,7 @@ void QAbstractItemViewPrivate::_q_scrollerStateChanged() item view classes. \ingroup model-view - + \inmodule QtWidgets QAbstractItemView class is the base class for every standard view that uses a QAbstractItemModel. QAbstractItemView is an abstract diff --git a/src/widgets/itemviews/qabstractproxymodel.cpp b/src/widgets/itemviews/qabstractproxymodel.cpp index 48c84acb56..47810d6cc7 100644 --- a/src/widgets/itemviews/qabstractproxymodel.cpp +++ b/src/widgets/itemviews/qabstractproxymodel.cpp @@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE \brief The QAbstractProxyModel class provides a base class for proxy item models that can do sorting, filtering or other data processing tasks. \ingroup model-view + \inmodule QtWidgets This class defines the standard interface that proxy models must use to be able to interoperate correctly with other model/view components. It is not diff --git a/src/widgets/itemviews/qcolumnview.cpp b/src/widgets/itemviews/qcolumnview.cpp index 2be03a0fe8..3b4bcae847 100644 --- a/src/widgets/itemviews/qcolumnview.cpp +++ b/src/widgets/itemviews/qcolumnview.cpp @@ -63,7 +63,7 @@ QT_BEGIN_NAMESPACE \brief The QColumnView class provides a model/view implementation of a column view. \ingroup model-view \ingroup advanced - + \inmodule QtWidgets QColumnView displays a model in a number of QListViews, one for each hierarchy in the tree. This is sometimes referred to as a cascading list. diff --git a/src/widgets/itemviews/qdatawidgetmapper.cpp b/src/widgets/itemviews/qdatawidgetmapper.cpp index 7d328fcce5..8f5203936d 100644 --- a/src/widgets/itemviews/qdatawidgetmapper.cpp +++ b/src/widgets/itemviews/qdatawidgetmapper.cpp @@ -258,6 +258,7 @@ void QDataWidgetMapperPrivate::_q_modelDestroyed() \since 4.2 \ingroup model-view \ingroup advanced + \inmodule QtWidgets QDataWidgetMapper can be used to create data-aware widgets by mapping them to sections of an item model. A section is a column of a model diff --git a/src/widgets/itemviews/qdirmodel.cpp b/src/widgets/itemviews/qdirmodel.cpp index fd9f0f748a..c80662414a 100644 --- a/src/widgets/itemviews/qdirmodel.cpp +++ b/src/widgets/itemviews/qdirmodel.cpp @@ -189,6 +189,7 @@ void QDirModelPrivate::invalidate() \brief The QDirModel class provides a data model for the local filesystem. \ingroup model-view + \inmodule QtWidgets The usage of QDirModel is not recommended anymore. The QFileSystemModel class is a more performant alternative. diff --git a/src/widgets/itemviews/qfileiconprovider.cpp b/src/widgets/itemviews/qfileiconprovider.cpp index 84081c5439..d4dd9e8ff6 100644 --- a/src/widgets/itemviews/qfileiconprovider.cpp +++ b/src/widgets/itemviews/qfileiconprovider.cpp @@ -73,6 +73,8 @@ QT_BEGIN_NAMESPACE /*! \class QFileIconProvider + \inmodule QtWidgets + \brief The QFileIconProvider class provides file icons for the QDirModel and the QFileSystemModel classes. */ diff --git a/src/widgets/itemviews/qheaderview.cpp b/src/widgets/itemviews/qheaderview.cpp index 8b3c6e80f7..aee39a5ea1 100644 --- a/src/widgets/itemviews/qheaderview.cpp +++ b/src/widgets/itemviews/qheaderview.cpp @@ -88,7 +88,7 @@ QDataStream &operator>>(QDataStream &in, QHeaderViewPrivate::SectionSpan &span) item views. \ingroup model-view - + \inmodule QtWidgets A QHeaderView displays the headers used in item views such as the QTableView and QTreeView classes. It takes the place of Qt3's \c QHeader diff --git a/src/widgets/itemviews/qidentityproxymodel.cpp b/src/widgets/itemviews/qidentityproxymodel.cpp index ee36b8319f..5893d1ba38 100644 --- a/src/widgets/itemviews/qidentityproxymodel.cpp +++ b/src/widgets/itemviews/qidentityproxymodel.cpp @@ -94,6 +94,7 @@ class QIdentityProxyModelPrivate : public QAbstractProxyModelPrivate \brief The QIdentityProxyModel class proxies its source model unmodified \ingroup model-view + \inmodule QtWidgets QIdentityProxyModel can be used to forward the structure of a source model exactly, with no sorting, filtering or other transformation. This is similar in concept to an identity matrix where A.I = A. diff --git a/src/widgets/itemviews/qitemdelegate.cpp b/src/widgets/itemviews/qitemdelegate.cpp index a2da62ac83..72f358ce68 100644 --- a/src/widgets/itemviews/qitemdelegate.cpp +++ b/src/widgets/itemviews/qitemdelegate.cpp @@ -186,7 +186,7 @@ QSizeF QItemDelegatePrivate::doTextLayout(int lineWidth) const data items from a model. \ingroup model-view - + \inmodule QtWidgets QItemDelegate can be used to provide custom display features and editor widgets for item views based on QAbstractItemView subclasses. Using a diff --git a/src/widgets/itemviews/qitemeditorfactory.cpp b/src/widgets/itemviews/qitemeditorfactory.cpp index cc9d1399bf..7ff3622ec4 100644 --- a/src/widgets/itemviews/qitemeditorfactory.cpp +++ b/src/widgets/itemviews/qitemeditorfactory.cpp @@ -79,6 +79,7 @@ public: in views and delegates. \since 4.2 \ingroup model-view + \inmodule QtWidgets When editing data in an item view, editors are created and displayed by a delegate. QItemDelegate, which is the delegate by @@ -324,6 +325,7 @@ void QItemEditorFactory::setDefaultFactory(QItemEditorFactory *factory) must be subclassed when implementing new item editor creators. \since 4.2 \ingroup model-view + \inmodule QtWidgets QItemEditorCreatorBase objects are specialized widget factories that provide editor widgets for one particular QVariant data type. They @@ -396,6 +398,7 @@ void QItemEditorFactory::setDefaultFactory(QItemEditorFactory *factory) \since 4.2 \ingroup model-view + \inmodule QtWidgets QItemEditorCreator is a convenience template class. It uses the template class to create editors for QItemEditorFactory. @@ -446,6 +449,7 @@ void QItemEditorFactory::setDefaultFactory(QItemEditorFactory *factory) \since 4.2 \ingroup model-view + \inmodule QtWidgets This convenience template class makes it possible to register widgets without having to subclass QItemEditorCreatorBase. diff --git a/src/widgets/itemviews/qitemselectionmodel.cpp b/src/widgets/itemviews/qitemselectionmodel.cpp index 0d0b5b1d42..423a5802c2 100644 --- a/src/widgets/itemviews/qitemselectionmodel.cpp +++ b/src/widgets/itemviews/qitemselectionmodel.cpp @@ -54,6 +54,7 @@ QT_BEGIN_NAMESPACE range of selected items in a model. \ingroup model-view + \inmodule QtWidgets A QItemSelectionRange contains information about a range of selected items in a model. A range of items is a contiguous array @@ -330,6 +331,7 @@ QModelIndexList QItemSelectionRange::indexes() const \brief The QItemSelection class manages information about selected items in a model. \ingroup model-view + \inmodule QtWidgets A QItemSelection describes the items in a model that have been selected by the user. A QItemSelection is basically a list of @@ -911,6 +913,7 @@ void QItemSelectionModelPrivate::_q_layoutChanged() \brief The QItemSelectionModel class keeps track of a view's selected items. \ingroup model-view + \inmodule QtWidgets A QItemSelectionModel keeps track of the selected items in a view, or in several views onto the same model. It also keeps track of the diff --git a/src/widgets/itemviews/qlistview.cpp b/src/widgets/itemviews/qlistview.cpp index 0b1c2d5673..ee20d8880b 100644 --- a/src/widgets/itemviews/qlistview.cpp +++ b/src/widgets/itemviews/qlistview.cpp @@ -67,7 +67,7 @@ QT_BEGIN_NAMESPACE \ingroup model-view \ingroup advanced - + \inmodule QtWidgets A QListView presents items stored in a model, either as a simple non-hierarchical list, or as a collection of icons. This class is used diff --git a/src/widgets/itemviews/qlistwidget.cpp b/src/widgets/itemviews/qlistwidget.cpp index 63badec3be..a4aaa6b4b6 100644 --- a/src/widgets/itemviews/qlistwidget.cpp +++ b/src/widgets/itemviews/qlistwidget.cpp @@ -461,6 +461,7 @@ Qt::DropActions QListModel::supportedDropActions() const QListWidget item view class. \ingroup model-view + \inmodule QtWidgets A QListWidgetItem represents a single item in a QListWidget. Each item can hold several pieces of information, and will display them appropriately. @@ -1140,7 +1141,7 @@ void QListWidgetPrivate::_q_dataChanged(const QModelIndex &topLeft, \brief The QListWidget class provides an item-based list widget. \ingroup model-view - + \inmodule QtWidgets QListWidget is a convenience class that provides a list view similar to the one supplied by QListView, but with a classic item-based interface for diff --git a/src/widgets/itemviews/qproxymodel.cpp b/src/widgets/itemviews/qproxymodel.cpp index 7042f7d0a6..bc76bf1623 100644 --- a/src/widgets/itemviews/qproxymodel.cpp +++ b/src/widgets/itemviews/qproxymodel.cpp @@ -55,6 +55,7 @@ QT_BEGIN_NAMESPACE passed between another model and a view. \ingroup model-view + \inmodule QtWidgets If you want to do filtering and sorting, see QSortFilterProxyModel. diff --git a/src/widgets/itemviews/qsortfilterproxymodel.cpp b/src/widgets/itemviews/qsortfilterproxymodel.cpp index b749286abe..4810d6e0fe 100644 --- a/src/widgets/itemviews/qsortfilterproxymodel.cpp +++ b/src/widgets/itemviews/qsortfilterproxymodel.cpp @@ -1360,6 +1360,7 @@ void QSortFilterProxyModelPrivate::_q_sourceColumnsRemoved( filtering data passed between another model and a view. \ingroup model-view + \inmodule QtWidgets QSortFilterProxyModel can be used for sorting items, filtering out items, or both. The model transforms the structure of a source model by mapping diff --git a/src/widgets/itemviews/qstandarditemmodel.cpp b/src/widgets/itemviews/qstandarditemmodel.cpp index 1bd5e8861c..293420beb7 100644 --- a/src/widgets/itemviews/qstandarditemmodel.cpp +++ b/src/widgets/itemviews/qstandarditemmodel.cpp @@ -614,6 +614,7 @@ void QStandardItemModelPrivate::columnsRemoved(QStandardItem *parent, QStandardItemModel class. \since 4.2 \ingroup model-view + \inmodule QtWidgets Items usually contain text, icons, or checkboxes. @@ -1951,6 +1952,7 @@ QDataStream &operator<<(QDataStream &out, const QStandardItem &item) \class QStandardItemModel \brief The QStandardItemModel class provides a generic model for storing custom data. \ingroup model-view + \inmodule QtWidgets QStandardItemModel can be used as a repository for standard Qt data types. It is one of the \l {Model/View Classes} and is part diff --git a/src/widgets/itemviews/qstringlistmodel.cpp b/src/widgets/itemviews/qstringlistmodel.cpp index 367decc7d8..9faaca0dd4 100644 --- a/src/widgets/itemviews/qstringlistmodel.cpp +++ b/src/widgets/itemviews/qstringlistmodel.cpp @@ -54,7 +54,7 @@ QT_BEGIN_NAMESPACE \brief The QStringListModel class provides a model that supplies strings to views. \ingroup model-view - + \inmodule QtWidgets QStringListModel is an editable model that can be used for simple cases where you need to display a number of strings in a view diff --git a/src/widgets/itemviews/qstyleditemdelegate.cpp b/src/widgets/itemviews/qstyleditemdelegate.cpp index 931d870acb..35d8d3d85b 100644 --- a/src/widgets/itemviews/qstyleditemdelegate.cpp +++ b/src/widgets/itemviews/qstyleditemdelegate.cpp @@ -112,6 +112,7 @@ public: data items from a model. \ingroup model-view + \inmodule QtWidgets \since 4.4 diff --git a/src/widgets/itemviews/qtableview.cpp b/src/widgets/itemviews/qtableview.cpp index 48731dbbe4..54aeddc78f 100644 --- a/src/widgets/itemviews/qtableview.cpp +++ b/src/widgets/itemviews/qtableview.cpp @@ -937,7 +937,7 @@ void QTableViewPrivate::drawCell(QPainter *painter, const QStyleOptionViewItemV4 \ingroup model-view \ingroup advanced - + \inmodule QtWidgets A QTableView implements a table view that displays items from a model. This class is used to provide standard tables that were diff --git a/src/widgets/itemviews/qtablewidget.cpp b/src/widgets/itemviews/qtablewidget.cpp index 3496327be1..6485fa503d 100644 --- a/src/widgets/itemviews/qtablewidget.cpp +++ b/src/widgets/itemviews/qtablewidget.cpp @@ -857,6 +857,7 @@ Qt::DropActions QTableModel::supportedDropActions() const selection in a model without using model indexes and a selection model. \ingroup model-view + \inmodule QtWidgets The QTableWidgetSelectionRange class stores the top left and bottom right rows and columns of a selection range in a table. The @@ -965,6 +966,7 @@ QTableWidgetSelectionRange::~QTableWidgetSelectionRange() QTableWidget class. \ingroup model-view + \inmodule QtWidgets Table items are used to hold pieces of information for table widgets. Items usually contain text, icons, or checkboxes @@ -1490,7 +1492,7 @@ QTableWidgetItem &QTableWidgetItem::operator=(const QTableWidgetItem &other) \brief The QTableWidget class provides an item-based table view with a default model. \ingroup model-view - + \inmodule QtWidgets Table widgets provide standard table display facilities for applications. The items in a QTableWidget are provided by QTableWidgetItem. diff --git a/src/widgets/itemviews/qtreeview.cpp b/src/widgets/itemviews/qtreeview.cpp index 5ff4f94c5a..25cb29ffd2 100644 --- a/src/widgets/itemviews/qtreeview.cpp +++ b/src/widgets/itemviews/qtreeview.cpp @@ -67,7 +67,7 @@ QT_BEGIN_NAMESPACE \ingroup model-view \ingroup advanced - + \inmodule QtWidgets A QTreeView implements a tree representation of items from a model. This class is used to provide standard hierarchical lists that diff --git a/src/widgets/itemviews/qtreewidget.cpp b/src/widgets/itemviews/qtreewidget.cpp index 5571732254..8c32e0ce87 100644 --- a/src/widgets/itemviews/qtreewidget.cpp +++ b/src/widgets/itemviews/qtreewidget.cpp @@ -75,6 +75,7 @@ public: \brief The QTreeModel class manages the items stored in a tree view. \ingroup model-view + \inmodule QtWidgets */ @@ -883,6 +884,7 @@ void QTreeModel::timerEvent(QTimerEvent *ev) QTreeWidget convenience class. \ingroup model-view + \inmodule QtWidgets Tree widget items are used to hold rows of information for tree widgets. Rows usually contain several columns of data, each of which can contain @@ -2337,7 +2339,7 @@ void QTreeWidgetPrivate::_q_dataChanged(const QModelIndex &topLeft, tree model. \ingroup model-view - + \inmodule QtWidgets The QTreeWidget class is a convenience class that provides a standard tree widget with a classic item-based interface similar to that used by diff --git a/src/widgets/itemviews/qtreewidgetitemiterator.cpp b/src/widgets/itemviews/qtreewidgetitemiterator.cpp index 579c5acdf6..f538917a09 100644 --- a/src/widgets/itemviews/qtreewidgetitemiterator.cpp +++ b/src/widgets/itemviews/qtreewidgetitemiterator.cpp @@ -51,6 +51,8 @@ QT_BEGIN_NAMESPACE /*! \class QTreeWidgetItemIterator \ingroup model-view + \inmodule QtWidgets + \brief The QTreeWidgetItemIterator class provides a way to iterate over the items in a QTreeWidget instance. |