#include <qqmlxmllistmodel_p.h>

Inheritance diagram for QQmlXmlListModel:

Collaboration diagram for QQmlXmlListModel:

Public Types
enum	Status { Null , Ready , Loading , Error }

Public Types inherited from QAbstractItemModel
enum	LayoutChangeHint { NoLayoutChangeHint , VerticalSortHint , HorizontalSortHint }
	This enum describes the way the model changes layout. More...

enum class	CheckIndexOption { NoOption = 0x0000 , IndexIsValid = 0x0001 , DoNotUseParent = 0x0002 , ParentIsInvalid = 0x0004 }

Public Slots
void	reload ()
	\qmlmethod QtQml.XmlListModel::XmlListModel::reload()

Public Slots inherited from QAbstractItemModel
virtual bool	submit ()
	Lets the model know that it should submit cached information to permanent storage.

virtual void	revert ()
	Lets the model know that it should discard cached information.

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	statusChanged (QQmlXmlListModel::Status)

void	progressChanged (qreal progress)

void	countChanged ()

void	sourceChanged ()

void	queryChanged ()

Signals inherited from QAbstractItemModel
void	dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QList< int > &roles=QList< int >())
	This signal is emitted whenever the data in an existing item changes.

void	headerDataChanged (Qt::Orientation orientation, int first, int last)
	This signal is emitted whenever a header is changed.

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

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

void	rowsAboutToBeInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted just before rows are inserted into the model.

void	rowsInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted after rows have been inserted into the model.

void	rowsAboutToBeRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted just before rows are removed from the model.

void	rowsRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted after rows have been removed from the model.

void	columnsAboutToBeInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted just before columns are inserted into the model.

void	columnsInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted after columns have been inserted into the model.

void	columnsAboutToBeRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted just before columns are removed from the model.

void	columnsRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted after columns have been removed from the model.

void	modelAboutToBeReset (QPrivateSignal)

void	modelReset (QPrivateSignal)

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

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

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

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

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
	QQmlXmlListModel (QObject *parent=nullptr)
	\qmltype XmlListModel \inqmlmodule QtQml.XmlListModel

	~QQmlXmlListModel ()

QModelIndex	index (int row, int column, const QModelIndex &parent) const override
	Returns the index of the data in row and column with parent.

int	rowCount (const QModelIndex &parent) const override
	Returns the number of rows under the given parent.

QVariant	data (const QModelIndex &index, int role) const override
	Returns the data stored under the given role for the item referred to by the index.

QHash< int, QByteArray >	roleNames () const override

int	count () const
	\qmlproperty int QtQml.XmlListModel::XmlListModel::count The number of data entries in the model.

QUrl	source () const
	\qmlproperty url QtQml.XmlListModel::XmlListModel::source The location of the XML data source.

void	setSource (const QUrl &)

QString	query () const
	\qmlproperty string QtQml.XmlListModel::XmlListModel::query A string representing the base path for creating model items from this model's \l [QML] {XmlListModelRole} objects.

void	setQuery (const QString &)

QQmlListProperty< QQmlXmlListModelRole >	roleObjects ()
	\qmlproperty list<XmlListModelRole> QtQml.XmlListModel::XmlListModel::roles

void	appendRole (QQmlXmlListModelRole *)

void	clearRole ()

Status	status () const
	\qmlproperty enumeration QtQml.XmlListModel::XmlListModel::status Specifies the model loading status, which can be one of the following:

qreal	progress () const
	\qmlproperty real QtQml.XmlListModel::XmlListModel::progress

Q_INVOKABLE QString	errorString () const
	\qmlmethod QtQml.XmlListModel::XmlListModel::errorString()

void	classBegin () override
	Invoked after class creation, but before any properties have been set.

void	componentComplete () override
	Invoked after the root component that caused this instantiation has completed construction.

Public Member Functions inherited from QAbstractListModel
	QAbstractListModel (QObject *parent=nullptr)
	Constructs an abstract list model with the given parent.

	~QAbstractListModel ()
	Destroys the abstract list model.

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

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

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

QObject *	parent () const
	Returns a pointer to the parent object.

Public Member Functions inherited from QAbstractItemModel
	QAbstractItemModel (QObject *parent=nullptr)
	Constructs an abstract item model with the given parent.

virtual	~QAbstractItemModel ()
	Destroys the abstract item model.

Q_INVOKABLE bool	hasIndex (int row, int column, const QModelIndex &parent=QModelIndex()) const
	Returns {true} if the model returns a valid QModelIndex for row and column with parent, otherwise returns {false}.

virtual Q_INVOKABLE bool	setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole)
	Sets the role data for the item at index to value.

virtual Q_INVOKABLE QVariant	headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const
	Returns the data for the given role and section in the header with the specified orientation.

virtual bool	setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role=Qt::EditRole)
	Sets the data for the given role and section in the header with the specified orientation to the value supplied.

virtual QMap< int, QVariant >	itemData (const QModelIndex &index) const
	Returns a map with values for all predefined roles in the model for the item at the given index.

virtual bool	setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles)
	Sets the role data for the item at index to the associated value in roles, for every Qt::ItemDataRole.

virtual bool	clearItemData (const QModelIndex &index)

virtual QStringList	mimeTypes () const
	Returns the list of allowed MIME types.

virtual QMimeData *	mimeData (const QModelIndexList &indexes) const
	Returns an object that contains serialized items of data corresponding to the list of indexes specified.

virtual bool	canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const
	Returns {true} if a model can accept a drop of the data.

virtual Qt::DropActions	supportedDropActions () const

virtual Qt::DropActions	supportedDragActions () const
	Returns the actions supported by the data in this model.

Q_INVOKABLE	Q_REVISION (6, 4) virtual bool insertRows(int row

Q_INVOKABLE	Q_REVISION (6, 4) virtual bool insertColumns(int column

Q_INVOKABLE	Q_REVISION (6, 4) virtual bool removeRows(int row

Q_INVOKABLE	Q_REVISION (6, 4) virtual bool removeColumns(int column

Q_INVOKABLE	Q_REVISION (6, 4) virtual bool moveRows(const QModelIndex &sourceParent

Q_INVOKABLE	Q_REVISION (6, 4) virtual bool moveColumns(const QModelIndex &sourceParent

Q_INVOKABLE	Q_REVISION (6, 4) inline bool insertRow(int row

Q_INVOKABLE	Q_REVISION (6, 4) inline bool insertColumn(int column

Q_INVOKABLE	Q_REVISION (6, 4) inline bool removeRow(int row

Q_INVOKABLE	Q_REVISION (6, 4) inline bool removeColumn(int column

Q_INVOKABLE	Q_REVISION (6, 4) inline bool moveRow(const QModelIndex &sourceParent

Q_INVOKABLE	Q_REVISION (6, 4) inline bool moveColumn(const QModelIndex &sourceParent

virtual Q_INVOKABLE void	fetchMore (const QModelIndex &parent)
	Fetches any available data for the items with the parent specified by the parent index.

virtual Q_INVOKABLE bool	canFetchMore (const QModelIndex &parent) const
	Returns {true} if there is more data available for parent; otherwise returns {false}.

Q_INVOKABLE	Q_REVISION (6, 4) virtual void sort(int column

virtual QModelIndex	buddy (const QModelIndex &index) const
	Returns a model index for the buddy of the item represented by index.

virtual Q_INVOKABLE QModelIndexList	match (const QModelIndex &start, int role, const QVariant &value, int hits=1, Qt::MatchFlags flags=Qt::MatchFlags(Qt::MatchStartsWith\|Qt::MatchWrap)) const
	Returns a list of indexes for the items in the column of the start index where data stored under the given role matches the specified value.

virtual QSize	span (const QModelIndex &index) const
	Returns the row and column span of the item represented by index.

bool	checkIndex (const QModelIndex &index, CheckIndexOptions options=CheckIndexOption::NoOption) const

virtual void	multiData (const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const

QObject *	parent () const
	Returns a pointer to the parent object.

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

void	killTimer (Qt::TimerId id)

template<typename T >
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T >
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T >
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

bool	setProperty (const char *name, QVariant &&value)

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Public Member Functions inherited from QQmlParserStatus
	QQmlParserStatus ()

virtual	~QQmlParserStatus ()

Properties
Status	status

qreal	progress

QUrl	source

QString	query

QQmlListProperty< QQmlXmlListModelRole >	roles

int	count

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Public Attributes inherited from QAbstractItemModel
Q_INVOKABLE int	count

Q_INVOKABLE int const QModelIndex &	parent = QModelIndex())
	Returns the parent of the model item with the given index.

Q_INVOKABLE int	sourceRow

Q_INVOKABLE int int	count

Q_INVOKABLE int int const QModelIndex &	destinationParent

Q_INVOKABLE int int const QModelIndex int	destinationChild

Q_INVOKABLE int	sourceColumn

Q_INVOKABLE const QModelIndex &	parent = QModelIndex())

Q_INVOKABLE int const QModelIndex &	destinationParent

Q_INVOKABLE int const QModelIndex int	destinationChild

Q_INVOKABLE Qt::SortOrder	order = Qt::AscendingOrder)

Protected Slots inherited from QAbstractItemModel
virtual void	resetInternalData ()

Protected Member Functions inherited from QAbstractListModel
	QAbstractListModel (QAbstractItemModelPrivate &dd, QObject *parent)

Protected Member Functions inherited from QAbstractItemModel
	QAbstractItemModel (QAbstractItemModelPrivate &dd, QObject *parent=nullptr)

QModelIndex	createIndex (int row, int column, const void *data=nullptr) const
	Creates a model index for the given row and column with the internal pointer ptr.

QModelIndex	createIndex (int row, int column, quintptr id) const
	Creates a model index for the given row and column with the internal identifier, id.

void	encodeData (const QModelIndexList &indexes, QDataStream &stream) const

bool	decodeData (int row, int column, const QModelIndex &parent, QDataStream &stream)

void	beginInsertRows (const QModelIndex &parent, int first, int last)
	Begins a row insertion operation.

void	endInsertRows ()
	Ends a row insertion operation.

void	beginRemoveRows (const QModelIndex &parent, int first, int last)
	Begins a row removal operation.

void	endRemoveRows ()
	Ends a row removal operation.

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

void	endMoveRows ()
	Ends a row move operation.

void	beginInsertColumns (const QModelIndex &parent, int first, int last)
	Begins a column insertion operation.

void	endInsertColumns ()
	Ends a column insertion operation.

void	beginRemoveColumns (const QModelIndex &parent, int first, int last)
	Begins a column removal operation.

void	endRemoveColumns ()
	Ends a column removal operation.

bool	beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationColumn)
	Begins a column move operation.

void	endMoveColumns ()
	Ends a column move operation.

void	beginResetModel ()
	Begins a model reset operation.

void	endResetModel ()
	Completes a model reset operation.

void	changePersistentIndex (const QModelIndex &from, const QModelIndex &to)
	Changes the QPersistentModelIndex that is equal to the given from model index to the given to model index.

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

QModelIndexList	persistentIndexList () const

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 95 of file qqmlxmllistmodel_p.h.

Member Enumeration Documentation

◆ Status

enum QQmlXmlListModel::Status

Enumerator
Null
Ready
Loading
Error

Definition at line 132 of file qqmlxmllistmodel_p.h.

Constructor & Destructor Documentation

◆ QQmlXmlListModel()

QQmlXmlListModel::QQmlXmlListModel ( QObject * parent = nullptr )

\qmltype XmlListModel \inqmlmodule QtQml.XmlListModel

For specifying a read-only model using XML data.

To use this element, you will need to import the module with the following line:

import QtQml.XmlListModel

XmlListModel is used to create a read-only model from XML data. It can be used as a data source for view elements (such as ListView, PathView, GridView) and other elements that interact with model data (such as Repeater).

Note: This model {does not} support the XPath queries. It supports simple slash-separated paths and, optionally, one attribute for each element.

For example, if there is an XML document at https://www.qt.io/blog/rss.xml like this:

<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0">
  ...
  <channel>
    <item>
      <title>Qt 6.0.2 Released</title>
      <link>https://www.qt.io/blog/qt-6.0.2-released</link>
      <pubDate>Wed, 03 Mar 2021 12:40:43 GMT</pubDate>
    </item>
    <item>
      <title>Qt 6.1 Beta Released</title>
      <link>https://www.qt.io/blog/qt-6.1-beta-released</link>
      <pubDate>Tue, 02 Mar 2021 13:05:47 GMT</pubDate>
    </item>
    <item>
      <title>Qt Creator 4.14.1 released</title>
      <link>https://www.qt.io/blog/qt-creator-4.14.1-released</link>
      <pubDate>Wed, 24 Feb 2021 13:53:21 GMT</pubDate>
    </item>
  </channel>
</rss>

A XmlListModel could create a model from this data, like this:

\qml import QtQml.XmlListModel

XmlListModel { id: xmlModel source: "https://www.qt.io/blog/rss.xml" query: "/rss/channel/item"

XmlListModelRole { name: "title"; elementName: "title" } XmlListModelRole { name: "pubDate"; elementName: "pubDate" } XmlListModelRole { name: "link"; elementName: "link" } } \endqml

The \l {XmlListModel::query}{query} value of "/rss/channel/item" specifies that the XmlListModel should generate a model item for each { } in the XML document.

The \l [QML] {XmlListModelRole} objects define the model item attributes. Here, each model item will have title, pubDate and link attributes that match the title, pubDate and link values of its corresponding { }. (See \l [QML] {XmlListModelRole} documentation for more examples.)

The model could be used in a ListView, like this:

\qml ListView { width: 180; height: 300 model: xmlModel delegate: Text { text: title + ": " + pubDate + "; link: " + link } } \endqml

The \l XmlListModel data is loaded asynchronously, and \l status is set to XmlListModel.Ready when loading is complete. Note this means when \l XmlListModel is used for a view, the view is not populated until the model is loaded.

Definition at line 339 of file qqmlxmllistmodel.cpp.

◆ ~QQmlXmlListModel()

QQmlXmlListModel::~QQmlXmlListModel ( )

Definition at line 341 of file qqmlxmllistmodel.cpp.

Member Function Documentation

◆ appendRole()

void QQmlXmlListModel::appendRole ( QQmlXmlListModelRole * role )

Definition at line 449 of file qqmlxmllistmodel.cpp.

◆ classBegin()

void QQmlXmlListModel::classBegin ( )

overridevirtual

Invoked after class creation, but before any properties have been set.

Implements QQmlParserStatus.

Definition at line 607 of file qqmlxmllistmodel.cpp.

◆ clearRole()

void QQmlXmlListModel::clearRole ( )

Definition at line 467 of file qqmlxmllistmodel.cpp.

◆ componentComplete()

void QQmlXmlListModel::componentComplete ( )

overridevirtual

Invoked after the root component that caused this instantiation has completed construction.

At this point all static values and binding values have been assigned to the class.

Implements QQmlParserStatus.

Definition at line 612 of file qqmlxmllistmodel.cpp.

◆ count()

int QQmlXmlListModel::count ( ) const

\qmlproperty int QtQml.XmlListModel::XmlListModel::count The number of data entries in the model.

Definition at line 387 of file qqmlxmllistmodel.cpp.

◆ countChanged

void QQmlXmlListModel::countChanged ( )

signal

◆ data()

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

overridevirtual

Returns the data stored under the given role for the item referred to by the index.

Note: If you do not have a value to return, return an invalid (default-constructed) QVariant.

See also: Qt::ItemDataRole, setData(), headerData()

Implements QAbstractItemModel.

Definition at line 368 of file qqmlxmllistmodel.cpp.

◆ errorString()

QString QQmlXmlListModel::errorString ( ) const

\qmlmethod QtQml.XmlListModel::XmlListModel::errorString()

Returns a string description of the last error that occurred if \l status is \l {XmlListModel}.Error.

Definition at line 602 of file qqmlxmllistmodel.cpp.

◆ index()

QModelIndex QQmlXmlListModel::index	(	int	row,
		int	column,
		const QModelIndex &	parent ) const

overridevirtual

Returns the index of the data in row and column with parent.

See also: parent()

Reimplemented from QAbstractListModel.

Definition at line 357 of file qqmlxmllistmodel.cpp.

◆ progress()

qreal QQmlXmlListModel::progress ( ) const

\qmlproperty real QtQml.XmlListModel::XmlListModel::progress

This indicates the current progress of the downloading of the XML data source. This value ranges from 0.0 (no data downloaded) to 1.0 (all data downloaded). If the XML data is not from a remote source, the progress becomes 1.0 as soon as the data is read.

Note that when the progress is 1.0, the XML data has been downloaded, but it is yet to be loaded into the model at this point. Use the status property to find out when the XML data has been read and loaded into the model.

See also: status, source

Definition at line 591 of file qqmlxmllistmodel.cpp.

◆ progressChanged

void QQmlXmlListModel::progressChanged ( qreal progress )

signal

◆ query()

QString QQmlXmlListModel::query ( ) const

\qmlproperty string QtQml.XmlListModel::XmlListModel::query A string representing the base path for creating model items from this model's \l [QML] {XmlListModelRole} objects.

The query should start with {'/'}.

Definition at line 416 of file qqmlxmllistmodel.cpp.

◆ queryChanged

void QQmlXmlListModel::queryChanged ( )

signal

◆ reload

void QQmlXmlListModel::reload ( )

slot

\qmlmethod QtQml.XmlListModel::XmlListModel::reload()

Reloads the model.

Definition at line 623 of file qqmlxmllistmodel.cpp.

◆ roleNames()

QHash< int, QByteArray > QQmlXmlListModel::roleNames ( ) const

overridevirtual

Since: 4.6

Returns the model's role names.

The default role names set by Qt are:

\table \header

Qt Role
QML Role Name \row
Qt::DisplayRole
display \row
Qt::DecorationRole
decoration \row
Qt::EditRole
edit \row
Qt::ToolTipRole
toolTip \row
Qt::StatusTipRole
statusTip \row
Qt::WhatsThisRole
whatsThis \endtable

Reimplemented from QAbstractItemModel.

Definition at line 375 of file qqmlxmllistmodel.cpp.

◆ roleObjects()

QQmlListProperty< QQmlXmlListModelRole > QQmlXmlListModel::roleObjects ( )

\qmlproperty list<XmlListModelRole> QtQml.XmlListModel::XmlListModel::roles

The roles to make available for this model.

Definition at line 441 of file qqmlxmllistmodel.cpp.

◆ rowCount()

int QQmlXmlListModel::rowCount ( const QModelIndex & parent ) const

overridevirtual

Returns the number of rows under the given parent.

When the parent is valid it means that rowCount is returning the number of children of parent.

Note: When implementing a table based model, rowCount() should return 0 when the parent is valid.

See also: columnCount()

Implements QAbstractItemModel.

Definition at line 363 of file qqmlxmllistmodel.cpp.

◆ setQuery()

void QQmlXmlListModel::setQuery ( const QString & query )

Definition at line 421 of file qqmlxmllistmodel.cpp.

◆ setSource()

void QQmlXmlListModel::setSource ( const QUrl & src )

Definition at line 401 of file qqmlxmllistmodel.cpp.

◆ source()

QUrl QQmlXmlListModel::source ( ) const

\qmlproperty url QtQml.XmlListModel::XmlListModel::source The location of the XML data source.

Definition at line 396 of file qqmlxmllistmodel.cpp.

◆ sourceChanged

void QQmlXmlListModel::sourceChanged ( )

signal

◆ status()

QQmlXmlListModel::Status QQmlXmlListModel::status ( ) const

\qmlproperty enumeration QtQml.XmlListModel::XmlListModel::status Specifies the model loading status, which can be one of the following:

\value XmlListModel.Null No XML data has been set for this model. \value XmlListModel.Ready The XML data has been loaded into the model. \value XmlListModel.Loading The model is in the process of reading and loading XML data. \value XmlListModel.Error An error occurred while the model was loading. See \l errorString() for details about the error.

See also: progress

Definition at line 571 of file qqmlxmllistmodel.cpp.

◆ statusChanged

void QQmlXmlListModel::statusChanged ( QQmlXmlListModel::Status )

signal

Property Documentation

◆ count

int QQmlXmlListModel::count

read

Definition at line 106 of file qqmlxmllistmodel_p.h.

◆ progress

qreal QQmlXmlListModel::progress

read

Definition at line 102 of file qqmlxmllistmodel_p.h.

◆ query

QString QQmlXmlListModel::query

readwrite

Definition at line 104 of file qqmlxmllistmodel_p.h.

◆ roles

QQmlListProperty<QQmlXmlListModelRole> QQmlXmlListModel::roles

read

Definition at line 105 of file qqmlxmllistmodel_p.h.

◆ source

QUrl QQmlXmlListModel::source

readwrite

Definition at line 103 of file qqmlxmllistmodel_p.h.

◆ status

Status QQmlXmlListModel::status

read

Definition at line 101 of file qqmlxmllistmodel_p.h.

The documentation for this class was generated from the following files:

qtdeclarative/src/qmlxmllistmodel/qqmlxmllistmodel_p.h (ba22fb2116ecf2076d207d5e4f0c5897bd4a1ab5)
qtdeclarative/src/qmlxmllistmodel/qqmlxmllistmodel.cpp (72c825e685229a2b747f1d79216ef3c6d3304de8)

Public Types

Public Slots

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Status

Constructor & Destructor Documentation

◆ QQmlXmlListModel()

◆ ~QQmlXmlListModel()

Member Function Documentation

◆ appendRole()

◆ classBegin()

◆ clearRole()

◆ componentComplete()

◆ count()

◆ countChanged

◆ data()

◆ errorString()

◆ index()

◆ progress()

◆ progressChanged

◆ query()

◆ queryChanged

◆ reload

◆ roleNames()

◆ roleObjects()

◆ rowCount()

◆ setQuery()

◆ setSource()

◆ source()

◆ sourceChanged

◆ status()

◆ statusChanged

Property Documentation

◆ count

◆ progress

◆ query

◆ roles

◆ source

◆ status