<?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" /> <!-- q3ptrlist.qdoc --> <title>Qt 4.8: Q3PtrListIterator 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>Q3PtrListIterator</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">Q3PtrListIterator Class Reference</h1> <!-- $$$Q3PtrListIterator-brief --> <p>The Q3PtrListIterator class provides an iterator for <a href="q3ptrlist.html">Q3PtrList</a> collections. <a href="#details">More...</a></p> <!-- @@@Q3PtrListIterator --> <pre class="cpp"> <span class="preprocessor">#include <Q3PtrListIterator></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> <p><b>Inherited by: </b><a href="q3strlistiterator.html">Q3StrListIterator</a>.</p> <ul> <li><a href="q3ptrlistiterator-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="q3ptrlistiterator.html#Q3PtrListIterator">Q3PtrListIterator</a></b> ( const Q3PtrList<type> & <i>list</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3ptrlistiterator.html#dtor.Q3PtrListIterator">~Q3PtrListIterator</a></b> ()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3ptrlistiterator.html#atFirst">atFirst</a></b> () const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3ptrlistiterator.html#atLast">atLast</a></b> () const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> uint </td><td class="memItemRight bottomAlign"><b><a href="q3ptrlistiterator.html#count">count</a></b> () const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> type * </td><td class="memItemRight bottomAlign"><b><a href="q3ptrlistiterator.html#current">current</a></b> () const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3ptrlistiterator.html#isEmpty">isEmpty</a></b> () const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> type * </td><td class="memItemRight bottomAlign"><b><a href="q3ptrlistiterator.html#toFirst">toFirst</a></b> ()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> type * </td><td class="memItemRight bottomAlign"><b><a href="q3ptrlistiterator.html#toLast">toLast</a></b> ()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3ptrlistiterator.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="q3ptrlistiterator.html#operator-28-29">operator()</a></b> ()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> type * </td><td class="memItemRight bottomAlign"><b><a href="q3ptrlistiterator.html#operator-2a">operator*</a></b> ()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> type * </td><td class="memItemRight bottomAlign"><b><a href="q3ptrlistiterator.html#operator-2b-2b">operator++</a></b> ()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> type * </td><td class="memItemRight bottomAlign"><b><a href="q3ptrlistiterator.html#operator-2b-eq">operator+=</a></b> ( uint <i>jump</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> type * </td><td class="memItemRight bottomAlign"><b><a href="q3ptrlistiterator.html#operator--">operator--</a></b> ()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> type * </td><td class="memItemRight bottomAlign"><b><a href="q3ptrlistiterator.html#operator--eq">operator-=</a></b> ( uint <i>jump</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> Q3PtrListIterator<type> & </td><td class="memItemRight bottomAlign"><b><a href="q3ptrlistiterator.html#operator-eq">operator=</a></b> ( const Q3PtrListIterator<type> & <i>it</i> )</td></tr> </table> <a name="details"></a> <!-- $$$Q3PtrListIterator-description --> <div class="descr"> <h2>Detailed Description</h2> <p>The Q3PtrListIterator class provides an iterator for <a href="q3ptrlist.html">Q3PtrList</a> collections.</p> <p>Define a template instance Q3PtrListIterator<X> to create a list iterator that operates on <a href="q3ptrlist.html">Q3PtrList</a><X> (list of X*).</p> <p>The following example is similar to the example in the <a href="q3ptrlist.html">Q3PtrList</a> class documentation, but it uses Q3PtrListIterator. The class Employee is defined there.</p> <pre class="cpp"> <span class="type"><a href="q3ptrlist.html">Q3PtrList</a></span><span class="operator"><</span>Employee<span class="operator">></span> list; list<span class="operator">.</span>append( <span class="keyword">new</span> Employee(<span class="string">"John"</span><span class="operator">,</span> <span class="string">"Doe"</span><span class="operator">,</span> <span class="number">50000</span>) ); list<span class="operator">.</span>append( <span class="keyword">new</span> Employee(<span class="string">"Jane"</span><span class="operator">,</span> <span class="string">"Williams"</span><span class="operator">,</span> <span class="number">80000</span>) ); list<span class="operator">.</span>append( <span class="keyword">new</span> Employee(<span class="string">"Tom"</span><span class="operator">,</span> <span class="string">"Jones"</span><span class="operator">,</span> <span class="number">60000</span>) ); <span class="type">Q3PtrListIterator</span><span class="operator"><</span>Employee<span class="operator">></span> it( list ); Employee <span class="operator">*</span>employee; <span class="keyword">while</span> ( (employee <span class="operator">=</span> it<span class="operator">.</span>current()) <span class="operator">!</span><span class="operator">=</span> <span class="number">0</span> ) { <span class="operator">+</span><span class="operator">+</span>it; cout <span class="operator"><</span><span class="operator"><</span> employee<span class="operator">-</span><span class="operator">></span>surname()<span class="operator">.</span>latin1() <span class="operator"><</span><span class="operator"><</span> <span class="string">", "</span> <span class="operator"><</span><span class="operator"><</span> employee<span class="operator">-</span><span class="operator">></span>forename()<span class="operator">.</span>latin1() <span class="operator"><</span><span class="operator"><</span> <span class="string">" earns "</span> <span class="operator"><</span><span class="operator"><</span> employee<span class="operator">-</span><span class="operator">></span>salary() <span class="operator"><</span><span class="operator"><</span> endl; }</pre> <p>The output is</p> <pre class="cpp"> Doe<span class="operator">,</span> John earns <span class="number">50000</span> Williams<span class="operator">,</span> Jane earns <span class="number">80000</span> Jones<span class="operator">,</span> Tom earns <span class="number">60000</span></pre> <p>Using a list iterator is a more robust way of traversing the list than using the <a href="q3ptrlist.html">Q3PtrList</a> member functions <a href="q3ptrlist.html#first">first</a>(), <a href="q3ptrlist.html#next">next</a>(), <a href="q3ptrlist.html#current">current</a>(), etc., as many iterators can traverse the same list independently.</p> <p>An iterator has its own current list item and can get the next and previous list items. It doesn't modify the list in any way.</p> <p>When an item is removed from the list, all iterators that point to that item are updated to point to <a href="q3ptrlist.html#current">Q3PtrList::current</a>() instead to avoid dangling references.</p> </div> <p><b>See also </b><a href="q3ptrlist.html">Q3PtrList</a>.</p> <!-- @@@Q3PtrListIterator --> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$Q3PtrListIterator[overload1]$$$Q3PtrListIteratorconstQ3PtrList<type>& --> <h3 class="fn"><a name="Q3PtrListIterator"></a>Q3PtrListIterator::<span class="name">Q3PtrListIterator</span> ( const <span class="type"><a href="q3ptrlist.html">Q3PtrList</a></span><<span class="type">type</span>> & <i>list</i> )</h3> <p>Constructs an iterator for <i>list</i>. The current iterator item is set to point on the first item in the <i>list</i>.</p> <!-- @@@Q3PtrListIterator --> <!-- $$$~Q3PtrListIterator[overload1]$$$~Q3PtrListIterator --> <h3 class="fn"><a name="dtor.Q3PtrListIterator"></a>Q3PtrListIterator::<span class="name">~Q3PtrListIterator</span> ()</h3> <p>Destroys the iterator.</p> <!-- @@@~Q3PtrListIterator --> <!-- $$$atFirst[overload1]$$$atFirst --> <h3 class="fn"><a name="atFirst"></a><span class="type">bool</span> Q3PtrListIterator::<span class="name">atFirst</span> () const</h3> <p>Returns TRUE if the current iterator item is the first list item; otherwise returns FALSE.</p> <p><b>See also </b><a href="q3ptrlistiterator.html#toFirst">toFirst</a>() and <a href="q3ptrlistiterator.html#atLast">atLast</a>().</p> <!-- @@@atFirst --> <!-- $$$atLast[overload1]$$$atLast --> <h3 class="fn"><a name="atLast"></a><span class="type">bool</span> Q3PtrListIterator::<span class="name">atLast</span> () const</h3> <p>Returns TRUE if the current iterator item is the last list item; otherwise returns FALSE.</p> <p><b>See also </b><a href="q3ptrlistiterator.html#toLast">toLast</a>() and <a href="q3ptrlistiterator.html#atFirst">atFirst</a>().</p> <!-- @@@atLast --> <!-- $$$count[overload1]$$$count --> <h3 class="fn"><a name="count"></a><span class="type"><a href="qtglobal.html#uint-typedef">uint</a></span> Q3PtrListIterator::<span class="name">count</span> () const</h3> <p>Returns the number of items in the list this iterator operates on.</p> <p><b>See also </b><a href="q3ptrlistiterator.html#isEmpty">isEmpty</a>().</p> <!-- @@@count --> <!-- $$$current[overload1]$$$current --> <h3 class="fn"><a name="current"></a><span class="type">type</span> * Q3PtrListIterator::<span class="name">current</span> () const</h3> <p>Returns a pointer to the current iterator item. If the iterator is positioned before the first item in the list or after the last item in the list, 0 is returned.</p> <!-- @@@current --> <!-- $$$isEmpty[overload1]$$$isEmpty --> <h3 class="fn"><a name="isEmpty"></a><span class="type">bool</span> Q3PtrListIterator::<span class="name">isEmpty</span> () const</h3> <p>Returns TRUE if the list is empty; otherwise returns FALSE.</p> <p><b>See also </b><a href="q3ptrlistiterator.html#count">count</a>().</p> <!-- @@@isEmpty --> <!-- $$$toFirst[overload1]$$$toFirst --> <h3 class="fn"><a name="toFirst"></a><span class="type">type</span> * Q3PtrListIterator::<span class="name">toFirst</span> ()</h3> <p>Sets the current iterator item to point to the first list item and returns a pointer to the item. Sets the current item to 0 and returns 0 if the list is empty.</p> <p><b>See also </b><a href="q3ptrlistiterator.html#toLast">toLast</a>() and <a href="q3ptrlistiterator.html#atFirst">atFirst</a>().</p> <!-- @@@toFirst --> <!-- $$$toLast[overload1]$$$toLast --> <h3 class="fn"><a name="toLast"></a><span class="type">type</span> * Q3PtrListIterator::<span class="name">toLast</span> ()</h3> <p>Sets the current iterator item to point to the last list item and returns a pointer to the item. Sets the current item to 0 and returns 0 if the list is empty.</p> <p><b>See also </b><a href="q3ptrlistiterator.html#toFirst">toFirst</a>() and <a href="q3ptrlistiterator.html#atLast">atLast</a>().</p> <!-- @@@toLast --> <!-- $$$operator type *[overload1]$$$operator type * --> <h3 class="fn"><a name="operator-type--2a"></a>Q3PtrListIterator::<span class="name">operator type *</span> () const</h3> <p>Cast operator. Returns a pointer to the current iterator item. Same as <a href="q3ptrlistiterator.html#current">current</a>().</p> <!-- @@@operator type * --> <!-- $$$operator()[overload1]$$$operator() --> <h3 class="fn"><a name="operator-28-29"></a><span class="type">type</span> * Q3PtrListIterator::<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 list or if it was 0, 0 is returned.</p> <!-- @@@operator() --> <!-- $$$operator*[overload1]$$$operator* --> <h3 class="fn"><a name="operator-2a"></a><span class="type">type</span> * Q3PtrListIterator::<span class="name">operator*</span> ()</h3> <p>Asterisk operator. Returns a pointer to the current iterator item. Same as <a href="q3ptrlistiterator.html#current">current</a>().</p> <!-- @@@operator* --> <!-- $$$operator++[overload1]$$$operator++ --> <h3 class="fn"><a name="operator-2b-2b"></a><span class="type">type</span> * Q3PtrListIterator::<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 list 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> * Q3PtrListIterator::<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 list is empty, it sets the current item to 0 and returns 0</p> <!-- @@@operator+= --> <!-- $$$operator--[overload1]$$$operator-- --> <h3 class="fn"><a name="operator--"></a><span class="type">type</span> * Q3PtrListIterator::<span class="name">operator--</span> ()</h3> <p>Prefix - makes the preceding item current and returns the new current item.</p> <p>If the current iterator item was the first item in the list or if it was 0, 0 is returned.</p> <!-- @@@operator-- --> <!-- $$$operator-=[overload1]$$$operator-=uint --> <h3 class="fn"><a name="operator--eq"></a><span class="type">type</span> * Q3PtrListIterator::<span class="name">operator-=</span> ( <span class="type"><a href="qtglobal.html#uint-typedef">uint</a></span> <i>jump</i> )</h3> <p>Returns the item <i>jump</i> positions before the current item or 0 if it is beyond the first item. Makes this the current item.</p> <!-- @@@operator-= --> <!-- $$$operator=[overload1]$$$operator=constQ3PtrListIterator<type>& --> <h3 class="fn"><a name="operator-eq"></a><span class="type">Q3PtrListIterator</span><<span class="type">type</span>> & Q3PtrListIterator::<span class="name">operator=</span> ( const <span class="type">Q3PtrListIterator</span><<span class="type">type</span>> & <i>it</i> )</h3> <p>Assignment. Makes a copy of the iterator <i>it</i> and returns a reference to this iterator.</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>