Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Simple DOM Model Example

The Simple DOM Model example shows how an existing class can be adapted for use with the model/view framework.

Qt provides two complementary sets of classes for reading XML files: The classes based around QXmlReader provide a SAX-style API for incremental reading of large files, and the classes based around QDomDocument enable developers to access the contents of XML files using a Document Object Model (DOM) API.

In this example, we create a model that uses the DOM API to expose the structure and contents of XML documents to views via the standard QAbstractModel interface.

Design and Concepts

Reading an XML document with Qt’s DOM classes is a straightforward process. Typically, the contents of a file are supplied to QDomDocument , and nodes are accessed using the functions provided by QDomNode and its subclasses.

The aim is to use the structure provided by QDomDocument by wrapping QDomNode objects in item objects similar to the TreeItem objects used in the Simple Tree Model example.

DomModel Class Definition

Let us begin by examining the DomModel class:

class DomModel(QAbstractItemModel):

    Q_OBJECT
# public
    DomModel = explicit(QDomDocument document, QObject parent = None)
    ~DomModel()
    QVariant data(QModelIndex index, int role) override
    Qt.ItemFlags flags(QModelIndex index) override
    QVariant headerData(int section, Qt.Orientation orientation,
                        role = Qt.DisplayRole) override()
    QModelIndex index(int row, int column,
                      QModelIndex parent = QModelIndex()) override
    QModelIndex parent(QModelIndex child) override
    int rowCount(QModelIndex parent = QModelIndex()) override
    int columnCount(QModelIndex parent = QModelIndex()) override
# private
    domDocument = QDomDocument()
    rootItem = DomItem()

The class definition contains all the basic functions that are needed for a read-only model. Only the constructor and document() function are specific to this model. The private domDocument variable is used to hold the document that is exposed by the model; the rootItem variable contains a pointer to the root item in the model.

DomItem Class Definition

The DomItem class is used to hold information about a specific QDomNode in the document:

class DomItem():

# public
    DomItem(QDomNode node, int row, DomItem parent = None)
    ~DomItem()
    child = DomItem(int i)
    parent = DomItem()
    node = QDomNode()
    row = int()
# private
    domNode = QDomNode()
DomItem = QHash<int,()
    parentItem = DomItem()
    rowNumber = int()

Each DomItem provides a wrapper for a QDomNode obtained from the underlying document which contains a reference to the node, it’s location in the parent node’s list of child nodes, and a pointer to a parent wrapper item.

The parent(), child(), and row() functions are convenience functions for the DomModel to use that provide basic information about the item to be discovered quickly. The node() function provides access to the underlying QDomNode object.

As well as the information supplied in the constructor, the class maintains a cache of information about any child items. This is used to provide a collection of persistent item objects that the model can identify consistently and improve the performance of the model when accessing child items.

DomItem Class Implementation

Since the DomItem class is only a thin wrapper around QDomNode objects, with a few additional features to help improve performance and memory usage, we can provide a brief outline of the class before discussing the model itself.

The constructor simply records details of the QDomNode that needs to be wrapped:

def __init__(self, node, row, parent):
    self.domNode = node              parentItem(parent),
      rowNumber(row)
{}

As a result, functions to provide the parent wrapper, the row number occupied by the item in its parent’s list of children, and the underlying QDomNode for each item are straightforward to write:

DomItem DomItem.parent()

    return parentItem
def row(self):

    return rowNumber
def node(self):

    return domNode

It is necessary to maintain a collection of items which can be consistently identified by the model. For that reason, we maintain a hash of child wrapper items that, to minimize memory usage, is initially empty. The model uses the item’s child() function to help create model indexes, and this constructs wrappers for the children of the item’s QDomNode , relating the row number of each child to the newly-constructed wrapper:

DomItem DomItem.child(int i)

    childItem = childItems.value(i)
    if childItem:
        return childItem
    # if child does not yet exist, create it
    if i >= 0 and i < domNode.childNodes().count():
        childNode = domNode.childNodes().item(i)
        childItem = DomItem(childNode, i, self)
        childItems[i] = childItem

    return childItem

If a QDomNode was previously wrapped, the cached wrapper is returned; otherwise, a new wrapper is constructed and stored for valid children, and zero is returned for invalid ones.

The class’s destructor deletes all the child items of the wrapper:

DomItem.~DomItem()

    qDeleteAll(childItems)

These, in turn, will delete their children and free any QDomNode objects in use.

DomModel Class Implementation

The structure provided by the DomItem class makes the implementation of DomModel similar to the TreeModel shown in the Simple Tree Model example.

The constructor accepts an existing document and a parent object for the model:

def __init__(self, document, parent):
    super().__init__(parent)
      domDocument(document),
      rootItem(DomItem(domDocument, 0))

A shallow copy of the document is stored for future reference, and a root item is created to provide a wrapper around the document. We assign the root item a row number of zero only to be consistent since the root item will have no siblings.

Since the model only contains information about the root item, the destructor only needs to delete this one item:

DomModel.~DomModel()

    del rootItem

All of the child items in the tree will be deleted by the DomItem destructor as their parent items are deleted.

Basic Properties of The Model

Some aspects of the model do not depend on the structure of the underlying document, and these are simple to implement.

The number of columns exposed by the model is returned by the columnCount() function:

def columnCount(self, QModelIndex parent):

    Q_UNUSED(parent)
    return 3

This value is fixed, and does not depend on the location or type of the underlying node in the document. We will use these three columns to display different kinds of data from the underlying document.

Since we only implement a read-only model, the flags() function is straightforward to write:

Qt.ItemFlags DomModel.flags(QModelIndex index)

    if not index.isValid():
        return Qt.NoItemFlags
    return QAbstractItemModel.flags(index)

Since the model is intended for use in a tree view, the headerData() function only provides a horizontal header:

QVariant DomModel.headerData(int section, Qt.Orientation orientation,
                              int role)

    if orientation == Qt.Horizontal and role == Qt.DisplayRole:

            if section == 0:
                return tr("Name")
            elif section == 1:
                return tr("Attributes")
            elif section == 2:
                return tr("Value")
            else:
                break


    return QVariant()

The model presents the names of nodes in the first column, element attributes in the second, and any node values in the third.

Navigating The Document

The index() function creates a model index for the item with the given row, column, and parent in the model:

def index(self, int row, int column, QModelIndex parent):

    if not hasIndex(row, column, parent):
        return QModelIndex()
    parentItem = DomItem()
    if not parent.isValid():
        parentItem = rootItem
else:
        parentItem = DomItem(parent.internalPointer())

The function first has to relate the parent index to an item that contains a node from the underlying document. If the parent index is invalid, it refers to the root node in the document, so we retrieve the root item that wraps it; otherwise, we obtain a pointer to the relevant item using the internalPointer() function. We are able to extract a pointer in this way because any valid model index will have been created by this function, and we store pointers to item objects in any new indexes that we create with createIndex() :

childItem = parentItem.child(row)
if childItem:
    return createIndex(row, column, childItem)
return QModelIndex()

A child item for the given row is provided by the parent item’s child() function. If a suitable child item was found then we call createIndex() to produce a model index for the requested row and column, passing a pointer to the child item for it to store internally. If no suitable child item is found, an invalid model index is returned.

Note that the items themselves maintain ownership of their child items. This means that the model does not need to keep track of the child items that have been created, and can let the items themselves tidy up when they are deleted.

The number of rows beneath a given item in the model is returned by the rowCount() function, and is the number of child nodes contained by the node that corresponds to the specified model index:

def rowCount(self, QModelIndex parent):

    if parent.column() > 0:
        return 0
    parentItem = DomItem()
    if not parent.isValid():
        parentItem = rootItem
else:
        parentItem = DomItem(parent.internalPointer())
    return parentItem.node().childNodes().count()

To obtain the relevant node in the underlying document, we access the item via the internal pointer stored in the model index. If an invalid index is supplied, the root item is used instead. We use the item’s node() function to access the node itself, and simply count the number of child nodes it contains.

Since the model is used to represent a hierarchical data structure, it needs to provide an implementation for the parent() function. This returns a model index that corresponds to the parent of a child model index supplied as its argument:

def parent(self, QModelIndex child):

    if not child.isValid():
        return QModelIndex()
    childItem = DomItem(child.internalPointer())
    parentItem = childItem.parent()
    if not parentItem or parentItem == rootItem:
        return QModelIndex()
    return createIndex(parentItem.row(), 0, parentItem)

For valid indexes other than the index corresponding to the root item, we obtain a pointer to the relevant item using the method described in the index() function, and use the item’s parent() function to obtain a pointer to the parent item.

If no valid parent item exists, or if the parent item is the root item, we can simply follow convention and return an invalid model index. For all other parent items, we create a model index containing the appropriate row and column numbers, and a pointer to the parent item we just obtained.

Data is provided by the data() function. For simplicity, we only provide data for the display role , returning an invalid variant for all other requests:

def data(self, QModelIndex index, int role):

    if not index.isValid():
        return QVariant()
    if role != Qt.DisplayRole:
        return QVariant()
    item = DomItem(index.internalPointer())
    node = item.node()

As before, we obtain an item pointer for the index supplied, and use it to obtain the underlying document node. Depending on the column specified, the data we return is obtained in different ways:

switch (index.column()) {
    elif reason == 0:
        return node.nodeName()
    elif reason == 1:

        attributeMap = node.attributes()
        attributes = QStringList()
        for i in range(0, attributeMap.count()):
            attribute = attributeMap.item(i)
            attributes << attribute.nodeName() + "=\""
                          + attribute.nodeValue() + '"'

        return attributes.join(' ')

    elif reason == 2:
        return node.nodeValue().split('\n').join(' ')
    else:
        break

return QVariant()

For the first column, we return the node’s name. For the second column, we read any attributes that the node may have, and return a string that contains a space-separated list of attribute-value assignments. For the third column, we return any value that the node may have; this allows the contents of text nodes to be displayed in a view.

If data from any other column is requested, an invalid variant is returned.

Implementation Notes

Ideally, we would rely on the structure provided by QDomDocument to help us write the parent() and index() functions that are required when subclassing QAbstractItemModel . However, since Qt’s DOM classes use their own system for dynamically allocating memory for DOM nodes, we cannot guarantee that the QDomNode objects returned for a given piece of information will be the same for subsequent accesses to the document.

We use item wrappers for each QDomNode to provide consistent pointers that the model can use to navigate the document structure.

Example project @ code.qt.io