/usr/share/qt5/doc/qtscript/qscriptstring.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 | <?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" />
<!-- qscriptstring.cpp -->
<title>QScriptString 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>QScriptString</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">QScriptString Class</h1>
<!-- $$$QScriptString-brief -->
<p>The QScriptString class acts as a handle to "interned" strings in a <a href="qscriptengine.html">QScriptEngine</a>. <a href="#details">More...</a></p>
<!-- @@@QScriptString -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QScriptString></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.4</td></tr></table><ul>
<li><a href="qscriptstring-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="qscriptstring.html#QScriptString">QScriptString</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qscriptstring.html#QScriptString-2">QScriptString</a></b>(const QScriptString &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qscriptstring.html#dtor.QScriptString">~QScriptString</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qscriptstring.html#isValid">isValid</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> quint32 </td><td class="memItemRight bottomAlign"><b><a href="qscriptstring.html#toArrayIndex">toArrayIndex</a></b>(bool *<i> ok</i> = 0) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qscriptstring.html#toString">toString</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qscriptstring.html#operator-QString">operator QString</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qscriptstring.html#operator-not-eq">operator!=</a></b>(const QScriptString &<i> other</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QScriptString & </td><td class="memItemRight bottomAlign"><b><a href="qscriptstring.html#operator-eq">operator=</a></b>(const QScriptString &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qscriptstring.html#operator-eq-eq">operator==</a></b>(const QScriptString &<i> other</i>) const</td></tr>
</table>
<a name="details"></a>
<!-- $$$QScriptString-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QScriptString class acts as a handle to "interned" strings in a <a href="qscriptengine.html">QScriptEngine</a>.</p>
<p>QScriptString can be used to achieve faster (repeated) property getting/setting, and comparison of property names, of script objects.</p>
<p>To get a QScriptString representation of a string, pass the string to <a href="qscriptengine.html#toStringHandle">QScriptEngine::toStringHandle</a>(). The typical usage pattern is to register one or more pre-defined strings when setting up your script environment, then subsequently use the relevant QScriptString as argument to e.g. <a href="qscriptvalue.html#property">QScriptValue::property</a>().</p>
<p>Call the <a href="qscriptstring.html#toString">toString</a>() function to obtain the string that a QScriptString represents.</p>
<p>Call the <a href="qscriptstring.html#toArrayIndex">toArrayIndex</a>() function to convert a QScriptString to an array index. This is useful when using <a href="qscriptclass.html">QScriptClass</a> to implement array-like objects.</p>
</div>
<!-- @@@QScriptString -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QScriptString[overload1]$$$QScriptString -->
<h3 class="fn"><a name="QScriptString"></a>QScriptString::<span class="name">QScriptString</span>()</h3>
<p>Constructs an invalid <a href="qscriptstring.html">QScriptString</a>.</p>
<!-- @@@QScriptString -->
<!-- $$$QScriptString$$$QScriptStringconstQScriptString& -->
<h3 class="fn"><a name="QScriptString-2"></a>QScriptString::<span class="name">QScriptString</span>(const <span class="type">QScriptString</span> &<i> other</i>)</h3>
<p>Constructs a new <a href="qscriptstring.html">QScriptString</a> that is a copy of <i>other</i>.</p>
<!-- @@@QScriptString -->
<!-- $$$~QScriptString[overload1]$$$~QScriptString -->
<h3 class="fn"><a name="dtor.QScriptString"></a>QScriptString::<span class="name">~QScriptString</span>()</h3>
<p>Destroys this <a href="qscriptstring.html">QScriptString</a>.</p>
<!-- @@@~QScriptString -->
<!-- $$$isValid[overload1]$$$isValid -->
<h3 class="fn"><a name="isValid"></a><span class="type">bool</span> QScriptString::<span class="name">isValid</span>() const</h3>
<p>Returns true if this <a href="qscriptstring.html">QScriptString</a> is valid; otherwise returns false.</p>
<!-- @@@isValid -->
<!-- $$$toArrayIndex[overload1]$$$toArrayIndexbool* -->
<h3 class="fn"><a name="toArrayIndex"></a><span class="type">quint32</span> QScriptString::<span class="name">toArrayIndex</span>(<span class="type">bool</span> *<i> ok</i> = 0) const</h3>
<p>Attempts to convert this <a href="qscriptstring.html">QScriptString</a> to a Qt Script array index, and returns the result.</p>
<p>If a conversion error occurs, *<i>ok</i> is set to false; otherwise *<i>ok</i> is set to true.</p>
<p>This function was introduced in Qt 4.6.</p>
<!-- @@@toArrayIndex -->
<!-- $$$toString[overload1]$$$toString -->
<h3 class="fn"><a name="toString"></a><span class="type">QString</span> QScriptString::<span class="name">toString</span>() const</h3>
<p>Returns the string that this <a href="qscriptstring.html">QScriptString</a> represents, or a null string if this <a href="qscriptstring.html">QScriptString</a> is not valid.</p>
<p><b>See also </b><a href="qscriptstring.html#isValid">isValid</a>().</p>
<!-- @@@toString -->
<!-- $$$operator QString[overload1]$$$operator QString -->
<h3 class="fn"><a name="operator-QString"></a>QScriptString::<span class="name">operator QString</span>() const</h3>
<p>Returns the string that this <a href="qscriptstring.html">QScriptString</a> represents, or a null string if this <a href="qscriptstring.html">QScriptString</a> is not valid.</p>
<p><b>See also </b><a href="qscriptstring.html#toString">toString</a>().</p>
<!-- @@@operator QString -->
<!-- $$$operator!=[overload1]$$$operator!=constQScriptString& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QScriptString::<span class="name">operator!=</span>(const <span class="type">QScriptString</span> &<i> other</i>) const</h3>
<p>Returns true if this <a href="qscriptstring.html">QScriptString</a> is not equal to <i>other</i>; otherwise returns false.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQScriptString& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QScriptString</span> & QScriptString::<span class="name">operator=</span>(const <span class="type">QScriptString</span> &<i> other</i>)</h3>
<p>Assigns the <i>other</i> value to this <a href="qscriptstring.html">QScriptString</a>.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQScriptString& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QScriptString::<span class="name">operator==</span>(const <span class="type">QScriptString</span> &<i> other</i>) const</h3>
<p>Returns true if this <a href="qscriptstring.html">QScriptString</a> is equal to <i>other</i>; otherwise returns false.</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>
|