src/declarative/qml/qdeclarativecontext.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtDeclarative module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** No Commercial Usage
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 ** Alternatively, this file may be used under the terms of the GNU Lesser
  18 ** General Public License version 2.1 as published by the Free Software
  19 ** Foundation and appearing in the file LICENSE.LGPL included in the
  20 ** packaging of this file.  Please review the following information to
  21 ** ensure the GNU Lesser General Public License version 2.1 requirements
  22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  23 **
  24 ** In addition, as a special exception, Nokia gives you certain additional
  25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QDECLARATIVECONTEXT_H
  43 #define QDECLARATIVECONTEXT_H
  44
  45 #include <QtCore/qurl.h>
  46 #include <QtCore/qobject.h>
  47 #include <QtScript/qscriptvalue.h>
  48 #include <QtCore/qmetatype.h>
  49 #include <QtCore/qvariant.h>
  50
  51 QT_BEGIN_HEADER
  52
  53 QT_BEGIN_NAMESPACE
  54
  55 QT_MODULE(Declarative)
  56
  57 class QString;
  58 class QDeclarativeEngine;
  59 class QDeclarativeRefCount;
  60 class QDeclarativeContextPrivate;
  61 class QDeclarativeCompositeTypeData;
  62 class QDeclarativeContextData;
  63
  64 class Q_DECLARATIVE_EXPORT QDeclarativeContext : public QObject
  65 {
  66     Q_OBJECT
  67     Q_DECLARE_PRIVATE(QDeclarativeContext)
  68
  69 public:
  70     QDeclarativeContext(QDeclarativeEngine *parent, QObject *objParent=0);
  71     QDeclarativeContext(QDeclarativeContext *parent, QObject *objParent=0);
  72     virtual ~QDeclarativeContext();
  73
  74     bool isValid() const;
  75
  76     QDeclarativeEngine *engine() const;
  77     QDeclarativeContext *parentContext() const;
  78
  79     QObject *contextObject() const;
  80     void setContextObject(QObject *);
  81
  82     QVariant contextProperty(const QString &) const;
  83     void setContextProperty(const QString &, QObject *);
  84     void setContextProperty(const QString &, const QVariant &);
  85
  86     QUrl resolvedUrl(const QUrl &);
  87
  88     void setBaseUrl(const QUrl &);
  89     QUrl baseUrl() const;
  90
  91 private:
  92     friend class QDeclarativeVME;
  93     friend class QDeclarativeEngine;
  94     friend class QDeclarativeEnginePrivate;
  95     friend class QDeclarativeExpression;
  96     friend class QDeclarativeExpressionPrivate;
  97     friend class QDeclarativeContextScriptClass;
  98     friend class QDeclarativeObjectScriptClass;
  99     friend class QDeclarativeComponent;
 100     friend class QDeclarativeComponentPrivate;
 101     friend class QDeclarativeScriptPrivate;
 102     friend class QDeclarativeBoundSignalProxy;
 103     friend class QDeclarativeContextData;
 104     QDeclarativeContext(QDeclarativeContextData *);
 105     QDeclarativeContext(QDeclarativeEngine *, bool);
 106     Q_DISABLE_COPY(QDeclarativeContext)
 107 };
 108 QT_END_NAMESPACE
 109
 110 Q_DECLARE_METATYPE(QList<QObject*>)
 111
 112 QT_END_HEADER
 113
 114 #endif // QDECLARATIVECONTEXT_H