/**************************************************************************** ** ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/ ** ** This file is part of the QtQml module of the Qt Toolkit. ** ** $QT_BEGIN_LICENSE:LGPL$ ** GNU Lesser General Public License Usage ** 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. ** ** 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. ** ** Other Usage ** Alternatively, this file may be used in accordance with the terms and ** conditions contained in a signed written agreement between you and Nokia. ** ** ** ** ** ** ** $QT_END_LICENSE$ ** ****************************************************************************/ #include "qquickpropertychanges_p.h" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include QT_BEGIN_NAMESPACE /*! \qmlclass PropertyChanges QQuickPropertyChanges \inqmlmodule QtQuick 2 \ingroup qml-state-elements \brief The PropertyChanges element describes new property bindings or values for a state. PropertyChanges is used to define the property values or bindings in a \l State. This enables an item's property values to be changed when it \l {QML States}{changes between states}. To create a PropertyChanges object, specify the \l target item whose properties are to be modified, and define the new property values or bindings. For example: \snippet doc/src/snippets/qml/propertychanges.qml import \codeline \snippet doc/src/snippets/qml/propertychanges.qml 0 When the mouse is pressed, the \l Rectangle changes to the \e resized state. In this state, the PropertyChanges object sets the rectangle's color to blue and the \c height value to that of \c container.height. Note this automatically binds \c rect.height to \c container.height in the \e resized state. If a property binding should not be established, and the height should just be set to the value of \c container.height at the time of the state change, set the \l explicit property to \c true. A PropertyChanges object can also override the default signal handler for an object to implement a signal handler specific to the new state: \qml PropertyChanges { target: myMouseArea onClicked: doSomethingDifferent() } \endqml \note PropertyChanges can be used to change anchor margins, but not other anchor values; use AnchorChanges for this instead. Similarly, to change an \l Item's \l {Item::}{parent} value, use ParentChanges instead. \section2 Resetting property values The \c undefined value can be used to reset the property value for a state. In the following example, when \c myText changes to the \e widerText state, its \c width property is reset, giving the text its natural width and displaying the whole string on a single line. \snippet doc/src/snippets/qml/propertychanges.qml reset \section2 Immediate property changes in transitions When \l{QML Animation and Transitions}{Transitions} are used to animate state changes, they animate properties from their values in the current state to those defined in the new state (as defined by PropertyChanges objects). However, it is sometimes desirable to set a property value \e immediately during a \l Transition, without animation; in these cases, the PropertyAction element can be used to force an immediate property change. See the PropertyAction documentation for more details. \sa {declarative/animation/states}{states example}, {qmlstate}{States}, QtQml */ /*! \qmlproperty Object QtQuick2::PropertyChanges::target This property holds the object which contains the properties to be changed. */ class QQuickReplaceSignalHandler : public QQuickActionEvent { public: QQuickReplaceSignalHandler() : expression(0), reverseExpression(0), rewindExpression(0), ownedExpression(0) {} ~QQuickReplaceSignalHandler() { delete ownedExpression; } virtual EventType type() const { return SignalHandler; } QQmlProperty property; QQmlExpression *expression; QQmlExpression *reverseExpression; QQmlExpression *rewindExpression; QQmlGuard ownedExpression; virtual void execute(Reason) { ownedExpression = QQmlPropertyPrivate::setSignalExpression(property, expression); if (ownedExpression == expression) ownedExpression = 0; } virtual bool isReversable() { return true; } virtual void reverse(Reason) { ownedExpression = QQmlPropertyPrivate::setSignalExpression(property, reverseExpression); if (ownedExpression == reverseExpression) ownedExpression = 0; } virtual void saveOriginals() { saveCurrentValues(); reverseExpression = rewindExpression; } virtual bool needsCopy() { return true; } virtual void copyOriginals(QQuickActionEvent *other) { QQuickReplaceSignalHandler *rsh = static_cast(other); saveCurrentValues(); if (rsh == this) return; reverseExpression = rsh->reverseExpression; if (rsh->ownedExpression == reverseExpression) { ownedExpression = rsh->ownedExpression; rsh->ownedExpression = 0; } } virtual void rewind() { ownedExpression = QQmlPropertyPrivate::setSignalExpression(property, rewindExpression); if (ownedExpression == rewindExpression) ownedExpression = 0; } virtual void saveCurrentValues() { rewindExpression = QQmlPropertyPrivate::signalExpression(property); } virtual bool override(QQuickActionEvent*other) { if (other == this) return true; if (other->type() != type()) return false; if (static_cast(other)->property == property) return true; return false; } }; class QQuickPropertyChangesPrivate : public QQuickStateOperationPrivate { Q_DECLARE_PUBLIC(QQuickPropertyChanges) public: QQuickPropertyChangesPrivate() : decoded(true), restore(true), isExplicit(false) {} QQmlGuard object; QByteArray data; bool decoded : 1; bool restore : 1; bool isExplicit : 1; void decode(); class ExpressionChange { public: ExpressionChange(const QString &_name, QQmlBinding::Identifier _id, QQmlExpression *_expr) : name(_name), id(_id), expression(_expr) {} QString name; QQmlBinding::Identifier id; QQmlExpression *expression; }; QList > properties; QList expressions; QList signalReplacements; QQmlProperty property(const QString &); }; void QQuickPropertyChangesParser::compileList(QList > &list, const QString &pre, const QQmlCustomParserProperty &prop) { QString propName = pre + prop.name(); QList values = prop.assignedValues(); for (int ii = 0; ii < values.count(); ++ii) { const QVariant &value = values.at(ii); if (value.userType() == qMetaTypeId()) { error(qvariant_cast(value), QQuickPropertyChanges::tr("PropertyChanges does not support creating state-specific objects.")); continue; } else if(value.userType() == qMetaTypeId()) { QQmlCustomParserProperty prop = qvariant_cast(value); QString pre = propName + QLatin1Char('.'); compileList(list, pre, prop); } else { list << qMakePair(propName, value); } } } QByteArray QQuickPropertyChangesParser::compile(const QList &props) { QList > data; for(int ii = 0; ii < props.count(); ++ii) compileList(data, QString(), props.at(ii)); QByteArray rv; QDataStream ds(&rv, QIODevice::WriteOnly); ds << data.count(); for(int ii = 0; ii < data.count(); ++ii) { QQmlScript::Variant v = qvariant_cast(data.at(ii).second); QVariant var; bool isScript = v.isScript(); QQmlBinding::Identifier id = 0; switch(v.type()) { case QQmlScript::Variant::Boolean: var = QVariant(v.asBoolean()); break; case QQmlScript::Variant::Number: var = QVariant(v.asNumber()); break; case QQmlScript::Variant::String: var = QVariant(v.asString()); break; case QQmlScript::Variant::Invalid: case QQmlScript::Variant::Script: var = QVariant(v.asScript()); { // Pre-rewrite the expression id = rewriteBinding(v, data.at(ii).first); } break; } ds << data.at(ii).first << isScript << var; if (isScript) ds << id; } return rv; } void QQuickPropertyChangesPrivate::decode() { Q_Q(QQuickPropertyChanges); if (decoded) return; QDataStream ds(&data, QIODevice::ReadOnly); int count; ds >> count; for (int ii = 0; ii < count; ++ii) { QString name; bool isScript; QVariant data; QQmlBinding::Identifier id = QQmlBinding::Invalid; ds >> name; ds >> isScript; ds >> data; if (isScript) ds >> id; QQmlProperty prop = property(name); //### better way to check for signal property? if (prop.type() & QQmlProperty::SignalProperty) { QQmlExpression *expression = new QQmlExpression(qmlContext(q), object, data.toString()); QQmlData *ddata = QQmlData::get(q); if (ddata && ddata->outerContext && !ddata->outerContext->url.isEmpty()) expression->setSourceLocation(ddata->outerContext->url.toString(), ddata->lineNumber, ddata->columnNumber); QQuickReplaceSignalHandler *handler = new QQuickReplaceSignalHandler; handler->property = prop; handler->expression = expression; signalReplacements << handler; } else if (isScript) { QQmlExpression *expression = new QQmlExpression(qmlContext(q), object, data.toString()); QQmlData *ddata = QQmlData::get(q); if (ddata && ddata->outerContext && !ddata->outerContext->url.isEmpty()) expression->setSourceLocation(ddata->outerContext->url.toString(), ddata->lineNumber, ddata->columnNumber); expressions << ExpressionChange(name, id, expression); } else { properties << qMakePair(name, data); } } decoded = true; data.clear(); } void QQuickPropertyChangesParser::setCustomData(QObject *object, const QByteArray &data) { QQuickPropertyChangesPrivate *p = static_cast(QObjectPrivate::get(object)); p->data = data; p->decoded = false; } QQuickPropertyChanges::QQuickPropertyChanges() : QQuickStateOperation(*(new QQuickPropertyChangesPrivate)) { } QQuickPropertyChanges::~QQuickPropertyChanges() { Q_D(QQuickPropertyChanges); for(int ii = 0; ii < d->expressions.count(); ++ii) delete d->expressions.at(ii).expression; for(int ii = 0; ii < d->signalReplacements.count(); ++ii) delete d->signalReplacements.at(ii); } QObject *QQuickPropertyChanges::object() const { Q_D(const QQuickPropertyChanges); return d->object; } void QQuickPropertyChanges::setObject(QObject *o) { Q_D(QQuickPropertyChanges); d->object = o; } /*! \qmlproperty bool QtQuick2::PropertyChanges::restoreEntryValues This property holds whether the previous values should be restored when leaving the state. The default value is \c true. Setting this value to \c false creates a temporary state that has permanent effects on property values. */ bool QQuickPropertyChanges::restoreEntryValues() const { Q_D(const QQuickPropertyChanges); return d->restore; } void QQuickPropertyChanges::setRestoreEntryValues(bool v) { Q_D(QQuickPropertyChanges); d->restore = v; } QQmlProperty QQuickPropertyChangesPrivate::property(const QString &property) { Q_Q(QQuickPropertyChanges); QQmlProperty prop(object, property, qmlContext(q)); if (!prop.isValid()) { qmlInfo(q) << QQuickPropertyChanges::tr("Cannot assign to non-existent property \"%1\"").arg(property); return QQmlProperty(); } else if (!(prop.type() & QQmlProperty::SignalProperty) && !prop.isWritable()) { qmlInfo(q) << QQuickPropertyChanges::tr("Cannot assign to read-only property \"%1\"").arg(property); return QQmlProperty(); } return prop; } QQuickPropertyChanges::ActionList QQuickPropertyChanges::actions() { Q_D(QQuickPropertyChanges); d->decode(); ActionList list; for (int ii = 0; ii < d->properties.count(); ++ii) { QQuickAction a(d->object, d->properties.at(ii).first, qmlContext(this), d->properties.at(ii).second); if (a.property.isValid()) { a.restore = restoreEntryValues(); list << a; } } for (int ii = 0; ii < d->signalReplacements.count(); ++ii) { QQuickReplaceSignalHandler *handler = d->signalReplacements.at(ii); if (handler->property.isValid()) { QQuickAction a; a.event = handler; list << a; } } for (int ii = 0; ii < d->expressions.count(); ++ii) { const QString &property = d->expressions.at(ii).name; QQmlProperty prop = d->property(property); if (prop.isValid()) { QQuickAction a; a.restore = restoreEntryValues(); a.property = prop; a.fromValue = a.property.read(); a.specifiedObject = d->object; a.specifiedProperty = property; if (d->isExplicit) { a.toValue = d->expressions.at(ii).expression->evaluate(); } else { QQmlExpression *e = d->expressions.at(ii).expression; QQmlBinding::Identifier id = d->expressions.at(ii).id; QQmlBinding *newBinding = id != QQmlBinding::Invalid ? QQmlBinding::createBinding(id, object(), qmlContext(this), e->sourceFile(), e->lineNumber()) : 0; if (!newBinding) { newBinding = new QQmlBinding(e->expression(), object(), qmlContext(this)); newBinding->setSourceLocation(e->sourceFile(), e->lineNumber(), e->columnNumber()); } newBinding->setTarget(prop); a.toBinding = newBinding; a.deletableToBinding = true; } list << a; } } return list; } /*! \qmlproperty bool QtQuick2::PropertyChanges::explicit If explicit is set to true, any potential bindings will be interpreted as once-off assignments that occur when the state is entered. In the following example, the addition of explicit prevents \c myItem.width from being bound to \c parent.width. Instead, it is assigned the value of \c parent.width at the time of the state change. \qml PropertyChanges { target: myItem explicit: true width: parent.width } \endqml By default, explicit is false. */ bool QQuickPropertyChanges::isExplicit() const { Q_D(const QQuickPropertyChanges); return d->isExplicit; } void QQuickPropertyChanges::setIsExplicit(bool e) { Q_D(QQuickPropertyChanges); d->isExplicit = e; } bool QQuickPropertyChanges::containsValue(const QString &name) const { Q_D(const QQuickPropertyChanges); typedef QPair PropertyEntry; QListIterator propertyIterator(d->properties); while (propertyIterator.hasNext()) { const PropertyEntry &entry = propertyIterator.next(); if (entry.first == name) { return true; } } return false; } bool QQuickPropertyChanges::containsExpression(const QString &name) const { Q_D(const QQuickPropertyChanges); typedef QQuickPropertyChangesPrivate::ExpressionChange ExpressionEntry; QListIterator expressionIterator(d->expressions); while (expressionIterator.hasNext()) { const ExpressionEntry &entry = expressionIterator.next(); if (entry.name == name) { return true; } } return false; } bool QQuickPropertyChanges::containsProperty(const QString &name) const { return containsValue(name) || containsExpression(name); } void QQuickPropertyChanges::changeValue(const QString &name, const QVariant &value) { Q_D(QQuickPropertyChanges); typedef QPair PropertyEntry; typedef QQuickPropertyChangesPrivate::ExpressionChange ExpressionEntry; QMutableListIterator expressionIterator(d->expressions); while (expressionIterator.hasNext()) { const ExpressionEntry &entry = expressionIterator.next(); if (entry.name == name) { expressionIterator.remove(); if (state() && state()->isStateActive()) { QQmlAbstractBinding *oldBinding = QQmlPropertyPrivate::binding(d->property(name)); if (oldBinding) { QQmlPropertyPrivate::setBinding(d->property(name), 0); oldBinding->destroy(); } d->property(name).write(value); } d->properties.append(PropertyEntry(name, value)); return; } } QMutableListIterator propertyIterator(d->properties); while (propertyIterator.hasNext()) { PropertyEntry &entry = propertyIterator.next(); if (entry.first == name) { entry.second = value; if (state() && state()->isStateActive()) d->property(name).write(value); return; } } QQuickAction action; action.restore = restoreEntryValues(); action.property = d->property(name); action.fromValue = action.property.read(); action.specifiedObject = object(); action.specifiedProperty = name; action.toValue = value; propertyIterator.insert(PropertyEntry(name, value)); if (state() && state()->isStateActive()) { state()->addEntryToRevertList(action); QQmlAbstractBinding *oldBinding = QQmlPropertyPrivate::binding(action.property); if (oldBinding) oldBinding->setEnabled(false, QQmlPropertyPrivate::DontRemoveBinding | QQmlPropertyPrivate::BypassInterceptor); d->property(name).write(value); } } void QQuickPropertyChanges::changeExpression(const QString &name, const QString &expression) { Q_D(QQuickPropertyChanges); typedef QPair PropertyEntry; typedef QQuickPropertyChangesPrivate::ExpressionChange ExpressionEntry; bool hadValue = false; QMutableListIterator propertyIterator(d->properties); while (propertyIterator.hasNext()) { PropertyEntry &entry = propertyIterator.next(); if (entry.first == name) { propertyIterator.remove(); hadValue = true; break; } } QMutableListIterator expressionIterator(d->expressions); while (expressionIterator.hasNext()) { const ExpressionEntry &entry = expressionIterator.next(); if (entry.name == name) { entry.expression->setExpression(expression); if (state() && state()->isStateActive()) { QQmlAbstractBinding *oldBinding = QQmlPropertyPrivate::binding(d->property(name)); if (oldBinding) { QQmlPropertyPrivate::setBinding(d->property(name), 0); oldBinding->destroy(); } QQmlBinding *newBinding = new QQmlBinding(expression, object(), qmlContext(this)); newBinding->setTarget(d->property(name)); QQmlPropertyPrivate::setBinding(d->property(name), newBinding, QQmlPropertyPrivate::DontRemoveBinding | QQmlPropertyPrivate::BypassInterceptor); } return; } } QQmlExpression *newExpression = new QQmlExpression(qmlContext(this), d->object, expression); expressionIterator.insert(ExpressionEntry(name, QQmlBinding::Invalid, newExpression)); if (state() && state()->isStateActive()) { if (hadValue) { QQmlAbstractBinding *oldBinding = QQmlPropertyPrivate::binding(d->property(name)); if (oldBinding) { oldBinding->setEnabled(false, QQmlPropertyPrivate::DontRemoveBinding | QQmlPropertyPrivate::BypassInterceptor); state()->changeBindingInRevertList(object(), name, oldBinding); } QQmlBinding *newBinding = new QQmlBinding(expression, object(), qmlContext(this)); newBinding->setTarget(d->property(name)); QQmlPropertyPrivate::setBinding(d->property(name), newBinding, QQmlPropertyPrivate::DontRemoveBinding | QQmlPropertyPrivate::BypassInterceptor); } else { QQuickAction action; action.restore = restoreEntryValues(); action.property = d->property(name); action.fromValue = action.property.read(); action.specifiedObject = object(); action.specifiedProperty = name; if (d->isExplicit) { action.toValue = newExpression->evaluate(); } else { QQmlBinding *newBinding = new QQmlBinding(newExpression->expression(), object(), qmlContext(this)); newBinding->setTarget(d->property(name)); action.toBinding = newBinding; action.deletableToBinding = true; state()->addEntryToRevertList(action); QQmlAbstractBinding *oldBinding = QQmlPropertyPrivate::binding(action.property); if (oldBinding) oldBinding->setEnabled(false, QQmlPropertyPrivate::DontRemoveBinding | QQmlPropertyPrivate::BypassInterceptor); QQmlPropertyPrivate::setBinding(action.property, newBinding, QQmlPropertyPrivate::DontRemoveBinding | QQmlPropertyPrivate::BypassInterceptor); } } } // what about the signal handler? } QVariant QQuickPropertyChanges::property(const QString &name) const { Q_D(const QQuickPropertyChanges); typedef QPair PropertyEntry; typedef QQuickPropertyChangesPrivate::ExpressionChange ExpressionEntry; QListIterator propertyIterator(d->properties); while (propertyIterator.hasNext()) { const PropertyEntry &entry = propertyIterator.next(); if (entry.first == name) { return entry.second; } } QListIterator expressionIterator(d->expressions); while (expressionIterator.hasNext()) { const ExpressionEntry &entry = expressionIterator.next(); if (entry.name == name) { return QVariant(entry.expression->expression()); } } return QVariant(); } void QQuickPropertyChanges::removeProperty(const QString &name) { Q_D(QQuickPropertyChanges); typedef QPair PropertyEntry; typedef QQuickPropertyChangesPrivate::ExpressionChange ExpressionEntry; QMutableListIterator expressionIterator(d->expressions); while (expressionIterator.hasNext()) { const ExpressionEntry &entry = expressionIterator.next(); if (entry.name == name) { expressionIterator.remove(); state()->removeEntryFromRevertList(object(), name); return; } } QMutableListIterator propertyIterator(d->properties); while (propertyIterator.hasNext()) { const PropertyEntry &entry = propertyIterator.next(); if (entry.first == name) { propertyIterator.remove(); state()->removeEntryFromRevertList(object(), name); return; } } } QVariant QQuickPropertyChanges::value(const QString &name) const { Q_D(const QQuickPropertyChanges); typedef QPair PropertyEntry; QListIterator propertyIterator(d->properties); while (propertyIterator.hasNext()) { const PropertyEntry &entry = propertyIterator.next(); if (entry.first == name) { return entry.second; } } return QVariant(); } QString QQuickPropertyChanges::expression(const QString &name) const { Q_D(const QQuickPropertyChanges); typedef QQuickPropertyChangesPrivate::ExpressionChange ExpressionEntry; QListIterator expressionIterator(d->expressions); while (expressionIterator.hasNext()) { const ExpressionEntry &entry = expressionIterator.next(); if (entry.name == name) { return entry.expression->expression(); } } return QString(); } void QQuickPropertyChanges::detachFromState() { if (state()) state()->removeAllEntriesFromRevertList(object()); } void QQuickPropertyChanges::attachToState() { if (state()) state()->addEntriesToRevertList(actions()); } QT_END_NAMESPACE