<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qqmlobjectmodel.cpp -->
<title>ObjectModel QML Type | Qt QML 5.12.6</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.12</td><td ><a href="qtqml-index.html">Qt QML</a></td><td ><a href="qtqml-qmlmodule.html">QML Types</a></td><td >ObjectModel QML Type</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtqml-index.html">Qt 5.12.6 Reference Documentation</a></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="#properties">Properties</a></li>
<li class="level1"><a href="#attached-properties">Attached Properties</a></li>
<li class="level1"><a href="#methods">Methods</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">ObjectModel QML Type</h1>
<span class="subtitle"></span>
<!-- $$$ObjectModel-brief -->
<p>Defines a set of items to be used as a model. <a href="#details">More...</a></p>
<!-- @@@ObjectModel -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtQml.Models 2.12</td></tr></table></div><ul>
<li><a href="qml-qtqml-models-objectmodel-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtqml-models-objectmodel.html#count-prop">count</a></b></b> : int</li>
</ul>
<a name="attached-properties"></a>
<h2 id="attached-properties">Attached Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtqml-models-objectmodel.html#index-attached-prop">index</a></b></b> : int</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtqml-models-objectmodel.html#append-method">append</a></b></b>(object <i>item</i>)</li>
<li class="fn"><b><b><a href="qml-qtqml-models-objectmodel.html#clear-method">clear</a></b></b>()</li>
<li class="fn">object <b><b><a href="qml-qtqml-models-objectmodel.html#get-method">get</a></b></b>(int <i>index</i>)</li>
<li class="fn"><b><b><a href="qml-qtqml-models-objectmodel.html#insert-method">insert</a></b></b>(int <i>index</i>, object <i>item</i>)</li>
<li class="fn"><b><b><a href="qml-qtqml-models-objectmodel.html#move-method">move</a></b></b>(int <i>from</i>, int <i>to</i>, <i> int n = 1</i>)</li>
<li class="fn"><b><b><a href="qml-qtqml-models-objectmodel.html#remove-method">remove</a></b></b>(int <i>index</i>, <i> int n = 1</i>)</li>
</ul>
<!-- $$$ObjectModel-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>An <a href="qml-qtqml-models-objectmodel.html">ObjectModel</a> contains the visual items to be used in a view. When an <a href="qml-qtqml-models-objectmodel.html">ObjectModel</a> is used in a view, the view does not require a delegate since the <a href="qml-qtqml-models-objectmodel.html">ObjectModel</a> already contains the visual delegate (items).</p>
<p>An item can determine its index within the model via the <a href="qml-qtqml-models-objectmodel.html#index-attached-prop">index</a> attached property.</p>
<p>The example below places three colored rectangles in a ListView.</p>
<pre class="cpp">
import <span class="type">QtQuick</span> <span class="number">2.0</span>
import <span class="type">QtQml</span><span class="operator">.</span>Models <span class="number">2.1</span>
Rectangle {
ObjectModel {
id: itemModel
Rectangle { height: <span class="number">30</span>; width: <span class="number">80</span>; color: <span class="string">"red"</span> }
Rectangle { height: <span class="number">30</span>; width: <span class="number">80</span>; color: <span class="string">"green"</span> }
Rectangle { height: <span class="number">30</span>; width: <span class="number">80</span>; color: <span class="string">"blue"</span> }
}
ListView {
anchors<span class="operator">.</span>fill: parent
model: itemModel
}
}
</pre>
<p class="centerAlign"><img src="images/objectmodel.png" alt="" /></p><p><b>See also </b>Qt Quick Examples - Views.</p>
<!-- @@@ObjectModel -->
<h2>Property Documentation</h2>
<!-- $$$count -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="count-prop">
<td class="tblQmlPropNode"><p>
<a name="count-prop"></a><span class="name">count</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The number of items in the model. This property is readonly.</p>
</div></div><!-- @@@count -->
<br/>
<h2>Attached Property Documentation</h2>
<!-- $$$index -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="index-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="index-attached-prop"></a><span class="name">ObjectModel.index</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This attached property holds the index of this delegate's item within the model.</p>
<p>It is attached to each instance of the delegate.</p>
</div></div><!-- @@@index -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$append -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="append-method">
<td class="tblQmlFuncNode"><p>
<a name="append-method"></a><span class="name">append</span>(<span class="type">object</span> <i>item</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Appends a new item to the end of the model.</p>
<pre class="cpp">
objectModel<span class="operator">.</span>append(objectComponent<span class="operator">.</span>createObject())
</pre>
<p>This method was introduced in Qt 5.6.</p>
<p><b>See also </b><a href="qml-qtqml-models-objectmodel.html#insert-method">insert()</a> and <a href="qml-qtqml-models-objectmodel.html#remove-method">remove()</a>.</p>
</div></div><!-- @@@append -->
<br/>
<!-- $$$clear -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="clear-method">
<td class="tblQmlFuncNode"><p>
<a name="clear-method"></a><span class="name">clear</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Clears all items from the model.</p>
<p>This method was introduced in Qt 5.6.</p>
<p><b>See also </b><a href="qml-qtqml-models-objectmodel.html#append-method">append()</a> and <a href="qml-qtqml-models-objectmodel.html#remove-method">remove()</a>.</p>
</div></div><!-- @@@clear -->
<br/>
<!-- $$$get -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="get-method">
<td class="tblQmlFuncNode"><p>
<a name="get-method"></a><span class="type">object</span> <span class="name">get</span>(<span class="type"><a href="qml-int.html">int</a></span> <i>index</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Returns the item at <i>index</i> in the model. This allows the item to be accessed or modified from JavaScript:</p>
<pre class="cpp">
Component<span class="operator">.</span>onCompleted: {
objectModel<span class="operator">.</span>append(objectComponent<span class="operator">.</span>createObject())
console<span class="operator">.</span>log(objectModel<span class="operator">.</span>get(<span class="number">0</span>)<span class="operator">.</span>objectName);
objectModel<span class="operator">.</span>get(<span class="number">0</span>)<span class="operator">.</span>objectName <span class="operator">=</span> <span class="string">"first"</span>;
}
</pre>
<p>The <i>index</i> must be an element in the list.</p>
<p>This method was introduced in Qt 5.6.</p>
<p><b>See also </b><a href="qml-qtqml-models-objectmodel.html#append-method">append()</a>.</p>
</div></div><!-- @@@get -->
<br/>
<!-- $$$insert -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="insert-method">
<td class="tblQmlFuncNode"><p>
<a name="insert-method"></a><span class="name">insert</span>(<span class="type"><a href="qml-int.html">int</a></span> <i>index</i>, <span class="type">object</span> <i>item</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Inserts a new item to the model at position <i>index</i>.</p>
<pre class="cpp">
objectModel<span class="operator">.</span>insert(<span class="number">2</span><span class="operator">,</span> objectComponent<span class="operator">.</span>createObject())
</pre>
<p>The <i>index</i> must be to an existing item in the list, or one past the end of the list (equivalent to append).</p>
<p>This method was introduced in Qt 5.6.</p>
<p><b>See also </b><a href="qml-qtqml-models-objectmodel.html#append-method">append()</a> and <a href="qml-qtqml-models-objectmodel.html#remove-method">remove()</a>.</p>
</div></div><!-- @@@insert -->
<br/>
<!-- $$$move -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="move-method">
<td class="tblQmlFuncNode"><p>
<a name="move-method"></a><span class="name">move</span>(<span class="type"><a href="qml-int.html">int</a></span> <i>from</i>, <span class="type"><a href="qml-int.html">int</a></span> <i>to</i>, <i> int n = 1</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Moves <i>n</i> items <i>from</i> one position <i>to</i> another.</p>
<p>The from and to ranges must exist; for example, to move the first 3 items to the end of the model:</p>
<pre class="cpp">
objectModel<span class="operator">.</span>move(<span class="number">0</span><span class="operator">,</span> objectModel<span class="operator">.</span>count <span class="operator">-</span> <span class="number">3</span><span class="operator">,</span> <span class="number">3</span>)
</pre>
<p>This method was introduced in Qt 5.6.</p>
<p><b>See also </b><a href="qml-qtqml-models-objectmodel.html#append-method">append()</a>.</p>
</div></div><!-- @@@move -->
<br/>
<!-- $$$remove -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="remove-method">
<td class="tblQmlFuncNode"><p>
<a name="remove-method"></a><span class="name">remove</span>(<span class="type"><a href="qml-int.html">int</a></span> <i>index</i>, <i> int n = 1</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Removes the items at <i>index</i> from the model.</p>
<p>This method was introduced in Qt 5.6.</p>
<p><b>See also </b><a href="qml-qtqml-models-objectmodel.html#clear-method">clear()</a>.</p>
</div></div><!-- @@@remove -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2019 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>
distrib
>
Mageia
>
7
>
i586
>
media
>
core-updates
>
by-pkgid
>
6e2327ca1c896c6d674ae53117299f21
>
files
>
104
