1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
7 ** This file is part of the QtDeclarative module of the Qt Toolkit.
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** GNU Lesser General Public License Usage
11 ** This file may be used under the terms of the GNU Lesser General Public
12 ** License version 2.1 as published by the Free Software Foundation and
13 ** appearing in the file LICENSE.LGPL included in the packaging of this
14 ** file. Please review the following information to ensure the GNU Lesser
15 ** General Public License version 2.1 requirements will be met:
16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
18 ** In addition, as a special exception, Nokia gives you certain additional
19 ** rights. These rights are described in the Nokia Qt LGPL Exception
20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
22 ** GNU General Public License Usage
23 ** Alternatively, this file may be used under the terms of the GNU General
24 ** Public License version 3.0 as published by the Free Software Foundation
25 ** and appearing in the file LICENSE.GPL included in the packaging of this
26 ** file. Please review the following information to ensure the GNU General
27 ** Public License version 3.0 requirements will be met:
28 ** http://www.gnu.org/copyleft/gpl.html.
31 ** Alternatively, this file may be used in accordance with the terms and
32 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
42 #include "qdeclarativestateoperations_p.h"
44 #include <qdeclarative.h>
45 #include <qdeclarativecontext.h>
46 #include <qdeclarativeexpression.h>
47 #include <qdeclarativeinfo.h>
48 #include <private/qdeclarativeguard_p.h>
49 #include <private/qdeclarativecontext_p.h>
50 #include <private/qdeclarativeproperty_p.h>
51 #include <private/qdeclarativebinding_p.h>
52 #include "qdeclarativestate_p_p.h"
54 #include <QtCore/qdebug.h>
55 #include <QtCore/qmath.h>
57 #include <private/qobject_p.h>
61 class QDeclarativeStateChangeScriptPrivate : public QDeclarativeStateOperationPrivate
64 QDeclarativeStateChangeScriptPrivate() {}
66 QDeclarativeScriptString script;
71 \qmlclass StateChangeScript QDeclarativeStateChangeScript
72 \inqmlmodule QtQuick 2
73 \ingroup qml-state-elements
74 \brief The StateChangeScript element allows you to run a script in a state.
76 A StateChangeScript is run upon entering a state. You can optionally use
77 ScriptAction to specify the point in the transition at which
78 the StateChangeScript should to be run.
80 \snippet snippets/declarative/states/statechangescript.qml state and transition
85 QDeclarativeStateChangeScript::QDeclarativeStateChangeScript(QObject *parent)
86 : QDeclarativeStateOperation(*(new QDeclarativeStateChangeScriptPrivate), parent)
90 QDeclarativeStateChangeScript::~QDeclarativeStateChangeScript()
95 \qmlproperty script QtQuick2::StateChangeScript::script
96 This property holds the script to run when the state is current.
98 QDeclarativeScriptString QDeclarativeStateChangeScript::script() const
100 Q_D(const QDeclarativeStateChangeScript);
104 void QDeclarativeStateChangeScript::setScript(const QDeclarativeScriptString &s)
106 Q_D(QDeclarativeStateChangeScript);
111 \qmlproperty string QtQuick2::StateChangeScript::name
112 This property holds the name of the script. This name can be used by a
113 ScriptAction to target a specific script.
115 \sa ScriptAction::scriptName
117 QString QDeclarativeStateChangeScript::name() const
119 Q_D(const QDeclarativeStateChangeScript);
123 void QDeclarativeStateChangeScript::setName(const QString &n)
125 Q_D(QDeclarativeStateChangeScript);
129 void QDeclarativeStateChangeScript::execute(Reason)
131 Q_D(QDeclarativeStateChangeScript);
132 if (!d->script.script().isEmpty()) {
133 QDeclarativeExpression expr(d->script);
136 qmlInfo(this, expr.error());
140 QDeclarativeStateChangeScript::ActionList QDeclarativeStateChangeScript::actions()
143 QDeclarativeAction a;
149 QString QDeclarativeStateChangeScript::typeName() const
151 return QLatin1String("StateChangeScript");
155 #include <moc_qdeclarativestateoperations_p.cpp>