1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
6 ** This file is part of the QtQml module of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** GNU Lesser General Public License Usage
10 ** This file may be used under the terms of the GNU Lesser General Public
11 ** License version 2.1 as published by the Free Software Foundation and
12 ** appearing in the file LICENSE.LGPL included in the packaging of this
13 ** file. Please review the following information to ensure the GNU Lesser
14 ** General Public License version 2.1 requirements will be met:
15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 ** In addition, as a special exception, Nokia gives you certain additional
18 ** rights. These rights are described in the Nokia Qt LGPL Exception
19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 ** GNU General Public License Usage
22 ** Alternatively, this file may be used under the terms of the GNU General
23 ** Public License version 3.0 as published by the Free Software Foundation
24 ** and appearing in the file LICENSE.GPL included in the packaging of this
25 ** file. Please review the following information to ensure the GNU General
26 ** Public License version 3.0 requirements will be met:
27 ** http://www.gnu.org/copyleft/gpl.html.
30 ** Alternatively, this file may be used in accordance with the terms and
31 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
42 #include "qquickstatechangescript_p.h"
45 #include <qqmlcontext.h>
46 #include <qqmlexpression.h>
48 #include <private/qqmlguard_p.h>
49 #include <private/qqmlcontext_p.h>
50 #include <private/qqmlproperty_p.h>
51 #include <private/qqmlbinding_p.h>
52 #include "qquickstate_p_p.h"
54 #include <QtCore/qdebug.h>
55 #include <QtCore/qmath.h>
57 #include <private/qobject_p.h>
61 class QQuickStateChangeScriptPrivate : public QQuickStateOperationPrivate
64 QQuickStateChangeScriptPrivate() {}
66 QQmlScriptString script;
71 \qmlclass StateChangeScript QQuickStateChangeScript
72 \inqmlmodule QtQuick 2
73 \ingroup qml-state-elements
74 \brief Specifies how 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/qml/states/statechangescript.qml state and transition
85 QQuickStateChangeScript::QQuickStateChangeScript(QObject *parent)
86 : QQuickStateOperation(*(new QQuickStateChangeScriptPrivate), parent)
90 QQuickStateChangeScript::~QQuickStateChangeScript()
95 \qmlproperty script QtQuick2::StateChangeScript::script
96 This property holds the script to run when the state is current.
98 QQmlScriptString QQuickStateChangeScript::script() const
100 Q_D(const QQuickStateChangeScript);
104 void QQuickStateChangeScript::setScript(const QQmlScriptString &s)
106 Q_D(QQuickStateChangeScript);
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 QQuickStateChangeScript::name() const
119 Q_D(const QQuickStateChangeScript);
123 void QQuickStateChangeScript::setName(const QString &n)
125 Q_D(QQuickStateChangeScript);
129 void QQuickStateChangeScript::execute(Reason)
131 Q_D(QQuickStateChangeScript);
132 if (!d->script.script().isEmpty()) {
133 QQmlExpression expr(d->script);
136 qmlInfo(this, expr.error());
140 QQuickStateChangeScript::ActionList QQuickStateChangeScript::actions()
149 QQuickActionEvent::EventType QQuickStateChangeScript::type() const
155 #include <moc_qquickstatechangescript_p.cpp>