summaryrefslogtreecommitdiffstats
path: root/src/declarative/qml/qmlmetaproperty.h
blob: 240f5a2f360678a5376ea46b577ae12a09b470ac (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtDeclarative module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QMLMETAPROPERTY_H
#define QMLMETAPROPERTY_H

#include <QtCore/qmetaobject.h>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

QT_MODULE(Declarative)

class QObject;
class QmlAbstractBinding;
class QmlExpression;
class QStringList;
class QVariant;
struct QMetaObject;
class QmlContext;
class QmlEngine;

class QmlMetaPropertyPrivate;
class Q_DECLARATIVE_EXPORT QmlMetaProperty
{
public:
    enum PropertyCategory {
        Unknown,
        InvalidProperty,
        Bindable,
        List,
        QmlList,    //XXX
        Object,
        Normal
    };
    QmlMetaProperty();
    QmlMetaProperty(QObject *);
    QmlMetaProperty(QObject *, const QString &);
    QmlMetaProperty(QObject *, QmlContext *);
    QmlMetaProperty(QObject *, const QString &, QmlContext *);
    QmlMetaProperty(const QmlMetaProperty &);
    QmlMetaProperty &operator=(const QmlMetaProperty &);
    ~QmlMetaProperty();

    QString name() const;

    QVariant read() const;
    bool write(const QVariant &) const;
    enum WriteFlag { BypassInterceptor = 0x01, DontRemoveBinding = 0x02 };
    Q_DECLARE_FLAGS(WriteFlags, WriteFlag)
    bool write(const QVariant &, QmlMetaProperty::WriteFlags) const;
    bool reset() const;

    bool hasChangedNotifier() const;
    bool needsChangedNotifier() const;
    bool connectNotifier(QObject *dest, const char *slot) const;
    bool connectNotifier(QObject *dest, int method) const;

    QMetaMethod method() const;

    enum Type { Invalid = 0x00, 
                Property = 0x01, 
                SignalProperty = 0x02,
                Default = 0x08,
                Attached = 0x10,
                ValueTypeProperty = 0x20 };

    Type type() const;
    bool isProperty() const;
    bool isDefault() const;
    bool isWritable() const;
    bool isDesignable() const;
    bool isResettable() const;
    bool isValid() const;
    QObject *object() const;

    PropertyCategory propertyCategory() const;

    int propertyType() const;
    const char *propertyTypeName() const;

    bool operator==(const QmlMetaProperty &) const;

    QMetaProperty property() const;

    QmlAbstractBinding *binding() const;
    QmlAbstractBinding *setBinding(QmlAbstractBinding *,
                                   QmlMetaProperty::WriteFlags flags = QmlMetaProperty::DontRemoveBinding) const;

    QmlExpression *signalExpression() const;
    QmlExpression *setSignalExpression(QmlExpression *) const;

    static QmlMetaProperty createProperty(QObject *, const QString &, QmlContext *context=0);

    int coreIndex() const;
    int valueTypeCoreIndex() const;
private:
    friend class QmlEnginePrivate;
    friend class QmlMetaPropertyPrivate;
    QmlMetaPropertyPrivate *d;
};
typedef QList<QmlMetaProperty> QmlMetaProperties;
 Q_DECLARE_OPERATORS_FOR_FLAGS(QmlMetaProperty::WriteFlags)

QT_END_NAMESPACE

QT_END_HEADER

#endif // QMLMETAPROPERTY_H