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
49 \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);
76 const QQmlScriptStringPrivate* QQmlScriptStringPrivate::get(const QQmlScriptString &script)
78 return script.d.constData();
82 Constructs an empty instance.
84 QQmlScriptString::QQmlScriptString()
85 : d(new QQmlScriptStringPrivate)
92 QQmlScriptString::QQmlScriptString(const QString &script, QQmlContext *context, QObject *scope)
93 : d(new QQmlScriptStringPrivate)
103 QQmlScriptString::QQmlScriptString(const QQmlScriptString &other)
111 QQmlScriptString::~QQmlScriptString()
116 Assigns \a other to this.
118 QQmlScriptString &QQmlScriptString::operator=(const QQmlScriptString &other)
125 Returns whether the QQmlScriptString is empty.
127 bool QQmlScriptString::isEmpty() const
129 return d->script.isEmpty();
133 Returns whether the content of the QQmlScriptString is the \c undefined literal.
135 bool QQmlScriptString::isUndefinedLiteral() const
137 return d->script == QStringLiteral("undefined");
141 Returns whether the content of the QQmlScriptString is the \c null literal.
143 bool QQmlScriptString::isNullLiteral() const
145 return d->script == QStringLiteral("null");
149 If the content of the QQmlScriptString is a string literal, returns that string.
150 Otherwise returns a null QString.
152 QString QQmlScriptString::stringLiteral() const
154 if (d->isStringLiteral)
155 return d->script.mid(1, d->script.length()-2);
160 If the content of the QQmlScriptString is a number literal, returns that number and
161 sets \a ok to true. Otherwise returns 0.0 and sets \a ok to false.
163 qreal QQmlScriptString::numberLiteral(bool *ok) const
166 *ok = d->isNumberLiteral;
167 return d->isNumberLiteral ? d->numberValue : 0.;
171 If the content of the QQmlScriptString is a boolean literal, returns the boolean value and
172 sets \a ok to true. Otherwise returns false and sets \a ok to false.
174 bool QQmlScriptString::booleanLiteral(bool *ok) const
176 bool isTrue = d->script == QStringLiteral("true");
177 bool isFalse = !isTrue && d->script == QStringLiteral("false");
179 *ok = isTrue || isFalse;
180 return isTrue ? true : false;