You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
212 lines
9.6 KiB
212 lines
9.6 KiB
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/doc/qasciicache.doc:300 -->
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
|
<title>QAsciiCacheIterator Class</title>
|
|
<style type="text/css"><!--
|
|
fn { margin-left: 1cm; text-indent: -1cm; }
|
|
a:link { color: #004faf; text-decoration: none }
|
|
a:visited { color: #672967; text-decoration: none }
|
|
body { background: #ffffff; color: black; }
|
|
--></style>
|
|
</head>
|
|
<body>
|
|
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|
<tr bgcolor="#E5E5E5">
|
|
<td 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="mainclasses.html">
|
|
<font color="#004faf">Main Classes</font></a>
|
|
| <a href="annotated.html">
|
|
<font color="#004faf">Annotated</font></a>
|
|
| <a href="groups.html">
|
|
<font color="#004faf">Grouped Classes</font></a>
|
|
| <a href="functions.html">
|
|
<font color="#004faf">Functions</font></a>
|
|
</td>
|
|
<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QAsciiCacheIterator Class Reference</h1>
|
|
|
|
<p>The QAsciiCacheIterator class provides an iterator for QAsciiCache collections.
|
|
<a href="#details">More...</a>
|
|
<p><tt>#include <<a href="qasciicache-h.html">qasciicache.h</a>></tt>
|
|
<p><a href="qasciicacheiterator-members.html">List of all member functions.</a>
|
|
<h2>Public Members</h2>
|
|
<ul>
|
|
<li class=fn><a href="#QAsciiCacheIterator"><b>QAsciiCacheIterator</b></a> ( const QAsciiCache<type> & cache )</li>
|
|
<li class=fn><a href="#QAsciiCacheIterator-2"><b>QAsciiCacheIterator</b></a> ( const QAsciiCacheIterator<type> & ci )</li>
|
|
<li class=fn>QAsciiCacheIterator<type> & <a href="#operator-eq"><b>operator=</b></a> ( const QAsciiCacheIterator<type> & ci )</li>
|
|
<li class=fn>uint <a href="#count"><b>count</b></a> () const</li>
|
|
<li class=fn>bool <a href="#isEmpty"><b>isEmpty</b></a> () const</li>
|
|
<li class=fn>bool <a href="#atFirst"><b>atFirst</b></a> () const</li>
|
|
<li class=fn>bool <a href="#atLast"><b>atLast</b></a> () const</li>
|
|
<li class=fn>type * <a href="#toFirst"><b>toFirst</b></a> ()</li>
|
|
<li class=fn>type * <a href="#toLast"><b>toLast</b></a> ()</li>
|
|
<li class=fn><a href="#operator-type-*"><b>operator type *</b></a> () const</li>
|
|
<li class=fn>type * <a href="#current"><b>current</b></a> () const</li>
|
|
<li class=fn>const char * <a href="#currentKey"><b>currentKey</b></a> () const</li>
|
|
<li class=fn>type * <a href="#operator()"><b>operator()</b></a> ()</li>
|
|
<li class=fn>type * <a href="#operator++"><b>operator++</b></a> ()</li>
|
|
<li class=fn>type * <a href="#operator+-eq"><b>operator+=</b></a> ( uint jump )</li>
|
|
<li class=fn>type * <a href="#operator--"><b>operator--</b></a> ()</li>
|
|
<li class=fn>type * <a href="#operator--eq"><b>operator-=</b></a> ( uint jump )</li>
|
|
</ul>
|
|
<hr><a name="details"></a><h2>Detailed Description</h2>
|
|
|
|
|
|
The QAsciiCacheIterator class provides an iterator for <a href="qasciicache.html">QAsciiCache</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> Multiple iterators are completely independent, even when they
|
|
operate on the same QAsciiCache. QAsciiCache updates all iterators
|
|
that refer an item when that item is removed.
|
|
<p> QAsciiCacheIterator provides an <a href="#operator++">operator++</a>() and an <a href="#operator+-eq">operator+=</a>()
|
|
to traverse the cache; <a href="#current">current</a>() and <a href="#currentKey">currentKey</a>() to access the
|
|
current cache item and its key. It also provides <a href="#atFirst">atFirst</a>() and
|
|
<a href="#atLast">atLast</a>(), which return TRUE if the iterator points to the first or
|
|
last item in the cache respectively. The <a href="#isEmpty">isEmpty</a>() function
|
|
returns TRUE if the cache is empty; and <a href="#count">count</a>() returns the number
|
|
of items in the cache.
|
|
<p> Note that atFirst() and atLast() refer to the iterator's arbitrary
|
|
ordering, not to the cache's internal least recently used list.
|
|
<p> <p>See also <a href="qasciicache.html">QAsciiCache</a>, <a href="collection.html">Collection Classes</a>, and <a href="tools.html">Non-GUI Classes</a>.
|
|
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<h3 class=fn><a name="QAsciiCacheIterator"></a>QAsciiCacheIterator::QAsciiCacheIterator ( const <a href="qasciicache.html">QAsciiCache</a><type> & cache )
|
|
</h3>
|
|
|
|
<p> Constructs an iterator for <em>cache</em>. The current iterator item is
|
|
set to point to the first item in the <em>cache</em>.
|
|
|
|
<h3 class=fn><a name="QAsciiCacheIterator-2"></a>QAsciiCacheIterator::QAsciiCacheIterator ( const <a href="qasciicacheiterator.html">QAsciiCacheIterator</a><type> & ci )
|
|
</h3>
|
|
|
|
<p> Constructs an iterator for the same cache as <em>ci</em>. The new
|
|
iterator starts at the same item as ci.<a href="#current">current</a>() but moves
|
|
independently from there on.
|
|
|
|
<h3 class=fn>bool <a name="atFirst"></a>QAsciiCacheIterator::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="#toFirst">toFirst</a>() and <a href="#atLast">atLast</a>().
|
|
|
|
<h3 class=fn>bool <a name="atLast"></a>QAsciiCacheIterator::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="#toLast">toLast</a>() and <a href="#atFirst">atFirst</a>().
|
|
|
|
<h3 class=fn>uint <a name="count"></a>QAsciiCacheIterator::count () const
|
|
</h3>
|
|
|
|
<p> Returns the number of items in the cache over which this iterator
|
|
operates.
|
|
<p> <p>See also <a href="#isEmpty">isEmpty</a>().
|
|
|
|
<h3 class=fn>type * <a name="current"></a>QAsciiCacheIterator::current () const
|
|
</h3>
|
|
|
|
<p> Returns a pointer to the current iterator item.
|
|
|
|
<h3 class=fn>const char * <a name="currentKey"></a>QAsciiCacheIterator::currentKey () const
|
|
</h3>
|
|
|
|
<p> Returns the key for the current iterator item.
|
|
|
|
<h3 class=fn>bool <a name="isEmpty"></a>QAsciiCacheIterator::isEmpty () const
|
|
</h3>
|
|
|
|
<p> Returns TRUE if the cache is empty, i.e. <a href="#count">count</a>() == 0; otherwise
|
|
returns FALSE.
|
|
<p> <p>See also <a href="#count">count</a>().
|
|
|
|
<h3 class=fn><a name="operator-type-*"></a>QAsciiCacheIterator::operator type * () const
|
|
</h3>
|
|
|
|
<p> Cast operator. Returns a pointer to the current iterator item.
|
|
Same as <a href="#current">current</a>().
|
|
|
|
<h3 class=fn>type * <a name="operator()"></a>QAsciiCacheIterator::operator() ()
|
|
</h3>
|
|
|
|
<p> Makes the succeeding item current and returns the original current
|
|
item.
|
|
<p> If the current iterator item was the last item in the cache or if
|
|
it was 0, 0 is returned.
|
|
|
|
<h3 class=fn>type * <a name="operator++"></a>QAsciiCacheIterator::operator++ ()
|
|
</h3>
|
|
|
|
<p> Prefix ++ makes the iterator point to the item just after
|
|
<a href="#current">current</a>(), and makes that the new current item for the iterator. If
|
|
current() was the last item, <a href="#operator++">operator++</a>() returns 0.
|
|
|
|
<h3 class=fn>type * <a name="operator+-eq"></a>QAsciiCacheIterator::operator+= ( uint jump )
|
|
</h3>
|
|
|
|
<p> Returns the item <em>jump</em> positions after the current item, or 0
|
|
if it is beyond the last item. Makes this the current item.
|
|
|
|
<h3 class=fn>type * <a name="operator--"></a>QAsciiCacheIterator::operator-- ()
|
|
</h3>
|
|
|
|
<p> Prefix -- makes the iterator point to the item just before
|
|
<a href="#current">current</a>(), and makes that the new current item for the iterator. If
|
|
current() was the first item, <a href="#operator--">operator--</a>() returns 0.
|
|
|
|
<h3 class=fn>type * <a name="operator--eq"></a>QAsciiCacheIterator::operator-= ( uint jump )
|
|
</h3>
|
|
|
|
<p> Returns the item <em>jump</em> positions before the current item, or 0
|
|
if it is before the first item. Makes this the current item.
|
|
|
|
<h3 class=fn><a href="qasciicacheiterator.html">QAsciiCacheIterator</a><type> & <a name="operator-eq"></a>QAsciiCacheIterator::operator= ( const <a href="qasciicacheiterator.html">QAsciiCacheIterator</a><type> & ci )
|
|
</h3>
|
|
|
|
<p> Makes this an iterator for the same cache as <em>ci</em>. The new
|
|
iterator starts at the same item as ci.<a href="#current">current</a>(), but moves
|
|
independently thereafter.
|
|
|
|
<h3 class=fn>type * <a name="toFirst"></a>QAsciiCacheIterator::toFirst ()
|
|
</h3>
|
|
|
|
<p> Sets the iterator to point to the first item in the cache and
|
|
returns a pointer to the item.
|
|
<p> Sets the iterator to 0 and returns 0 if the cache is empty.
|
|
<p> <p>See also <a href="#toLast">toLast</a>() and <a href="#isEmpty">isEmpty</a>().
|
|
|
|
<h3 class=fn>type * <a name="toLast"></a>QAsciiCacheIterator::toLast ()
|
|
</h3>
|
|
|
|
<p> Sets the iterator to point to the last item in the cache and
|
|
returns a pointer to the item.
|
|
<p> Sets the iterator to 0 and returns 0 if the cache is empty.
|
|
<p> <p>See also <a href="#isEmpty">isEmpty</a>().
|
|
|
|
<!-- eof -->
|
|
<hr><p>
|
|
This file is part of the <a href="index.html">Qt toolkit</a>.
|
|
Copyright © 1995-2007
|
|
<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
|
|
<table width=100% cellspacing=0 border=0><tr>
|
|
<td>Copyright © 2007
|
|
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
|
|
<td align=right><div align=right>Qt 3.3.8</div>
|
|
</table></div></address></body>
|
|
</html>
|