| /**************************************************************************** |
| ** |
| ** Copyright (C) 2016 The Qt Company Ltd. |
| ** Contact: https://www.qt.io/licensing/ |
| ** |
| ** This file is part of the QtQml module of the Qt Toolkit. |
| ** |
| ** $QT_BEGIN_LICENSE:LGPL$ |
| ** Commercial License Usage |
| ** Licensees holding valid commercial Qt licenses may use this file in |
| ** accordance with the commercial license agreement provided with the |
| ** Software or, alternatively, in accordance with the terms contained in |
| ** a written agreement between you and The Qt Company. For licensing terms |
| ** and conditions see https://www.qt.io/terms-conditions. For further |
| ** information use the contact form at https://www.qt.io/contact-us. |
| ** |
| ** GNU Lesser General Public License Usage |
| ** Alternatively, this file may be used under the terms of the GNU Lesser |
| ** General Public License version 3 as published by the Free Software |
| ** Foundation and appearing in the file LICENSE.LGPL3 included in the |
| ** packaging of this file. Please review the following information to |
| ** ensure the GNU Lesser General Public License version 3 requirements |
| ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. |
| ** |
| ** GNU General Public License Usage |
| ** Alternatively, this file may be used under the terms of the GNU |
| ** General Public License version 2.0 or (at your option) the GNU General |
| ** Public license version 3 or any later version approved by the KDE Free |
| ** Qt Foundation. The licenses are as published by the Free Software |
| ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 |
| ** included in the packaging of this file. Please review the following |
| ** information to ensure the GNU General Public License requirements will |
| ** be met: https://www.gnu.org/licenses/gpl-2.0.html and |
| ** https://www.gnu.org/licenses/gpl-3.0.html. |
| ** |
| ** $QT_END_LICENSE$ |
| ** |
| ****************************************************************************/ |
| |
| #ifndef QQUICKXMLLISTMODEL_H |
| #define QQUICKXMLLISTMODEL_H |
| |
| // |
| // W A R N I N G |
| // ------------- |
| // |
| // This file is not part of the Qt API. It exists purely as an |
| // implementation detail. This header file may change from version to |
| // version without notice, or even be removed. |
| // |
| // We mean it. |
| // |
| |
| #include <qqml.h> |
| #include <qqmlinfo.h> |
| #include <qjsvalue.h> |
| |
| #include <QtCore/qurl.h> |
| #include <QtCore/qstringlist.h> |
| #include <QtCore/qabstractitemmodel.h> |
| |
| QT_BEGIN_NAMESPACE |
| |
| |
| class QQmlContext; |
| class QQuickXmlListModelRole; |
| class QQuickXmlListModelPrivate; |
| |
| struct QQuickXmlQueryResult { |
| int queryId; |
| int size; |
| QList<QList<QVariant> > data; |
| QList<QPair<int, int> > inserted; |
| QList<QPair<int, int> > removed; |
| QStringList keyRoleResultsCache; |
| }; |
| |
| class QQuickXmlListModel : public QAbstractListModel, public QQmlParserStatus |
| { |
| Q_OBJECT |
| Q_INTERFACES(QQmlParserStatus) |
| |
| Q_PROPERTY(Status status READ status NOTIFY statusChanged) |
| Q_PROPERTY(qreal progress READ progress NOTIFY progressChanged) |
| Q_PROPERTY(QUrl source READ source WRITE setSource NOTIFY sourceChanged) |
| Q_PROPERTY(QString xml READ xml WRITE setXml NOTIFY xmlChanged) |
| Q_PROPERTY(QString query READ query WRITE setQuery NOTIFY queryChanged) |
| Q_PROPERTY(QString namespaceDeclarations READ namespaceDeclarations WRITE setNamespaceDeclarations NOTIFY namespaceDeclarationsChanged) |
| Q_PROPERTY(QQmlListProperty<QQuickXmlListModelRole> roles READ roleObjects) |
| Q_PROPERTY(int count READ count NOTIFY countChanged) |
| Q_CLASSINFO("DefaultProperty", "roles") |
| |
| public: |
| QQuickXmlListModel(QObject *parent = 0); |
| ~QQuickXmlListModel(); |
| |
| QModelIndex index(int row, int column, const QModelIndex &parent) const override; |
| int rowCount(const QModelIndex &parent) const override; |
| QVariant data(const QModelIndex &index, int role) const override; |
| QHash<int, QByteArray> roleNames() const override; |
| |
| int count() const; |
| |
| QQmlListProperty<QQuickXmlListModelRole> roleObjects(); |
| |
| QUrl source() const; |
| void setSource(const QUrl&); |
| |
| QString xml() const; |
| void setXml(const QString&); |
| |
| QString query() const; |
| void setQuery(const QString&); |
| |
| QString namespaceDeclarations() const; |
| void setNamespaceDeclarations(const QString&); |
| |
| Q_INVOKABLE QJSValue get(int index) const; |
| |
| enum Status { Null, Ready, Loading, Error }; |
| Q_ENUM(Status) |
| Status status() const; |
| qreal progress() const; |
| |
| Q_INVOKABLE QString errorString() const; |
| |
| void classBegin() override; |
| void componentComplete() override; |
| |
| Q_SIGNALS: |
| void statusChanged(QQuickXmlListModel::Status); |
| void progressChanged(qreal progress); |
| void countChanged(); |
| void sourceChanged(); |
| void xmlChanged(); |
| void queryChanged(); |
| void namespaceDeclarationsChanged(); |
| |
| public Q_SLOTS: |
| // ### need to use/expose Expiry to guess when to call this? |
| // ### property to auto-call this on reasonable Expiry? |
| // ### LastModified/Age also useful to guess. |
| // ### Probably also applies to other network-requesting types. |
| void reload(); |
| |
| private Q_SLOTS: |
| #if QT_CONFIG(qml_network) |
| void requestFinished(); |
| #endif |
| void requestProgress(qint64,qint64); |
| void dataCleared(); |
| void queryCompleted(const QQuickXmlQueryResult &); |
| void queryError(void* object, const QString& error); |
| |
| private: |
| Q_DECLARE_PRIVATE(QQuickXmlListModel) |
| Q_DISABLE_COPY(QQuickXmlListModel) |
| }; |
| |
| class QQuickXmlListModelRole : public QObject |
| { |
| Q_OBJECT |
| Q_PROPERTY(QString name READ name WRITE setName NOTIFY nameChanged) |
| Q_PROPERTY(QString query READ query WRITE setQuery NOTIFY queryChanged) |
| Q_PROPERTY(bool isKey READ isKey WRITE setIsKey NOTIFY isKeyChanged) |
| public: |
| QQuickXmlListModelRole() : m_isKey(false) {} |
| ~QQuickXmlListModelRole() {} |
| |
| QString name() const { return m_name; } |
| void setName(const QString &name) { |
| if (name == m_name) |
| return; |
| m_name = name; |
| Q_EMIT nameChanged(); |
| } |
| |
| QString query() const { return m_query; } |
| void setQuery(const QString &query) |
| { |
| if (query.startsWith(QLatin1Char('/'))) { |
| qmlWarning(this) << tr("An XmlRole query must not start with '/'"); |
| return; |
| } |
| if (m_query == query) |
| return; |
| m_query = query; |
| Q_EMIT queryChanged(); |
| } |
| |
| bool isKey() const { return m_isKey; } |
| void setIsKey(bool b) { |
| if (m_isKey == b) |
| return; |
| m_isKey = b; |
| Q_EMIT isKeyChanged(); |
| } |
| |
| bool isValid() const { |
| return !m_name.isEmpty() && !m_query.isEmpty(); |
| } |
| |
| Q_SIGNALS: |
| void nameChanged(); |
| void queryChanged(); |
| void isKeyChanged(); |
| |
| private: |
| QString m_name; |
| QString m_query; |
| bool m_isKey; |
| }; |
| |
| QT_END_NAMESPACE |
| |
| QML_DECLARE_TYPE(QQuickXmlListModel) |
| QML_DECLARE_TYPE(QQuickXmlListModelRole) |
| |
| #endif // QQUICKXMLLISTMODEL_H |