summaryrefslogtreecommitdiffstats
path: root/src/declarative/util/qmlsetproperties.cpp
blob: 7a68ba2a094b4dbd6263272c29f11a839dd6005e (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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** Contact: Qt Software Information (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 either Technology Preview License Agreement or the
** Beta Release License Agreement.
**
** 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.0, included in the file LGPL_EXCEPTION.txt in this
** package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at qt-sales@nokia.com.
** $QT_END_LICENSE$
**
****************************************************************************/

#include "private/qobject_p.h"
#include "qmlopenmetaobject.h"
#include "qmlsetproperties.h"
#include <QtCore/qdebug.h>
#include <QtDeclarative/qmlinfo.h>
#include <private/qmlcustomparser_p.h>
#include <private/qmlparser_p.h>
#include <QtDeclarative/qmlexpression.h>
#include <QtDeclarative/qmlbindablevalue.h>

QT_BEGIN_NAMESPACE

/*!
    \qmlclass SetProperties QmlSetProperties
    \brief The SetProperties element describes new property values for a state.

    SetProperties is a convenience element for changing many properties on a single
    object. It allows you to specify the property names and values similar to how
    you normally would specify them for the actual item:

    \code
    SetProperties {
        target: myRect
        x: 52
        y: 300
        width: 48
    }
    \endcode

    \c target is a property of \c SetProperties, so if the property you want to change
    is named \e target you will have to use \l SetProperty instead. You should also 
    use \l SetProperty if you want to update the binding for a property, 
    as SetProperties does not support this.
*/

/*!
    \internal
    \class QmlSetProperties
    \brief The QmlSetProperties class describes new property values for a state.

    \ingroup group_states

    QmlSetProperties is a convenience class for changing many properties on a single
    object. It allows you to specify the property names and values similar to how
    you normally would specify them for the actual item:

    \code
    SetProperties {
        target: myRect
        x: 52
        y: 300
        width: 48
    }
    \endcode

    \c target is a property of \c SetProperties, so if the property you want to change
    is named \e target you will have to use QmlSetProperty instead. You should also use QmlSetProperty
    if you want to update the binding for a property, as QmlSetProperties does not support this.

    \sa QmlSetProperty
*/

/*!
    \qmlproperty Object SetProperties::target
    This property holds the object that the properties to change belong to
*/

/*!
    \property QmlSetProperties::target
    \brief the object that the properties to change belong to
*/
class QmlSetPropertiesPrivate : public QObjectPrivate
{
    Q_DECLARE_PUBLIC(QmlSetProperties)
public:
    QmlSetPropertiesPrivate() : object(0), decoded(true), restore(true), 
                                isExplicit(false) {}

    QObject *object;
    QByteArray data;
    bool decoded;
    void decode();

    bool restore;
    bool isExplicit;

    QList<QPair<QByteArray, QVariant> > properties;
    QList<QPair<QByteArray, QmlExpression *> > expressions;

    QmlMetaProperty property(const QByteArray &);
};

class QmlSetPropertiesParser : public QmlCustomParser
{
public:
    void compileList(QList<QPair<QByteArray, QVariant> > &list, const QByteArray &pre, const QmlCustomParserProperty &prop);

    virtual QByteArray compile(const QList<QmlCustomParserProperty> &, bool *ok);
    virtual void setCustomData(QObject *, const QByteArray &);
};

void 
QmlSetPropertiesParser::compileList(QList<QPair<QByteArray, QVariant> > &list, 
                                     const QByteArray &pre, 
                                     const QmlCustomParserProperty &prop)
{
    QByteArray propName = pre + prop.name();

    QList<QVariant> values = prop.assignedValues();
    for (int ii = 0; ii < values.count(); ++ii) {
        const QVariant &value = values.at(ii);

        if (value.userType() == qMetaTypeId<QmlCustomParserNode>()) {
            continue;
        } else if(value.userType() == qMetaTypeId<QmlCustomParserProperty>()) {

            QmlCustomParserProperty prop = 
                qvariant_cast<QmlCustomParserProperty>(value);
            QByteArray pre = propName + ".";
            compileList(list, pre, prop);

        } else {
            list << qMakePair(propName, value);
        }
    }
}

QByteArray 
QmlSetPropertiesParser::compile(const QList<QmlCustomParserProperty> &props, 
                                bool *ok)
{
    *ok = true;

    QList<QPair<QByteArray, QVariant> > data;
    for(int ii = 0; ii < props.count(); ++ii)
        compileList(data, QByteArray(), props.at(ii));

    QByteArray rv;
    QDataStream ds(&rv, QIODevice::WriteOnly);

    ds << data.count();
    for(int ii = 0; ii < data.count(); ++ii) {
        QmlParser::Variant v = qvariant_cast<QmlParser::Variant>(data.at(ii).second);
        QVariant var;
        bool isScript = v.isScript();
        switch(v.type()) {
        case QmlParser::Variant::Boolean:
            var = QVariant(v.asBoolean());
            break;
        case QmlParser::Variant::Number:
            var = QVariant(v.asNumber());
            break;
        case QmlParser::Variant::String:
            var = QVariant(v.asString());
            break;
        case QmlParser::Variant::Invalid:
        case QmlParser::Variant::Script:
            var = QVariant(v.asScript());
            break;
        }

        ds << data.at(ii).first << isScript << var;
    }

    return rv;
}

void QmlSetPropertiesPrivate::decode()
{
    Q_Q(QmlSetProperties);
    if (decoded)
        return;

    QDataStream ds(&data, QIODevice::ReadOnly);

    int count;
    ds >> count;
    for (int ii = 0; ii < count; ++ii) {
        QByteArray name;
        bool isScript;
        QVariant data;
        ds >> name;
        ds >> isScript;
        ds >> data;

        if (isScript) {
            QmlExpression *expression = new QmlExpression(qmlContext(q), data.toString(), object);
            expression->setTrackChange(false);
            expressions << qMakePair(name, expression);
        } else {
            properties << qMakePair(name, data);
        }
    }

    decoded = true;
    data.clear();
}

void QmlSetPropertiesParser::setCustomData(QObject *object, 
                                            const QByteArray &data)
{
    QmlSetPropertiesPrivate *p = 
        static_cast<QmlSetPropertiesPrivate *>(QObjectPrivate::get(object));
    p->data = data;
    p->decoded = false;
}

QmlSetProperties::QmlSetProperties()
: QmlStateOperation(*(new QmlSetPropertiesPrivate))
{
}

QmlSetProperties::~QmlSetProperties()
{
    Q_D(QmlSetProperties);
    for(int ii = 0; ii < d->expressions.count(); ++ii)
        delete d->expressions.at(ii).second;
}

QObject *QmlSetProperties::object() const
{
    Q_D(const QmlSetProperties);
    return d->object;
}

void QmlSetProperties::setObject(QObject *o)
{
    Q_D(QmlSetProperties);
    d->object = o;
}

bool QmlSetProperties::restoreEntryValues() const
{
    Q_D(const QmlSetProperties);
    return d->restore;
}

void QmlSetProperties::setRestoreEntryValues(bool v)
{
    Q_D(QmlSetProperties);
    d->restore = v;
}

QmlMetaProperty
QmlSetPropertiesPrivate::property(const QByteArray &property)
{
    Q_Q(QmlSetProperties);
    QmlMetaProperty prop = QmlMetaProperty::createProperty(object, QString::fromLatin1(property));
    if (!prop.isValid()) {
        qmlInfo(q) << "Cannot assign to non-existant property" << property;
        return QmlMetaProperty();
    } else if (!prop.isWritable()) {
        qmlInfo(q) << "Cannot assign to read-only property" << property;
        return QmlMetaProperty();
    }
    return prop;
}

QmlSetProperties::ActionList QmlSetProperties::actions()
{
    Q_D(QmlSetProperties);

    d->decode();

    ActionList list;

    for (int ii = 0; ii < d->properties.count(); ++ii) {

        QByteArray property = d->properties.at(ii).first;
        QmlMetaProperty prop = d->property(property);

        if (prop.isValid()) {
            Action a;
            a.restore = restoreEntryValues();
            a.property = prop;
            a.fromValue = a.property.read();
            a.toValue = d->properties.at(ii).second;
            a.specifiedObject = d->object;
            a.specifiedProperty = QString::fromLatin1(property);

            list << a;
        }
    }

    for (int ii = 0; ii < d->expressions.count(); ++ii) {

        QByteArray property = d->expressions.at(ii).first;
        QmlMetaProperty prop = d->property(property);

        if (prop.isValid()) {
            Action a;
            a.restore = restoreEntryValues();
            a.property = prop;
            a.fromValue = a.property.read();
            a.specifiedObject = d->object;
            a.specifiedProperty = QString::fromLatin1(property);

            if (d->isExplicit) {
                a.toValue = d->expressions.at(ii).second->value();
            } else {
                a.toBinding = new QmlBindableValue(d->expressions.at(ii).second->expression(), object(), qmlContext(this));
                a.toBinding->setTarget(prop);
            }

            list << a;
        }
    }

    return list;
}

bool QmlSetProperties::isExplicit() const
{
    Q_D(const QmlSetProperties);
    return d->isExplicit;
}

void QmlSetProperties::setIsExplicit(bool e)
{
    Q_D(QmlSetProperties);
    d->isExplicit = e;
}

QML_DEFINE_CUSTOM_TYPE(QmlSetProperties,SetProperties,QmlSetPropertiesParser)

QT_END_NAMESPACE