/usr/share/qt5/doc/qtqml/qqmlscriptstring.html is in qtdeclarative5-doc-html 5.2.1-3ubuntu15.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.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" />
<!-- qqmlscriptstring.cpp -->
<title>QQmlScriptString Class | QtQml 5.2</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.2</li>
<li><a href="qtqml-index.html">Qt QML</a></li>
<li><a href="qtqml-module.html">C++ Classes</a></li>
<li>QQmlScriptString</li>
<li id="buildversion">
Qt 5.2.1 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<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">QQmlScriptString Class</h1>
<!-- $$$QQmlScriptString-brief -->
<p>The QQmlScriptString class encapsulates a script and its context. <a href="#details">More...</a></p>
<!-- @@@QQmlScriptString -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QQmlScriptString></span>
</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> <tt>QT += qml</tt></td></tr></table><ul>
<li><a href="qqmlscriptstring-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="qqmlscriptstring.html#QQmlScriptString">QQmlScriptString</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qqmlscriptstring.html#QQmlScriptString-2">QQmlScriptString</a></b>(const QQmlScriptString &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qqmlscriptstring.html#booleanLiteral">booleanLiteral</a></b>(bool *<i> ok</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qqmlscriptstring.html#isEmpty">isEmpty</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qqmlscriptstring.html#isNullLiteral">isNullLiteral</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qqmlscriptstring.html#isUndefinedLiteral">isUndefinedLiteral</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qqmlscriptstring.html#numberLiteral">numberLiteral</a></b>(bool *<i> ok</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qqmlscriptstring.html#stringLiteral">stringLiteral</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QQmlScriptString & </td><td class="memItemRight bottomAlign"><b><a href="qqmlscriptstring.html#operator-eq">operator=</a></b>(const QQmlScriptString &<i> other</i>)</td></tr>
</table>
<a name="details"></a>
<!-- $$$QQmlScriptString-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QQmlScriptString class encapsulates a script and its context.</p>
<p>QQmlScriptString is used to create QObject 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 QQmlScriptString, 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="qqmlexpression.html">QQmlExpression</a>.</p>
<pre class="cpp"><span class="type"><a href="qqmlexpression.html">QQmlExpression</a></span> expr(scriptString);
expr<span class="operator">.</span>evaluate();</pre>
</div>
<p><b>See also </b><a href="qqmlexpression.html">QQmlExpression</a>.</p>
<!-- @@@QQmlScriptString -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QQmlScriptString[overload1]$$$QQmlScriptString -->
<h3 class="fn"><a name="QQmlScriptString"></a>QQmlScriptString::<span class="name">QQmlScriptString</span>()</h3>
<p>Constructs an empty instance.</p>
<!-- @@@QQmlScriptString -->
<!-- $$$QQmlScriptString$$$QQmlScriptStringconstQQmlScriptString& -->
<h3 class="fn"><a name="QQmlScriptString-2"></a>QQmlScriptString::<span class="name">QQmlScriptString</span>(const <span class="type">QQmlScriptString</span> &<i> other</i>)</h3>
<p>Copies <i>other</i>.</p>
<!-- @@@QQmlScriptString -->
<!-- $$$booleanLiteral[overload1]$$$booleanLiteralbool* -->
<h3 class="fn"><a name="booleanLiteral"></a><span class="type">bool</span> QQmlScriptString::<span class="name">booleanLiteral</span>(<span class="type">bool</span> *<i> ok</i>) const</h3>
<p>If the content of the <a href="qqmlscriptstring.html">QQmlScriptString</a> is a boolean literal, returns the boolean value and sets <i>ok</i> to true. Otherwise returns false and sets <i>ok</i> to false.</p>
<!-- @@@booleanLiteral -->
<!-- $$$isEmpty[overload1]$$$isEmpty -->
<h3 class="fn"><a name="isEmpty"></a><span class="type">bool</span> QQmlScriptString::<span class="name">isEmpty</span>() const</h3>
<p>Returns whether the <a href="qqmlscriptstring.html">QQmlScriptString</a> is empty.</p>
<!-- @@@isEmpty -->
<!-- $$$isNullLiteral[overload1]$$$isNullLiteral -->
<h3 class="fn"><a name="isNullLiteral"></a><span class="type">bool</span> QQmlScriptString::<span class="name">isNullLiteral</span>() const</h3>
<p>Returns whether the content of the <a href="qqmlscriptstring.html">QQmlScriptString</a> is the <tt>null</tt> literal.</p>
<!-- @@@isNullLiteral -->
<!-- $$$isUndefinedLiteral[overload1]$$$isUndefinedLiteral -->
<h3 class="fn"><a name="isUndefinedLiteral"></a><span class="type">bool</span> QQmlScriptString::<span class="name">isUndefinedLiteral</span>() const</h3>
<p>Returns whether the content of the <a href="qqmlscriptstring.html">QQmlScriptString</a> is the <tt>undefined</tt> literal.</p>
<!-- @@@isUndefinedLiteral -->
<!-- $$$numberLiteral[overload1]$$$numberLiteralbool* -->
<h3 class="fn"><a name="numberLiteral"></a><span class="type">qreal</span> QQmlScriptString::<span class="name">numberLiteral</span>(<span class="type">bool</span> *<i> ok</i>) const</h3>
<p>If the content of the <a href="qqmlscriptstring.html">QQmlScriptString</a> is a number literal, returns that number and sets <i>ok</i> to true. Otherwise returns 0.0 and sets <i>ok</i> to false.</p>
<!-- @@@numberLiteral -->
<!-- $$$stringLiteral[overload1]$$$stringLiteral -->
<h3 class="fn"><a name="stringLiteral"></a><span class="type">QString</span> QQmlScriptString::<span class="name">stringLiteral</span>() const</h3>
<p>If the content of the <a href="qqmlscriptstring.html">QQmlScriptString</a> is a string literal, returns that string. Otherwise returns a null QString.</p>
<!-- @@@stringLiteral -->
<!-- $$$operator=[overload1]$$$operator=constQQmlScriptString& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QQmlScriptString</span> & QQmlScriptString::<span class="name">operator=</span>(const <span class="type">QQmlScriptString</span> &<i> other</i>)</h3>
<p>Assigns <i>other</i> to this.</p>
<!-- @@@operator= -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.<br> 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.<br> Digia, Qt and their respective logos are trademarks of Digia Plc in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|