The QStringListModel class implements a model where the data is a list of strings. More...

Inheritance diagram for QStringListModel:

Public Methods
	QStringListModel (const QStringList &strings, QObject *parent=nullptr)

	QStringListModel (QObject *parent=nullptr)

QVariant	data (const QModelIndex &index, int role) const override

Qt::ItemFlags	flags (const QModelIndex &index) const override

bool	insertRows (int row, int count, const QModelIndex &parent=QModelIndex ()) override

bool	removeRows (int row, int count, const QModelIndex &parent=QModelIndex ()) override

int	rowCount (const QModelIndex &parent=QModelIndex ()) const override

bool	setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole) override

void	setStringList (const QStringList &strings)

QModelIndex	sibling (int row, int column, const QModelIndex &idx) const override

void	sort (int column, Qt::SortOrder order=Qt::AscendingOrder) override

QStringList	stringList () const

Qt::DropActions	supportedDropActions () const override

Public Methods inherited from QAbstractListModel
	QAbstractListModel (QObject *parent=nullptr)

	~QAbstractListModel ()

bool	dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override

QModelIndex	index (int row, int column=0, const QModelIndex &parent=QModelIndex ()) const override

QObject *	parent () const

Public Methods inherited from QAbstractItemModel
	QAbstractItemModel (QObject *parent=nullptr)

virtual	~QAbstractItemModel ()

virtual QModelIndex	buddy (const QModelIndex &index) const

virtual bool	canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const

virtual bool	canFetchMore (const QModelIndex &parent) const

virtual void	fetchMore (const QModelIndex &parent)

bool	hasIndex (int row, int column, const QModelIndex &parent=QModelIndex ()) const

virtual QVariant	headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const

bool	insertColumn (int column, const QModelIndex &parent=QModelIndex ())

virtual bool	insertColumns (int column, int count, const QModelIndex &parent=QModelIndex ())

bool	insertRow (int row, const QModelIndex &parent=QModelIndex ())

virtual QMap< int, QVariant >	itemData (const QModelIndex &index) const

virtual QModelIndexList	match (const QModelIndex &start, int role, const QVariant &value, int hits=1, Qt::MatchFlags flags=Qt::MatchFlags (Qt::MatchStartsWith\|Qt::MatchWrap)) const

virtual QMimeData *	mimeData (const QModelIndexList &indexes) const

virtual QStringList	mimeTypes () const

bool	moveColumn (const QModelIndex &sourceParent, int sourceColumn, const QModelIndex &destinationParent, int destinationChild)

virtual bool	moveColumns (const QModelIndex &sourceParent, int sourceColumn, int count, const QModelIndex &destinationParent, int destinationChild)

bool	moveRow (const QModelIndex &sourceParent, int sourceRow, const QModelIndex &destinationParent, int destinationChild)

virtual bool	moveRows (const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationChild)

QObject *	parent () const

bool	removeColumn (int column, const QModelIndex &parent=QModelIndex ())

virtual bool	removeColumns (int column, int count, const QModelIndex &parent=QModelIndex ())

bool	removeRow (int row, const QModelIndex &parent=QModelIndex ())

virtual QMultiHash< int, QString >	roleNames () const

virtual bool	setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role=Qt::EditRole)

virtual bool	setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles)

virtual QSize	span (const QModelIndex &index) const

virtual Qt::DropActions	supportedDragActions () const

Public Methods inherited from QObject
	QObject (QObject *parent=nullptr)

	~QObject ()

bool	blockSignals (bool block)

const QList< QObject * > &	children () const

bool	connect (const QObject *sender, const QString &signalMethod, const QString &location, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)

bool	connect (const QObject *sender, const QString &signalMethod, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)

bool	disconnect (const QObject *receiver, const QString &slotMethod=QString ()) const

bool	disconnect (const QString &signalMethod, const QString &location, const QObject *receiver=nullptr, const QString &slotMethod=QString ()) const

bool	disconnect (const QString &signalMethod=QString (), const QObject *receiver=nullptr, const QString &slotMethod=QString ()) const

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QString >	dynamicPropertyNames () const

virtual bool	event (QEvent *event)

virtual bool	eventFilter (QObject watched, QEvent event)

template<typename T >
T	findChild (const QString &childName=QString ()) const

template<class T >
QList< T >	findChildren (const QRegularExpression &regExp, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<class T >
QList< T >	findChildren (const QString &childName=QString (), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

bool	inherits (const QString &className) const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const

bool	isWindowType () const

void	killTimer (int id)

const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

QString	objectName () const

QObject *	parent () const

template<class T = QVariant>
T	property (const QString &name) const

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const QString &name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)

QThread *	thread () const

Additional Inherited Members
Public Signals inherited from QAbstractItemModel
void	columnsAboutToBeInserted (const QModelIndex &parent, int first, int last)

void	columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)

void	columnsAboutToBeRemoved (const QModelIndex &parent, int first, int last)

void	columnsInserted (const QModelIndex &parent, int first, int last)

void	columnsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)

void	columnsRemoved (const QModelIndex &parent, int first, int last)

void	dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QVector< int > &roles=QVector< int >())

void	headerDataChanged (Qt::Orientation orientation, int first, int last)

void	layoutAboutToBeChanged (const QList< QPersistentModelIndex > &parents=QList< QPersistentModelIndex >(), QAbstractItemModel::LayoutChangeHint hint=QAbstractItemModel::NoLayoutChangeHint)

void	layoutChanged (const QList< QPersistentModelIndex > &parents=QList< QPersistentModelIndex >(), QAbstractItemModel::LayoutChangeHint hint=QAbstractItemModel::NoLayoutChangeHint)

void	modelAboutToBeReset ()

void	modelReset ()

void	rowsAboutToBeInserted (const QModelIndex &parent, int first, int last)

void	rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)

void	rowsAboutToBeRemoved (const QModelIndex &parent, int first, int last)

void	rowsInserted (const QModelIndex &parent, int first, int last)

void	rowsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)

void	rowsRemoved (const QModelIndex &parent, int first, int last)

Public Signals inherited from QObject
void	destroyed (QObject *obj=nullptr)

void	objectNameChanged (const QString &objectName)

Public Slots inherited from QAbstractItemModel
virtual void	revert ()

virtual bool	submit ()

Public Slots inherited from QObject
void	deleteLater ()

Static Public Methods inherited from QObject
static bool	connect (const QObject sender, const QMetaMethod &signalMethod, const QObject receiver, const QMetaMethod &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)

static bool	connect (const QObject sender, const QString &signalMethod, const QObject receiver, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection, const QString &location=QString ())

static bool	connect (const QObject sender, const QString &signalMethod, const QString &location, const QObject receiver, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)

template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class SlotClass , class... SlotArgs, class SlotReturn >
static bool	connect (const Sender sender, void (SignalClass::signalMethod)(SignalArgs...), const Receiver receiver, SlotReturn (SlotClass::slotMethod)(SlotArgs...), Qt::ConnectionType type=Qt::AutoConnection)

template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class T >
static bool	connect (const Sender sender, void (SignalClass::signalMethod)(SignalArgs...), const Receiver *receiver, T slotLambda, Qt::ConnectionType type=Qt::AutoConnection)

static bool	disconnect (const QObject sender, const QMetaMethod &signalMethod, const QObject receiver, const QMetaMethod &slotMethod)

static bool	disconnect (const QObject sender, const QString &signalMethod, const QObject receiver, const QString &slotMethod)

static bool	disconnect (const QObject sender, const QString &signalMethod, const QString &location, const QObject receiver, const QString &slotMethod)

static bool	disconnect (const QObject sender, std::nullptr_t, const QObject receiver, std::nullptr_t)

template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class SlotClass , class... SlotArgs, class SlotReturn >
static bool	disconnect (const Sender sender, void (SignalClass::signalMethod)(SignalArgs...), const Receiver receiver, SlotReturn (SlotClass::slotMethod)(SlotArgs...))

template<class Sender , class SignalClass , class... SignalArgs, class Receiver >
static bool	disconnect (const Sender sender, void (SignalClass::signalMethod)(SignalArgs...), const Receiver *receiver, std::nullptr_t slotMethod=nullptr)

template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class T >
static bool	disconnect (const Sender sender, void (SignalClass::signalMethod)(SignalArgs...), const Receiver *receiver, T slotMethod)

static QMetaObject &	staticMetaObject ()

static QString	tr (const char text, const char comment=nullptr, std::optional< int > numArg=std::optional< int >())

Protected Slots inherited from QAbstractItemModel
void	resetInternalData ()

Protected Methods inherited from QAbstractItemModel
void	beginInsertColumns (const QModelIndex &parent, int first, int last)

void	beginInsertRows (const QModelIndex &parent, int first, int last)

bool	beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationColumn)

bool	beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationRow)

void	beginRemoveColumns (const QModelIndex &parent, int first, int last)

void	beginRemoveRows (const QModelIndex &parent, int first, int last)

void	beginResetModel ()

void	changePersistentIndex (const QModelIndex &from, const QModelIndex &to)

void	changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to)

QModelIndex	createIndex (int row, int column, quintptr id) const

QModelIndex	createIndex (int row, int column, void *data=nullptr) const

void	endInsertColumns ()

void	endInsertRows ()

void	endMoveColumns ()

void	endMoveRows ()

void	endRemoveColumns ()

void	endRemoveRows ()

void	endResetModel ()

QModelIndexList	persistentIndexList () const

Protected Methods inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signalMethod) const

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signalMethod) const

bool	isSignalConnected (const QMetaMethod &signalMethod) const

int	receivers (const QString &signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Properties inherited from QObject
	objectName

Related Functions inherited from QObject
T	qobject_cast (QObject *object)

	QObjectList

Detailed Description

The QStringListModel class implements a model where the data is a list of strings. This class is often used when displaying strings in a view such as a QListView or a QComboBox. The data in the model can be edited.

A model index corresponding to an item can be obtained by calling the index() method. This index is used when calling many of the other methods in this class. Data is read with the data() method and written with setData(). The number of rows or number of items in the string list can be found with the rowCount() method.

The model can be constructed with an existing string list or strings can be set later with the setStringList() method. Strings can also be inserted using insertRows() and removed with removeRows(). The contents of the string list can be retrieved with the stringList() method.

An example usage of QStringListModel.

QStringListModel *model = new QStringListModel();
 
QStringList list;
list << "a" << "b" << "c";
 
model->setStringList(list);

See also: QAbstractListModel, QAbstractItemModel, Models

Constructor & Destructor Documentation

QStringListModel::QStringListModel ( QObject * parent = nullptr )

explicit

Constructs a string list model with the given parent.

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

explicit

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

Method Documentation

QVariant QStringListModel::data	(	const QModelIndex &	index,
		int	role
	)		const

overridevirtual

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

Implements QAbstractItemModel::data()

Qt::ItemFlags QStringListModel::flags ( const QModelIndex & index ) const

overridevirtual

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

Reimplemented from QAbstractListModel::flags()

bool QStringListModel::insertRows	(	int	row,
		int	count,
		const QModelIndex &	parent = `QModelIndex()`
	)

overridevirtual

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

Reimplemented from QAbstractItemModel::insertRows()

bool QStringListModel::removeRows	(	int	row,
		int	count,
		const QModelIndex &	parent = `QModelIndex()`
	)

overridevirtual

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

Reimplemented from QAbstractItemModel::removeRows()

int QStringListModel::rowCount ( const QModelIndex & parent = QModelIndex() ) const

overridevirtual

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(), QAbstractItemModel::rowCount()

Implements QAbstractItemModel::rowCount()

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

overridevirtual

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: data(), Qt::ItemDataRole

Reimplemented from QAbstractItemModel::setData()

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(), dataChanged()

QModelIndex QStringListModel::sibling	(	int	row,
		int	column,
		const QModelIndex &	index
	)		const

overridevirtual

Returns the sibling at row and column for the item at index, or an invalid QModelIndex if there is no sibling at that location. The sibling() method finds the item's parent and uses it to retrieve the index of the child item in the specified row and column.

See also: index(), QModelIndex::row(), QModelIndex::column()

Reimplemented from QAbstractListModel::sibling()

void QStringListModel::sort	(	int	column,
		Qt::SortOrder	order = `Qt::AscendingOrder`
	)

overridevirtual

Reimplemented from QAbstractItemModel::sort()

QStringList QStringListModel::stringList ( ) const

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

See also: setStringList()

Qt::DropActions QStringListModel::supportedDropActions ( ) const

overridevirtual

Reimplemented from QAbstractItemModel::supportedDropActions()

Public Methods

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Method Documentation