The QAbstractListModel class provides an abstract model that can be subclassed to create one-dimensional list models. More...
|CMake:|| find_package(Qt6 COMPONENTS Core REQUIRED) |
target_link_libraries(mytarget PRIVATE Qt6::Core)
|qmake:||QT += core|
|virtual bool||dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override|
|virtual Qt::ItemFlags||flags(const QModelIndex &index) const override|
|virtual QModelIndex||index(int row, int column = 0, const QModelIndex &parent = QModelIndex()) const override|
|virtual QModelIndex||sibling(int row, int column, const QModelIndex &idx) const override|
QAbstractListModel provides a standard interface for models that represent their data as a simple non-hierarchical sequence of items. It is not used directly, but must be subclassed.
Since the model provides a more specialized interface than QAbstractItemModel, it is not suitable for use with tree views; you will need to subclass QAbstractItemModel if you want to provide a model for that purpose. If you need to use a number of list models to manage data, it may be more appropriate to subclass QAbstractTableModel instead.
Simple models can be created by subclassing this class and implementing the minimum number of required functions. For example, we could implement a simple read-only QStringList-based model that provides a list of strings to a QListView widget. In such a case, we only need to implement the rowCount() function to return the number of items in the list, and the data() function to retrieve items from the list.
Since the model represents a one-dimensional structure, the rowCount() function returns the total number of items in the model. The columnCount() function is implemented for interoperability with all kinds of views, but by default informs views that the model contains only one column.
If your model is used within QML and requires roles other than the default ones provided by the roleNames() function, you must override it.
Note that QAbstractListModel provides a default implementation of columnCount() that informs views that there is only a single column of items in this model.
Models that provide interfaces to resizable list-like data structures can provide implementations of insertRows() and removeRows(). When implementing these functions, it is important to call the appropriate functions so that all connected views are aware of any changes:
- An insertRows() implementation must call beginInsertRows() before inserting new rows into the data structure, and it must call endInsertRows() immediately afterwards.
- A removeRows() implementation must call beginRemoveRows() before the rows are removed from the data structure, and it must call endRemoveRows() immediately afterwards.
Note: Some general guidelines for subclassing models are available in the Model Subclassing Reference.
Member Function Documentation
QAbstractListModel::QAbstractListModel(QObject *parent = nullptr)
Constructs an abstract list model with the given parent.
Destroys the abstract list model.
[override virtual] bool QAbstractListModel::dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)
Reimplements: QAbstractItemModel::dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent).
[override virtual] Qt::ItemFlags QAbstractListModel::flags(const QModelIndex &index) const
Reimplements: QAbstractItemModel::flags(const QModelIndex &index) const.
[override virtual] QModelIndex QAbstractListModel::index(int row, int column = 0, const QModelIndex &parent = QModelIndex()) const
Returns the index of the data in row and column with parent.
See also parent().
[override virtual] QModelIndex QAbstractListModel::sibling(int row, int column, const QModelIndex &idx) const
© 2023 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.