|  | Home · Examples

# Model Classes

[Previous: Using Models and Views][Model/View Programming][Next: Creating New Models]

- Basic Concepts

- Model Indexes
- Rows and Columns
- Parents of Items
- Item Roles
- Summary of Concepts
- Using Model Indexes

- Further Reading

## Basic Concepts

In the model/view architecture, the model provides a standard interface that views and delegates use to access data. In Qt, the standard interface is defined by the QAbstractItemModel class. No matter how the items of data are stored in any underlying data structure, all subclasses of QAbstractItemModel represent the data as a hierarchical structure containing tables of items. Views use this convention to access items of data in the model, but they are not restricted in the way that they present this information to the user.
Models also notify any attached views about changes to data through the signals and slots mechanism.

This chapter describes some basic concepts that are central to the way item of data are accessed by other components via a model class. More advanced concepts are discussed in later chapters.

### Model Indexes

To ensure that the representation of the data is kept separate from the way it is accessed, the concept of a model index is introduced. Each piece of information that can be obtained via a model is represented by a model index. Views and delegates use these indexes to request items of data to display.

As a result, only the model needs to know how to obtain data, and the type of data managed by the model can be defined fairly generally. Model indexes contain a pointer to the model that created them, and this prevents confusion when working with more than one model.

    QAbstractItemModel model = index.model();

Model indexes provide temporary references to pieces of information, and can be used to retrieve or modify data via the model. Since models may reorganize their internal structures from time to time, model indexes may become invalid, and should not be stored. If a long-term reference to a piece of information is required, a persistent model index must be created. This provides a reference to the information that the model keeps up-to-date. Temporary model indexes are provided by the QModelIndex class, and persistent model indexes are provided by the QPersistentModelIndex class.

To obtain a model index that corresponds to an item of data, three properties must be specified to the model: a row number, a column number, and the model index of a parent item. The following sections describe and explain these properties in detail.

### Rows and Columns

In its most basic form, a model can be accessed as a simple table in which items are located by their row and column numbers. This does not mean that the underlying pieces of data are stored in an array structure; the use of row and column numbers is only a convention to allow components to communicate with each other. We can retrieve information about any given item by specifying its row and column numbers to the model, and we receive an index that represents the item:

    QModelIndex index = model.index(row, column, ...);

Models that provide interfaces to simple, single level data structures like lists and tables do not need any other information to be provided but, as the above code indicates, we need to supply more information when obtaining a model index.

| Rows and columns The diagram shows a representation of a basic table model in which each item is located by a pair of row and column numbers. By passing the relevant row and column numbers to the model we obtain a model index that refers to an item of data.
    QModelIndex indexA = model.index(0, 0);
    QModelIndex indexB = model.index(1, 1);
    QModelIndex indexC = model.index(2, 1);
Top level items in a model are always referenced by specifying `QModelIndex()` as their parent item. This is discussed in the next section.

### Parents of Items

The table-like interface to item data provided by models is ideal when using data in a table or list view; the row and column number system maps exactly to the way the views display items. However, structures such as tree views require the model to expose a more flexible interface to the items within. As a result, each item can also be the parent of another table of items, in much the same way that a top-level item in a tree view can contain another list of items.

When requesting an index for a model item, we must provide some information about the item's parent. Outside the model, the only way to refer to an item is through a model index, so a parent model index must also be given:

    QModelIndex index = model.index(row, column, parent);

| Parents, rows, and columns The diagram shows a representation of a tree model in which each item is referred to by a parent, a row number, and a column number. Items "A" and "C" are represented as top-level siblings in the model:
    QModelIndex indexA = model.index(0, 0);
    QModelIndex indexC = model.index(2, 1);
Item "A" has a number of children. A model index for item "B" is obtained with the following code:
    QModelIndex indexB = model.index(1, 0, indexA);

### Item Roles

Items in a model can perform various roles for other components, allowing different kinds of data to be supplied for different situations. For example, Qt::DisplayRole is used to access a string that can be displayed as text in a view. Typically, items contain data for a number of different roles, and the standard roles are defined by Qt::ItemDataRole.

We can ask the model for the item's data by passing it the model index corresponding to the item, and by specifying a role to obtain the type of data we want:

    QVariant value = model.data(index, role);

| Item roles The role indicates to the model which type of data is being referred to. Views can display the roles in different ways, so it is important to supply appropriate information for each role. The Creating New Models section covers some specific uses of roles in more detail.

Most common uses for item data are covered by the standard roles defined in Qt::ItemDataRole. By supplying appropriate item data for each role, models can provide hints to views and delegates about how items should be presented to the user. Different kinds of views have the freedom to interpret or ignore this information as required. It is also possible to define additional roles for application-specific purposes.

### Summary of Concepts

- Model indexes give views and delegates information about the location of items provided by models in a way that is independent of any underlying data structures.
- Items are referred to by their row and column numbers, and by the model index of their parent items.
- Model indexes are constructed by models at the request of other components, such as views and delegates.
- If a valid model index is specified for the parent item when an index is requested using index(), the index returned will refer to an item beneath that parent item in the model. The index obtained refers to a child of that item.
- If an invalid model index is specified for the parent item when an index is requested using index(), the index returned will refer to a top-level item in the model.
- The role distinguishes between the different kinds of data associated with an item.

### Using Model Indexes

To demonstrate how data can be retrieved from a model, using model indexes, we set up a QDirModel without a view and display the names of files and directories in a widget. Although this does not show a normal way of using a model, it demonstrates the conventions used by models when dealing with model indexes.

We construct a directory model in the following way:

            QDirModel model = new QDirModel();
            QModelIndex parentIndex = model.index(QDir.currentPath());
            int numRows = model.rowCount(parentIndex);

In this case, we set up a default QDirModel, obtain a parent index using a specific implementation of index() provided by that model, and we count the number of rows in the model using the rowCount() function.

For simplicity, we are only interested in the items in the first column of the model. We examine each row in turn, obtaining a model index for the first item in each row, and read the data stored for that item in the model.

            for (int row = 0; row < numRows; ++row) {
                QModelIndex index = model.index(row, 0, parentIndex);

To obtain a model index, we specify the row number, column number (zero for the first column), and the appropriate model index for the parent of all the items that we want. The text stored in each item is retrieved using the model's data() function. We specify the model index and the DisplayRole to obtain data for the item in the form of a string.

                String text = model.data(index, Qt.ItemDataRole.DisplayRole).toString();
                // Display the text in a widget.

            }

The above example demonstrates the basic principles used to retrieve data from a model:

- The dimensions of a model can be found using rowCount() and columnCount(). These functions generally require a parent model index to be specified.
- Model indexes are used to access items in the model. The row, column, and parent model index are needed to specify the item.
- To access top-level items in a model, specify a null model index as the parent index with `QModelIndex()`.
- Items contain data for different roles. To obtain the data for a particular role, both the model index and the role must be supplied to the model.

## Further Reading

New models can be created by implementing the standard interface provided by QAbstractItemModel. In the Creating New Models chapter, we will demonstrate this by creating a convenient ready-to-use model for holding lists of strings.