QStringListModel Class
The QStringListModel class provides a model that supplies strings to views. More...
| Header: | #include <QStringListModel> |
| CMake: | find_package(Qt6 COMPONENTS Core REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Core) |
| qmake: | QT += core |
| Inherits: | QAbstractListModel |
| Inherited By: |
Public Functions
| QStringListModel(const QStringList &strings, QObject *parent = nullptr) | |
| QStringListModel(QObject *parent = nullptr) | |
| void | setStringList(const QStringList &strings) |
| QStringList | stringList() const |
Reimplemented Public Functions
| virtual bool | clearItemData(const QModelIndex &index) override |
| virtual QVariant | data(const QModelIndex &index, int role = Qt::DisplayRole) const override |
| virtual Qt::ItemFlags | flags(const QModelIndex &index) const override |
| virtual bool | insertRows(int row, int count, const QModelIndex &parent = QModelIndex()) override |
| virtual QMap<int, QVariant> | itemData(const QModelIndex &index) const override |
| virtual bool | moveRows(const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationChild) override |
| virtual bool | removeRows(int row, int count, const QModelIndex &parent = QModelIndex()) override |
| virtual int | rowCount(const QModelIndex &parent = QModelIndex()) const override |
| virtual bool | setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole) override |
| virtual bool | setItemData(const QModelIndex &index, const QMap<int, QVariant> &roles) override |
| virtual QModelIndex | sibling(int row, int column, const QModelIndex &idx) const override |
| virtual void | sort(int column, Qt::SortOrder order = Qt::AscendingOrder) override |
| virtual Qt::DropActions | supportedDropActions() const override |
Detailed Description
QStringListModel is an editable model that can be used for simple cases where you need to display a number of strings in a view widget, such as a QListView or a QComboBox.
The model provides all the standard functions of an editable model, representing the data in the string list as a model with one column and a number of rows equal to the number of items in the list.
Model indexes corresponding to items are obtained with the index() function, and item flags are obtained with flags(). Item data is read with the data() function and written with setData(). The number of rows (and number of items in the string list) can be found with the rowCount() function.
The model can be constructed with an existing string list, or strings can be set later with the setStringList() convenience function. Strings can also be inserted in the usual way with the insertRows() function, and removed with removeRows(). The contents of the string list can be retrieved with the stringList() convenience function.
An example usage of QStringListModel:
QStringListModel *model = new QStringListModel();
QStringList list;
list << "a" << "b" << "c";
model->setStringList(list);
See also QAbstractListModel, QAbstractItemModel, and Model Classes.
Member Function Documentation
QStringListModel::QStringListModel(const QStringList &strings, QObject *parent = nullptr)
Constructs a string list model containing the specified strings with the given parent.
QStringListModel::QStringListModel(QObject *parent = nullptr)
Constructs a string list model with the given parent.
[override virtual, since 6.0] bool QStringListModel::clearItemData(const QModelIndex &index)
Reimplements: QAbstractItemModel::clearItemData(const QModelIndex &index).
This function was introduced in Qt 6.0.
[override virtual] QVariant QStringListModel::data(const QModelIndex &index, int role = Qt::DisplayRole) const
Reimplements: QAbstractItemModel::data(const QModelIndex &index, int role) const.
Returns data for the specified role, from the item with the given index.
If the view requests an invalid index, an invalid variant is returned.
See also setData().
[override virtual] Qt::ItemFlags QStringListModel::flags(const QModelIndex &index) const
Reimplements: QAbstractListModel::flags(const QModelIndex &index) const.
Returns the flags for the item with the given index.
Valid items are enabled, selectable, editable, drag enabled and drop enabled.
See also QAbstractItemModel::flags().
[override virtual] bool QStringListModel::insertRows(int row, int count, const QModelIndex &parent = QModelIndex())
Reimplements: QAbstractItemModel::insertRows(int row, int count, const QModelIndex &parent).
Inserts count rows into the model, beginning at the given row.
The parent index of the rows is optional and is only used for consistency with QAbstractItemModel. By default, a null index is specified, indicating that the rows are inserted in the top level of the model.
Returns true if the insertion was successful.
See also QAbstractItemModel::insertRows().
[override virtual, since 5.13] QMap<int, QVariant> QStringListModel::itemData(const QModelIndex &index) const
Reimplements: QAbstractItemModel::itemData(const QModelIndex &index) const.
This function was introduced in Qt 5.13.
See also setItemData().
[override virtual, since 5.13] bool QStringListModel::moveRows(const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationChild)
Reimplements: QAbstractItemModel::moveRows(const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationChild).
This function was introduced in Qt 5.13.
[override virtual] bool QStringListModel::removeRows(int row, int count, const QModelIndex &parent = QModelIndex())
Reimplements: QAbstractItemModel::removeRows(int row, int count, const QModelIndex &parent).
Removes count rows from the model, beginning at the given row.
The parent index of the rows is optional and is only used for consistency with QAbstractItemModel. By default, a null index is specified, indicating that the rows are removed in the top level of the model.
Returns true if the row removal was successful.
See also QAbstractItemModel::removeRows().
[override virtual] int QStringListModel::rowCount(const QModelIndex &parent = QModelIndex()) const
Reimplements: QAbstractItemModel::rowCount(const QModelIndex &parent) const.
Returns the number of rows in the model. This value corresponds to the number of items in the model's internal string list.
The optional parent argument is in most models used to specify the parent of the rows to be counted. Because this is a list if a valid parent is specified, the result will always be 0.
See also insertRows(), removeRows(), and QAbstractItemModel::rowCount().
[override virtual] bool QStringListModel::setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole)
Reimplements: QAbstractItemModel::setData(const QModelIndex &index, const QVariant &value, int role).
Sets the data for the specified role in the item with the given index in the model, to the provided value.
The dataChanged() signal is emitted if the item is changed. Returns true after emitting the dataChanged() signal.
See also Qt::ItemDataRole and data().
[override virtual, since 5.13] bool QStringListModel::setItemData(const QModelIndex &index, const QMap<int, QVariant> &roles)
Reimplements: QAbstractItemModel::setItemData(const QModelIndex &index, const QMap<int, QVariant> &roles).
If roles contains both Qt::DisplayRole and Qt::EditRole, the latter will take precedence
This function was introduced in Qt 5.13.
See also itemData().
void QStringListModel::setStringList(const QStringList &strings)
Sets the model's internal string list to strings. The model will notify any attached views that its underlying data has changed.
See also stringList() and dataChanged().
[override virtual] QModelIndex QStringListModel::sibling(int row, int column, const QModelIndex &idx) const
Reimplements: QAbstractListModel::sibling(int row, int column, const QModelIndex &idx) const.
[override virtual] void QStringListModel::sort(int column, Qt::SortOrder order = Qt::AscendingOrder)
Reimplements: QAbstractItemModel::sort(int column, Qt::SortOrder order).
QStringList QStringListModel::stringList() const
Returns the string list used by the model to store data.
See also setStringList().
[override virtual] Qt::DropActions QStringListModel::supportedDropActions() const
Reimplements: QAbstractItemModel::supportedDropActions() const.