1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtQml module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QQMLCONTEXT_H
41#define QQMLCONTEXT_H
42
43#include <QtCore/qurl.h>
44#include <QtCore/qobject.h>
45#include <QtCore/qlist.h>
46#include <QtCore/qpair.h>
47#include <QtQml/qjsvalue.h>
48#include <QtCore/qmetatype.h>
49#include <QtCore/qvariant.h>
50
51QT_BEGIN_NAMESPACE
52
53
54class QString;
55class QQmlEngine;
56class QQmlRefCount;
57class QQmlContextPrivate;
58class QQmlCompositeTypeData;
59class QQmlContextData;
60
61class Q_QML_EXPORT QQmlContext : public QObject
62{
63 Q_OBJECT
64 Q_DECLARE_PRIVATE(QQmlContext)
65
66public:
67 struct PropertyPair { QString name; QVariant value; };
68
69 QQmlContext(QQmlEngine *parent, QObject *objParent = nullptr);
70 QQmlContext(QQmlContext *parent, QObject *objParent = nullptr);
71 ~QQmlContext() override;
72
73 bool isValid() const;
74
75 QQmlEngine *engine() const;
76 QQmlContext *parentContext() const;
77
78 QObject *contextObject() const;
79 void setContextObject(QObject *);
80
81 QVariant contextProperty(const QString &) const;
82 void setContextProperty(const QString &, QObject *);
83 void setContextProperty(const QString &, const QVariant &);
84 void setContextProperties(const QVector<PropertyPair> &properties);
85
86 // ### Qt 6: no need for a mutable object, this should become a const QObject pointer
87 QString nameForObject(QObject *) const;
88
89 QUrl resolvedUrl(const QUrl &);
90
91 void setBaseUrl(const QUrl &);
92 QUrl baseUrl() const;
93
94private:
95 friend class QQmlEngine;
96 friend class QQmlEnginePrivate;
97 friend class QQmlExpression;
98 friend class QQmlExpressionPrivate;
99 friend class QQmlComponent;
100 friend class QQmlComponentPrivate;
101 friend class QQmlScriptPrivate;
102 friend class QQmlContextData;
103 QQmlContext(QQmlContextData *);
104 QQmlContext(QQmlEngine *, bool);
105 Q_DISABLE_COPY(QQmlContext)
106};
107QT_END_NAMESPACE
108
109Q_DECLARE_METATYPE(QList<QObject*>)
110
111#endif // QQMLCONTEXT_H
112