src/qml/qml/qqmlproperty.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 QQMLPROPERTY_H
  43 #define QQMLPROPERTY_H
  44
  45 #include <QtQml/qtqmlglobal.h>
  46 #include <QtCore/qmetaobject.h>
  47
  48 QT_BEGIN_HEADER
  49
  50 QT_BEGIN_NAMESPACE
  51
  52
  53 class QObject;
  54 class QVariant;
  55 class QQmlContext;
  56 class QQmlEngine;
  57
  58 class QQmlPropertyPrivate;
  59 class Q_QML_EXPORT QQmlProperty
  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     QQmlProperty();
  76     ~QQmlProperty();
  77
  78     QQmlProperty(QObject *);
  79     QQmlProperty(QObject *, QQmlContext *);
  80     QQmlProperty(QObject *, QQmlEngine *);
  81
  82     QQmlProperty(QObject *, const QString &);
  83     QQmlProperty(QObject *, const QString &, QQmlContext *);
  84     QQmlProperty(QObject *, const QString &, QQmlEngine *);
  85
  86     QQmlProperty(const QQmlProperty &);
  87     QQmlProperty &operator=(const QQmlProperty &);
  88
  89     bool operator==(const QQmlProperty &) 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 &, QQmlContext *);
 105     static QVariant read(QObject *, const QString &, QQmlEngine *);
 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 &, QQmlContext *);
 110     static bool write(QObject *, const QString &, const QVariant &, QQmlEngine *);
 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 QQmlPropertyPrivate;
 130     QQmlPropertyPrivate *d;
 131 };
 132 typedef QList<QQmlProperty> QQmlProperties;
 133
 134 inline uint qHash (const QQmlProperty &key)
 135 {
 136     return qHash(key.object()) + qHash(key.name());
 137 }
 138
 139 QT_END_NAMESPACE
 140
 141 QT_END_HEADER
 142
 143 #endif // QQMLPROPERTY_H