src/declarative/qml/qdeclarativebinding_p.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 QDECLARATIVEBINDING_P_H
  43 #define QDECLARATIVEBINDING_P_H
  44
  45 //
  46 //  W A R N I N G
  47 //  -------------
  48 //
  49 // This file is not part of the Qt API.  It exists purely as an
  50 // implementation detail.  This header file may change from version to
  51 // version without notice, or even be removed.
  52 //
  53 // We mean it.
  54 //
  55
  56 #include "qdeclarative.h"
  57 #include "qdeclarativepropertyvaluesource.h"
  58 #include "qdeclarativeexpression.h"
  59 #include "qdeclarativeproperty.h"
  60 #include "private/qdeclarativeproperty_p.h"
  61
  62 #include <QtCore/QObject>
  63 #include <QtCore/QMetaProperty>
  64
  65 QT_BEGIN_NAMESPACE
  66
  67 class Q_DECLARATIVE_PRIVATE_EXPORT QDeclarativeAbstractBinding
  68 {
  69 public:
  70     typedef QWeakPointer<QDeclarativeAbstractBinding> Pointer;
  71
  72     QDeclarativeAbstractBinding();
  73
  74     virtual void destroy();
  75
  76     virtual QString expression() const;
  77
  78     enum Type { PropertyBinding, ValueTypeProxy };
  79     virtual Type bindingType() const { return PropertyBinding; }
  80
  81     QObject *object() const;
  82     int propertyIndex() const;
  83
  84     void setEnabled(bool e) { setEnabled(e, QDeclarativePropertyPrivate::DontRemoveBinding); }
  85     virtual void setEnabled(bool, QDeclarativePropertyPrivate::WriteFlags) = 0;
  86
  87     void update() { update(QDeclarativePropertyPrivate::DontRemoveBinding); }
  88     virtual void update(QDeclarativePropertyPrivate::WriteFlags) = 0;
  89
  90     void addToObject(QObject *, int);
  91     void removeFromObject();
  92
  93     static Pointer getPointer(QDeclarativeAbstractBinding *p) { return p ? p->weakPointer() : Pointer(); }
  94
  95 protected:
  96     virtual ~QDeclarativeAbstractBinding();
  97     void clear();
  98
  99 private:
 100     Pointer weakPointer();
 101
 102     friend class QDeclarativeData;
 103     friend class QDeclarativeComponentPrivate;
 104     friend class QDeclarativeValueTypeProxyBinding;
 105     friend class QDeclarativePropertyPrivate;
 106     friend class QDeclarativeVME;
 107     friend class QtSharedPointer::ExternalRefCount<QDeclarativeAbstractBinding>;
 108
 109     QObject *m_object;
 110     int m_propertyIndex;
 111     QDeclarativeAbstractBinding **m_mePtr;
 112     QDeclarativeAbstractBinding **m_prevBinding;
 113     QDeclarativeAbstractBinding  *m_nextBinding;
 114     QSharedPointer<QDeclarativeAbstractBinding> m_selfPointer;
 115 };
 116
 117 class QDeclarativeValueTypeProxyBinding : public QDeclarativeAbstractBinding
 118 {
 119 public:
 120     QDeclarativeValueTypeProxyBinding(QObject *o, int coreIndex);
 121
 122     virtual Type bindingType() const { return ValueTypeProxy; }
 123
 124     virtual void setEnabled(bool, QDeclarativePropertyPrivate::WriteFlags);
 125     virtual void update(QDeclarativePropertyPrivate::WriteFlags);
 126
 127     QDeclarativeAbstractBinding *binding(int propertyIndex);
 128
 129     void removeBindings(quint32 mask);
 130
 131 protected:
 132     ~QDeclarativeValueTypeProxyBinding();
 133
 134 private:
 135     void recursiveEnable(QDeclarativeAbstractBinding *, QDeclarativePropertyPrivate::WriteFlags);
 136     void recursiveDisable(QDeclarativeAbstractBinding *);
 137
 138     friend class QDeclarativeAbstractBinding;
 139     QObject *m_object;
 140     int m_index;
 141     QDeclarativeAbstractBinding *m_bindings;
 142 };
 143
 144 class QDeclarativeContext;
 145 class QDeclarativeBindingPrivate;
 146 class Q_DECLARATIVE_PRIVATE_EXPORT QDeclarativeBinding : public QDeclarativeExpression, public QDeclarativeAbstractBinding
 147 {
 148 Q_OBJECT
 149 public:
 150     enum EvaluateFlag { RequiresThisObject = 0x01 };
 151     Q_DECLARE_FLAGS(EvaluateFlags, EvaluateFlag)
 152
 153     QDeclarativeBinding(const QString &, QObject *, QDeclarativeContext *, QObject *parent=0);
 154     QDeclarativeBinding(const QString &, QObject *, QDeclarativeContextData *, QObject *parent=0);
 155     QDeclarativeBinding(void *, QDeclarativeRefCount *, QObject *, QDeclarativeContextData *,
 156                         const QString &, int, QObject *parent);
 157     QDeclarativeBinding(const QScriptValue &, QObject *, QDeclarativeContextData *, QObject *parent=0);
 158
 159     void setTarget(const QDeclarativeProperty &);
 160     QDeclarativeProperty property() const;
 161
 162     void setEvaluateFlags(EvaluateFlags flags);
 163     EvaluateFlags evaluateFlags() const;
 164
 165     bool enabled() const;
 166
 167     // Inherited from  QDeclarativeAbstractBinding
 168     virtual void setEnabled(bool, QDeclarativePropertyPrivate::WriteFlags flags);
 169     virtual void update(QDeclarativePropertyPrivate::WriteFlags flags);
 170     virtual QString expression() const;
 171
 172     typedef int Identifier;
 173     static Identifier Invalid;
 174     static QDeclarativeBinding *createBinding(Identifier, QObject *, QDeclarativeContext *, const QString &, int, QObject *parent=0);
 175
 176 public Q_SLOTS:
 177     void update() { update(QDeclarativePropertyPrivate::DontRemoveBinding); }
 178
 179 protected:
 180     ~QDeclarativeBinding();
 181     void emitValueChanged();
 182
 183 private:
 184     Q_DECLARE_PRIVATE(QDeclarativeBinding)
 185 };
 186
 187 Q_DECLARE_OPERATORS_FOR_FLAGS(QDeclarativeBinding::EvaluateFlags)
 188
 189 QT_END_NAMESPACE
 190
 191 Q_DECLARE_METATYPE(QDeclarativeBinding*)
 192
 193 #endif // QDECLARATIVEBINDING_P_H