QMLのモデルビュー。 パート4：C ++モデル

QMLの主な目的はインターフェースを作成することであるため、MVCパターンに従って、プレゼンテーションと制御が実装されます。 モデルの実装では、C ++は非常に論理的です。 ここで、制限がはるかに少なくなり、複雑なモデルを実装できるようになります。 さらに、プログラムの大部分がC ++で記述されており、そこからデータが取得される場合、モデルを同じ場所に配置するのが最善です。

そのようなモデルの使用は、実装の見かけ上の複雑さによっておびえているかもしれません。 C ++が最も簡単な言語ではないとは言いません。 これはQMLよりも複雑であり、足元で自分自身を撃たないように注意が必要です。これは事実です。 それにもかかわらず、実際には、すべてがそれほど怖いわけではありません。

まず、純粋なC ++で書いているのではなく、Qtを使用していることを忘れないでください。 QObjectの親子、コンテナ、シグナル、スロットの暗黙的な共有、QVariantなど、メモリを使用した作業を大幅に簡素化および自動化します。これにより、開発者は頭痛から解放され、信頼性が向上します。 動的プログラミング言語で書いているように見えることさえあります。 これにより、QMLとC ++の間のギャップも小さくなり、QMLとC ++間の移行が多少スムーズになります。

第二に、すべてのQMLモデルは最終的にこれらの同じC ++モデルに縮小されます。最高のパフォーマンスではなく、単純化されたバージョンのみが取得されます。 QMLモデルの操作方法を既に理解している場合は、C ++モデルを扱う方が簡単です。 プロセスでもう少し低レベルの情報を学習するだけでなく、それがどのように機能するかを理解することが改善されます。

一般的に、C ++モデルをマスターする価値はあります。 これは特に、QAbstractItemModelについて当てはまります。

QMLのモデルビュー：

• QMLのモデルビュー。 パートゼロ、入門
• QMLのモデルビュー。 パート1：事前作成されたコンポーネントビュー
• QMLのモデルビュー。 パート2：カスタムビュー
• QMLのモデルビュー。 パート3：QMLおよびJavaScriptのモデル
• QMLのモデルビュー。 パート4：C ++モデル

1. C ++-QAbstractItemModelモデル

これは、Qt Model-Viewフレームワークの標準モデルです。 このクラスには豊富な機能があり、さまざまな複雑さのモデルを構築できます。

そのようなモデルには3つの基本クラスがあります。 QAbstractTableModelはデータを表形式で表し、行番号と列番号を使用してデータにアクセスします。 QAbstractListModelはリスト内のデータを表し、1つの列を持つ以前のモデルの特殊なケースと言えます。

それどころか、QAbstractItemModelはより一般化されたバージョンです。 各テーブル要素には、子要素を含めることもできます。子要素もテーブル形式で編成されます。 したがって、このテーブルを使用して、ツリー構造を整理できます。 Qtには、子は最初の列の要素しか持てないという一般的なルールがあります。QTreeViewなどのQtからのビューを使用する場合、この形式が必要ですが、便利な方法でモデルを編成することを禁止しません。 そのようなモデルの例として、QFileSystemModelクラスを引用できます。 最初の列は、ファイルまたはディレクトリの名前です。 ディレクトリの場合、この列の要素にも子があります。 残りの列には、ファイルに関するさまざまな情報（サイズ、変更時間など）が含まれます。 このようなデータ構造は、任意のファイルマネージャーにあります。

モデルとビューの間に特別なプロキシモデルを挿入できます。 このようなモデルは、メインモデルへの呼び出しをインターセプトし、特定の要素を隠したり、順序を変更したり、データの受信や記録に影響を与えたりすることができます Qtには、既成のQSortFilterProxyModelクラスがあり、モデルデータをソートおよび/またはフィルターされた形式で表すことができます。 機能が十分でない場合は、このクラスまたはQAbstractProxyModelから継承して、独自のプロキシモデルを作成できます。

QMLのビューはリストのみを表示できます。 VisualDataModelを使用すると、ツリー構造をナビゲートできますが、現在のレベルの要素のみを表示できます。 データをツリーに保存してQMLで表示する必要がある場合は、VisualDataModelを使用するか、このツリーをリストに変換する独自のプロキシモデルを作成する必要があります。

独自のモデルを作成するには、モデルの基本クラスの1つから継承し、このモデルに必要なメソッドを決定する必要があります。 何をする必要があるかを簡単に説明しますが、より詳細な情報はドキュメントで入手できます 。 複雑さの昇順で検討します。

リストモデルの場合、QAbstractListModelから派生クラスを作成し、そのようなメソッドを定義する必要があります。

• rowCount（）-行数を返します。この場合、これは要素の数です。
• data（）-要素のデータを返します。
• roleNames（）-デリゲートで利用可能なロールのリストを返します。 デフォルトでは、表示、装飾、編集、toolTip、statusTip、およびwhatsThisの役割が定義されています。 Qtの4番目のバージョンでは、この関数をオーバーライドする代わりに、必要なロール名を設定するsetRoleNames（）関数を呼び出す必要がありました。

デリゲートの助けを借りてモデルデータを編集する予定がない場合は、これで十分です。 編集したモデルについては少し後で検討します。

テーブルモデルの場合、列数を返すcolumnCount（）メソッドも追加されます。 QMLテーブルビューは最初の列の要素を使用し、表示されると、この要素の役割を列として分散します。 したがって、QMLのテーブルは同じリストを使用して実装され、テーブルモデルを使用することはほとんど意味がありません。

ツリー構造のモデルが必要な場合は、QAbstractItemModelを使用します。 このモデルでは、さらに次の機能を決定する必要があります。

• parent（）-要素の親インデックスを返します。
• index（）-要素のインデックスを返します。

Qtモデルでは、要素へのアクセスは特別なインデックス-QModelIndex型のオブジェクトを介して行われます。 これらには、行と列の番号、親要素のインデックス、およびいくつかの追加データが含まれます。 モデルのルート要素に無効なQModelIndex（）インデックスがあります。 したがって、単純なリストまたはテーブルがある場合、すべての要素について、親要素はそれだけになります。 ツリーの場合、最上位要素のみがそのような親を持ちます。 index（）関数は、親のインデックスと要素の行番号と列番号を取得し、要素のインデックスを返す必要があります。 インデックスはcreateIndex（）関数を使用して作成されます。

実際、ネストが必要になると困難が始まり、すべてが非常に簡単です。

例として、リストモデルを考えます。 データは、行のリストと同じオブジェクトに保存されます。 add（）関数も作成します。この関数は、モデルにもう1つの要素を追加し、QMLから呼び出せるように特別なマクロQ_INVOKABLEでマークします。

クラス定義：

#include <QAbstractListModel> #include <QStringList> class TestModel : public QAbstractListModel { Q_OBJECT public: enum Roles { ColorRole = Qt::UserRole + 1, TextRole }; TestModel(QObject *parent = 0); virtual int rowCount(const QModelIndex &parent) const; virtual QVariant data(const QModelIndex &index, int role) const; virtual QHash<int, QByteArray> roleNames() const; Q_INVOKABLE void add(); private: QStringList m_data; };
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ColorRoleとTextRoleの2つのロールを定義し、それらにQt :: UserRoleより大きい値を使用します。これは、Qtの予約値が終了する場所です。 したがって、ユーザーロールの場合、Qt :: UserRoleで始まる値を使用する必要があります。

クラスメソッドの実装：

 TestModel::TestModel(QObject *parent): QAbstractListModel(parent) { m_data.append("old"); m_data.append("another old"); } int TestModel::rowCount(const QModelIndex &parent) const { if (parent.isValid()) { return 0; } return m_data.size(); } QVariant TestModel::data(const QModelIndex &index, int role) const { if (!index.isValid()) { return QVariant(); } switch (role) { case ColorRole: return QVariant(index.row() < 2 ? "orange" : "skyblue"); case TextRole: return m_data.at(index.row()); default: return QVariant(); } } QHash<int, QByteArray> TestModel::roleNames() const { QHash<int, QByteArray> roles = QAbstractListModel::roleNames(); roles[ColorRole] = "color"; roles[TextRole] = "text"; return roles; } void TestModel::add() { beginInsertRows(QModelIndex(), m_data.size(), m_data.size()); m_data.append("new"); endInsertRows(); m_data[0] = QString("Size: %1").arg(m_data.size()); QModelIndex index = createIndex(0, 0, static_cast<void *>(0)); emit dataChanged(index, index); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

QMLは整数定数ではなく文字列名を使用してロールにアクセスするため、色とテキストの名前を定義します。 追加する前に、特別な関数beginInsertRows（）を呼び出します。これは、要素が準備されていることとそれらが追加される場所をビューが認識できるように、必要な信号を発行します。 次に、endInsertRows（）関数を呼び出します。この関数は、モデルに要素が追加されたことを示す信号を再度送信します。 すべての追加は、この方法でラップする必要があります。 アイテムを削除および移動するための同様の機能があります。

add（）関数では、最初の要素のテキストを変更して、リスト内の要素の数を表示します。 その後、シグナルdataChanged（）を発行して、ビューについて通知します。 変更されたデータの最初と最後のインデックスのパラメーターに信号を渡します（同じものがあります）。 インデックスはcreateIndex（）関数を使用して取得されます。この関数は、パラメータを行、列、およびプライベートデータへのポインタに渡します。 通常、データを持つオブジェクトへのポインターが後者として使用されますが、この場合、単純化して常にNULLを使用できます。

QMLプログラムとして、2番目の例を少しやり直します。 C ++-モデルはプラグイン（プラグイン）として実装されます。 ファイルの先頭に、インポートを追加します。

 import TestModel 1.0
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

このタイプのオブジェクトを作成し、モデルとして使用します。

 TestModel { id: dataModel }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

プログラムを開始していくつかの要素を追加すると、次のような結果が得られます。

モデルデータを編集するには、デリゲートに標準インターフェイスがあり、それを使用するには、モデルのsetData（）メソッドを再定義する必要があります。 QMLからQAbstractItemModelデータを編集する機能はQt 5で登場しました。

次の宣言をヘッダーファイルに追加します。

 virtual bool setData(const QModelIndex &index, const QVariant &value, int role); virtual Qt::ItemFlags flags(const QModelIndex &index) const;
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

そして、定義実装ファイルに：

 bool TestModel::setData(const QModelIndex &index, const QVariant &value, int role) { if (!index.isValid()) { return false; } switch (role) { case ColorRole: return false; // This property can not be set case TextRole: m_data[index.row()] = value.toString(); break; default: return false; } emit dataChanged(index, index, QVector<int>() << role); return true; } Qt::ItemFlags TestModel::flags(const QModelIndex &index) const { if (!index.isValid()) return Qt::ItemIsEnabled; return QAbstractListModel::flags(index) | Qt::ItemIsEditable; }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

モデルと同様のコードを使用して、デリゲートからテキストプロパティを直接編集する機能を追加しました。

 model.text = "Some new text"
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

この例のデリゲートを編集して、次の要素を追加してみましょう。

 MouseArea { anchors.fill: parent onDoubleClicked: model.text = "Edited" }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

これで、要素をダブルクリックすると、そのテキストが「編集済み」に変わります。

Qt :: ItemIsEditableフラグはQt表示に使用され、アイテムを編集できることを示すため、flags（）メソッドを再定義する必要があります。 現時点では、このフラグはQMLでチェックされておらず、モデルはインストールされていなくても編集可能ですが、無視しないことをお勧めします。 将来のバージョンでは、このチェックが追加される可能性があります。

2. C ++-リスト

モデルとして、文字列のリストまたはQObject型のオブジェクトを使用できます。

QStringList型のプロパティを持つ単純なクラスを作成してみましょう。

 #include <QObject> #include <QStringList> class TestModel : public QObject { Q_OBJECT Q_PROPERTY(QStringList data READ data CONSTANT) public: TestModel(QObject *parent = 0); QStringList data() const; }; TestModel::TestModel(QObject *parent): QObject(parent) { } QStringList TestModel::data() const { return QStringList() << "orange" << "skyblue"; }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

少しやり直した最初の例を使用します。 モデルオブジェクトのインポートと作成は、前の例とまったく同じです。 ただし、オブジェクト自体の代わりに、そのプロパティがモデルとして使用されます。

 model: dataModel.data
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

テキストは要素のインデックスを使用します：

 text: model.index
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

このようなリストは、JavaScript配列のように機能します。 したがって、これは受動モデルであり、要素の追加/削除はプレゼンテーションに影響しません。

3. QQmlListProperty

このクラスを使用すると、C ++とQMLの両方に入力できるリストを作成できます。 QMLの入力は、オブジェクトの作成時に静的に実行されます（ListModelで行われます）。 C ++では、要素を追加/削除することもできます。そのため、特別なメソッドを作成してQ_INVOKABLEマクロでマークすると、QMLからもこれを行うことができます。

このタイプのリストには、タイプQObjectのオブジェクトとそれから派生したタイプを保存できます。 型では、使用されるすべてのプロパティを定義する価値があります（Q_PROPERTYを使用）。

そのようなオブジェクトの例を考えてみましょう。

 #include <QObject> class Element : public QObject { Q_OBJECT Q_PROPERTY(QString color READ color WRITE setColor NOTIFY colorChanged) Q_PROPERTY(QString text READ text WRITE setText NOTIFY textChanged) public: explicit Element(QObject *parent = 0); QString color() const; void setColor(QString color); QString text() const; void setText(QString text); signals: void colorChanged(QString color); void textChanged(QString text); private: QString m_color; QString m_text; }; Element::Element(QObject *parent) : QObject(parent) { } QString Element::color() const { return m_color; } void Element::setColor(QString color) { if (m_color == color) { return; } m_color = color; emit colorChanged(m_color); } QString Element::text() const { return m_text; } void Element::setText(QString text) { if (m_text == text) { return; } m_text = text; emit textChanged(m_text); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

色とテキスト、ゲッター、セッター、およびそれらの通知機能という2つのプロパティを含む単純なクラスを作成しました。

このタイプのオブジェクトをQQmlListPropertyで使用するには、このタイプがQMLで表示されている必要があります。 このためには、qmlRegisterType（）関数を使用してこのタイプを登録する必要があります。 私はC ++プラグインを使用しているので、このタイプをモデルとともに特別なハンドラーに登録します。

 void TestModelPlugin::registerTypes(const char *uri) { qmlRegisterType<TestModel>(uri, 1, 0, "TestModel"); qmlRegisterType<Element>(uri, 1, 0, "Element"); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

QQmlListPropertyを使用するには、オブジェクトにQQmlListProperty型のプロパティを作成する必要があります。ここで、Tは保存するオブジェクトの型です。 この場合、タイプQQmlListPropertyのプロパティがあります。

QQmlListPropertyコンストラクターは、リストを操作するときにQMLエンジンが呼び出すメソッドを引数として受け取ります。 これらは、アイテムの追加と取得、アイテムの数の取得、およびリストのクリアのためのメソッドです。 最初のもののみが必須ですが、すべてを定義する方が良いです。

したがって、モデルのクラスコード：

 #include <QObject> #include <QQmlListProperty> class Element; class TestModel : public QObject { Q_OBJECT Q_PROPERTY(QQmlListProperty<Element> data READ data NOTIFY dataChanged) Q_CLASSINFO("DefaultProperty", "data") public: TestModel(QObject *parent = 0); QQmlListProperty<Element> data(); Q_INVOKABLE void add(); signals: void dataChanged(); private: static void appendData(QQmlListProperty<Element> *list, Element *value); static int countData(QQmlListProperty<Element> *list); static Element *atData(QQmlListProperty<Element> *list, int index); static void clearData(QQmlListProperty<Element> *list); QList<Element*> m_data; }; TestModel::TestModel(QObject *parent): QObject(parent) { Element *element = new Element(this); element->setProperty("color", "lightgreen"); element->setProperty("text", "eldest"); m_data << element; } QQmlListProperty<Element> TestModel::data() { return QQmlListProperty<Element>(static_cast<QObject *>(this), static_cast<void *>(&m_data), &TestModel::appendData, &TestModel::countData, &TestModel::atData, &TestModel::clearData); } void TestModel::add() { Element *element = new Element(this); element->setProperty("color", "skyblue"); element->setProperty("text", "new"); m_data.append(element); emit dataChanged(); } void TestModel::appendData(QQmlListProperty<Element> *list, Element *value) { QList<Element*> *data = static_cast<QList<Element*> *>(list->data); data->append(value); } int TestModel::countData(QQmlListProperty<Element> *list) { QList<Element*> *data = static_cast<QList<Element*> *>(list->data); return data->size(); } Element *TestModel::atData(QQmlListProperty<Element> *list, int index) { QList<Element*> *data = static_cast<QList<Element*> *>(list->data); return data->at(index); } void TestModel::clearData(QQmlListProperty<Element> *list) { QList<Element*> *data = static_cast<QList<Element*> *>(list->data); qDeleteAll(data->begin(), data->end()); data->clear(); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

QAbstractItemModelの例のように、要素を追加するためのadd（）メソッドがあり、要素もコンストラクターに追加されます。

タイプQQmlListPropertyのオブジェクトは、data（）メソッドで作成されます。 コンストラクターでは、親（QObject）、プライベートデータへのポインターを受け取ります。これは、リストと関数自体を操作するための関数で使用できます。 すべての関数で、最初の引数は、データプロパティにプライベートデータを持つQQmlListProperty型のオブジェクトへのポインターです。 タイプElementのオブジェクトが実際に保存されるリストをそこに置きます。

操作中にオブジェクトを追加/削除するときに、ビューがモデルの変更に関する情報を受け取るように、データプロパティの信号が必要です。 そのような信号の後、ディスプレイはモデル全体を再読み取りします。

このモデルを示すために、わずかにやり直した2番目の例を取り上げます。

C ++を接続します-プラグイン：

 import ListProperty_Plugin 1.0  : TestModel { id: dataModel data: [ Element { color: "orange" text: "old" }, Element { color: "lightgray" text: "another old" } ] }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

データプロパティは、通常のリストとして定義されます。 Elementタイプを登録したため、そのようなオブジェクトをQMLで作成できるようになりました。 ここでのデータ配列の要素の定義は、すでに存在する要素を置き換えるものではないことに注意してください。 これらの要素は、TestModelクラスのコンストラクターで定義された要素に追加されます。

モデル自体はTestModel型のオブジェクトではなく、同じデータプロパティです。

 model: dataModel.data
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

デリゲートのデータには、modelDataからアクセスできます。

 color: modelData.color
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

そして

 text: modelData.text
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

要素はdataプロパティに静的にのみ追加できるため、このために作成したadd（）関数を使用します。

 onClicked: dataModel.add()
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

その結果、次のような結果が得られます。

TestModelクラスでは、データをデフォルトプロパティとして指定しました（Q_CLASSINFOディレクティブを使用）。 これにより、TestModelオブジェクトでElementオブジェクトを直接定義する機会が与えられ、それら自体が目的のプロパティに追加されます。 したがって、モデルの定義を単純化し、次のように書き換えることができます。

 TestModel { id: dataModel Element { color: "orange" text: "old" } Element { color: "lightgray" text: "another old" } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

したがって、QQmlListPropertyを使用すると、QAbstractItemModelクラスを使用せずにアクティブモデルを実装できます。 大量のデータが予期されておらず、頻繁に変更されるべきではない場合、このようなモデルは非常に適しています。

まとめ

モデル開発は、QMLプログラミングだけでなく、プログラミング全体の重要な部分です。 フレッド・ブルックスが言ったように、「フローチャートを表示し、テーブルを非表示にすると、困惑し、テーブルを表示し、フローチャートを必要としない可能性が高くなります。それは明らかです。」 そのデータはプログラミングの中心的なテーマです。 データ構造の設計とアクセスは重要なタスクであり、プログラムのアーキテクチャを大きく決定します。

この部分と前の部分で説明したツールを理解すると、データを最も適切な方法で整理し、データとプログラム自体を整理するのに役立ちます。 Model-Viewの概念はQMLの基本概念の1つであるため、これらのツールで十分です。

モデルを作成するさまざまな方法を検討しました。 私自身の経験から、最もよく使用されるのはQAbstractItemModel、ListModel、およびJavaScript配列です。 だから、まず第一に、注意を払うことをお勧めします。