QAbstractListModel詳解

一、介紹

QAbstractListModel是Qt中的一個抽象模型類，通過其實現自定義模型提供數據給QML界面使用，也可以被QWidget界面使用。

它是Qt的模型/視圖架構中的一個模型，被用於ListView、GridView、PathView、TableView、TreeView等控件上。

一個模型可以包含一對多行數據，在列中提供元素的數據。該模型可以被視圖控件使用，讓用戶可以以不同的方式對數據進行查看和修改。

二、功能

QAbstractListModel負責實現獲取數據、添加數據、修改數據、刪除數據等操作，同時還具有以下功能：

1、數據通知機制：在更改模型數據時，通知視圖(例如，QListView)進行更新。

2、可排序(排序原理類似於QSortFilterProxyModel)：根據需要對模型的行進行排序。

3、可過濾：根據需要對模型的行進行過濾。

4、可分組：根據需要將模型的行分為組。

三、數據結構

QAbstractListModel中的數據結構是一個二維數組，即每個元素都是一個列表。每個列表表示一個列，每個列表中的元素表示該列的一個值。

例如有一個包含4列數據和3行數據的模型，數據如下：

1 2 3 4
a b c d
1 2 3 4

那麼QAbstractListModel中的數據結構，就是一個包含4個列表的列表，每個列表中包含3個元素。

[1, a, 1]
[2, b, 2]
[3, c, 3]
[4, d, 4]

四、實現

1、數據獲取

數據獲取是QAbstractListModel的主要功能，其核心函數是:data()

QVariant QAbstractListModel::data(const QModelIndex &current, int role = Qt::DisplayRole) const

其中：

current：表示一個模型索引，用來返回當前行和列的數據。

role：表示角色，用於指定返回哪個角色的數據。若是不指定默認值，會返回Qt::DisplayRole角色的數據。

該函數返回當前行和列的數據，可以根據角色(role)的不同返回不同角色的數據。

示例代碼：

QVariant MyModel::data(const QModelIndex &index, int role) const
{
    if (!index.isValid())
        return QVariant();

    if (role == Qt::DisplayRole || role == Qt::EditRole) {
        MyData data = m_dataList.at(index.row());
        if (index.column() == 0) {
            return data.id;
        } else if (index.column() == 1) {
            return data.name;
        }
    }

    return QVariant();
}

上面的代碼實現了數據的獲取，其中包含了2列獲取。

對於角色(role)的說明：

1、Qt::DisplayRole：顯示該項的數據(默認的角色)。

2、Qt::EditRole：可編輯該項的數據。

3、Qt::ToolTipRole：懸停在該項上時顯示的提示。

4、Qt::DecorationRole：在該項上顯示的圖標或裝飾。

2、數據更改

數據更改是QAbstractListModel的另一個重要功能。下面給出setData()函數的另一個版本，它用於當模型中的數據發生更改時更新該索引項。

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

其中：

index：表示一個模型索引，用來確定要更新哪個元素。

value：表示新的值。

role：表示角色，用於指定要更新哪個角色的數據。默認情況下，該函數更新Qt::EditRole角色的數據。

示例代碼：

bool MyModel::setData(const QModelIndex &index, const QVariant &value,
                       int role)
{
    if (index.isValid() && role == Qt::EditRole) {
        int row = index.row();

        MyData data = m_dataList.value(row);
        if (index.column() == 0)
            data.id = value.toString();
        else if (index.column() == 1)
            data.name = value.toString();
        else
            return false;

        m_dataList.replace(row, data);
        emit dataChanged(index, index, QVector() << role);

        return true;
    }
    return false;
}

上面的代碼實現了setData()的功能，實現了根據索引號進行更新。

請注意，您需要在更改模型數據後發出信號dataChanged()，以通知視圖更新模型顯示的數據。這個信號需要傳遞兩個QModelIndex，表示要更新的數據的行和列。

3、數據插入和刪除

數據插入和刪除在QAbstractListModel中是使用insertRows()和removeRows()函數實現的。

bool QAbstractListModel::insertRows(int row, int count, const QModelIndex &parent = QModelIndex())
bool QAbstractListModel::removeRows(int row, int count, const QModelIndex &parent = QModelIndex())

其中：

row：表示要插入或刪除的行號。

count：表示要插入或刪除的行數。

parent：表示模型中某個節點的父節點。默認情況下，該節點沒有父節點，因此使用QModelIndex()。

示例代碼:

bool MyModel::insertRows(int row, int count, const QModelIndex &parent)
{
    beginInsertRows(parent, row, row + count - 1);

    for (int i = 0; i < count; ++i) {
        MyData data;
        data.id = "";
        data.name = "";
        m_dataList.insert(row, data);
    }

    endInsertRows();
    return true;
}

bool MyModel::removeRows(int row, int count, const QModelIndex &parent)
{
    beginRemoveRows(parent, row, row + count - 1);

    for (int i = 0; i < count; ++i) {
        m_dataList.removeAt(row);
    }

    endRemoveRows();
    return true;
}

上述代碼演示了如何插入和刪除模型中的行。

請注意，您需要在數據被插入或刪除後發出信號beginInsertRows()或beginRemoveRows()，並在插入或刪除數據後發出相應的結束信號。

五、總結

QAbstractListModel是Qt中模型/視圖架構中的一個抽象模型類，提供了數據通知、數據獲取、數據更改、數據插入和刪除等功能，方便用戶在QML、QWidget等界面中使用自定義的模型。

通過以上的示例代碼，希望對讀者能夠更深入地了解QAbstractListModel的使用和實現原理。