<?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" />
<!-- qmlviews.qdoc -->
<title>Qt 4.8: Presenting Data with Views</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>Presenting Data with Views</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">
<link rel="prev" href="qdeclarativemodels.html" />
<link rel="next" href="qml-extending.html" />
<p class="naviNextPrevious headerNavi">
<a class="prevPage" href="qdeclarativemodels.html">Structuring Data with Models</a>
<a class="nextPage" href="qml-extending.html">Extending QML Functionalities using C++</a>
</p><p/>
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#models">Models</a></li>
<li class="level1"><a href="#view-delegates">View Delegates</a></li>
<li class="level1"><a href="#decorating-views">Decorating Views</a></li>
<li class="level1"><a href="#listview-sections">ListView Sections</a></li>
</ul>
</div>
<h1 class="title">Presenting Data with Views</h1>
<span class="subtitle"></span>
<!-- $$$qml-views.html-description -->
<div class="descr"> <a name="details"></a>
<p>Views are containers for collections of items. They are feature-rich and can be customizable to meet style or behavior requirements.</p>
<a name="qml-view-elements"></a><p>A set of standard views are provided in the basic set of Qt Quick graphical elements:</p>
<ul>
<li><a href="qml-listview.html">ListView</a> arranges items in a horizontal or vertical list</li>
<li><a href="qml-gridview.html">GridView</a> arranges items in a grid within the available space</li>
<li><a href="qml-pathview.html">PathView</a> arranges items on a path</li>
<li><a href="qml-webview.html">WebView</a> - available from the <a href="qmlwebkit.html">QtWebKit QML Module</a>.</li>
</ul>
<p>Unlike other views, <a href="qml-webview.html">WebView</a> is not a fully-featured view item, and needs to be combined with a <a href="qml-flickable.html">Flickable</a> item to create a view that performs like a Web browser.</p>
<p>These elements have properties and behaviors exclusive to each element. Visit their respective documentation for more information.</p>
<a name="models"></a>
<h2>Models</h2>
<p>Views display <a href="qdeclarativemodels.html">models</a> onto the screen. A model could be a simple list of <a href="qdeclarativemodels.html#an-integer">integer</a> or a <a href="qdeclarativemodels.html#qml-c-models">C++ model</a>.</p>
<p>To assign a model to a view, bind the view's <tt>model</tt> property to a model.</p>
<pre class="qml"> <span class="type"><a href="qml-listmodel.html">ListModel</a></span> {
<span class="name">id</span>: <span class="name">petlist</span>
<span class="type"><a href="qml-listelement.html">ListElement</a></span> { <span class="name">type</span>: <span class="string">"Cat"</span> }
<span class="type"><a href="qml-listelement.html">ListElement</a></span> { <span class="name">type</span>: <span class="string">"Dog"</span> }
<span class="type"><a href="qml-listelement.html">ListElement</a></span> { <span class="name">type</span>: <span class="string">"Mouse"</span> }
<span class="type"><a href="qml-listelement.html">ListElement</a></span> { <span class="name">type</span>: <span class="string">"Rabbit"</span> }
<span class="type"><a href="qml-listelement.html">ListElement</a></span> { <span class="name">type</span>: <span class="string">"Horse"</span> }
}
<span class="type"><a href="qml-listview.html">ListView</a></span> {
<span class="name">id</span>: <span class="name">view</span>
<span class="name">anchors</span>.fill: <span class="name">parent</span>
<span class="name">model</span>: <span class="name">petlist</span>
<span class="name">delegate</span>: <span class="name">petdelegate</span>
}</pre>
<p>For more information, consult the <a href="qdeclarativemodels.html">QML Data Models</a> article.</p>
<a name="qml-view-delegate"></a><a name="view-delegates"></a>
<h2>View Delegates</h2>
<p>Views need a <i>delegate</i> to visually represent an item in a list. A view will visualize each item list according to the template defined by the delegate. Items in a model are accessible through the <tt>index</tt> property as well as the item's properties.</p>
<pre class="qml"> <span class="type"><a href="qml-component.html">Component</a></span> {
<span class="name">id</span>: <span class="name">petdelegate</span>
<span class="type"><a href="qml-text.html">Text</a></span> {
<span class="name">id</span>: <span class="name">label</span>
<span class="name">font</span>.pixelSize: <span class="number">24</span>
<span class="name">text</span>: <span class="keyword">if</span> (<span class="name">index</span> <span class="operator">==</span> <span class="number">0</span>)
<span class="name">label</span>.<span class="name">text</span> <span class="operator">=</span> <span class="name">type</span> <span class="operator">+</span> <span class="string">" (default)"</span>
else
<span class="name">text</span>: <span class="name">type</span>
}
}</pre>
<p class="centerAlign"><img src="images/listview-setup.png" alt="" /></p><a name="decorating-views"></a>
<h2>Decorating Views</h2>
<p>Views allow visual customization through <i>decoration</i> properties such as the <tt>header</tt>, <tt>footer</tt>, and <tt>section</tt> properties. By binding an object, usually another visual object, to these properties, the views are decoratable. A footer may include a <a href="qml-rectangle.html">Rectangle</a> element showcasing borders or a header that displays a logo on top of the list.</p>
<p>Suppose that a specific club wants to decorate its members list with its brand colors. A member list is in a <tt>model</tt> and the <tt>delegate</tt> will display the model's content.</p>
<pre class="qml"> <span class="type"><a href="qml-listmodel.html">ListModel</a></span> {
<span class="name">id</span>: <span class="name">nameModel</span>
<span class="type"><a href="qml-listelement.html">ListElement</a></span> { <span class="name">name</span>: <span class="string">"Alice"</span> }
<span class="type"><a href="qml-listelement.html">ListElement</a></span> { <span class="name">name</span>: <span class="string">"Bob"</span> }
<span class="type"><a href="qml-listelement.html">ListElement</a></span> { <span class="name">name</span>: <span class="string">"Jane"</span> }
<span class="type"><a href="qml-listelement.html">ListElement</a></span> { <span class="name">name</span>: <span class="string">"Harry"</span> }
<span class="type"><a href="qml-listelement.html">ListElement</a></span> { <span class="name">name</span>: <span class="string">"Wendy"</span> }
}
<span class="type"><a href="qml-component.html">Component</a></span> {
<span class="name">id</span>: <span class="name">nameDelegate</span>
<span class="type"><a href="qml-text.html">Text</a></span> {
<span class="name">text</span>: <span class="name">name</span>;
<span class="name">font</span>.pixelSize: <span class="number">24</span>
}
}</pre>
<p>The club may decorate the members list by binding visual objects to the <tt>header</tt> and <tt>footer</tt> properties. The visual object may be defined inline, in another file, or in a <a href="qml-component.html">Component</a> element.</p>
<pre class="qml"> <span class="type"><a href="qml-listview.html">ListView</a></span> {
<span class="name">anchors</span>.fill: <span class="name">parent</span>
<span class="name">clip</span>: <span class="number">true</span>
<span class="name">model</span>: <span class="name">nameModel</span>
<span class="name">delegate</span>: <span class="name">nameDelegate</span>
<span class="name">header</span>: <span class="name">bannercomponent</span>
<span class="name">footer</span>: <span class="name">Rectangle</span> {
<span class="name">width</span>: <span class="name">parent</span>.<span class="name">width</span>; <span class="name">height</span>: <span class="number">30</span>;
<span class="name">gradient</span>: <span class="name">clubcolors</span>
}
<span class="name">highlight</span>: <span class="name">Rectangle</span> {
<span class="name">width</span>: <span class="name">parent</span>.<span class="name">width</span>
<span class="name">color</span>: <span class="string">"lightgray"</span>
}
}
<span class="type"><a href="qml-component.html">Component</a></span> { <span class="comment">//instantiated when header is processed</span>
<span class="name">id</span>: <span class="name">bannercomponent</span>
<span class="type"><a href="qml-rectangle.html">Rectangle</a></span> {
<span class="name">id</span>: <span class="name">banner</span>
<span class="name">width</span>: <span class="name">parent</span>.<span class="name">width</span>; <span class="name">height</span>: <span class="number">50</span>
<span class="name">gradient</span>: <span class="name">clubcolors</span>
<span class="type">border</span> {<span class="name">color</span>: <span class="string">"#9EDDF2"</span>; <span class="name">width</span>: <span class="number">2</span>}
<span class="type"><a href="qml-text.html">Text</a></span> {
<span class="name">anchors</span>.centerIn: <span class="name">parent</span>
<span class="name">text</span>: <span class="string">"Club Members"</span>
<span class="name">font</span>.pixelSize: <span class="number">32</span>
}
}
}
<span class="type"><a href="qml-gradient.html">Gradient</a></span> {
<span class="name">id</span>: <span class="name">clubcolors</span>
<span class="type"><a href="qml-gradientstop.html">GradientStop</a></span> { <span class="name">position</span>: <span class="number">0.0</span>; <span class="name">color</span>: <span class="string">"#8EE2FE"</span>}
<span class="type"><a href="qml-gradientstop.html">GradientStop</a></span> { <span class="name">position</span>: <span class="number">0.66</span>; <span class="name">color</span>: <span class="string">"#7ED2EE"</span>}
}</pre>
<p class="centerAlign"><img src="images/listview-decorations.png" alt="" /></p><a name="listview-sections"></a>
<h2>ListView Sections</h2>
<p><a href="qml-listview.html">ListView</a> contents may be grouped into <i>sections</i>, where related list items are labeled according to their sections. Further, the sections may be decorated with <a href="#qml-view-delegate">delegates</a>.</p>
<p>A list may contain a list indicating people's names and the team on which team the person belongs.</p>
<pre class="qml"> <span class="type"><a href="qml-listmodel.html">ListModel</a></span> {
<span class="name">id</span>: <span class="name">nameModel</span>
<span class="type"><a href="qml-listelement.html">ListElement</a></span> { <span class="name">name</span>: <span class="string">"Alice"</span>; <span class="name">team</span>: <span class="string">"Crypto"</span> }
<span class="type"><a href="qml-listelement.html">ListElement</a></span> { <span class="name">name</span>: <span class="string">"Bob"</span>; <span class="name">team</span>: <span class="string">"Crypto"</span> }
<span class="type"><a href="qml-listelement.html">ListElement</a></span> { <span class="name">name</span>: <span class="string">"Jane"</span>; <span class="name">team</span>: <span class="string">"QA"</span> }
<span class="type"><a href="qml-listelement.html">ListElement</a></span> { <span class="name">name</span>: <span class="string">"Victor"</span>; <span class="name">team</span>: <span class="string">"QA"</span> }
<span class="type"><a href="qml-listelement.html">ListElement</a></span> { <span class="name">name</span>: <span class="string">"Wendy"</span>; <span class="name">team</span>: <span class="string">"Graphics"</span> }
}
<span class="type"><a href="qml-component.html">Component</a></span> {
<span class="name">id</span>: <span class="name">nameDelegate</span>
<span class="type"><a href="qml-text.html">Text</a></span> {
<span class="name">text</span>: <span class="name">name</span>;
<span class="name">font</span>.pixelSize: <span class="number">24</span>
<span class="name">anchors</span>.left: <span class="name">parent</span>.<span class="name">left</span>
<span class="name">anchors</span>.leftMargin: <span class="number">2</span>
}
}</pre>
<p>The <a href="qml-listview.html">ListView</a> element has the <tt>section</tt> <a href="propertybinding.html#attached-properties">attached property</a> that can combine adjacent and related elements into a section. The section's <tt>property</tt> property is for selecting which list element property to use as sections. The <tt>criteria</tt> can dictate how the section names are displayed and the <tt>delegate</tt> is similar to the views' <a href="#qml-view-delegate">delegate</a> property.</p>
<pre class="qml"> <span class="type"><a href="qml-listview.html">ListView</a></span> {
<span class="name">anchors</span>.fill: <span class="name">parent</span>
<span class="name">model</span>: <span class="name">nameModel</span>
<span class="name">delegate</span>: <span class="name">nameDelegate</span>
<span class="name">focus</span>: <span class="number">true</span>
<span class="name">highlight</span>: <span class="name">Rectangle</span> {
<span class="name">color</span>: <span class="string">"lightblue"</span>
<span class="name">width</span>: <span class="name">parent</span>.<span class="name">width</span>
}
<span class="type">section</span> {
<span class="name">property</span>: <span class="string">"team"</span>
<span class="name">criteria</span>: <span class="name">ViewSection</span>.<span class="name">FullString</span>
<span class="name">delegate</span>: <span class="name">Rectangle</span> {
<span class="name">color</span>: <span class="string">"#b0dfb0"</span>
<span class="name">width</span>: <span class="name">parent</span>.<span class="name">width</span>
<span class="name">height</span>: <span class="name">childrenRect</span>.<span class="name">height</span> <span class="operator">+</span> <span class="number">4</span>
<span class="type"><a href="qml-text.html">Text</a></span> { <span class="name">anchors</span>.horizontalCenter: <span class="name">parent</span>.<span class="name">horizontalCenter</span>
<span class="name">font</span>.pixelSize: <span class="number">16</span>
<span class="name">font</span>.bold: <span class="number">true</span>
<span class="name">text</span>: <span class="name">section</span>
}
}
}
}</pre>
<p class="centerAlign"><img src="images/listview-section.png" alt="" /></p></div>
<!-- @@@qml-views.html -->
<p class="naviNextPrevious footerNavi">
<a class="prevPage" href="qdeclarativemodels.html">Structuring Data with Models</a>
<a class="nextPage" href="qml-extending.html">Extending QML Functionalities using C++</a>
</p>
</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>
