<?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" />
<!-- qdeclarativelist.cpp -->
<title>Qt 4.8: QDeclarativeListReference 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>QDeclarativeListReference</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">QDeclarativeListReference Class Reference</h1>
<!-- $$$QDeclarativeListReference-brief -->
<p>The QDeclarativeListReference class allows the manipulation of <a href="qdeclarativelistproperty.html">QDeclarativeListProperty</a> properties. <a href="#details">More...</a></p>
<!-- @@@QDeclarativeListReference -->
<pre class="cpp"> <span class="preprocessor">#include <QDeclarativeListReference></span></pre><p>This class was introduced in Qt 4.7.</p>
<ul>
<li><a href="qdeclarativelistreference-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="qdeclarativelistreference.html#QDeclarativeListReference">QDeclarativeListReference</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qdeclarativelistreference.html#QDeclarativeListReference-2">QDeclarativeListReference</a></b> ( QObject * <i>object</i>, const char * <i>property</i>, QDeclarativeEngine * <i>engine</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qdeclarativelistreference.html#append">append</a></b> ( QObject * <i>object</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QObject * </td><td class="memItemRight bottomAlign"><b><a href="qdeclarativelistreference.html#at">at</a></b> ( int <i>index</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qdeclarativelistreference.html#canAppend">canAppend</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qdeclarativelistreference.html#canAt">canAt</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qdeclarativelistreference.html#canClear">canClear</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qdeclarativelistreference.html#canCount">canCount</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qdeclarativelistreference.html#clear">clear</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qdeclarativelistreference.html#count">count</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qdeclarativelistreference.html#isValid">isValid</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QMetaObject * </td><td class="memItemRight bottomAlign"><b><a href="qdeclarativelistreference.html#listElementType">listElementType</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QObject * </td><td class="memItemRight bottomAlign"><b><a href="qdeclarativelistreference.html#object">object</a></b> () const</td></tr>
</table>
<a name="details"></a>
<!-- $$$QDeclarativeListReference-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QDeclarativeListReference class allows the manipulation of <a href="qdeclarativelistproperty.html">QDeclarativeListProperty</a> properties.</p>
<p>QDeclarativeListReference allows C++ programs to read from, and assign values to a QML list property in a simple and type safe way. A QDeclarativeListReference can be created by passing an object and property name or through a <a href="qdeclarativeproperty.html">QDeclarativeProperty</a> instance. These two are equivalant:</p>
<pre class="cpp"> <span class="type">QDeclarativeListReference</span> ref1(object<span class="operator">,</span> <span class="string">"children"</span>);
<span class="type"><a href="qdeclarativeproperty.html">QDeclarativeProperty</a></span> ref2(object<span class="operator">,</span> <span class="string">"children"</span>);
<span class="type">QDeclarativeListReference</span> ref2 <span class="operator">=</span> qvariant_cast<span class="operator"><</span><span class="type">QDeclarativeListReference</span><span class="operator">></span>(ref2<span class="operator">.</span>read());</pre>
<p>Not all QML list properties support all operations. A set of methods, <a href="qdeclarativelistreference.html#canAppend">canAppend</a>(), <a href="qdeclarativelistreference.html#canAt">canAt</a>(), <a href="qdeclarativelistreference.html#canClear">canClear</a>() and <a href="qdeclarativelistreference.html#canCount">canCount</a>() allow programs to query whether an operation is supported on a given property.</p>
<p>QML list properties are typesafe. Only <a href="qobject.html">QObject</a>'s that derive from the correct base class can be assigned to the list. The <a href="qdeclarativelistreference.html#listElementType">listElementType</a>() method can be used to query the <a href="qmetaobject.html">QMetaObject</a> of the <a href="qobject.html">QObject</a> type supported. Attempting to add objects of the incorrect type to a list property will fail.</p>
<p>Like with normal lists, when accessing a list element by index, it is the callers responsibility to ensure that it does not request an out of range element using the <a href="qdeclarativelistreference.html#count">count</a>() method before calling <a href="qdeclarativelistreference.html#at">at</a>().</p>
</div>
<!-- @@@QDeclarativeListReference -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QDeclarativeListReference[overload1]$$$QDeclarativeListReference -->
<h3 class="fn"><a name="QDeclarativeListReference"></a>QDeclarativeListReference::<span class="name">QDeclarativeListReference</span> ()</h3>
<p>Constructs an invalid instance.</p>
<!-- @@@QDeclarativeListReference -->
<!-- $$$QDeclarativeListReference$$$QDeclarativeListReferenceQObject*constchar*QDeclarativeEngine* -->
<h3 class="fn"><a name="QDeclarativeListReference-2"></a>QDeclarativeListReference::<span class="name">QDeclarativeListReference</span> ( <span class="type"><a href="qobject.html">QObject</a></span> * <i>object</i>, const <span class="type">char</span> * <i>property</i>, <span class="type"><a href="qdeclarativeengine.html">QDeclarativeEngine</a></span> * <i>engine</i> = 0 )</h3>
<p>Constructs a <a href="qdeclarativelistreference.html">QDeclarativeListReference</a> for <i>object</i>'s <i>property</i>. If <i>property</i> is not a list property, an invalid <a href="qdeclarativelistreference.html">QDeclarativeListReference</a> is created. If <i>object</i> is destroyed after the reference is constructed, it will automatically become invalid. That is, it is safe to hold <a href="qdeclarativelistreference.html">QDeclarativeListReference</a> instances even after <i>object</i> is deleted.</p>
<p>Passing <i>engine</i> is required to access some QML created list properties. If in doubt, and an engine is available, pass it.</p>
<!-- @@@QDeclarativeListReference -->
<!-- $$$append[overload1]$$$appendQObject* -->
<h3 class="fn"><a name="append"></a><span class="type">bool</span> QDeclarativeListReference::<span class="name">append</span> ( <span class="type"><a href="qobject.html">QObject</a></span> * <i>object</i> ) const</h3>
<p>Appends <i>object</i> to the list. Returns true if the operation succeeded, otherwise false.</p>
<p><b>See also </b><a href="qdeclarativelistreference.html#canAppend">canAppend</a>().</p>
<!-- @@@append -->
<!-- $$$at[overload1]$$$atint -->
<h3 class="fn"><a name="at"></a><span class="type"><a href="qobject.html">QObject</a></span> * QDeclarativeListReference::<span class="name">at</span> ( <span class="type">int</span> <i>index</i> ) const</h3>
<p>Returns the list element at <i>index</i>, or 0 if the operation failed.</p>
<p><b>See also </b><a href="qdeclarativelistreference.html#canAt">canAt</a>().</p>
<!-- @@@at -->
<!-- $$$canAppend[overload1]$$$canAppend -->
<h3 class="fn"><a name="canAppend"></a><span class="type">bool</span> QDeclarativeListReference::<span class="name">canAppend</span> () const</h3>
<p>Returns true if the list property can be appended to, otherwise false. Returns false if the reference is invalid.</p>
<p><b>See also </b><a href="qdeclarativelistreference.html#append">append</a>().</p>
<!-- @@@canAppend -->
<!-- $$$canAt[overload1]$$$canAt -->
<h3 class="fn"><a name="canAt"></a><span class="type">bool</span> QDeclarativeListReference::<span class="name">canAt</span> () const</h3>
<p>Returns true if the list property can queried by index, otherwise false. Returns false if the reference is invalid.</p>
<p><b>See also </b><a href="qdeclarativelistreference.html#at">at</a>().</p>
<!-- @@@canAt -->
<!-- $$$canClear[overload1]$$$canClear -->
<h3 class="fn"><a name="canClear"></a><span class="type">bool</span> QDeclarativeListReference::<span class="name">canClear</span> () const</h3>
<p>Returns true if the list property can be cleared, otherwise false. Returns false if the reference is invalid.</p>
<p><b>See also </b><a href="qdeclarativelistreference.html#clear">clear</a>().</p>
<!-- @@@canClear -->
<!-- $$$canCount[overload1]$$$canCount -->
<h3 class="fn"><a name="canCount"></a><span class="type">bool</span> QDeclarativeListReference::<span class="name">canCount</span> () const</h3>
<p>Returns true if the list property can be queried for its element count, otherwise false. Returns false if the reference is invalid.</p>
<p><b>See also </b><a href="qdeclarativelistreference.html#count">count</a>().</p>
<!-- @@@canCount -->
<!-- $$$clear[overload1]$$$clear -->
<h3 class="fn"><a name="clear"></a><span class="type">bool</span> QDeclarativeListReference::<span class="name">clear</span> () const</h3>
<p>Clears the list. Returns true if the operation succeeded, otherwise false.</p>
<p><b>See also </b><a href="qdeclarativelistreference.html#canClear">canClear</a>().</p>
<!-- @@@clear -->
<!-- $$$count[overload1]$$$count -->
<h3 class="fn"><a name="count"></a><span class="type">int</span> QDeclarativeListReference::<span class="name">count</span> () const</h3>
<p>Returns the number of objects in the list, or 0 if the operation failed.</p>
<!-- @@@count -->
<!-- $$$isValid[overload1]$$$isValid -->
<h3 class="fn"><a name="isValid"></a><span class="type">bool</span> QDeclarativeListReference::<span class="name">isValid</span> () const</h3>
<p>Returns true if the instance refers to a valid list property, otherwise false.</p>
<!-- @@@isValid -->
<!-- $$$listElementType[overload1]$$$listElementType -->
<h3 class="fn"><a name="listElementType"></a>const <span class="type"><a href="qmetaobject.html">QMetaObject</a></span> * QDeclarativeListReference::<span class="name">listElementType</span> () const</h3>
<p>Returns the <a href="qmetaobject.html">QMetaObject</a> for the elements stored in the list property. Returns 0 if the reference is invalid.</p>
<p>The <a href="qmetaobject.html">QMetaObject</a> can be used ahead of time to determine whether a given instance can be added to a list.</p>
<!-- @@@listElementType -->
<!-- $$$object[overload1]$$$object -->
<h3 class="fn"><a name="object"></a><span class="type"><a href="qobject.html">QObject</a></span> * QDeclarativeListReference::<span class="name">object</span> () const</h3>
<p>Returns the list property's object. Returns 0 if the reference is invalid.</p>
<!-- @@@object -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</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.</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>
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. <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>
