QStringListModel Class

The QStringListModel class provides a model that supplies strings to views. More...

Header: #include <QStringListModel>
qmake: QT += core
Inherits: QAbstractListModel
Inherited By:

QHelpIndexModel

Public Functions

QStringListModel(QObject *parent = Q_NULLPTR)
QStringListModel(const QStringList &strings, QObject *parent = Q_NULLPTR)
void setStringList(const QStringList &strings)
QStringList stringList() const

Reimplemented Public Functions

virtual QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const
virtual Qt::ItemFlags flags(const QModelIndex &index) const
virtual bool insertRows(int row, int count, const QModelIndex &parent = QModelIndex())
virtual bool removeRows(int row, int count, const QModelIndex &parent = QModelIndex())
virtual int rowCount(const QModelIndex &parent = QModelIndex()) const
virtual bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole)
virtual QModelIndex sibling(int row, int column, const QModelIndex &idx) const
virtual void sort(int column, Qt::SortOrder order = Qt::AscendingOrder)
virtual Qt::DropActions supportedDropActions() const

Additional Inherited Members

Detailed Description

The QStringListModel class provides a model that supplies strings to views.

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(QObject *parent = Q_NULLPTR)

Constructs a string list model with the given parent.

QStringListModel::QStringListModel(const QStringList &strings, QObject *parent = Q_NULLPTR)

Constructs a string list model containing the specified strings with the given parent.

[virtual] QVariant QStringListModel::data(const QModelIndex &index, int role = Qt::DisplayRole) const

Reimplemented from QAbstractItemModel::data().

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().

[virtual] Qt::ItemFlags QStringListModel::flags(const QModelIndex &index) const

Reimplemented from QAbstractItemModel::flags().

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().

[virtual] bool QStringListModel::insertRows(int row, int count, const QModelIndex &parent = QModelIndex())

Reimplemented from QAbstractItemModel::insertRows().

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.

See also QAbstractItemModel::insertRows().

[virtual] bool QStringListModel::removeRows(int row, int count, const QModelIndex &parent = QModelIndex())

Reimplemented from QAbstractItemModel::removeRows().

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.

See also QAbstractItemModel::removeRows().

[virtual] int QStringListModel::rowCount(const QModelIndex &parent = QModelIndex()) const

Reimplemented from QAbstractItemModel::rowCount().

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().

[virtual] bool QStringListModel::setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole)

Reimplemented from QAbstractItemModel::setData().

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.

See also Qt::ItemDataRole and data().

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().

[virtual] QModelIndex QStringListModel::sibling(int row, int column, const QModelIndex &idx) const

Reimplemented from QAbstractItemModel::sibling().

[virtual] void QStringListModel::sort(int column, Qt::SortOrder order = Qt::AscendingOrder)

Reimplemented from QAbstractItemModel::sort().

QStringList QStringListModel::stringList() const

Returns the string list used by the model to store data.

See also setStringList().

[virtual] Qt::DropActions QStringListModel::supportedDropActions() const

Reimplemented from QAbstractItemModel::supportedDropActions().

© 2017 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.