123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372 | // Copyright (C) 2016 The Qt Company Ltd.// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only/* A simple model that uses a QStringList as its data source.*/#include"qstringlistmodel.h"#include <QtCore/qlist.h>#include <QtCore/qmap.h>#include <algorithm> QT_BEGIN_NAMESPACE /*! \class QStringListModel \inmodule QtCore \brief The QStringListModel class provides a model that supplies strings to views. \ingroup model-view 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 \l{QAbstractListModel::index()}{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: \snippet qstringlistmodel/main.cpp 0 \sa QAbstractListModel, QAbstractItemModel, {Model Classes}*//*! Constructs a string list model with the given \a parent.*/QStringListModel::QStringListModel(QObject *parent):QAbstractListModel(parent){}/*! Constructs a string list model containing the specified \a strings with the given \a parent.*/QStringListModel::QStringListModel(const QStringList &strings, QObject *parent):QAbstractListModel(parent),lst(strings){}/*! 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 \a 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. \sa insertRows(), removeRows(), QAbstractItemModel::rowCount()*/intQStringListModel::rowCount(const QModelIndex &parent)const{if(parent.isValid())return0;return lst.size();}/*! \reimp*/ QModelIndex QStringListModel::sibling(int row,int column,const QModelIndex &idx)const{if(!idx.isValid() || column !=0|| row >= lst.size() || row <0)returnQModelIndex();returncreateIndex(row,0);}/*! \reimp \since 5.13*/ QMap<int, QVariant>QStringListModel::itemData(const QModelIndex &index)const{if(!checkIndex(index,CheckIndexOption::IndexIsValid |CheckIndexOption::ParentIsInvalid))return QMap<int, QVariant>{};const QVariant displayData = lst.at(index.row());return QMap<int, QVariant>{{std::make_pair<int>(Qt::DisplayRole, displayData),std::make_pair<int>(Qt::EditRole, displayData)}};}/*! \reimp \since 5.13 If \a roles contains both Qt::DisplayRole and Qt::EditRole, the latter will take precedence*/boolQStringListModel::setItemData(const QModelIndex &index,const QMap<int, QVariant> &roles){if(roles.isEmpty())return false;if(std::any_of(roles.keyBegin(), roles.keyEnd(), [](int role) ->bool{return role !=Qt::DisplayRole && role !=Qt::EditRole;})) {return false;}auto roleIter = roles.constFind(Qt::EditRole);if(roleIter == roles.constEnd()) roleIter = roles.constFind(Qt::DisplayRole);Q_ASSERT(roleIter != roles.constEnd());returnsetData(index, roleIter.value(), roleIter.key());}/*! Returns data for the specified \a role, from the item with the given \a index. If the view requests an invalid index, an invalid variant is returned. \sa setData()*/ QVariant QStringListModel::data(const QModelIndex &index,int role)const{if(index.row() <0|| index.row() >= lst.size())returnQVariant();if(role ==Qt::DisplayRole || role ==Qt::EditRole)return lst.at(index.row());returnQVariant();}/*! Returns the flags for the item with the given \a index. Valid items are enabled, selectable, editable, drag enabled and drop enabled. \sa QAbstractItemModel::flags()*/Qt::ItemFlags QStringListModel::flags(const QModelIndex &index)const{if(!index.isValid())returnQAbstractListModel::flags(index) |Qt::ItemIsDropEnabled;returnQAbstractListModel::flags(index) |Qt::ItemIsEditable |Qt::ItemIsDragEnabled |Qt::ItemIsDropEnabled;}/*! Sets the data for the specified \a role in the item with the given \a index in the model, to the provided \a value. The dataChanged() signal is emitted if the item is changed. Returns \c true after emitting the dataChanged() signal. \sa Qt::ItemDataRole, data()*/boolQStringListModel::setData(const QModelIndex &index,const QVariant &value,int role){if(index.row() >=0&& index.row() < lst.size()&& (role ==Qt::EditRole || role ==Qt::DisplayRole)) {const QString valueString = value.toString();if(lst.at(index.row()) == valueString)return true; lst.replace(index.row(), valueString); emit dataChanged(index, index, {Qt::DisplayRole,Qt::EditRole});return true;}return false;}/*! \reimp \since 6.0 */boolQStringListModel::clearItemData(const QModelIndex &index){returnsetData(index,QVariant(),Qt::EditRole);}/*! Inserts \a count rows into the model, beginning at the given \a row. The \a 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 \c true if the insertion was successful. \sa QAbstractItemModel::insertRows()*/boolQStringListModel::insertRows(int row,int count,const QModelIndex &parent){if(count <1|| row <0|| row >rowCount(parent))return false;beginInsertRows(QModelIndex(), row, row + count -1);for(int r =0; r < count; ++r) lst.insert(row,QString());endInsertRows();return true;}/*! Removes \a count rows from the model, beginning at the given \a row. The \a 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 \c true if the row removal was successful. \sa QAbstractItemModel::removeRows()*/boolQStringListModel::removeRows(int row,int count,const QModelIndex &parent){if(count <=0|| row <0|| (row + count) >rowCount(parent))return false;beginRemoveRows(QModelIndex(), row, row + count -1);constauto it = lst.begin() + row; lst.erase(it, it + count);endRemoveRows();return true;}/*! \since 5.13 \reimp*/boolQStringListModel::moveRows(const QModelIndex &sourceParent,int sourceRow,int count,const QModelIndex &destinationParent,int destinationChild){if(sourceRow <0|| sourceRow + count -1>=rowCount(sourceParent)|| destinationChild <0|| destinationChild >rowCount(destinationParent)|| sourceRow == destinationChild || sourceRow == destinationChild -1|| count <=0|| sourceParent.isValid()|| destinationParent.isValid()) {return false;}if(!beginMoveRows(QModelIndex(), sourceRow, sourceRow + count -1,QModelIndex(), destinationChild))return false;int fromRow = sourceRow;if(destinationChild < sourceRow) fromRow += count -1;else destinationChild--;while(count--) lst.move(fromRow, destinationChild);endMoveRows();return true;}static boolascendingLessThan(conststd::pair<QString,int> &s1,conststd::pair<QString,int> &s2){return s1.first < s2.first;}static booldecendingLessThan(conststd::pair<QString,int> &s1,conststd::pair<QString,int> &s2){return s1.first > s2.first;}/*! \reimp*/voidQStringListModel::sort(int,Qt::SortOrder order){ emit layoutAboutToBeChanged(QList<QPersistentModelIndex>(), VerticalSortHint); QList<std::pair<QString,int>> list;const int lstCount = lst.size(); list.reserve(lstCount);for(int i =0; i < lstCount; ++i) list.emplace_back(lst.at(i), i);if(order ==Qt::AscendingOrder)std::sort(list.begin(), list.end(), ascendingLessThan);elsestd::sort(list.begin(), list.end(), decendingLessThan); lst.clear(); QList<int>forwarding(lstCount);for(int i =0; i < lstCount; ++i) { lst.append(list.at(i).first); forwarding[list.at(i).second] = i;} QModelIndexList oldList =persistentIndexList(); QModelIndexList newList;const int numOldIndexes = oldList.size(); newList.reserve(numOldIndexes);for(int i =0; i < numOldIndexes; ++i) newList.append(index(forwarding.at(oldList.at(i).row()),0));changePersistentIndexList(oldList, newList); emit layoutChanged(QList<QPersistentModelIndex>(), VerticalSortHint);}/*! Returns the string list used by the model to store data.*/ QStringList QStringListModel::stringList()const{return lst;}/*! Sets the model's internal string list to \a strings. The model will notify any attached views that its underlying data has changed. \sa dataChanged()*/voidQStringListModel::setStringList(const QStringList &strings){beginResetModel(); lst = strings;endResetModel();}/*! \reimp*/Qt::DropActions QStringListModel::supportedDropActions()const{returnQAbstractItemModel::supportedDropActions() |Qt::MoveAction;} QT_END_NAMESPACE #include"moc_qstringlistmodel.cpp"
|
