<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- q3cache.qdoc -->
<head>
<title>Qt 4.6: Q3CacheIterator Class Reference</title>
<link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<a name="//apple_ref/cpp/cl//Q3CacheIterator"></a>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><a href="http://qt.nokia.com/"><img src="images/qt-logo.png" align="left" border="0" /></a></td>
<td width="1"> </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="functions.html"><font color="#004faf">All Functions</font></a> · <a href="overviews.html"><font color="#004faf">Overviews</font></a></td></tr></table><h1 class="title">Q3CacheIterator Class Reference<br /><span class="small-subtitle">[<a href="qt3support.html">Qt3Support</a> module]</span>
</h1>
<p>The Q3CacheIterator class provides an iterator for <a href="q3cache.html">Q3Cache</a> collections. <a href="#details">More...</a></p>
<pre> #include <Q3CacheIterator></pre><p><b>This class is part of the Qt 3 support library.</b> It is provided to keep old source code working. We strongly advise against using it in new code. See <a href="porting4.html">Porting to Qt 4</a> for more information.</p>
<ul>
<li><a href="q3cacheiterator-members.html">List of all members, including inherited members</a></li>
</ul>
<hr />
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="q3cacheiterator.html#Q3CacheIterator">Q3CacheIterator</a></b> ( const Q3Cache<type> & <i>cache</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="q3cacheiterator.html#Q3CacheIterator-2">Q3CacheIterator</a></b> ( const Q3CacheIterator<type> & <i>ci</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="q3cacheiterator.html#atFirst">atFirst</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="q3cacheiterator.html#atLast">atLast</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint </td><td class="memItemRight" valign="bottom"><b><a href="q3cacheiterator.html#count">count</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">type * </td><td class="memItemRight" valign="bottom"><b><a href="q3cacheiterator.html#current">current</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><b><a href="q3cacheiterator.html#currentKey">currentKey</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="q3cacheiterator.html#isEmpty">isEmpty</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">type * </td><td class="memItemRight" valign="bottom"><b><a href="q3cacheiterator.html#toFirst">toFirst</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">type * </td><td class="memItemRight" valign="bottom"><b><a href="q3cacheiterator.html#toLast">toLast</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="q3cacheiterator.html#operator-type--2a">operator type *</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">type * </td><td class="memItemRight" valign="bottom"><b><a href="q3cacheiterator.html#operator-28-29">operator()</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">type * </td><td class="memItemRight" valign="bottom"><b><a href="q3cacheiterator.html#operator-2b-2b">operator++</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">type * </td><td class="memItemRight" valign="bottom"><b><a href="q3cacheiterator.html#operator-2b-eq">operator+=</a></b> ( uint <i>jump</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">type * </td><td class="memItemRight" valign="bottom"><b><a href="q3cacheiterator.html#operator--">operator--</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">type * </td><td class="memItemRight" valign="bottom"><b><a href="q3cacheiterator.html#operator--eq">operator-=</a></b> ( uint <i>jump</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Q3CacheIterator<type> & </td><td class="memItemRight" valign="bottom"><b><a href="q3cacheiterator.html#operator-eq">operator=</a></b> ( const Q3CacheIterator<type> & <i>ci</i> )</td></tr>
</table>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The Q3CacheIterator class provides an iterator for <a href="q3cache.html">Q3Cache</a> collections.</p>
<p>Note that the traversal order is arbitrary; you are not guaranteed any particular order. If new objects are inserted into the cache while the iterator is active, the iterator may or may not see them.</p>
<p>Multiple iterators are completely independent, even when they operate on the same <a href="q3cache.html">Q3Cache</a>. <a href="q3cache.html">Q3Cache</a> updates all iterators that refer an item when that item is removed.</p>
<p>Q3CacheIterator provides an operator++(), and an operator+=() to traverse the cache. The <a href="q3cacheiterator.html#current">current</a>() and <a href="q3cacheiterator.html#currentKey">currentKey</a>() functions are used to access the current cache item and its key. The <a href="q3cacheiterator.html#atFirst">atFirst</a>() and <a href="q3cacheiterator.html#atLast">atLast</a>() return TRUE if the iterator points to the first or last item in the cache respectively. The <a href="q3cacheiterator.html#isEmpty">isEmpty</a>() function returns TRUE if the cache is empty, and <a href="q3cacheiterator.html#count">count</a>() returns the number of items in the cache.</p>
<p>Note that <a href="q3cacheiterator.html#atFirst">atFirst</a>() and <a href="q3cacheiterator.html#atLast">atLast</a>() refer to the iterator's arbitrary ordering, not to the cache's internal least recently used list.</p>
<p>See also <a href="q3cache.html">Q3Cache</a>.</p>
<hr />
<h2>Member Function Documentation</h2>
<a name="//apple_ref/cpp/instm/Q3CacheIterator/Q3CacheIterator"></a>
<h3 class="fn"><a name="Q3CacheIterator"></a>Q3CacheIterator::Q3CacheIterator ( const <a href="q3cache.html">Q3Cache</a><type> & <i>cache</i> )</h3>
<p>Constructs an iterator for <i>cache</i>. The current iterator item is set to point to the first item in the <i>cache</i>.</p>
<h3 class="fn"><a name="Q3CacheIterator-2"></a>Q3CacheIterator::Q3CacheIterator ( const Q3CacheIterator<type> & <i>ci</i> )</h3>
<p>Constructs an iterator for the same cache as <i>ci</i>. The new iterator starts at the same item as ci.<a href="q3cacheiterator.html#current">current</a>(), but moves independently from there on.</p>
<a name="//apple_ref/cpp/instm/Q3CacheIterator/atFirst"></a>
<h3 class="fn"><a name="atFirst"></a>bool Q3CacheIterator::atFirst () const</h3>
<p>Returns TRUE if the iterator points to the first item in the cache; otherwise returns FALSE. Note that this refers to the iterator's arbitrary ordering, not to the cache's internal least recently used list.</p>
<p>See also <a href="q3cacheiterator.html#toFirst">toFirst</a>() and <a href="q3cacheiterator.html#atLast">atLast</a>().</p>
<a name="//apple_ref/cpp/instm/Q3CacheIterator/atLast"></a>
<h3 class="fn"><a name="atLast"></a>bool Q3CacheIterator::atLast () const</h3>
<p>Returns TRUE if the iterator points to the last item in the cache; otherwise returns FALSE. Note that this refers to the iterator's arbitrary ordering, not to the cache's internal least recently used list.</p>
<p>See also <a href="q3cacheiterator.html#toLast">toLast</a>() and <a href="q3cacheiterator.html#atFirst">atFirst</a>().</p>
<a name="//apple_ref/cpp/instm/Q3CacheIterator/count"></a>
<h3 class="fn"><a name="count"></a><a href="qtglobal.html#uint-typedef">uint</a> Q3CacheIterator::count () const</h3>
<p>Returns the number of items in the cache on which this iterator operates.</p>
<p>See also <a href="q3cacheiterator.html#isEmpty">isEmpty</a>().</p>
<a name="//apple_ref/cpp/instm/Q3CacheIterator/current"></a>
<h3 class="fn"><a name="current"></a>type * Q3CacheIterator::current () const</h3>
<p>Returns a pointer to the current iterator item.</p>
<a name="//apple_ref/cpp/instm/Q3CacheIterator/currentKey"></a>
<h3 class="fn"><a name="currentKey"></a><a href="qstring.html">QString</a> Q3CacheIterator::currentKey () const</h3>
<p>Returns the key for the current iterator item.</p>
<a name="//apple_ref/cpp/instm/Q3CacheIterator/isEmpty"></a>
<h3 class="fn"><a name="isEmpty"></a>bool Q3CacheIterator::isEmpty () const</h3>
<p>Returns TRUE if the cache is empty, i.e. <a href="q3cacheiterator.html#count">count</a>() == 0; otherwise it returns FALSE.</p>
<p>See also <a href="q3cacheiterator.html#count">count</a>().</p>
<a name="//apple_ref/cpp/instm/Q3CacheIterator/toFirst"></a>
<h3 class="fn"><a name="toFirst"></a>type * Q3CacheIterator::toFirst ()</h3>
<p>Sets the iterator to point to the first item in the cache and returns a pointer to the item.</p>
<p>Sets the iterator to 0 and returns 0 if the cache is empty.</p>
<p>See also <a href="q3cacheiterator.html#toLast">toLast</a>() and <a href="q3cacheiterator.html#isEmpty">isEmpty</a>().</p>
<a name="//apple_ref/cpp/instm/Q3CacheIterator/toLast"></a>
<h3 class="fn"><a name="toLast"></a>type * Q3CacheIterator::toLast ()</h3>
<p>Sets the iterator to point to the last item in the cache and returns a pointer to the item.</p>
<p>Sets the iterator to 0 and returns 0 if the cache is empty.</p>
<p>See also <a href="q3cacheiterator.html#toFirst">toFirst</a>() and <a href="q3cacheiterator.html#isEmpty">isEmpty</a>().</p>
<a name="//apple_ref/cpp/instm/Q3CacheIterator/operator type *"></a>
<h3 class="fn"><a name="operator-type--2a"></a>Q3CacheIterator::operator type * () const</h3>
<p>Cast operator. Returns a pointer to the current iterator item. Same as <a href="q3cacheiterator.html#current">current</a>().</p>
<a name="//apple_ref/cpp/instm/Q3CacheIterator/operator"></a>
<h3 class="fn"><a name="operator-28-29"></a>type * Q3CacheIterator::operator() ()</h3>
<p>Makes the succeeding item current and returns the original current item.</p>
<p>If the current iterator item was the last item in the cache or if it was 0, 0 is returned.</p>
<a name="//apple_ref/cpp/instm/Q3CacheIterator/operator++"></a>
<h3 class="fn"><a name="operator-2b-2b"></a>type * Q3CacheIterator::operator++ ()</h3>
<p>Prefix++ makes the iterator point to the item just after <a href="q3cacheiterator.html#current">current</a>() and makes that the new current item for the iterator. If <a href="q3cacheiterator.html#current">current</a>() was the last item, operator++() returns 0.</p>
<a name="//apple_ref/cpp/instm/Q3CacheIterator/operator+="></a>
<h3 class="fn"><a name="operator-2b-eq"></a>type * Q3CacheIterator::operator+= ( <a href="qtglobal.html#uint-typedef">uint</a> <i>jump</i> )</h3>
<p>Returns the item <i>jump</i> positions after the current item, or 0 if it is beyond the last item. Makes this the current item.</p>
<a name="//apple_ref/cpp/instm/Q3CacheIterator/operator--"></a>
<h3 class="fn"><a name="operator--"></a>type * Q3CacheIterator::operator-- ()</h3>
<p>Prefix-- makes the iterator point to the item just before <a href="q3cacheiterator.html#current">current</a>() and makes that the new current item for the iterator. If <a href="q3cacheiterator.html#current">current</a>() was the first item, operator--() returns 0.</p>
<a name="//apple_ref/cpp/instm/Q3CacheIterator/operator-="></a>
<h3 class="fn"><a name="operator--eq"></a>type * Q3CacheIterator::operator-= ( <a href="qtglobal.html#uint-typedef">uint</a> <i>jump</i> )</h3>
<p>Returns the item <i>jump</i> positions before the current item, or 0 if it is before the first item. Makes this the current item.</p>
<a name="//apple_ref/cpp/instm/Q3CacheIterator/operator="></a>
<h3 class="fn"><a name="operator-eq"></a>Q3CacheIterator<type> & Q3CacheIterator::operator= ( const Q3CacheIterator<type> & <i>ci</i> )</h3>
<p>Makes this an iterator for the same cache as <i>ci</i>. The new iterator starts at the same item as ci.<a href="q3cacheiterator.html#current">current</a>(), but moves independently thereafter.</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="40%" align="left">Copyright © 2010 Nokia Corporation and/or its subsidiary(-ies)</td>
<td width="20%" align="center"><a href="trademarks.html">Trademarks</a></td>
<td width="40%" align="right"><div align="right">Qt 4.6.3</div></td>
</tr></table></div></address></body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
8e6051afcdb111a0317a58fb64c2abf5
>
files
>
3289
