src/declarative/util/qdeclarativestateoperations.cpp

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtDeclarative module of the Qt Toolkit.
   8 **
   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.
  17 **
  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.
  21 **
  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.
  29 **
  30 ** Other Usage
  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.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #include "private/qdeclarativestateoperations_p.h"
  43
  44 #include <qdeclarative.h>
  45 #include <qdeclarativecontext.h>
  46 #include <qdeclarativeexpression.h>
  47 #include <qdeclarativeinfo.h>
  48 #include <qdeclarativeguard_p.h>
  49 #include <qdeclarativenullablevalue_p_p.h>
  50 #include "private/qdeclarativecontext_p.h"
  51 #include "private/qdeclarativeproperty_p.h"
  52 #include "private/qdeclarativebinding_p.h"
  53 #include "private/qdeclarativestate_p_p.h"
  54
  55 #include <QtCore/qdebug.h>
  56 #include <QtWidgets/qgraphicsitem.h>
  57 #include <QtCore/qmath.h>
  58
  59 #include <private/qobject_p.h>
  60
  61 QT_BEGIN_NAMESPACE
  62
  63 class QDeclarativeStateChangeScriptPrivate : public QDeclarativeStateOperationPrivate
  64 {
  65 public:
  66     QDeclarativeStateChangeScriptPrivate() {}
  67
  68     QDeclarativeScriptString script;
  69     QString name;
  70 };
  71
  72 /*!
  73     \qmlclass StateChangeScript QDeclarativeStateChangeScript
  74     \inqmlmodule QtQuick 2
  75     \ingroup qml-state-elements
  76     \brief The StateChangeScript element allows you to run a script in a state.
  77
  78     A StateChangeScript is run upon entering a state. You can optionally use
  79     ScriptAction to specify the point in the transition at which
  80     the StateChangeScript should to be run.
  81
  82     \snippet snippets/declarative/states/statechangescript.qml state and transition
  83
  84     \sa ScriptAction
  85 */
  86
  87 QDeclarativeStateChangeScript::QDeclarativeStateChangeScript(QObject *parent)
  88 : QDeclarativeStateOperation(*(new QDeclarativeStateChangeScriptPrivate), parent)
  89 {
  90 }
  91
  92 QDeclarativeStateChangeScript::~QDeclarativeStateChangeScript()
  93 {
  94 }
  95
  96 /*!
  97     \qmlproperty script QtQuick2::StateChangeScript::script
  98     This property holds the script to run when the state is current.
  99 */
 100 QDeclarativeScriptString QDeclarativeStateChangeScript::script() const
 101 {
 102     Q_D(const QDeclarativeStateChangeScript);
 103     return d->script;
 104 }
 105
 106 void QDeclarativeStateChangeScript::setScript(const QDeclarativeScriptString &s)
 107 {
 108     Q_D(QDeclarativeStateChangeScript);
 109     d->script = s;
 110 }
 111
 112 /*!
 113     \qmlproperty string QtQuick2::StateChangeScript::name
 114     This property holds the name of the script. This name can be used by a
 115     ScriptAction to target a specific script.
 116
 117     \sa ScriptAction::scriptName
 118 */
 119 QString QDeclarativeStateChangeScript::name() const
 120 {
 121     Q_D(const QDeclarativeStateChangeScript);
 122     return d->name;
 123 }
 124
 125 void QDeclarativeStateChangeScript::setName(const QString &n)
 126 {
 127     Q_D(QDeclarativeStateChangeScript);
 128     d->name = n;
 129 }
 130
 131 void QDeclarativeStateChangeScript::execute(Reason)
 132 {
 133     Q_D(QDeclarativeStateChangeScript);
 134     const QString &script = d->script.script();
 135     if (!script.isEmpty()) {
 136         QDeclarativeExpression expr(d->script.context(), d->script.scopeObject(), script);
 137         QDeclarativeData *ddata = QDeclarativeData::get(this);
 138         if (ddata && ddata->outerContext && !ddata->outerContext->url.isEmpty())
 139             expr.setSourceLocation(ddata->outerContext->url.toString(), ddata->lineNumber);
 140         expr.evaluate();
 141         if (expr.hasError())
 142             qmlInfo(this, expr.error());
 143     }
 144 }
 145
 146 QDeclarativeStateChangeScript::ActionList QDeclarativeStateChangeScript::actions()
 147 {
 148     ActionList rv;
 149     QDeclarativeAction a;
 150     a.event = this;
 151     rv << a;
 152     return rv;
 153 }
 154
 155 QString QDeclarativeStateChangeScript::typeName() const
 156 {
 157     return QLatin1String("StateChangeScript");
 158 }
 159
 160
 161 #include <moc_qdeclarativestateoperations_p.cpp>
 162
 163 QT_END_NAMESPACE
 164