<?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" />
<!-- qml-extending.qdoc -->
<title>Qt 4.8: Extending QML - Object and List Property Types Example</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="all-examples.html">Examples</a></li>
<li>QML Examples & Demos</li>
<li>Extending QML - Object and List Property Types Example</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="#declare-the-birthdayparty">Declare the BirthdayParty</a></li>
<li class="level2"><a href="#define-the-birthdayparty">Define the BirthdayParty</a></li>
<li class="level1"><a href="#running-the-example">Running the example</a></li>
</ul>
</div>
<h1 class="title">Extending QML - Object and List Property Types Example</h1>
<span class="subtitle"></span>
<!-- $$$declarative/cppextensions/referenceexamples/properties-description -->
<div class="descr"> <a name="details"></a>
<p>Files:</p>
<ul>
<li><a href="declarative-cppextensions-referenceexamples-properties-birthdayparty-cpp.html">declarative/cppextensions/referenceexamples/properties/birthdayparty.cpp</a></li>
<li><a href="declarative-cppextensions-referenceexamples-properties-birthdayparty-h.html">declarative/cppextensions/referenceexamples/properties/birthdayparty.h</a></li>
<li><a href="declarative-cppextensions-referenceexamples-properties-example-qml.html">declarative/cppextensions/referenceexamples/properties/example.qml</a></li>
<li><a href="declarative-cppextensions-referenceexamples-properties-person-cpp.html">declarative/cppextensions/referenceexamples/properties/person.cpp</a></li>
<li><a href="declarative-cppextensions-referenceexamples-properties-person-h.html">declarative/cppextensions/referenceexamples/properties/person.h</a></li>
<li><a href="declarative-cppextensions-referenceexamples-properties-main-cpp.html">declarative/cppextensions/referenceexamples/properties/main.cpp</a></li>
<li><a href="declarative-cppextensions-referenceexamples-properties-properties-pro.html">declarative/cppextensions/referenceexamples/properties/properties.pro</a></li>
<li><a href="declarative-cppextensions-referenceexamples-properties-properties-qrc.html">declarative/cppextensions/referenceexamples/properties/properties.qrc</a></li>
</ul>
<p>This example builds on:</p>
<ul>
<li><a href="declarative-cppextensions-referenceexamples-adding.html">Extending QML - Adding Types Example</a></li>
</ul>
<p>The Object and List Property Types example shows how to add object and list properties in QML. This example adds a BirthdayParty element that specifies a birthday party, consisting of a celebrant and a list of guests. People are specified using the People QML type built in the previous example.</p>
<pre class="qml"> <span class="type">BirthdayParty</span> {
<span class="name">host</span>: <span class="name">Person</span> {
<span class="name">name</span>: <span class="string">"Bob Jones"</span>
<span class="name">shoeSize</span>: <span class="number">12</span>
}
<span class="name">guests</span>: [
<span class="type">Person</span> { <span class="name">name</span>: <span class="string">"Leo Hodges"</span> },
<span class="type">Person</span> { <span class="name">name</span>: <span class="string">"Jack Smith"</span> },
<span class="type">Person</span> { <span class="name">name</span>: <span class="string">"Anne Brown"</span> }
]
}</pre>
<a name="declare-the-birthdayparty"></a>
<h2>Declare the BirthdayParty</h2>
<p>The BirthdayParty class is declared like this:</p>
<pre class="cpp"> <span class="keyword">class</span> BirthdayParty : <span class="keyword">public</span> <span class="type"><a href="qobject.html">QObject</a></span>
{
Q_OBJECT
Q_PROPERTY(Person <span class="operator">*</span>host READ host WRITE setHost)
Q_PROPERTY(<span class="type"><a href="qdeclarativelistproperty.html">QDeclarativeListProperty</a></span><span class="operator"><</span>Person<span class="operator">></span> guests READ guests)
<span class="keyword">public</span>:
BirthdayParty(<span class="type"><a href="qobject.html">QObject</a></span> <span class="operator">*</span>parent <span class="operator">=</span> <span class="number">0</span>);
Person <span class="operator">*</span>host() <span class="keyword">const</span>;
<span class="type">void</span> setHost(Person <span class="operator">*</span>);
<span class="type"><a href="qdeclarativelistproperty.html">QDeclarativeListProperty</a></span><span class="operator"><</span>Person<span class="operator">></span> guests();
<span class="type">int</span> guestCount() <span class="keyword">const</span>;
Person <span class="operator">*</span>guest(<span class="type">int</span>) <span class="keyword">const</span>;
<span class="keyword">private</span>:
Person <span class="operator">*</span>m_host;
<span class="type"><a href="qlist.html">QList</a></span><span class="operator"><</span>Person <span class="operator">*</span><span class="operator">></span> m_guests;
};</pre>
<p>The class contains a member to store the celebrant object, and also a <a href="qlist.html">QList</a><Person *> member.</p>
<p>In QML, the type of a list properties - and the guests property is a list of people - are all of type <a href="qdeclarativelistproperty.html">QDeclarativeListProperty</a><T>. <a href="qdeclarativelistproperty.html">QDeclarativeListProperty</a> is simple value type that contains a set of function pointers. QML calls these function pointers whenever it needs to read from, write to or otherwise interact with the list. In addition to concrete lists like the people list used in this example, the use of <a href="qdeclarativelistproperty.html">QDeclarativeListProperty</a> allows for "virtual lists" and other advanced scenarios.</p>
<a name="define-the-birthdayparty"></a>
<h3>Define the BirthdayParty</h3>
<p>The implementation of BirthdayParty property accessors is straight forward.</p>
<pre class="cpp"> Person <span class="operator">*</span>BirthdayParty<span class="operator">::</span>host() <span class="keyword">const</span>
{
<span class="keyword">return</span> m_host;
}
<span class="type">void</span> BirthdayParty<span class="operator">::</span>setHost(Person <span class="operator">*</span>c)
{
m_host <span class="operator">=</span> c;
}
<span class="type"><a href="qdeclarativelistproperty.html">QDeclarativeListProperty</a></span><span class="operator"><</span>Person<span class="operator">></span> BirthdayParty<span class="operator">::</span>guests()
{
<span class="keyword">return</span> <span class="type"><a href="qdeclarativelistproperty.html">QDeclarativeListProperty</a></span><span class="operator"><</span>Person<span class="operator">></span>(<span class="keyword">this</span><span class="operator">,</span> m_guests);
}
<span class="type">int</span> BirthdayParty<span class="operator">::</span>guestCount() <span class="keyword">const</span>
{
<span class="keyword">return</span> m_guests<span class="operator">.</span>count();
}
Person <span class="operator">*</span>BirthdayParty<span class="operator">::</span>guest(<span class="type">int</span> index) <span class="keyword">const</span>
{
<span class="keyword">return</span> m_guests<span class="operator">.</span>at(index);
}</pre>
<a name="running-the-example"></a>
<h2>Running the example</h2>
<p>The main.cpp file in the example includes a simple shell application that loads and runs the QML snippet shown at the beginning of this page.</p>
</div>
<!-- @@@declarative/cppextensions/referenceexamples/properties -->
</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>
