XmlListModel QML Type

For specifying a read-only model using XML data. More...

• List of all members, including inherited members

Properties

• count : int
• progress : real
• query : string
• roles : list<XmlListModelRole>
• source : url
• status : enumeration

Methods

• errorString()
• reload()

Detailed Description

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

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:

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" }
}

The query value of "/rss/channel/item" specifies that the XmlListModel should generate a model item for each <item> in the XML document.

The 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 <item>. (See XmlListModelRole documentation for more examples.)

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

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

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

Property Documentation

Method Documentation