QML 中使用 QAbstractListModel 作為 ListView 的 model 實例

本文對應的源碼地址:
https://github.com/imtoby/CppModelForQMLExample

程序運行效果:

運行效果

我們需要注意的是我們在使用 QAbstractListModel 時至少要實現的方法:

int rowCount(const QModelIndex &parent) const;
QVariant data(const QModelIndex &index, int role) const;
virtual QHash<int, QByteArray> roleNames() const;

我們定義一個繼承自 QAbstractListModel 的類 ObjectModel 用于管理 QObject 對象列表,并將其作為 ListView 的 model 傳給 QML 端使用。

下面是其頭文件的內容:

/***************************************************************************
    Copyright (C) 2017 by ZhaoDongshuang
    Author: ZhaoDongshuang
    Email: imtoby@126.com
    Date: 2017/11/07
    File: ObjectModel.h
 ***************************************************************************/
#ifndef OBJECTMODEL_H_2DBDF593_DAA2_5084_8BE0_A727A0C68256
#define OBJECTMODEL_H_2DBDF593_DAA2_5084_8BE0_A727A0C68256

#include <QAbstractListModel>

class ObjectModelPrivate;

class ObjectModel : public QAbstractListModel
{
    Q_OBJECT
public:
    explicit ObjectModel(QObject *parent = 0);
    ~ObjectModel();

    int rowCount(const QModelIndex &parent) const;
    int columnCount(const QModelIndex &parent) const;
    QVariant data(const QModelIndex &index, int role) const;
    bool setData(const QModelIndex &index, const QVariant &value, int role);
    virtual QHash<int, QByteArray> roleNames() const;

    void insert(int index, QObject* object);
    void append(QObject* object);
    void push_front(QObject* object);
    void push_back(QObject* object);

    void replace(int index, QObject* object);
    void set(QObjectList * objectList);

    void remove(QObject* object);
    void remove(int index);
    void clear();

    QObject * get(int index);
    QObjectList* getAll();

private:
    QScopedPointer<ObjectModelPrivate> d_ptr;
    Q_DECLARE_PRIVATE(ObjectModel)
};

#endif // OBJECTMODEL_H_2DBDF593_DAA2_5084_8BE0_A727A0C68256

然后是實現文件:

/***************************************************************************
    Copyright (C) 2017 by ZhaoDongshuang
    Author: ZhaoDongshuang
    Email: imtoby@126.com
    Date: 2017/11/07
    File: ObjectModel.cpp
 ***************************************************************************/
#include "ObjectModel.h"
#include <QMutex>

#include "Config.h"

namespace {

enum {
    ObjectModelRole = Qt::UserRole + 1
};

}

class ObjectModelPrivate
{
public:
    ObjectModelPrivate(ObjectModel * parent)
        : q_ptr(parent)
        , mutex(NULL)
    {
    }

    void init();
    void uninit();

private:
    ObjectModel * const q_ptr;
    Q_DECLARE_PUBLIC(ObjectModel)

    QHash<int, QByteArray> rolesNames;
    QObjectList objectList;
    QMutex *mutex;
};

ObjectModel::ObjectModel(QObject *parent) :
    QAbstractListModel(parent),
    d_ptr(new ObjectModelPrivate(this))
{
    Q_D(ObjectModel);
    d->init();
    d->rolesNames[ObjectModelRole] = "objectModelRole";
}

ObjectModel::~ObjectModel()
{
    Q_D(ObjectModel);
    d->uninit();
}

int ObjectModel::rowCount(const QModelIndex &parent) const
{
    C_D(ObjectModel);
    Q_UNUSED(parent);
    return d->objectList.size();
}

int ObjectModel::columnCount(const QModelIndex &parent) const
{
    Q_UNUSED(parent);
    return 1;
}

QVariant ObjectModel::data(const QModelIndex &index, int role) const
{
    C_D(ObjectModel);
    if (index.row() >= 0 && index.row() < d->objectList.size() ) {
        if (role == ObjectModelRole) {
            QObject *object = d->objectList.at(index.row());
            return QVariant::fromValue(object);
        }
    }
    return QVariant(0);
}

bool ObjectModel::setData(const QModelIndex &index, const QVariant &value, int role)
{
    Q_D(ObjectModel);
    if (index.row() >= 0 && index.row() < d->objectList.size() ) {
        if (role == ObjectModelRole) {
            d->mutex->lock();
            d->objectList.replace(index.row(), value.value<QObject *>());
            d->mutex->unlock();
            return true;
        }
    }
    return false;
}

QHash<int, QByteArray> ObjectModel::roleNames() const
{
    C_D(ObjectModel);
    return d->rolesNames;
}

void ObjectModel::insert(int index, QObject *object)
{
    Q_D(ObjectModel);
    if (index >= 0  && index <= d->objectList.size()) {
        d->mutex->lock();
        beginInsertRows(QModelIndex(), index, index);
        d->objectList.insert(index, object);
        endInsertRows();
        d->mutex->unlock();
    }
}

void ObjectModel::append(QObject *object)
{
    Q_D(ObjectModel);
    insert(d->objectList.size(), object);
}

void ObjectModel::push_front(QObject *object)
{
    insert(0, object);
}

void ObjectModel::push_back(QObject *object)
{
    append(object);
}

void ObjectModel::replace(int index, QObject *object)
{
    Q_D(ObjectModel);
    if (index >= 0  && index < d->objectList.size()) {
        d->mutex->lock();
        d->objectList.replace(index, object);
        d->mutex->unlock();
        emit dataChanged(createIndex(index, 0), createIndex(index, 0));
    }
}

void ObjectModel::set(QObjectList *objectList)
{
    Q_D(ObjectModel);
    d->mutex->lock();
    beginResetModel();
    d->objectList = *objectList;
    endResetModel();
    d->mutex->unlock();
}

void ObjectModel::remove(QObject *object)
{
    Q_D(ObjectModel);
    d->mutex->lock();
    const int index = d->objectList.indexOf(object);
    if (index >= 0) {
        beginRemoveRows(QModelIndex(), index, index);
        d->objectList.removeAt(index);
        endRemoveRows();
    }
    d->mutex->unlock();
}

void ObjectModel::remove(int index)
{
    Q_D(ObjectModel);
    if (index >= 0 && index < d->objectList.size()) {
        d->mutex->lock();
        beginRemoveRows(QModelIndex(), index, index);
        QObject* object = d->objectList.at(index);
        d->objectList.removeAt(index);
        object->deleteLater();
        endRemoveRows();
        d->mutex->unlock();
    }
}

void ObjectModel::clear()
{
    Q_D(ObjectModel);
    d->mutex->lock();
    beginResetModel();
    qDeleteAll(d->objectList.begin(), d->objectList.end());
    d->objectList.clear();
    endResetModel();
    d->mutex->unlock();
}

QObject *ObjectModel::get(int index)
{
    Q_D(ObjectModel);
    if (index >= 0 && index < d->objectList.size()) {
        d->mutex->lock();
        QObject * object = d->objectList.at(index);
        d->mutex->unlock();
        return object;
    }
    return NULL;
}

QObjectList *ObjectModel::getAll()
{
    Q_D(ObjectModel);
    d->mutex->lock();
    QObjectList * objectList = &(d->objectList);
    d->mutex->unlock();
    return objectList;
}


void ObjectModelPrivate::init()
{
    rolesNames.clear();
    objectList.clear();
    if (mutex == NULL) {
        mutex = new QMutex(QMutex::Recursive);
    }
}

void ObjectModelPrivate::uninit()
{
    qDeleteAll(objectList.begin(), objectList.end());
    objectList.clear();
    rolesNames.clear();
    if (mutex) {
        delete mutex;
        mutex = NULL;
    }
}

這里定義一個繼承自 QObject 的子類 TestItem,用于作為實際的數據結構存儲類。
其頭文件如下:

/***************************************************************************
    Copyright (C) 2017 by ZhaoDongshuang
    Author: ZhaoDongshuang
    Email: imtoby@126.com
    Date: 2017/11/07
    File: TestItem.h
 ***************************************************************************/
#ifndef TESTITEM_H_B3E135CE_37B2_5BA7_B57A_AD850A413E91
#define TESTITEM_H_B3E135CE_37B2_5BA7_B57A_AD850A413E91

#include <QObject>

class TestItemPrivate;

class TestItem : public QObject
{
    Q_OBJECT
    Q_PROPERTY(QString name READ name WRITE setName NOTIFY nameChanged)
public:
    explicit TestItem(QObject *parent = 0);
    ~TestItem();

    TestItem(const TestItem &other, QObject *parent = 0);
    TestItem& operator=(const TestItem &other);

    QString name() const;
    void setName(const QString& name);

signals:
    void nameChanged();

private:
    QScopedPointer<TestItemPrivate> d_ptr;
    Q_DECLARE_PRIVATE(TestItem)
};

#endif // TESTITEM_H_B3E135CE_37B2_5BA7_B57A_AD850A413E91

實現文件如下:

/***************************************************************************
    Copyright (C) 2017 by ZhaoDongshuang
    Author: ZhaoDongshuang
    Email: imtoby@126.com
    Date: 2017/11/07
    File: TestItem.cpp
 ***************************************************************************/
#include "TestItem.h"

#include "Config.h"

class TestItemPrivate
{
public:
    TestItemPrivate(TestItem *parent)
        : q_ptr(parent)
        , name("test")
    {}

private:
    TestItem * const q_ptr;
    Q_DECLARE_PUBLIC(TestItem)

    QString name;
};

TestItem::TestItem(QObject *parent) :
    QObject(parent) ,
    d_ptr(new TestItemPrivate(this))
{
}

TestItem::~TestItem()
{
}

TestItem::TestItem(const TestItem &other, QObject *parent) :
    QObject(parent) ,
    d_ptr(new TestItemPrivate(this))
{
    d_ptr.swap(const_cast< QScopedPointer<TestItemPrivate>&>(other.d_ptr));
}

TestItem &TestItem::operator=(const TestItem &other)
{
    d_ptr.swap(const_cast< QScopedPointer<TestItemPrivate>&>(other.d_ptr));
    return *this;
}

QString TestItem::name() const
{
    C_D(TestItem);
    return d->name;
}

void TestItem::setName(const QString& name)
{
    Q_D(TestItem);
    if (name != d->name) {
        d->name = name;
        emit nameChanged();
    }
}

接下來我們定義一個數據管理類 ModelManager,其頭文件如下:

/***************************************************************************
    Copyright (C) 2017 by ZhaoDongshuang
    Author: ZhaoDongshuang
    Email: imtoby@126.com
    Date: 2017/11/07
    File: ModelManager.h
 ***************************************************************************/
#ifndef MODELMANAGER_H_0E42B205_5B88_5E39_84B8_6A36CED83E8A
#define MODELMANAGER_H_0E42B205_5B88_5E39_84B8_6A36CED83E8A

#include <QObject>

#include "ObjectModel.h"

class ModelManagerPrivate;

class ModelManager : public QObject
{
    Q_OBJECT
public:
    explicit ModelManager(QObject *parent = 0);
    ~ModelManager();

    Q_INVOKABLE void initData();
    Q_INVOKABLE ObjectModel* objectModel();
    Q_INVOKABLE void testInsert();

private:
    QScopedPointer<ModelManagerPrivate> d_ptr;
    Q_DECLARE_PRIVATE(ModelManager)
};

#endif // MODELMANAGER_H_0E42B205_5B88_5E39_84B8_6A36CED83E8A

實現文件如下:

/***************************************************************************
    Copyright (C) 2017 by ZhaoDongshuang
    Author: ZhaoDongshuang
    Email: imtoby@126.com
    Date: 2017/11/07
    File: ModelManager.cpp
 ***************************************************************************/
#include "ModelManager.h"
#include <QThread>
#include <QDateTime>

#include "TestItem.h"

class ModelManagerPrivate
{
public:
    ModelManagerPrivate(ModelManager *parent)
        : q_ptr(parent)
        , objectModel(NULL)
    {
    }

    void init();
    void uninit();

private:
    ModelManager * const q_ptr;
    Q_DECLARE_PUBLIC(ModelManager)

    ObjectModel* objectModel;
    QThread workerThread;
};

ModelManager::ModelManager(QObject *parent) :
    QObject(parent),
    d_ptr(new ModelManagerPrivate(this))
{
    Q_D(ModelManager);
    d->init();
}

ModelManager::~ModelManager()
{
    Q_D(ModelManager);
    d->uninit();
}

void ModelManager::initData()
{
    Q_D(ModelManager);
    QObjectList testItemList;
    for (int i=0; i<5; ++i) {
        TestItem* newTestItem = new TestItem(this);
        testItemList.append(newTestItem);
    }
    d->objectModel->set(&testItemList);
}

ObjectModel *ModelManager::objectModel()
{
    Q_D(ModelManager);
    return d->objectModel;
}

void ModelManager::testInsert()
{
    Q_D(ModelManager);
    TestItem* newTestItem = new TestItem(this);
    newTestItem->setName(QString::number(QDateTime::currentMSecsSinceEpoch()));
    d->objectModel->append(newTestItem);
}

void ModelManagerPrivate::init()
{
    Q_Q(ModelManager);
    if (objectModel == NULL) {
        objectModel = new ObjectModel(q);
    }
}

void ModelManagerPrivate::uninit()
{
    if (objectModel) {
        objectModel->deleteLater();
        objectModel = NULL;
    }
}

接下來是用于測試的 main.cpp 文件的內容:

/***************************************************************************
    Copyright (C) 2017 by ZhaoDongshuang
    Author: ZhaoDongshuang
    Email: imtoby@126.com
    Date: 2017/11/07
    File: main.cpp
 ***************************************************************************/
#include <QGuiApplication>
#include <QQmlApplicationEngine>
#include <QQmlContext>
#include <QQmlEngine>
#include <QQuickItem>

#include "ModelManager.h"
#include "ObjectModel.h"

int main(int argc, char *argv[])
{
    QGuiApplication app(argc, argv);

    QQmlApplicationEngine engine;

    // 向 QML 域注冊 ObjectModel 類
    qmlRegisterUncreatableType<ObjectModel, 1>("com.test.model", 1, 0,
                                               "ObjectModel",
                                               "Cannot create ObjectModel");

    ModelManager* modelMgr = new ModelManager(&app);
    engine.rootContext()->setContextProperty("modelMgr", modelMgr);

    engine.load(QUrl(QStringLiteral("qrc:/main.qml")));

    // 初始化數據
    modelMgr->initData();

    int r = app.exec();

    if (modelMgr) {
        modelMgr->deleteLater();
        modelMgr = NULL;
    }

    return r;
}

至于 QML 文件就相對很簡單了:

/***************************************************************************
    Copyright (C) 2017 by ZhaoDongshuang
    Author: ZhaoDongshuang
    Email: imtoby@126.com
    Date: 2017/11/07
    File: main.qml
 ***************************************************************************/
import QtQuick 2.3
import QtQuick.Window 2.2
import "qml/dialog"

Window {
    id: rootWindow
    visible: true
    width: 240
    height: 360

    ListView {
        anchors.fill: parent

        model: modelMgr.objectModel()

        delegate: Text {
            width: rootWindow.width
            height: 40
            text: model.modelData.name + index
        }
    }

    MouseArea {
        anchors.fill: parent
        onClicked: {
            modelMgr.testInsert()
        }
    }
}
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,837評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,196評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,688評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,654評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,456評論 6 406
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,955評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,044評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,195評論 0 287
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,725評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,608評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,802評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,318評論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,048評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,422評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,673評論 1 281
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,424評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,762評論 2 372

推薦閱讀更多精彩內容

  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,605評論 25 708
  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具(例如配置管理,服務發現,斷路器,智...
    卡卡羅2017閱讀 134,781評論 18 139
  • 1.項目經驗 2.基礎問題 3.指南認識 4.解決思路 ios開發三大塊: 1.Oc基礎 2.CocoaTouch...
    陽光的大男孩兒閱讀 5,012評論 0 13
  • 很高興能借此機會向大家學習教養孩子的心得,回想淘淘上學一年時間里讓我觸動最深的是閱讀習慣的養成。剛開學老師就跟我反...
    夏夏kit閱讀 229評論 0 0
  • 當團隊中有新成員進來時就需要給他們做培訓,從最簡單的協作開始,讓他們快速地適應團隊。 研發和測試協作最多的應該是B...
    灼灼2015閱讀 489評論 0 1