src/qml/qml/qqmlcontext.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 QQMLCONTEXT_H
  43 #define QQMLCONTEXT_H
  44
  45 #include <QtCore/qurl.h>
  46 #include <QtCore/qobject.h>
  47 #include <QtQml/qjsvalue.h>
  48 #include <QtCore/qmetatype.h>
  49 #include <QtCore/qvariant.h>
  50
  51 QT_BEGIN_HEADER
  52
  53 QT_BEGIN_NAMESPACE
  54
  55
  56 class QString;
  57 class QQmlEngine;
  58 class QQmlRefCount;
  59 class QQmlContextPrivate;
  60 class QQmlCompositeTypeData;
  61 class QQmlContextData;
  62
  63 class Q_QML_EXPORT QQmlContext : public QObject
  64 {
  65     Q_OBJECT
  66     Q_DECLARE_PRIVATE(QQmlContext)
  67
  68 public:
  69     QQmlContext(QQmlEngine *parent, QObject *objParent=0);
  70     QQmlContext(QQmlContext *parent, QObject *objParent=0);
  71     virtual ~QQmlContext();
  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
  85     QString nameForObject(QObject *) const;
  86
  87     QUrl resolvedUrl(const QUrl &);
  88
  89     void setBaseUrl(const QUrl &);
  90     QUrl baseUrl() const;
  91
  92 private:
  93     friend class QQmlVME;
  94     friend class QQmlEngine;
  95     friend class QQmlEnginePrivate;
  96     friend class QQmlExpression;
  97     friend class QQmlExpressionPrivate;
  98     friend class QQmlComponent;
  99     friend class QQmlComponentPrivate;
 100     friend class QQmlScriptPrivate;
 101     friend class QQmlBoundSignalProxy;
 102     friend class QQmlContextData;
 103     QQmlContext(QQmlContextData *);
 104     QQmlContext(QQmlEngine *, bool);
 105     Q_DISABLE_COPY(QQmlContext)
 106 };
 107 QT_END_NAMESPACE
 108
 109 Q_DECLARE_METATYPE(QList<QObject*>)
 110
 111 QT_END_HEADER
 112
 113 #endif // QQMLCONTEXT_H