src/declarative/qml/qdeclarativescriptstring.cpp

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtDeclarative module of the Qt Toolkit.
   7 **
   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.
  16 **
  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.
  20 **
  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.
  28 **
  29 ** Other Usage
  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.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #include "qdeclarativescriptstring.h"
  43 #include "qdeclarativescriptstring_p.h"
  44
  45 QT_BEGIN_NAMESPACE
  46
  47 /*!
  48 \class QDeclarativeScriptString
  49 \since 4.7
  50 \brief The QDeclarativeScriptString class encapsulates a script and its context.
  51
  52 QDeclarativeScriptString is used to create QObject properties that accept a script "assignment" from QML.
  53
  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)}
  56
  57 \qml
  58 MyType {
  59     script: myObj.value = Math.max(myValue, 100)
  60 }
  61 \endqml
  62
  63 If instead the property had a type of QDeclarativeScriptString,
  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 QDeclarativeExpression.
  67
  68 \code
  69 QDeclarativeExpression expr(scriptString);
  70 expr.evaluate();
  71 \endcode
  72
  73 \sa QDeclarativeExpression
  74 */
  75
  76 /*!
  77 Constructs an empty instance.
  78 */
  79 QDeclarativeScriptString::QDeclarativeScriptString()
  80 :  d(new QDeclarativeScriptStringPrivate)
  81 {
  82 }
  83
  84 /*!
  85 Copies \a other.
  86 */
  87 QDeclarativeScriptString::QDeclarativeScriptString(const QDeclarativeScriptString &other)
  88 : d(other.d)
  89 {
  90 }
  91
  92 /*!
  93 \internal
  94 */
  95 QDeclarativeScriptString::~QDeclarativeScriptString()
  96 {
  97 }
  98
  99 /*!
 100 Assigns \a other to this.
 101 */
 102 QDeclarativeScriptString &QDeclarativeScriptString::operator=(const QDeclarativeScriptString &other)
 103 {
 104     d = other.d;
 105     return *this;
 106 }
 107
 108 /*!
 109 Returns the context for the script.
 110 */
 111 QDeclarativeContext *QDeclarativeScriptString::context() const
 112 {
 113     return d->context;
 114 }
 115
 116 /*!
 117 Sets the \a context for the script.
 118 */
 119 void QDeclarativeScriptString::setContext(QDeclarativeContext *context)
 120 {
 121     d->context = context;
 122 }
 123
 124 /*!
 125 Returns the scope object for the script.
 126 */
 127 QObject *QDeclarativeScriptString::scopeObject() const
 128 {
 129     return d->scope;
 130 }
 131
 132 /*!
 133 Sets the scope \a object for the script.
 134 */
 135 void QDeclarativeScriptString::setScopeObject(QObject *object)
 136 {
 137     d->scope = object;
 138 }
 139
 140 /*!
 141 Returns the script text.
 142 */
 143 QString QDeclarativeScriptString::script() const
 144 {
 145     return d->script;
 146 }
 147
 148 /*!
 149 Sets the \a script text.
 150 */
 151 void QDeclarativeScriptString::setScript(const QString &script)
 152 {
 153     d->script = script;
 154 }
 155
 156 QT_END_NAMESPACE
 157