← Back to branch summary

~oif-team/ubuntu/natty/qt4-x11/xi2.1

« back to all changes in this revision

Viewing changes to doc/html/qabstractfileengineiterator.html

  • Committer: Bazaar Package Importer
  • Author(s): Alessandro Ghersi
  • Date: 2009-11-02 18:30:08 UTC
  • mfrom: (1.2.2 upstream)
  • mto: (15.2.5 experimental)
  • mto: This revision was merged to the branch mainline in revision 88.
  • Revision ID: james.westby@ubuntu.com-20091102183008-b6a4gcs128mvfb3m
Tags: upstream-4.6.0~beta1
Import upstream version 4.6.0~beta1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/qabstractfileengineiterator.html
2
2
<!DOCTYPE html
3
3
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
4
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
 
<!-- /fasttmp/mkdist-qt-4.5.2-1245473805/qt-x11-opensource-src-4.5.2/src/corelib/io/qabstractfileengine.cpp -->
 
5
<!-- qabstractfileengine.cpp -->
6
6
<head>
7
 
  <title>Qt 4.5: QAbstractFileEngineIterator Class Reference</title>
 
7
  <title>Qt 4.6: QAbstractFileEngineIterator Class Reference</title>
8
8
  <link href="classic.css" rel="stylesheet" type="text/css" />
9
9
</head>
10
10
<body>
 
11
<a name="//apple_ref/cpp/cl//QAbstractFileEngineIterator" />
11
12
<table border="0" cellpadding="0" cellspacing="0" width="100%">
12
13
<tr>
13
 
<td align="left" valign="top" width="32"><a href="http://qtsoftware.com/products/qt"><img src="images/qt-logo.png" align="left" border="0" /></a></td>
14
 
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="namespaces.html"><font color="#004faf">All&nbsp;Namespaces</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="mainclasses.html"><font color="#004faf">Main&nbsp;Classes</font></a>&nbsp;&middot; <a href="groups.html"><font color="#004faf">Grouped&nbsp;Classes</font></a>&nbsp;&middot; <a href="modules.html"><font color="#004faf">Modules</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">Functions</font></a></td>
15
 
<td align="right" valign="top" width="230"></td></tr></table><h1 class="title">QAbstractFileEngineIterator Class Reference<br /><span class="small-subtitle">[<a href="qtcore.html">QtCore</a> module]</span>
 
14
<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>
 
15
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">All&nbsp;Functions</font></a>&nbsp;&middot; <a href="overviews.html"><font color="#004faf">Overviews</font></a></td><td class="searchBar" align="right" valign="center"><form action="http://www.google.com/cse" id="cse-search-box"><div><input type="hidden" name="cx" value="000136343326384750312:dhbxnqlakyu" /><input type="hidden" name="ie" value="UTF-8" /><input type="text" name="q" size="31" /><input type="submit" name="sa" value="Search" /></div></form></td>
 
16
</tr></table><h1 class="title">QAbstractFileEngineIterator Class Reference<br /><span class="small-subtitle">[<a href="qtcore.html">QtCore</a> module]</span>
16
17
</h1>
17
18
<p>The QAbstractFileEngineIterator class provides an iterator interface for custom file engines. <a href="#details">More...</a></p>
18
19
<pre> #include &lt;QAbstractFileEngineIterator&gt;</pre><p>This class was introduced in Qt 4.3.</p>
19
20
<ul>
20
21
<li><a href="qabstractfileengineiterator-members.html">List of all members, including inherited members</a></li>
21
22
</ul>
 
23
<hr />
22
24
<a name="public-functions"></a>
23
 
<h3>Public Functions</h3>
24
 
<ul>
25
 
<li><div class="fn"></div><b><a href="qabstractfileengineiterator.html#QAbstractFileEngineIterator">QAbstractFileEngineIterator</a></b> ( QDir::Filters <i>filters</i>, const QStringList &amp; <i>nameFilters</i> )</li>
26
 
<li><div class="fn"></div>virtual <b><a href="qabstractfileengineiterator.html#dtor.QAbstractFileEngineIterator">~QAbstractFileEngineIterator</a></b> ()</li>
27
 
<li><div class="fn"></div>virtual QFileInfo <b><a href="qabstractfileengineiterator.html#currentFileInfo">currentFileInfo</a></b> () const</li>
28
 
<li><div class="fn"></div>virtual QString <b><a href="qabstractfileengineiterator.html#currentFileName">currentFileName</a></b> () const = 0</li>
29
 
<li><div class="fn"></div>QString <b><a href="qabstractfileengineiterator.html#currentFilePath">currentFilePath</a></b> () const</li>
30
 
<li><div class="fn"></div>QDir::Filters <b><a href="qabstractfileengineiterator.html#filters">filters</a></b> () const</li>
31
 
<li><div class="fn"></div>virtual bool <b><a href="qabstractfileengineiterator.html#hasNext">hasNext</a></b> () const = 0</li>
32
 
<li><div class="fn"></div>QStringList <b><a href="qabstractfileengineiterator.html#nameFilters">nameFilters</a></b> () const</li>
33
 
<li><div class="fn"></div>virtual QString <b><a href="qabstractfileengineiterator.html#next">next</a></b> () = 0</li>
34
 
<li><div class="fn"></div>QString <b><a href="qabstractfileengineiterator.html#pathx">path</a></b> () const</li>
35
 
</ul>
 
25
<h2>Public Functions</h2>
 
26
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
27
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qabstractfileengineiterator.html#QAbstractFileEngineIterator">QAbstractFileEngineIterator</a></b> ( QDir::Filters <i>filters</i>, const QStringList &amp; <i>nameFilters</i> )</td></tr>
 
28
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><b><a href="qabstractfileengineiterator.html#dtor.QAbstractFileEngineIterator">~QAbstractFileEngineIterator</a></b> ()</td></tr>
 
29
<tr><td class="memItemLeft" align="right" valign="top">virtual QFileInfo </td><td class="memItemRight" valign="bottom"><b><a href="qabstractfileengineiterator.html#currentFileInfo">currentFileInfo</a></b> () const</td></tr>
 
30
<tr><td class="memItemLeft" align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><b><a href="qabstractfileengineiterator.html#currentFileName">currentFileName</a></b> () const = 0</td></tr>
 
31
<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><b><a href="qabstractfileengineiterator.html#currentFilePath">currentFilePath</a></b> () const</td></tr>
 
32
<tr><td class="memItemLeft" align="right" valign="top">QDir::Filters </td><td class="memItemRight" valign="bottom"><b><a href="qabstractfileengineiterator.html#filters">filters</a></b> () const</td></tr>
 
33
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qabstractfileengineiterator.html#hasNext">hasNext</a></b> () const = 0</td></tr>
 
34
<tr><td class="memItemLeft" align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><b><a href="qabstractfileengineiterator.html#nameFilters">nameFilters</a></b> () const</td></tr>
 
35
<tr><td class="memItemLeft" align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><b><a href="qabstractfileengineiterator.html#next">next</a></b> () = 0</td></tr>
 
36
<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><b><a href="qabstractfileengineiterator.html#pathx">path</a></b> () const</td></tr>
 
37
</table>
36
38
<a name="details"></a>
37
39
<hr />
38
40
<h2>Detailed Description</h2>
87
89
<p>See also <a href="qdiriterator.html">QDirIterator</a>.</p>
88
90
<hr />
89
91
<h2>Member Function Documentation</h2>
 
92
<a name="//apple_ref/cpp/instm/QAbstractFileEngineIterator/QAbstractFileEngineIterator" />
90
93
<h3 class="fn"><a name="QAbstractFileEngineIterator"></a>QAbstractFileEngineIterator::QAbstractFileEngineIterator ( <a href="qdir.html#Filter-enum">QDir::Filters</a> <i>filters</i>, const <a href="qstringlist.html">QStringList</a> &amp; <i>nameFilters</i> )</h3>
91
94
<p>Constructs a <a href="qabstractfileengineiterator.html">QAbstractFileEngineIterator</a>, using the entry filters <i>filters</i>, and wildcard name filters <i>nameFilters</i>.</p>
 
95
<a name="//apple_ref/cpp/instm/QAbstractFileEngineIterator/~QAbstractFileEngineIterator" />
92
96
<h3 class="fn"><a name="dtor.QAbstractFileEngineIterator"></a>QAbstractFileEngineIterator::~QAbstractFileEngineIterator ()&nbsp;&nbsp;<tt> [virtual]</tt></h3>
93
97
<p>Destroys the <a href="qabstractfileengineiterator.html">QAbstractFileEngineIterator</a>.</p>
94
98
<p>See also <a href="qdiriterator.html">QDirIterator</a>.</p>
 
99
<a name="//apple_ref/cpp/instm/QAbstractFileEngineIterator/currentFileInfo" />
95
100
<h3 class="fn"><a name="currentFileInfo"></a><a href="qfileinfo.html">QFileInfo</a> QAbstractFileEngineIterator::currentFileInfo () const&nbsp;&nbsp;<tt> [virtual]</tt></h3>
96
101
<p>The virtual function returns a <a href="qfileinfo.html">QFileInfo</a> for the current directory entry. This function is provided for convenience. It can also be slightly faster that creating a <a href="qfileinfo.html">QFileInfo</a> object yourself, as the object returned by this function might contain cached information that <a href="qfileinfo.html">QFileInfo</a> otherwise would have to access through the file engine.</p>
97
102
<p>See also <a href="qabstractfileengineiterator.html#currentFileName">currentFileName</a>().</p>
 
103
<a name="//apple_ref/cpp/instm/QAbstractFileEngineIterator/currentFileName" />
98
104
<h3 class="fn"><a name="currentFileName"></a><a href="qstring.html">QString</a> QAbstractFileEngineIterator::currentFileName () const&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
99
105
<p>This pure virtual function returns the name of the current directory entry, excluding the path.</p>
100
106
<p>See also <a href="qabstractfileengineiterator.html#currentFilePath">currentFilePath</a>().</p>
 
107
<a name="//apple_ref/cpp/instm/QAbstractFileEngineIterator/currentFilePath" />
101
108
<h3 class="fn"><a name="currentFilePath"></a><a href="qstring.html">QString</a> QAbstractFileEngineIterator::currentFilePath () const</h3>
102
109
<p>Returns the path to the current directory entry. It's the same as prepending <a href="qabstractfileengineiterator.html#pathx">path</a>() to the return value of <a href="qabstractfileengineiterator.html#currentFileName">currentFileName</a>().</p>
103
110
<p>See also <a href="qabstractfileengineiterator.html#currentFileName">currentFileName</a>().</p>
 
111
<a name="//apple_ref/cpp/instm/QAbstractFileEngineIterator/filters" />
104
112
<h3 class="fn"><a name="filters"></a><a href="qdir.html#Filter-enum">QDir::Filters</a> QAbstractFileEngineIterator::filters () const</h3>
105
113
<p>Returns the entry filters for this iterator.</p>
106
114
<p>See also <a href="qdir.html#filter">QDir::filter</a>(), <a href="qabstractfileengineiterator.html#nameFilters">nameFilters</a>(), and <a href="qabstractfileengineiterator.html#pathx">path</a>().</p>
 
115
<a name="//apple_ref/cpp/instm/QAbstractFileEngineIterator/hasNext" />
107
116
<h3 class="fn"><a name="hasNext"></a>bool QAbstractFileEngineIterator::hasNext () const&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
108
117
<p>This pure virtual function returns true if there is at least one more entry in the current directory (i.e&#x2e;, the iterator path is valid and accessible, and the iterator has not reached the end of the entry list).</p>
109
118
<p>See also <a href="qdiriterator.html#hasNext">QDirIterator::hasNext</a>().</p>
 
119
<a name="//apple_ref/cpp/instm/QAbstractFileEngineIterator/nameFilters" />
110
120
<h3 class="fn"><a name="nameFilters"></a><a href="qstringlist.html">QStringList</a> QAbstractFileEngineIterator::nameFilters () const</h3>
111
121
<p>Returns the name filters for this iterator.</p>
112
122
<p>See also <a href="qdir.html#nameFilters">QDir::nameFilters</a>(), <a href="qabstractfileengineiterator.html#filters">filters</a>(), and <a href="qabstractfileengineiterator.html#pathx">path</a>().</p>
 
123
<a name="//apple_ref/cpp/instm/QAbstractFileEngineIterator/next" />
113
124
<h3 class="fn"><a name="next"></a><a href="qstring.html">QString</a> QAbstractFileEngineIterator::next ()&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
114
125
<p>This pure virtual function advances the iterator to the next directory entry, and returns the file path to the current entry.</p>
115
126
<p>This function can optionally make use of <a href="qabstractfileengineiterator.html#nameFilters">nameFilters</a>() and <a href="qabstractfileengineiterator.html#filters">filters</a>() to optimize its performance.</p>
116
127
<p>Reimplement this function in a subclass to advance the iterator.</p>
117
128
<p>See also <a href="qdiriterator.html#next">QDirIterator::next</a>().</p>
 
129
<a name="//apple_ref/cpp/instm/QAbstractFileEngineIterator/path" />
118
130
<h3 class="fn"><a name="pathx"></a><a href="qstring.html">QString</a> QAbstractFileEngineIterator::path () const</h3>
119
131
<p>Returns the path for this iterator. <a href="qdiriterator.html">QDirIterator</a> is responsible for assigning this path; it cannot change during the iterator's lifetime.</p>
120
132
<p>See also <a href="qabstractfileengineiterator.html#nameFilters">nameFilters</a>() and <a href="qabstractfileengineiterator.html#filters">filters</a>().</p>
121
133
<p /><address><hr /><div align="center">
122
134
<table width="100%" cellspacing="0" border="0"><tr class="address">
123
 
<td width="30%" align="left">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies)</td>
124
 
<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>
125
 
<td width="30%" align="right"><div align="right">Qt 4.5.2</div></td>
126
 
</tr></table></div></address></body>
 
135
<td width="40%" align="left">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies)</td>
 
136
<td width="20%" align="center"><a href="trademarks.html">Trademarks</a></td>
 
137
<td width="40%" align="right"><div align="right">Qt 4.6.0</div></td>
 
138
<script type="text/javascript" src="http://www.google.com/jsapi"></script><script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script><script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en"></script><script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en"></script></tr></table></div></address></body>
127
139
</html>