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 QQMLEXPRESSION_H
41#define QQMLEXPRESSION_H
42
43#include <QtQml/qqmlerror.h>
44#include <QtQml/qqmlscriptstring.h>
45
46#include <QtCore/qobject.h>
47#include <QtCore/qvariant.h>
48
49QT_BEGIN_NAMESPACE
50
51
52class QString;
53class QQmlRefCount;
54class QQmlEngine;
55class QQmlContext;
56class QQmlExpressionPrivate;
57class QQmlContextData;
58class Q_QML_EXPORT QQmlExpression : public QObject
59{
60 Q_OBJECT
61public:
62 QQmlExpression();
63 QQmlExpression(QQmlContext *, QObject *, const QString &, QObject * = nullptr);
64 explicit QQmlExpression(const QQmlScriptString &, QQmlContext * = nullptr, QObject * = nullptr, QObject * = nullptr);
65 ~QQmlExpression() override;
66
67 QQmlEngine *engine() const;
68 QQmlContext *context() const;
69
70 QString expression() const;
71 void setExpression(const QString &);
72
73 bool notifyOnValueChanged() const;
74 void setNotifyOnValueChanged(bool);
75
76 QString sourceFile() const;
77 int lineNumber() const;
78 int columnNumber() const;
79 void setSourceLocation(const QString &fileName, int line, int column = 0);
80
81 QObject *scopeObject() const;
82
83 bool hasError() const;
84 void clearError();
85 QQmlError error() const;
86
87 QVariant evaluate(bool *valueIsUndefined = nullptr);
88
89Q_SIGNALS:
90 void valueChanged();
91
92private:
93 QQmlExpression(QQmlContextData *, QObject *, const QString &);
94
95 Q_DISABLE_COPY(QQmlExpression)
96 Q_DECLARE_PRIVATE(QQmlExpression)
97 friend class QQmlDebugger;
98 friend class QQmlContext;
99};
100
101QT_END_NAMESPACE
102
103#endif // QQMLEXPRESSION_H
104
105