summaryrefslogtreecommitdiffstats
path: root/src/declarative/util/qmlbehavior.cpp
blob: 9757fa2ea79809e6b0715c32abe17d93556414f0 (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
/****************************************************************************
**
** 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$
**
****************************************************************************/

#include "qmlbehavior_p.h"

#include "qmlanimation_p.h"
#include "qmltransition_p.h"

#include <qmlcontext.h>
#include <qmlinfo.h>

#include <QtCore/qparallelanimationgroup.h>

#include <private/qobject_p.h>

QT_BEGIN_NAMESPACE

QML_DEFINE_TYPE(Qt,4,6,Behavior,QmlBehavior)

class QmlBehaviorPrivate : public QObjectPrivate
{
    Q_DECLARE_PUBLIC(QmlBehavior)
public:
    QmlBehaviorPrivate() : animation(0), enabled(true) {}

    QmlMetaProperty property;
    QVariant currentValue;
    QmlAbstractAnimation *animation;
    bool enabled;
};

/*!
    \qmlclass Behavior QmlBehavior
    \brief The Behavior element allows you to specify a default animation for a property change.

    Behaviors provide one way to specify \l{qmlanimation.html}{animations} in QML.

    In the example below, the rect will use a bounce easing curve over 200 millisecond for any changes to its y property:
    \code
    Rectangle {
        width: 20; height: 20
        color: "#00ff00"
        y: 200  //initial value
        y: Behavior {
            NumberAnimation {
                easing: "easeOutBounce(amplitude:100)"
                duration: 200
            }
        }
    }
    \endcode

    Currently only a single Behavior may be specified for a property;
    this Behavior can be enabled and disabled via the \l{enabled} property.
*/


QmlBehavior::QmlBehavior(QObject *parent)
    : QObject(*(new QmlBehaviorPrivate), parent)
{
}

QmlBehavior::~QmlBehavior()
{
}

/*!
    \qmlproperty Animation Behavior::animation
    \default

    The animation to use when the behavior is triggered.
*/

QmlAbstractAnimation *QmlBehavior::animation()
{
    Q_D(QmlBehavior);
    return d->animation;
}

void QmlBehavior::setAnimation(QmlAbstractAnimation *animation)
{
    Q_D(QmlBehavior);
    if (d->animation) {
        qmlInfo(this) << tr("Can't change the animation assigned to a Behavior.");
        return;
    }

    d->animation = animation;
    if (d->animation)
        d->animation->setTarget(d->property);
}

/*!
    \qmlproperty bool Behavior::enabled
    Whether the Behavior will be triggered when the property it is tracking changes.

    By default a Behavior is enabled.
*/

bool QmlBehavior::enabled() const
{
    Q_D(const QmlBehavior);
    return d->enabled;
}

void QmlBehavior::setEnabled(bool enabled)
{
    Q_D(QmlBehavior);
    if (d->enabled == enabled)
        return;
    d->enabled = enabled;
    emit enabledChanged();
}

void QmlBehavior::write(const QVariant &value)
{
    Q_D(QmlBehavior);
    if (!d->animation || !d->enabled) {
        d->property.write(value, QmlMetaProperty::BypassInterceptor | QmlMetaProperty::DontRemoveBinding);
        return;
    }

    d->currentValue = d->property.read();

    d->animation->qtAnimation()->stop();

    QmlStateOperation::ActionList actions;
    Action action;
    action.property = d->property;
    action.fromValue = d->currentValue;
    action.toValue = value;
    actions << action;

    QList<QmlMetaProperty> after;
    if (d->animation)
        d->animation->transition(actions, after, QmlAbstractAnimation::Forward);
    d->animation->qtAnimation()->start();
    if (!after.contains(d->property))
        d->property.write(value, QmlMetaProperty::BypassInterceptor | QmlMetaProperty::DontRemoveBinding);
}

void QmlBehavior::setTarget(const QmlMetaProperty &property)
{
    Q_D(QmlBehavior);
    d->property = property;
    d->currentValue = property.read();
    if (d->animation)
        d->animation->setTarget(property);
}

QT_END_NAMESPACE