<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdeclarativescriptstring.cpp -->
<title>Qt 4.8: QDeclarativeScriptString Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtdeclarative.html">QtDeclarative</a></li>
<li>QDeclarativeScriptString</li>
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QDeclarativeScriptString Class Reference</h1>
<!-- $$$QDeclarativeScriptString-brief -->
<p>The QDeclarativeScriptString class encapsulates a script and its context. <a href="#details">More...</a></p>
<!-- @@@QDeclarativeScriptString -->
<pre class="cpp"> <span class="preprocessor">#include <QDeclarativeScriptString></span></pre><p>This class was introduced in Qt 4.7.</p>
<ul>
<li><a href="qdeclarativescriptstring-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qdeclarativescriptstring.html#QDeclarativeScriptString">QDeclarativeScriptString</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qdeclarativescriptstring.html#QDeclarativeScriptString-2">QDeclarativeScriptString</a></b> ( const QDeclarativeScriptString & <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDeclarativeContext * </td><td class="memItemRight bottomAlign"><b><a href="qdeclarativescriptstring.html#context">context</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QObject * </td><td class="memItemRight bottomAlign"><b><a href="qdeclarativescriptstring.html#scopeObject">scopeObject</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qdeclarativescriptstring.html#script">script</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qdeclarativescriptstring.html#setContext">setContext</a></b> ( QDeclarativeContext * <i>context</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qdeclarativescriptstring.html#setScopeObject">setScopeObject</a></b> ( QObject * <i>object</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qdeclarativescriptstring.html#setScript">setScript</a></b> ( const QString & <i>script</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDeclarativeScriptString & </td><td class="memItemRight bottomAlign"><b><a href="qdeclarativescriptstring.html#operator-eq">operator=</a></b> ( const QDeclarativeScriptString & <i>other</i> )</td></tr>
</table>
<a name="details"></a>
<!-- $$$QDeclarativeScriptString-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QDeclarativeScriptString class encapsulates a script and its context.</p>
<p>QDeclarativeScriptString is used to create <a href="qobject.html">QObject</a> properties that accept a script "assignment" from QML.</p>
<p>Normally, the following QML would result in a binding being established for the <tt>script</tt> property; i.e. <tt>script</tt> would be assigned the value obtained from running <tt>myObj.value = Math.max(myValue, 100)</tt></p>
<pre class="qml"> <span class="type">MyType</span> {
<span class="name">script</span>: <span class="name">myObj</span>.<span class="name">value</span> <span class="operator">=</span> <span class="name">Math</span>.<span class="name">max</span>(<span class="name">myValue</span>, <span class="number">100</span>)
}</pre>
<p>If instead the property had a type of QDeclarativeScriptString, the script itself -- <i>myObj.value = Math.max(myValue, 100)</i> -- would be passed to the <tt>script</tt> property and the class could choose how to handle it. Typically, the class will evaluate the script at some later time using a <a href="qdeclarativeexpression.html">QDeclarativeExpression</a>.</p>
<pre class="cpp"> <span class="type"><a href="qdeclarativeexpression.html">QDeclarativeExpression</a></span> expr(scriptString<span class="operator">.</span>context()<span class="operator">,</span> scriptString<span class="operator">.</span>script()<span class="operator">,</span> scriptStr<span class="operator">.</span>scopeObject());
expr<span class="operator">.</span>value();</pre>
</div>
<p><b>See also </b><a href="qdeclarativeexpression.html">QDeclarativeExpression</a>.</p>
<!-- @@@QDeclarativeScriptString -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QDeclarativeScriptString[overload1]$$$QDeclarativeScriptString -->
<h3 class="fn"><a name="QDeclarativeScriptString"></a>QDeclarativeScriptString::<span class="name">QDeclarativeScriptString</span> ()</h3>
<p>Constructs an empty instance.</p>
<!-- @@@QDeclarativeScriptString -->
<!-- $$$QDeclarativeScriptString$$$QDeclarativeScriptStringconstQDeclarativeScriptString& -->
<h3 class="fn"><a name="QDeclarativeScriptString-2"></a>QDeclarativeScriptString::<span class="name">QDeclarativeScriptString</span> ( const <span class="type">QDeclarativeScriptString</span> & <i>other</i> )</h3>
<p>Copies <i>other</i>.</p>
<!-- @@@QDeclarativeScriptString -->
<!-- $$$context[overload1]$$$context -->
<h3 class="fn"><a name="context"></a><span class="type"><a href="qdeclarativecontext.html">QDeclarativeContext</a></span> * QDeclarativeScriptString::<span class="name">context</span> () const</h3>
<p>Returns the context for the script.</p>
<p><b>See also </b><a href="qdeclarativescriptstring.html#setContext">setContext</a>().</p>
<!-- @@@context -->
<!-- $$$scopeObject[overload1]$$$scopeObject -->
<h3 class="fn"><a name="scopeObject"></a><span class="type"><a href="qobject.html">QObject</a></span> * QDeclarativeScriptString::<span class="name">scopeObject</span> () const</h3>
<p>Returns the scope object for the script.</p>
<p><b>See also </b><a href="qdeclarativescriptstring.html#setScopeObject">setScopeObject</a>().</p>
<!-- @@@scopeObject -->
<!-- $$$script[overload1]$$$script -->
<h3 class="fn"><a name="script"></a><span class="type"><a href="qstring.html">QString</a></span> QDeclarativeScriptString::<span class="name">script</span> () const</h3>
<p>Returns the script text.</p>
<p><b>See also </b><a href="qdeclarativescriptstring.html#setScript">setScript</a>().</p>
<!-- @@@script -->
<!-- $$$setContext[overload1]$$$setContextQDeclarativeContext* -->
<h3 class="fn"><a name="setContext"></a><span class="type">void</span> QDeclarativeScriptString::<span class="name">setContext</span> ( <span class="type"><a href="qdeclarativecontext.html">QDeclarativeContext</a></span> * <i>context</i> )</h3>
<p>Sets the <i>context</i> for the script.</p>
<p><b>See also </b><a href="qdeclarativescriptstring.html#context">context</a>().</p>
<!-- @@@setContext -->
<!-- $$$setScopeObject[overload1]$$$setScopeObjectQObject* -->
<h3 class="fn"><a name="setScopeObject"></a><span class="type">void</span> QDeclarativeScriptString::<span class="name">setScopeObject</span> ( <span class="type"><a href="qobject.html">QObject</a></span> * <i>object</i> )</h3>
<p>Sets the scope <i>object</i> for the script.</p>
<p><b>See also </b><a href="qdeclarativescriptstring.html#scopeObject">scopeObject</a>().</p>
<!-- @@@setScopeObject -->
<!-- $$$setScript[overload1]$$$setScriptconstQString& -->
<h3 class="fn"><a name="setScript"></a><span class="type">void</span> QDeclarativeScriptString::<span class="name">setScript</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>script</i> )</h3>
<p>Sets the <i>script</i> text.</p>
<p><b>See also </b><a href="qdeclarativescriptstring.html#script">script</a>().</p>
<!-- @@@setScript -->
<!-- $$$operator=[overload1]$$$operator=constQDeclarativeScriptString& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QDeclarativeScriptString</span> & QDeclarativeScriptString::<span class="name">operator=</span> ( const <span class="type">QDeclarativeScriptString</span> & <i>other</i> )</h3>
<p>Assigns <i>other</i> to this.</p>
<!-- @@@operator= -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Qt and respective logos are trademarks of The Qt Company Ltd
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
