src/declarative/qml/qdeclarativeproperty.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 QDECLARATIVEPROPERTY_H
  43 #define QDECLARATIVEPROPERTY_H
  44
  45 #include <QtCore/qmetaobject.h>
  46
  47 QT_BEGIN_HEADER
  48
  49 QT_BEGIN_NAMESPACE
  50
  51 QT_MODULE(Declarative)
  52
  53 class QObject;
  54 class QVariant;
  55 class QDeclarativeContext;
  56 class QDeclarativeEngine;
  57
  58 class QDeclarativePropertyPrivate;
  59 class Q_DECLARATIVE_EXPORT QDeclarativeProperty
  60 {
  61 public:
  62     enum PropertyTypeCategory {
  63         InvalidCategory,
  64         List,
  65         Object,
  66         Normal
  67     };
  68
  69     enum Type {
  70         Invalid,
  71         Property,
  72         SignalProperty
  73     };
  74
  75     QDeclarativeProperty();
  76     ~QDeclarativeProperty();
  77
  78     QDeclarativeProperty(QObject *);
  79     QDeclarativeProperty(QObject *, QDeclarativeContext *);
  80     QDeclarativeProperty(QObject *, QDeclarativeEngine *);
  81
  82     QDeclarativeProperty(QObject *, const QString &);
  83     QDeclarativeProperty(QObject *, const QString &, QDeclarativeContext *);
  84     QDeclarativeProperty(QObject *, const QString &, QDeclarativeEngine *);
  85
  86     QDeclarativeProperty(const QDeclarativeProperty &);
  87     QDeclarativeProperty &operator=(const QDeclarativeProperty &);
  88
  89     bool operator==(const QDeclarativeProperty &) const;
  90
  91     Type type() const;
  92     bool isValid() const;
  93     bool isProperty() const;
  94     bool isSignalProperty() const;
  95
  96     int propertyType() const;
  97     PropertyTypeCategory propertyTypeCategory() const;
  98     const char *propertyTypeName() const;
  99
 100     QString name() const;
 101
 102     QVariant read() const;
 103     static QVariant read(QObject *, const QString &);
 104     static QVariant read(QObject *, const QString &, QDeclarativeContext *);
 105     static QVariant read(QObject *, const QString &, QDeclarativeEngine *);
 106
 107     bool write(const QVariant &) const;
 108     static bool write(QObject *, const QString &, const QVariant &);
 109     static bool write(QObject *, const QString &, const QVariant &, QDeclarativeContext *);
 110     static bool write(QObject *, const QString &, const QVariant &, QDeclarativeEngine *);
 111
 112     bool reset() const;
 113
 114     bool hasNotifySignal() const;
 115     bool needsNotifySignal() const;
 116     bool connectNotifySignal(QObject *dest, const char *slot) const;
 117     bool connectNotifySignal(QObject *dest, int method) const;
 118
 119     bool isWritable() const;
 120     bool isDesignable() const;
 121     bool isResettable() const;
 122     QObject *object() const;
 123
 124     int index() const;
 125     QMetaProperty property() const;
 126     QMetaMethod method() const;
 127
 128 private:
 129     friend class QDeclarativePropertyPrivate;
 130     QDeclarativePropertyPrivate *d;
 131 };
 132 typedef QList<QDeclarativeProperty> QDeclarativeProperties;
 133
 134 inline uint qHash (const QDeclarativeProperty &key)
 135 {
 136     return qHash(key.object()) + qHash(key.name());
 137 }
 138
 139 QT_END_NAMESPACE
 140
 141 QT_END_HEADER
 142
 143 #endif // QDECLARATIVEPROPERTY_H