/usr/share/qt5/doc/qtscript/qscriptvalueiterator.html is in qtscript5-doc-html 5.2.1+dfsg-1ubuntu1.
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 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 | <?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" />
<!-- qscriptvalueiterator.cpp -->
<title>QScriptValueIterator Class | QtScript </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="qtscript-index.html">Qt Script</a></li>
<li><a href="qtscript-module.html">C++ Classes</a></li>
<li>QScriptValueIterator</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">QScriptValueIterator Class</h1>
<!-- $$$QScriptValueIterator-brief -->
<p>The QScriptValueIterator class provides a Java-style iterator for <a href="qscriptvalue.html">QScriptValue</a>. <a href="#details">More...</a></p>
<!-- @@@QScriptValueIterator -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QScriptValueIterator></span>
</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> <tt>QT += script</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 4.3</td></tr></table><ul>
<li><a href="qscriptvalueiterator-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="qscriptvalueiterator.html#QScriptValueIterator">QScriptValueIterator</a></b>(const QScriptValue &<i> object</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qscriptvalueiterator.html#dtor.QScriptValueIterator">~QScriptValueIterator</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QScriptValue::PropertyFlags </td><td class="memItemRight bottomAlign"><b><a href="qscriptvalueiterator.html#flags">flags</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qscriptvalueiterator.html#hasNext">hasNext</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qscriptvalueiterator.html#hasPrevious">hasPrevious</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qscriptvalueiterator.html#name">name</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qscriptvalueiterator.html#next">next</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qscriptvalueiterator.html#previous">previous</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qscriptvalueiterator.html#remove">remove</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QScriptString </td><td class="memItemRight bottomAlign"><b><a href="qscriptvalueiterator.html#scriptName">scriptName</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qscriptvalueiterator.html#setValue">setValue</a></b>(const QScriptValue &<i> value</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qscriptvalueiterator.html#toBack">toBack</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qscriptvalueiterator.html#toFront">toFront</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QScriptValue </td><td class="memItemRight bottomAlign"><b><a href="qscriptvalueiterator.html#value">value</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QScriptValueIterator & </td><td class="memItemRight bottomAlign"><b><a href="qscriptvalueiterator.html#operator-eq">operator=</a></b>(QScriptValue &<i> object</i>)</td></tr>
</table>
<a name="details"></a>
<!-- $$$QScriptValueIterator-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QScriptValueIterator class provides a Java-style iterator for <a href="qscriptvalue.html">QScriptValue</a>.</p>
<p>The QScriptValueIterator constructor takes a <a href="qscriptvalue.html">QScriptValue</a> as argument. After construction, the iterator is located at the very beginning of the sequence of properties. Here's how to iterate over all the properties of a <a href="qscriptvalue.html">QScriptValue</a>:</p>
<pre class="cpp"><span class="type"><a href="qscriptvalue.html">QScriptValue</a></span> object;
<span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>
<span class="type">QScriptValueIterator</span> it(object);
<span class="keyword">while</span> (it<span class="operator">.</span>hasNext()) {
it<span class="operator">.</span>next();
qDebug() <span class="operator"><</span><span class="operator"><</span> it<span class="operator">.</span>name() <span class="operator"><</span><span class="operator"><</span> <span class="string">": "</span> <span class="operator"><</span><span class="operator"><</span> it<span class="operator">.</span>value()<span class="operator">.</span>toString();
}</pre>
<p>The <a href="qscriptvalueiterator.html#next">next</a>() advances the iterator. The <a href="qscriptvalueiterator.html#name">name</a>(), <a href="qscriptvalueiterator.html#value">value</a>() and <a href="qscriptvalueiterator.html#flags">flags</a>() functions return the name, value and flags of the last item that was jumped over.</p>
<p>If you want to remove properties as you iterate over the <a href="qscriptvalue.html">QScriptValue</a>, use <a href="qscriptvalueiterator.html#remove">remove</a>(). If you want to modify the value of a property, use <a href="qscriptvalueiterator.html#setValue">setValue</a>().</p>
<p>Note that QScriptValueIterator only iterates over the <a href="qscriptvalue.html">QScriptValue</a>'s own properties; i.e. it does not follow the prototype chain. You can use a loop like this to follow the prototype chain:</p>
<pre class="cpp"><span class="type"><a href="qscriptvalue.html">QScriptValue</a></span> obj <span class="operator">=</span> <span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>; <span class="comment">// the object to iterate over</span>
<span class="keyword">while</span> (obj<span class="operator">.</span>isObject()) {
<span class="type">QScriptValueIterator</span> it(obj);
<span class="keyword">while</span> (it<span class="operator">.</span>hasNext()) {
it<span class="operator">.</span>next();
qDebug() <span class="operator"><</span><span class="operator"><</span> it<span class="operator">.</span>name();
}
obj <span class="operator">=</span> obj<span class="operator">.</span>prototype();
}</pre>
<p>Note that QScriptValueIterator will not automatically skip over properties that have the <a href="qscriptvalue.html#PropertyFlag-enum">QScriptValue::SkipInEnumeration</a> flag set; that flag only affects iteration in script code. If you want, you can skip over such properties with code like the following:</p>
<pre class="cpp"><span class="keyword">while</span> (it<span class="operator">.</span>hasNext()) {
it<span class="operator">.</span>next();
<span class="keyword">if</span> (it<span class="operator">.</span>flags() <span class="operator">&</span> <span class="type"><a href="qscriptvalue.html">QScriptValue</a></span><span class="operator">::</span>SkipInEnumeration)
<span class="keyword">continue</span>;
qDebug() <span class="operator"><</span><span class="operator"><</span> <span class="string">"found enumerated property:"</span> <span class="operator"><</span><span class="operator"><</span> it<span class="operator">.</span>name();
}</pre>
</div>
<p><b>See also </b><a href="qscriptvalue.html#property">QScriptValue::property</a>().</p>
<!-- @@@QScriptValueIterator -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QScriptValueIterator[overload1]$$$QScriptValueIteratorconstQScriptValue& -->
<h3 class="fn"><a name="QScriptValueIterator"></a>QScriptValueIterator::<span class="name">QScriptValueIterator</span>(const <span class="type"><a href="qscriptvalue.html">QScriptValue</a></span> &<i> object</i>)</h3>
<p>Constructs an iterator for traversing <i>object</i>. The iterator is set to be at the front of the sequence of properties (before the first property).</p>
<!-- @@@QScriptValueIterator -->
<!-- $$$~QScriptValueIterator[overload1]$$$~QScriptValueIterator -->
<h3 class="fn"><a name="dtor.QScriptValueIterator"></a>QScriptValueIterator::<span class="name">~QScriptValueIterator</span>()</h3>
<p>Destroys the iterator.</p>
<!-- @@@~QScriptValueIterator -->
<!-- $$$flags[overload1]$$$flags -->
<h3 class="fn"><a name="flags"></a><span class="type"><a href="qscriptvalue.html#PropertyFlag-enum">QScriptValue::PropertyFlags</a></span> QScriptValueIterator::<span class="name">flags</span>() const</h3>
<p>Returns the flags of the last property that was jumped over using <a href="qscriptvalueiterator.html#next">next</a>() or <a href="qscriptvalueiterator.html#previous">previous</a>().</p>
<p><b>See also </b><a href="qscriptvalueiterator.html#value">value</a>().</p>
<!-- @@@flags -->
<!-- $$$hasNext[overload1]$$$hasNext -->
<h3 class="fn"><a name="hasNext"></a><span class="type">bool</span> QScriptValueIterator::<span class="name">hasNext</span>() const</h3>
<p>Returns true if there is at least one item ahead of the iterator (i.e. the iterator is <i>not</i> at the back of the property sequence); otherwise returns false.</p>
<p><b>See also </b><a href="qscriptvalueiterator.html#next">next</a>() and <a href="qscriptvalueiterator.html#hasPrevious">hasPrevious</a>().</p>
<!-- @@@hasNext -->
<!-- $$$hasPrevious[overload1]$$$hasPrevious -->
<h3 class="fn"><a name="hasPrevious"></a><span class="type">bool</span> QScriptValueIterator::<span class="name">hasPrevious</span>() const</h3>
<p>Returns true if there is at least one item behind the iterator (i.e. the iterator is <i>not</i> at the front of the property sequence); otherwise returns false.</p>
<p><b>See also </b><a href="qscriptvalueiterator.html#previous">previous</a>() and <a href="qscriptvalueiterator.html#hasNext">hasNext</a>().</p>
<!-- @@@hasPrevious -->
<!-- $$$name[overload1]$$$name -->
<h3 class="fn"><a name="name"></a><span class="type">QString</span> QScriptValueIterator::<span class="name">name</span>() const</h3>
<p>Returns the name of the last property that was jumped over using <a href="qscriptvalueiterator.html#next">next</a>() or <a href="qscriptvalueiterator.html#previous">previous</a>().</p>
<p><b>See also </b><a href="qscriptvalueiterator.html#value">value</a>() and <a href="qscriptvalueiterator.html#flags">flags</a>().</p>
<!-- @@@name -->
<!-- $$$next[overload1]$$$next -->
<h3 class="fn"><a name="next"></a><span class="type">void</span> QScriptValueIterator::<span class="name">next</span>()</h3>
<p>Advances the iterator by one position.</p>
<p>Calling this function on an iterator located at the back of the container leads to undefined results.</p>
<p><b>See also </b><a href="qscriptvalueiterator.html#hasNext">hasNext</a>(), <a href="qscriptvalueiterator.html#previous">previous</a>(), and <a href="qscriptvalueiterator.html#name">name</a>().</p>
<!-- @@@next -->
<!-- $$$previous[overload1]$$$previous -->
<h3 class="fn"><a name="previous"></a><span class="type">void</span> QScriptValueIterator::<span class="name">previous</span>()</h3>
<p>Moves the iterator back by one position.</p>
<p>Calling this function on an iterator located at the front of the container leads to undefined results.</p>
<p><b>See also </b><a href="qscriptvalueiterator.html#hasPrevious">hasPrevious</a>(), <a href="qscriptvalueiterator.html#next">next</a>(), and <a href="qscriptvalueiterator.html#name">name</a>().</p>
<!-- @@@previous -->
<!-- $$$remove[overload1]$$$remove -->
<h3 class="fn"><a name="remove"></a><span class="type">void</span> QScriptValueIterator::<span class="name">remove</span>()</h3>
<p>Removes the last property that was jumped over using <a href="qscriptvalueiterator.html#next">next</a>() or <a href="qscriptvalueiterator.html#previous">previous</a>().</p>
<p><b>See also </b><a href="qscriptvalueiterator.html#setValue">setValue</a>().</p>
<!-- @@@remove -->
<!-- $$$scriptName[overload1]$$$scriptName -->
<h3 class="fn"><a name="scriptName"></a><span class="type"><a href="qscriptstring.html">QScriptString</a></span> QScriptValueIterator::<span class="name">scriptName</span>() const</h3>
<p>Returns the name of the last property that was jumped over using <a href="qscriptvalueiterator.html#next">next</a>() or <a href="qscriptvalueiterator.html#previous">previous</a>().</p>
<p>This function was introduced in Qt 4.4.</p>
<!-- @@@scriptName -->
<!-- $$$setValue[overload1]$$$setValueconstQScriptValue& -->
<h3 class="fn"><a name="setValue"></a><span class="type">void</span> QScriptValueIterator::<span class="name">setValue</span>(const <span class="type"><a href="qscriptvalue.html">QScriptValue</a></span> &<i> value</i>)</h3>
<p>Sets the <i>value</i> of the last property that was jumped over using <a href="qscriptvalueiterator.html#next">next</a>() or <a href="qscriptvalueiterator.html#previous">previous</a>().</p>
<p><b>See also </b><a href="qscriptvalueiterator.html#value">value</a>() and <a href="qscriptvalueiterator.html#name">name</a>().</p>
<!-- @@@setValue -->
<!-- $$$toBack[overload1]$$$toBack -->
<h3 class="fn"><a name="toBack"></a><span class="type">void</span> QScriptValueIterator::<span class="name">toBack</span>()</h3>
<p>Moves the iterator to the back of the <a href="qscriptvalue.html">QScriptValue</a> (after the last property).</p>
<p><b>See also </b><a href="qscriptvalueiterator.html#toFront">toFront</a>() and <a href="qscriptvalueiterator.html#previous">previous</a>().</p>
<!-- @@@toBack -->
<!-- $$$toFront[overload1]$$$toFront -->
<h3 class="fn"><a name="toFront"></a><span class="type">void</span> QScriptValueIterator::<span class="name">toFront</span>()</h3>
<p>Moves the iterator to the front of the <a href="qscriptvalue.html">QScriptValue</a> (before the first property).</p>
<p><b>See also </b><a href="qscriptvalueiterator.html#toBack">toBack</a>() and <a href="qscriptvalueiterator.html#next">next</a>().</p>
<!-- @@@toFront -->
<!-- $$$value[overload1]$$$value -->
<h3 class="fn"><a name="value"></a><span class="type"><a href="qscriptvalue.html">QScriptValue</a></span> QScriptValueIterator::<span class="name">value</span>() const</h3>
<p>Returns the value of the last property that was jumped over using <a href="qscriptvalueiterator.html#next">next</a>() or <a href="qscriptvalueiterator.html#previous">previous</a>().</p>
<p><b>See also </b><a href="qscriptvalueiterator.html#setValue">setValue</a>() and <a href="qscriptvalueiterator.html#name">name</a>().</p>
<!-- @@@value -->
<!-- $$$operator=[overload1]$$$operator=QScriptValue& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QScriptValueIterator</span> & QScriptValueIterator::<span class="name">operator=</span>(<span class="type"><a href="qscriptvalue.html">QScriptValue</a></span> &<i> object</i>)</h3>
<p>Makes the iterator operate on <i>object</i>. The iterator is set to be at the front of the sequence of properties (before the first property).</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>
|