288 lines
17 KiB
HTML
288 lines
17 KiB
HTML
<?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" />
|
|
<!-- qscriptstring.cpp -->
|
|
<title>Qt 4.8: QScriptString 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="qtscript.html">QtScript</a></li>
|
|
<li>QScriptString</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">QScriptString Class Reference</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 -->
|
|
<pre class="cpp"> <span class="preprocessor">#include <QScriptString></span></pre><p>This class was introduced in Qt 4.4.</p>
|
|
<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"><a href="qtglobal.html#quint32-typedef">quint32</a></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 <a href="qtscript.html">QtScript</a> 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"><a href="qstring.html">QString</a></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 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>
|