<?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" />
<!-- fetchmore.qdoc -->
<title>Qt 4.8: Fetch More 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>Fetch More 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="#filelistmodel-class-definition">FileListModel Class Definition</a></li>
<li class="level1"><a href="#filelistmodel-class-implementation">FileListModel Class Implementation</a></li>
</ul>
</div>
<h1 class="title">Fetch More Example</h1>
<span class="subtitle"></span>
<!-- $$$itemviews/fetchmore-description -->
<div class="descr"> <a name="details"></a>
<p>Files:</p>
<ul>
<li><a href="itemviews-fetchmore-filelistmodel-cpp.html">itemviews/fetchmore/filelistmodel.cpp</a></li>
<li><a href="itemviews-fetchmore-filelistmodel-h.html">itemviews/fetchmore/filelistmodel.h</a></li>
<li><a href="itemviews-fetchmore-window-cpp.html">itemviews/fetchmore/window.cpp</a></li>
<li><a href="itemviews-fetchmore-window-h.html">itemviews/fetchmore/window.h</a></li>
<li><a href="itemviews-fetchmore-main-cpp.html">itemviews/fetchmore/main.cpp</a></li>
<li><a href="itemviews-fetchmore-fetchmore-pro.html">itemviews/fetchmore/fetchmore.pro</a></li>
</ul>
<p>The Fetch More example shows how two add items to an item view model on demand.<p class="centerAlign"><img src="images/fetchmore-example.png" alt="" /></p><p>The user of the example can enter a directory in the <b>Directory</b> line edit. The contents of the directory will be listed in the list view below.</p>
<p>When you have large - or perhaps even infinite - data sets, you will need to add items to the model in batches, and preferably only when the items are needed by the view (i.e., when they are visible in the view).</p>
<p>In this example, we implement <tt>FileListModel</tt> - an item view model containing the entries of a directory. We also have <tt>Window</tt>, which sets up the GUI and feeds the model with directories.</p>
<p>Let's take a tour of <tt>FileListModel</tt>'s code.</p>
<a name="filelistmodel-class-definition"></a>
<h2>FileListModel Class Definition</h2>
<p>The <tt>FileListModel</tt> inherits <a href="qabstractlistmodel.html">QAbstractListModel</a> and contains the contents of a directory. It will add items to itself only when requested to do so by the view.</p>
<pre class="cpp"> <span class="keyword">class</span> FileListModel : <span class="keyword">public</span> <span class="type"><a href="qabstractlistmodel.html">QAbstractListModel</a></span>
{
Q_OBJECT
<span class="keyword">public</span>:
FileListModel(<span class="type"><a href="qobject.html">QObject</a></span> <span class="operator">*</span>parent <span class="operator">=</span> <span class="number">0</span>);
<span class="type">int</span> rowCount(<span class="keyword">const</span> <span class="type"><a href="qmodelindex.html">QModelIndex</a></span> <span class="operator">&</span>parent <span class="operator">=</span> <span class="type"><a href="qmodelindex.html">QModelIndex</a></span>()) <span class="keyword">const</span>;
<span class="type"><a href="qvariant.html">QVariant</a></span> data(<span class="keyword">const</span> <span class="type"><a href="qmodelindex.html">QModelIndex</a></span> <span class="operator">&</span>index<span class="operator">,</span> <span class="type">int</span> role <span class="operator">=</span> <span class="type"><a href="qt.html">Qt</a></span><span class="operator">::</span>DisplayRole) <span class="keyword">const</span>;
<span class="keyword">signals</span>:
<span class="type">void</span> numberPopulated(<span class="type">int</span> number);
<span class="keyword">public</span> <span class="keyword">slots</span>:
<span class="type">void</span> setDirPath(<span class="keyword">const</span> <span class="type"><a href="qstring.html">QString</a></span> <span class="operator">&</span>path);
<span class="keyword">protected</span>:
<span class="type">bool</span> canFetchMore(<span class="keyword">const</span> <span class="type"><a href="qmodelindex.html">QModelIndex</a></span> <span class="operator">&</span>parent) <span class="keyword">const</span>;
<span class="type">void</span> fetchMore(<span class="keyword">const</span> <span class="type"><a href="qmodelindex.html">QModelIndex</a></span> <span class="operator">&</span>parent);
<span class="keyword">private</span>:
<span class="type"><a href="qstringlist.html">QStringList</a></span> fileList;
<span class="type">int</span> fileCount;
};</pre>
<p>The secret lies in the reimplementation of <a href="qabstractitemmodel.html#fetchMore">fetchMore()</a> and <a href="qabstractitemmodel.html#canFetchMore">canFetchMore()</a> from <a href="qabstractitemmodel.html">QAbstractItemModel</a>. These functions are called by the item view when it needs more items.</p>
<p>The <tt>setDirPath()</tt> function sets the directory the model will work on. We emit <tt>numberPopulated()</tt> each time we add a batch of items to the model.</p>
<p>We keep all directory entries in <tt>fileList</tt>. <tt>fileCount</tt> is the number of items that have been added to the model.</p>
<a name="filelistmodel-class-implementation"></a>
<h2>FileListModel Class Implementation</h2>
<p>We start by checking out the <tt>setDirPath()</tt>.</p>
<pre class="cpp"> <span class="type">void</span> FileListModel<span class="operator">::</span>setDirPath(<span class="keyword">const</span> <span class="type"><a href="qstring.html">QString</a></span> <span class="operator">&</span>path)
{
<span class="type"><a href="qdir.html">QDir</a></span> dir(path);
fileList <span class="operator">=</span> dir<span class="operator">.</span>entryList();
fileCount <span class="operator">=</span> <span class="number">0</span>;
reset();
}</pre>
<p>We use a <a href="qdir.html">QDir</a> to get the contents of the directory. We need to inform <a href="qabstractitemmodel.html">QAbstractItemModel</a> that we want to remove all items - if any - from the model.</p>
<pre class="cpp"> <span class="type">bool</span> FileListModel<span class="operator">::</span>canFetchMore(<span class="keyword">const</span> <span class="type"><a href="qmodelindex.html">QModelIndex</a></span> <span class="operator">&</span> <span class="comment">/* index */</span>) <span class="keyword">const</span>
{
<span class="keyword">if</span> (fileCount <span class="operator"><</span> fileList<span class="operator">.</span>size())
<span class="keyword">return</span> <span class="keyword">true</span>;
<span class="keyword">else</span>
<span class="keyword">return</span> <span class="keyword">false</span>;
}</pre>
<p>The <tt>canFetchMore()</tt> function is called by the view when it needs more items. We return true if there still are entries that we have not added to the model; otherwise, we return false.</p>
<p>And now, the <tt>fetchMore()</tt> function itself:</p>
<pre class="cpp"> <span class="type">void</span> FileListModel<span class="operator">::</span>fetchMore(<span class="keyword">const</span> <span class="type"><a href="qmodelindex.html">QModelIndex</a></span> <span class="operator">&</span> <span class="comment">/* index */</span>)
{
<span class="type">int</span> remainder <span class="operator">=</span> fileList<span class="operator">.</span>size() <span class="operator">-</span> fileCount;
<span class="type">int</span> itemsToFetch <span class="operator">=</span> <a href="qtglobal.html#qMin">qMin</a>(<span class="number">100</span><span class="operator">,</span> remainder);
beginInsertRows(<span class="type"><a href="qmodelindex.html">QModelIndex</a></span>()<span class="operator">,</span> fileCount<span class="operator">,</span> fileCount<span class="operator">+</span>itemsToFetch<span class="operator">-</span><span class="number">1</span>);
fileCount <span class="operator">+</span><span class="operator">=</span> itemsToFetch;
endInsertRows();
<span class="keyword">emit</span> numberPopulated(itemsToFetch);
}</pre>
<p>We first calculate the number of items to fetch. <a href="qabstractitemmodel.html#beginInsertRows">beginInsertRows()</a> and <a href="qabstractitemmodel.html#endInsertRows">endInsertRows()</a> are mandatory for <a href="qabstractitemmodel.html">QAbstractItemModel</a> to keep up with the row insertions. Finally, we emit <tt>numberPopulated()</tt>, which is picked up by <tt>Window</tt>.</p>
<p>To complete the tour, we also look at <tt>rowCount()</tt> and <tt>data()</tt>.</p>
<pre class="cpp"> <span class="type">int</span> FileListModel<span class="operator">::</span>rowCount(<span class="keyword">const</span> <span class="type"><a href="qmodelindex.html">QModelIndex</a></span> <span class="operator">&</span> <span class="comment">/* parent */</span>) <span class="keyword">const</span>
{
<span class="keyword">return</span> fileCount;
}
<span class="type"><a href="qvariant.html">QVariant</a></span> FileListModel<span class="operator">::</span>data(<span class="keyword">const</span> <span class="type"><a href="qmodelindex.html">QModelIndex</a></span> <span class="operator">&</span>index<span class="operator">,</span> <span class="type">int</span> role) <span class="keyword">const</span>
{
<span class="keyword">if</span> (<span class="operator">!</span>index<span class="operator">.</span>isValid())
<span class="keyword">return</span> <span class="type"><a href="qvariant.html">QVariant</a></span>();
<span class="keyword">if</span> (index<span class="operator">.</span>row() <span class="operator">></span><span class="operator">=</span> fileList<span class="operator">.</span>size() <span class="operator">|</span><span class="operator">|</span> index<span class="operator">.</span>row() <span class="operator"><</span> <span class="number">0</span>)
<span class="keyword">return</span> <span class="type"><a href="qvariant.html">QVariant</a></span>();
<span class="keyword">if</span> (role <span class="operator">=</span><span class="operator">=</span> <span class="type"><a href="qt.html">Qt</a></span><span class="operator">::</span>DisplayRole)
<span class="keyword">return</span> fileList<span class="operator">.</span>at(index<span class="operator">.</span>row());
<span class="keyword">else</span> <span class="keyword">if</span> (role <span class="operator">=</span><span class="operator">=</span> <span class="type"><a href="qt.html">Qt</a></span><span class="operator">::</span>BackgroundRole) {
<span class="type">int</span> batch <span class="operator">=</span> (index<span class="operator">.</span>row() <span class="operator">/</span> <span class="number">100</span>) <span class="operator">%</span> <span class="number">2</span>;
<span class="keyword">if</span> (batch <span class="operator">=</span><span class="operator">=</span> <span class="number">0</span>)
<span class="keyword">return</span> qApp<span class="operator">-</span><span class="operator">></span>palette()<span class="operator">.</span>base();
<span class="keyword">else</span>
<span class="keyword">return</span> qApp<span class="operator">-</span><span class="operator">></span>palette()<span class="operator">.</span>alternateBase();
}
<span class="keyword">return</span> <span class="type"><a href="qvariant.html">QVariant</a></span>();
}</pre>
<p>Notice that the row count is only the items we have added so far, i.e., not the number of entries in the directory.</p>
<p>In <tt>data()</tt>, we return the appropriate entry from the <tt>fileList</tt>. We also separate the batches with a different background color.</p>
</div>
<!-- @@@itemviews/fetchmore -->
</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>
