src/qml/qml/qqmlexpression.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtQml module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QQMLEXPRESSION_H
  43 #define QQMLEXPRESSION_H
  44
  45 #include <QtQml/qqmlerror.h>
  46 #include <QtQml/qqmlscriptstring.h>
  47
  48 #include <QtCore/qobject.h>
  49 #include <QtCore/qvariant.h>
  50
  51 QT_BEGIN_HEADER
  52
  53 QT_BEGIN_NAMESPACE
  54
  55
  56 class QString;
  57 class QQmlRefCount;
  58 class QQmlEngine;
  59 class QQmlContext;
  60 class QQmlExpressionPrivate;
  61 class QQmlContextData;
  62 class Q_QML_EXPORT QQmlExpression : public QObject
  63 {
  64     Q_OBJECT
  65 public:
  66     QQmlExpression();
  67     QQmlExpression(QQmlContext *, QObject *, const QString &, QObject * = 0);
  68     explicit QQmlExpression(const QQmlScriptString &, QObject * = 0);
  69     virtual ~QQmlExpression();
  70
  71     QQmlEngine *engine() const;
  72     QQmlContext *context() const;
  73
  74     QString expression() const;
  75     void setExpression(const QString &);
  76
  77     bool notifyOnValueChanged() const;
  78     void setNotifyOnValueChanged(bool);
  79
  80     QString sourceFile() const;
  81     int lineNumber() const;
  82     int columnNumber() const;
  83     void setSourceLocation(const QString &fileName, int line, int column = 0);
  84
  85     QObject *scopeObject() const;
  86
  87     bool hasError() const;
  88     void clearError();
  89     QQmlError error() const;
  90
  91     QVariant evaluate(bool *valueIsUndefined = 0);
  92
  93 Q_SIGNALS:
  94     void valueChanged();
  95
  96 protected:
  97     QQmlExpression(QQmlContextData *, QObject *, const QString &,
  98                            QQmlExpressionPrivate &dd);
  99     QQmlExpression(QQmlContextData *, QObject *, const QString &, bool,
 100                            const QString &, int, int, QQmlExpressionPrivate &dd);
 101     QQmlExpression(QQmlContextData *, QObject *, const QByteArray &, bool,
 102                            const QString &, int, int, QQmlExpressionPrivate &dd);
 103
 104 private:
 105     QQmlExpression(QQmlContextData *, QObject *, const QString &);
 106
 107     Q_DISABLE_COPY(QQmlExpression)
 108     Q_DECLARE_PRIVATE(QQmlExpression)
 109     friend class QQmlDebugger;
 110     friend class QQmlContext;
 111     friend class QQmlVME;
 112 };
 113
 114 QT_END_NAMESPACE
 115
 116 QT_END_HEADER
 117
 118 #endif // QQMLEXPRESSION_H
 119