src/declarative/qml/qdeclarativeproperty.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: http://www.qt-project.org/
   6 **
   7 ** This file is part of the QtDeclarative module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  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
  52 class QObject;
  53 class QVariant;
  54 class QDeclarativeContext;
  55 class QDeclarativeEngine;
  56
  57 class QDeclarativePropertyPrivate;
  58 class Q_DECLARATIVE_EXPORT QDeclarativeProperty
  59 {
  60 public:
  61     enum PropertyTypeCategory {
  62         InvalidCategory,
  63         List,
  64         Object,
  65         Normal
  66     };
  67
  68     enum Type {
  69         Invalid,
  70         Property,
  71         SignalProperty
  72     };
  73
  74     QDeclarativeProperty();
  75     ~QDeclarativeProperty();
  76
  77     QDeclarativeProperty(QObject *);
  78     QDeclarativeProperty(QObject *, QDeclarativeContext *);
  79     QDeclarativeProperty(QObject *, QDeclarativeEngine *);
  80
  81     QDeclarativeProperty(QObject *, const QString &);
  82     QDeclarativeProperty(QObject *, const QString &, QDeclarativeContext *);
  83     QDeclarativeProperty(QObject *, const QString &, QDeclarativeEngine *);
  84
  85     QDeclarativeProperty(const QDeclarativeProperty &);
  86     QDeclarativeProperty &operator=(const QDeclarativeProperty &);
  87
  88     bool operator==(const QDeclarativeProperty &) const;
  89
  90     Type type() const;
  91     bool isValid() const;
  92     bool isProperty() const;
  93     bool isSignalProperty() const;
  94
  95     int propertyType() const;
  96     PropertyTypeCategory propertyTypeCategory() const;
  97     const char *propertyTypeName() const;
  98
  99     QString name() const;
 100
 101     QVariant read() const;
 102     static QVariant read(QObject *, const QString &);
 103     static QVariant read(QObject *, const QString &, QDeclarativeContext *);
 104     static QVariant read(QObject *, const QString &, QDeclarativeEngine *);
 105
 106     bool write(const QVariant &) const;
 107     static bool write(QObject *, const QString &, const QVariant &);
 108     static bool write(QObject *, const QString &, const QVariant &, QDeclarativeContext *);
 109     static bool write(QObject *, const QString &, const QVariant &, QDeclarativeEngine *);
 110
 111     bool reset() const;
 112
 113     bool hasNotifySignal() const;
 114     bool needsNotifySignal() const;
 115     bool connectNotifySignal(QObject *dest, const char *slot) const;
 116     bool connectNotifySignal(QObject *dest, int method) const;
 117
 118     bool isWritable() const;
 119     bool isDesignable() const;
 120     bool isResettable() const;
 121     QObject *object() const;
 122
 123     int index() const;
 124     QMetaProperty property() const;
 125     QMetaMethod method() const;
 126
 127 private:
 128     friend class QDeclarativePropertyPrivate;
 129     QDeclarativePropertyPrivate *d;
 130 };
 131 typedef QList<QDeclarativeProperty> QDeclarativeProperties;
 132
 133 inline uint qHash (const QDeclarativeProperty &key)
 134 {
 135     return qHash(key.object()) + qHash(key.name());
 136 }
 137
 138 QT_END_NAMESPACE
 139
 140 QT_END_HEADER
 141
 142 #endif // QDECLARATIVEPROPERTY_H