<?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" />
<!-- q3asciidict.qdoc -->
<title>Qt 4.8: Q3AsciiDictIterator Class Reference</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="modules.html">Modules</a></li>
<li>Qt3SupportLight</li>
<li>Q3AsciiDictIterator</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="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">Q3AsciiDictIterator Class Reference</h1>
<!-- $$$Q3AsciiDictIterator-brief -->
<p>The Q3AsciiDictIterator class provides an iterator for <a href="q3asciidict.html">Q3AsciiDict</a> collections. <a href="#details">More...</a></p>
<!-- @@@Q3AsciiDictIterator -->
<pre class="cpp"> <span class="preprocessor">#include <Q3AsciiDictIterator></span></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="q3asciidictiterator-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3asciidictiterator.html#Q3AsciiDictIterator">Q3AsciiDictIterator</a></b> ( const Q3AsciiDict<type> & <i>dict</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3asciidictiterator.html#dtor.Q3AsciiDictIterator">~Q3AsciiDictIterator</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> uint </td><td class="memItemRight bottomAlign"><b><a href="q3asciidictiterator.html#count">count</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> type * </td><td class="memItemRight bottomAlign"><b><a href="q3asciidictiterator.html#current">current</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const char * </td><td class="memItemRight bottomAlign"><b><a href="q3asciidictiterator.html#currentKey">currentKey</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3asciidictiterator.html#isEmpty">isEmpty</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> type * </td><td class="memItemRight bottomAlign"><b><a href="q3asciidictiterator.html#toFirst">toFirst</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3asciidictiterator.html#operator-type--2a">operator type *</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> type * </td><td class="memItemRight bottomAlign"><b><a href="q3asciidictiterator.html#operator-28-29">operator()</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> type * </td><td class="memItemRight bottomAlign"><b><a href="q3asciidictiterator.html#operator-2b-2b">operator++</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> type * </td><td class="memItemRight bottomAlign"><b><a href="q3asciidictiterator.html#operator-2b-eq">operator+=</a></b> ( uint <i>jump</i> )</td></tr>
</table>
<a name="details"></a>
<!-- $$$Q3AsciiDictIterator-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The Q3AsciiDictIterator class provides an iterator for <a href="q3asciidict.html">Q3AsciiDict</a> collections.</p>
<p>Q3AsciiDictIterator is implemented as a template class. Define a template instance Q3AsciiDictIterator<X> to create a dictionary iterator that operates on <a href="q3asciidict.html">Q3AsciiDict</a><X> (dictionary of X*).</p>
<p>Example:</p>
<pre class="cpp"> <span class="type"><a href="q3asciidict.html">Q3AsciiDict</a></span><span class="operator"><</span><span class="type"><a href="qlineedit.html">QLineEdit</a></span><span class="operator">></span> fields;
fields<span class="operator">.</span>insert( <span class="string">"forename"</span><span class="operator">,</span> <span class="keyword">new</span> <span class="type"><a href="qlineedit.html">QLineEdit</a></span>( <span class="keyword">this</span> ) );
fields<span class="operator">.</span>insert( <span class="string">"surname"</span><span class="operator">,</span> <span class="keyword">new</span> <span class="type"><a href="qlineedit.html">QLineEdit</a></span>( <span class="keyword">this</span> ) );
fields<span class="operator">.</span>insert( <span class="string">"age"</span><span class="operator">,</span> <span class="keyword">new</span> <span class="type"><a href="qlineedit.html">QLineEdit</a></span>( <span class="keyword">this</span> ) );
fields<span class="operator">[</span><span class="string">"forename"</span><span class="operator">]</span><span class="operator">-</span><span class="operator">></span>setText( <span class="string">"Homer"</span> );
fields<span class="operator">[</span><span class="string">"surname"</span><span class="operator">]</span><span class="operator">-</span><span class="operator">></span>setText( <span class="string">"Simpson"</span> );
fields<span class="operator">[</span><span class="string">"age"</span><span class="operator">]</span><span class="operator">-</span><span class="operator">></span>setText( <span class="string">"45"</span> );
<span class="type">Q3AsciiDictIterator</span><span class="operator"><</span><span class="type"><a href="qlineedit.html">QLineEdit</a></span><span class="operator">></span> it( fields );
<span class="keyword">for</span>( ; it<span class="operator">.</span>current(); <span class="operator">+</span><span class="operator">+</span>it )
cout <span class="operator"><</span><span class="operator"><</span> it<span class="operator">.</span><a href="q3asciidictiterator.html#currentKey">currentKey</a>() <span class="operator"><</span><span class="operator"><</span> <span class="string">": "</span> <span class="operator"><</span><span class="operator"><</span> it<span class="operator">.</span><a href="q3asciidictiterator.html#current">current</a>()<span class="operator">-</span><span class="operator">></span>text() <span class="operator"><</span><span class="operator"><</span> endl;
cout <span class="operator"><</span><span class="operator"><</span> endl;
<span class="comment">// Output (random order):</span>
<span class="comment">// age: 45</span>
<span class="comment">// surname: Simpson</span>
<span class="comment">// forename: Homer</span></pre>
<p>In the example we insert some line edits into a dictionary, then iterate over the dictionary printing the strings associated with those line edits.</p>
<p>Note that the traversal order is arbitrary; you are not guaranteed any particular order.</p>
<p>Multiple iterators may independently traverse the same dictionary. A <a href="q3asciidict.html">Q3AsciiDict</a> knows about all the iterators that are operating on the dictionary. When an item is removed from the dictionary, <a href="q3asciidict.html">Q3AsciiDict</a> updates all the iterators that are referring to the removed item to point to the next item in the (arbitrary) traversal order.</p>
</div>
<p><b>See also </b><a href="q3asciidict.html">Q3AsciiDict</a>.</p>
<!-- @@@Q3AsciiDictIterator -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$Q3AsciiDictIterator[overload1]$$$Q3AsciiDictIteratorconstQ3AsciiDict<type>& -->
<h3 class="fn"><a name="Q3AsciiDictIterator"></a>Q3AsciiDictIterator::<span class="name">Q3AsciiDictIterator</span> ( const <span class="type"><a href="q3asciidict.html">Q3AsciiDict</a></span><<span class="type">type</span>> & <i>dict</i> )</h3>
<p>Constructs an iterator for <i>dict</i>. The current iterator item is set to point on the first item in the <i>dict</i>.</p>
<!-- @@@Q3AsciiDictIterator -->
<!-- $$$~Q3AsciiDictIterator[overload1]$$$~Q3AsciiDictIterator -->
<h3 class="fn"><a name="dtor.Q3AsciiDictIterator"></a>Q3AsciiDictIterator::<span class="name">~Q3AsciiDictIterator</span> ()</h3>
<p>Destroys the iterator.</p>
<!-- @@@~Q3AsciiDictIterator -->
<!-- $$$count[overload1]$$$count -->
<h3 class="fn"><a name="count"></a><span class="type"><a href="qtglobal.html#uint-typedef">uint</a></span> Q3AsciiDictIterator::<span class="name">count</span> () const</h3>
<p>Returns the number of items in the dictionary this iterator operates over.</p>
<p><b>See also </b><a href="q3asciidictiterator.html#isEmpty">isEmpty</a>().</p>
<!-- @@@count -->
<!-- $$$current[overload1]$$$current -->
<h3 class="fn"><a name="current"></a><span class="type">type</span> * Q3AsciiDictIterator::<span class="name">current</span> () const</h3>
<p>Returns a pointer to the current iterator item.</p>
<!-- @@@current -->
<!-- $$$currentKey[overload1]$$$currentKey -->
<h3 class="fn"><a name="currentKey"></a>const <span class="type">char</span> * Q3AsciiDictIterator::<span class="name">currentKey</span> () const</h3>
<p>Returns a pointer to the key for the current iterator item.</p>
<!-- @@@currentKey -->
<!-- $$$isEmpty[overload1]$$$isEmpty -->
<h3 class="fn"><a name="isEmpty"></a><span class="type">bool</span> Q3AsciiDictIterator::<span class="name">isEmpty</span> () const</h3>
<p>Returns TRUE if the dictionary is empty, i.e. <a href="q3asciidictiterator.html#count">count</a>() == 0, otherwise returns FALSE.</p>
<p><b>See also </b><a href="q3asciidictiterator.html#count">count</a>().</p>
<!-- @@@isEmpty -->
<!-- $$$toFirst[overload1]$$$toFirst -->
<h3 class="fn"><a name="toFirst"></a><span class="type">type</span> * Q3AsciiDictIterator::<span class="name">toFirst</span> ()</h3>
<p>Sets the current iterator item to point to the first item in the dictionary and returns a pointer to the item. If the dictionary is empty it sets the current item to 0 and returns 0.</p>
<!-- @@@toFirst -->
<!-- $$$operator type *[overload1]$$$operator type * -->
<h3 class="fn"><a name="operator-type--2a"></a>Q3AsciiDictIterator::<span class="name">operator type *</span> () const</h3>
<p>Cast operator. Returns a pointer to the current iterator item. Same as <a href="q3asciidictiterator.html#current">current</a>().</p>
<!-- @@@operator type * -->
<!-- $$$operator()[overload1]$$$operator() -->
<h3 class="fn"><a name="operator-28-29"></a><span class="type">type</span> * Q3AsciiDictIterator::<span class="name">operator()</span> ()</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 dictionary or if it was 0, 0 is returned.</p>
<!-- @@@operator() -->
<!-- $$$operator++[overload1]$$$operator++ -->
<h3 class="fn"><a name="operator-2b-2b"></a><span class="type">type</span> * Q3AsciiDictIterator::<span class="name">operator++</span> ()</h3>
<p>Prefix ++ makes the succeeding item current and returns the new current item.</p>
<p>If the current iterator item was the last item in the dictionary or if it was 0, 0 is returned.</p>
<!-- @@@operator++ -->
<!-- $$$operator+=[overload1]$$$operator+=uint -->
<h3 class="fn"><a name="operator-2b-eq"></a><span class="type">type</span> * Q3AsciiDictIterator::<span class="name">operator+=</span> ( <span class="type"><a href="qtglobal.html#uint-typedef">uint</a></span> <i>jump</i> )</h3>
<p>Sets the current item to the item <i>jump</i> positions after the current item, and returns a pointer to that item.</p>
<p>If that item is beyond the last item or if the dictionary is empty, it sets the current item to 0 and returns 0.</p>
<!-- @@@operator+= -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd.
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>
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. <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>
