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 "qqmlscriptstring.h"
43 #include "qqmlscriptstring_p.h"
48 \class QQmlScriptString
50 \brief The QQmlScriptString class encapsulates a script and its context.
52 QQmlScriptString is used to create QObject properties that accept a script "assignment" from QML.
54 Normally, the following QML would result in a binding being established for the \c script
55 property; i.e. \c script would be assigned the value obtained from running \c {myObj.value = Math.max(myValue, 100)}
59 script: myObj.value = Math.max(myValue, 100)
63 If instead the property had a type of QQmlScriptString,
64 the script itself -- \e {myObj.value = Math.max(myValue, 100)} -- would be passed to the \c script property
65 and the class could choose how to handle it. Typically, the class will evaluate
66 the script at some later time using a QQmlExpression.
69 QQmlExpression expr(scriptString);
77 Constructs an empty instance.
79 QQmlScriptString::QQmlScriptString()
80 : d(new QQmlScriptStringPrivate)
87 QQmlScriptString::QQmlScriptString(const QQmlScriptString &other)
95 QQmlScriptString::~QQmlScriptString()
100 Assigns \a other to this.
102 QQmlScriptString &QQmlScriptString::operator=(const QQmlScriptString &other)
109 Returns the context for the script.
111 QQmlContext *QQmlScriptString::context() const
117 Sets the \a context for the script.
119 void QQmlScriptString::setContext(QQmlContext *context)
121 d->context = context;
125 Returns the scope object for the script.
127 QObject *QQmlScriptString::scopeObject() const
133 Sets the scope \a object for the script.
135 void QQmlScriptString::setScopeObject(QObject *object)
141 Returns the script text.
143 QString QQmlScriptString::script() const
149 Sets the \a script text.
151 void QQmlScriptString::setScript(const QString &script)