<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qquickpackage.cpp -->
<title>Package QML Type | Qt QML 5.9</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.9</td><td ><a href="qtqml-index.html">Qt QML</a></td><td ><a href="qtqml-qmlmodule.html">QML Types</a></td><td >Package QML Type</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#attached-properties">Attached Properties</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Package QML Type</h1>
<span class="subtitle"></span>
<!-- $$$Package-brief -->
<p>Specifies a collection of named items <a href="#details">More...</a></p>
<!-- @@@Package -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import .</td></tr></table></div><ul>
<li><a href="qml-package-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="attached-properties"></a>
<h2 id="attached-properties">Attached Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-package.html#name-attached-prop">name</a></b></b> : string</li>
</ul>
<!-- $$$Package-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>The Package type is used in conjunction with <a href="qml-qtqml-models-delegatemodel.html">DelegateModel</a> to enable delegates with a shared context to be provided to multiple views.</p>
<p>Any item within a Package may be assigned a name via the <a href="qml-package.html#name-attached-prop">Package.name</a> attached property.</p>
<p>The example below creates a Package containing two named items; <i>list</i> and <i>grid</i>. The third item in the package (the Rectangle) is parented to whichever delegate it should appear in. This allows an item to move between views.</p>
<pre class="qml">
<span class="type"><a href="qml-package.html">Package</a></span> {
<span class="type">Text</span> { <span class="name">id</span>: <span class="name">listDelegate</span>; <span class="name">width</span>: <span class="name">parent</span>.<span class="name">width</span>; <span class="name">height</span>: <span class="number">25</span>; <span class="name">text</span>: <span class="string">'Empty'</span>; <span class="name">Package</span>.name: <span class="string">'list'</span> }
<span class="type">Text</span> { <span class="name">id</span>: <span class="name">gridDelegate</span>; <span class="name">width</span>: <span class="name">parent</span>.<span class="name">width</span> <span class="operator">/</span> <span class="number">2</span>; <span class="name">height</span>: <span class="number">50</span>; <span class="name">text</span>: <span class="string">'Empty'</span>; <span class="name">Package</span>.name: <span class="string">'grid'</span> }
<span class="type">Rectangle</span> {
<span class="name">id</span>: <span class="name">wrapper</span>
<span class="name">width</span>: <span class="name">parent</span>.<span class="name">width</span>; <span class="name">height</span>: <span class="number">25</span>
<span class="name">color</span>: <span class="string">'lightsteelblue'</span>
<span class="type">Text</span> { <span class="name">text</span>: <span class="name">display</span>; <span class="name">anchors</span>.centerIn: <span class="name">parent</span> }
<span class="name">state</span>: <span class="name">root</span>.<span class="name">upTo</span> <span class="operator">></span> <span class="name">index</span> ? <span class="string">'inGrid'</span> : <span class="string">'inList'</span>
<span class="name">states</span>: [
<span class="type"><a href="qml-qtqml-statemachine-state.html">State</a></span> {
<span class="name">name</span>: <span class="string">'inList'</span>
<span class="type">ParentChange</span> { <span class="name">target</span>: <span class="name">wrapper</span>; <span class="name">parent</span>: <span class="name">listDelegate</span> }
},
<span class="type"><a href="qml-qtqml-statemachine-state.html">State</a></span> {
<span class="name">name</span>: <span class="string">'inGrid'</span>
<span class="type">ParentChange</span> {
<span class="name">target</span>: <span class="name">wrapper</span>; <span class="name">parent</span>: <span class="name">gridDelegate</span>
<span class="name">x</span>: <span class="number">0</span>; <span class="name">y</span>: <span class="number">0</span>; <span class="name">width</span>: <span class="name">gridDelegate</span>.<span class="name">width</span>; <span class="name">height</span>: <span class="name">gridDelegate</span>.<span class="name">height</span>
}
}
]
<span class="name">transitions</span>: [
<span class="type">Transition</span> {
<span class="type">ParentAnimation</span> {
<span class="type">NumberAnimation</span> { <span class="name">properties</span>: <span class="string">'x,y,width,height'</span>; <span class="name">duration</span>: <span class="number">300</span> }
}
}
]
}
}
</pre>
<p>These named items are used as the delegates by the two views who reference the special <a href="qml-qtqml-models-delegatemodel.html#parts-prop">DelegateModel::parts</a> property to select a model which provides the chosen delegate.</p>
<pre class="qml">
<span class="type"><a href="qml-qtqml-models-delegatemodel.html">DelegateModel</a></span> {
<span class="name">id</span>: <span class="name">visualModel</span>
<span class="name">delegate</span>: <span class="name">Delegate</span> {}
<span class="name">model</span>: <span class="name">myModel</span>
}
<span class="type">ListView</span> {
<span class="name">id</span>: <span class="name">lv</span>
<span class="name">height</span>: <span class="name">parent</span>.<span class="name">height</span><span class="operator">/</span><span class="number">2</span>
<span class="name">width</span>: <span class="name">parent</span>.<span class="name">width</span>
<span class="name">model</span>: <span class="name">visualModel</span>.<span class="name">parts</span>.<span class="name">list</span>
}
<span class="type">GridView</span> {
<span class="name">y</span>: <span class="name">parent</span>.<span class="name">height</span><span class="operator">/</span><span class="number">2</span>
<span class="name">height</span>: <span class="name">parent</span>.<span class="name">height</span><span class="operator">/</span><span class="number">2</span>
<span class="name">width</span>: <span class="name">parent</span>.<span class="name">width</span>
<span class="name">cellWidth</span>: <span class="name">width</span> <span class="operator">/</span> <span class="number">2</span>
<span class="name">cellHeight</span>: <span class="number">50</span>
<span class="name">model</span>: <span class="name">visualModel</span>.<span class="name">parts</span>.<span class="name">grid</span>
}
</pre>
<p><b>See also </b>Qt Quick Examples - Views, Qt Quick Demo - Photo Viewer, and <a href="qtqml-index.html">Qt QML</a>.</p>
<!-- @@@Package -->
<h2>Attached Property Documentation</h2>
<!-- $$$name -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="name-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="name-attached-prop"></a><span class="name">Package.name</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This attached property holds the name of an item within a Package.</p>
</div></div><!-- @@@name -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd.
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> 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. </p>
</div>
</body>
</html>
