← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/html/qtextframe-iterator.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/qtextframe-iterator.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/gui/text/qtextobject.cpp -->
 
5
<!-- qtextobject.cpp -->
6
6
<head>
7
 
  <title>Qt 4.5: iterator Class Reference</title>
 
7
  <title>Qt 4.6: iterator 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/QTextFrame/iterator" />
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">iterator Class Reference<br /><span class="small-subtitle">(QTextFrame::iterator)<br />[<a href="qtgui.html">QtGui</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">iterator Class Reference<br /><span class="small-subtitle">(QTextFrame::iterator)<br />[<a href="qtgui.html">QtGui</a> module]</span>
16
17
</h1>
17
18
<p>The iterator class provides an iterator for reading the contents of a <a href="qtextframe.html">QTextFrame</a>. <a href="#details">More...</a></p>
18
19
<pre> #include &lt;<a href="qtextframe.html">QTextFrame</a>&gt;</pre><ul>
19
20
<li><a href="qtextframe-iterator-members.html">List of all members, including inherited members</a></li>
20
21
</ul>
 
22
<hr />
21
23
<a name="public-functions"></a>
22
 
<h3>Public Functions</h3>
23
 
<ul>
24
 
<li><div class="fn"></div><b><a href="qtextframe-iterator.html#iterator">iterator</a></b> ()</li>
25
 
<li><div class="fn"></div><b><a href="qtextframe-iterator.html#iterator-3">iterator</a></b> ( const iterator &amp; <i>other</i> )</li>
26
 
<li><div class="fn"></div>bool <b><a href="qtextframe-iterator.html#atEnd">atEnd</a></b> () const</li>
27
 
<li><div class="fn"></div>QTextBlock <b><a href="qtextframe-iterator.html#currentBlock">currentBlock</a></b> () const</li>
28
 
<li><div class="fn"></div>QTextFrame * <b><a href="qtextframe-iterator.html#currentFrame">currentFrame</a></b> () const</li>
29
 
<li><div class="fn"></div>QTextFrame * <b><a href="qtextframe-iterator.html#parentFrame">parentFrame</a></b> () const</li>
30
 
<li><div class="fn"></div>bool <b><a href="qtextframe-iterator.html#operator-not-eq">operator!=</a></b> ( const iterator &amp; <i>other</i> ) const</li>
31
 
<li><div class="fn"></div>iterator &amp; <b><a href="qtextframe-iterator.html#operator-2b-2b">operator++</a></b> ()</li>
32
 
<li><div class="fn"></div>iterator <b><a href="qtextframe-iterator.html#operator-2b-2b-2">operator++</a></b> ( int )</li>
33
 
<li><div class="fn"></div>iterator &amp; <b><a href="qtextframe-iterator.html#operator--">operator--</a></b> ()</li>
34
 
<li><div class="fn"></div>iterator <b><a href="qtextframe-iterator.html#operator---2">operator--</a></b> ( int )</li>
35
 
<li><div class="fn"></div>iterator &amp; <b><a href="qtextframe-iterator.html#operator-eq">operator=</a></b> ( const iterator &amp; <i>other</i> )</li>
36
 
<li><div class="fn"></div>bool <b><a href="qtextframe-iterator.html#operator-eq-eq">operator==</a></b> ( const iterator &amp; <i>other</i> ) const</li>
37
 
</ul>
 
24
<h2>Public Functions</h2>
 
25
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
26
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qtextframe-iterator.html#iterator">iterator</a></b> ()</td></tr>
 
27
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qtextframe-iterator.html#iterator-3">iterator</a></b> ( const iterator &amp; <i>other</i> )</td></tr>
 
28
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qtextframe-iterator.html#atEnd">atEnd</a></b> () const</td></tr>
 
29
<tr><td class="memItemLeft" align="right" valign="top">QTextBlock </td><td class="memItemRight" valign="bottom"><b><a href="qtextframe-iterator.html#currentBlock">currentBlock</a></b> () const</td></tr>
 
30
<tr><td class="memItemLeft" align="right" valign="top">QTextFrame * </td><td class="memItemRight" valign="bottom"><b><a href="qtextframe-iterator.html#currentFrame">currentFrame</a></b> () const</td></tr>
 
31
<tr><td class="memItemLeft" align="right" valign="top">QTextFrame * </td><td class="memItemRight" valign="bottom"><b><a href="qtextframe-iterator.html#parentFrame">parentFrame</a></b> () const</td></tr>
 
32
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qtextframe-iterator.html#operator-not-eq">operator!=</a></b> ( const iterator &amp; <i>other</i> ) const</td></tr>
 
33
<tr><td class="memItemLeft" align="right" valign="top">iterator &amp; </td><td class="memItemRight" valign="bottom"><b><a href="qtextframe-iterator.html#operator-2b-2b">operator++</a></b> ()</td></tr>
 
34
<tr><td class="memItemLeft" align="right" valign="top">iterator </td><td class="memItemRight" valign="bottom"><b><a href="qtextframe-iterator.html#operator-2b-2b-2">operator++</a></b> ( int )</td></tr>
 
35
<tr><td class="memItemLeft" align="right" valign="top">iterator &amp; </td><td class="memItemRight" valign="bottom"><b><a href="qtextframe-iterator.html#operator--">operator--</a></b> ()</td></tr>
 
36
<tr><td class="memItemLeft" align="right" valign="top">iterator </td><td class="memItemRight" valign="bottom"><b><a href="qtextframe-iterator.html#operator---2">operator--</a></b> ( int )</td></tr>
 
37
<tr><td class="memItemLeft" align="right" valign="top">iterator &amp; </td><td class="memItemRight" valign="bottom"><b><a href="qtextframe-iterator.html#operator-eq">operator=</a></b> ( const iterator &amp; <i>other</i> )</td></tr>
 
38
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qtextframe-iterator.html#operator-eq-eq">operator==</a></b> ( const iterator &amp; <i>other</i> ) const</td></tr>
 
39
</table>
38
40
<a name="details"></a>
39
41
<hr />
40
42
<h2>Detailed Description</h2>
42
44
<p>A frame consists of an arbitrary sequence of <a href="qtextblock.html">QTextBlock</a>s and child <a href="qtextframe.html">QTextFrame</a>s. This class provides a way to iterate over the child objects of a frame, and read their contents. It does not provide a way to modify the contents of the frame.</p>
43
45
<hr />
44
46
<h2>Member Function Documentation</h2>
 
47
<a name="//apple_ref/cpp/instm/QTextFrame::iterator/iterator" />
45
48
<h3 class="fn"><a name="iterator"></a>iterator::iterator ()</h3>
46
49
<p>Constructs an invalid iterator.</p>
47
50
<h3 class="fn"><a name="iterator-3"></a>iterator::iterator ( const iterator &amp; <i>other</i> )</h3>
48
51
<p>Copy constructor. Constructs a copy of the <i>other</i> iterator.</p>
 
52
<a name="//apple_ref/cpp/instm/QTextFrame::iterator/atEnd" />
49
53
<h3 class="fn"><a name="atEnd"></a>bool iterator::atEnd () const</h3>
50
54
<p>Returns true if the current item is the last item in the text frame.</p>
 
55
<a name="//apple_ref/cpp/instm/QTextFrame::iterator/currentBlock" />
51
56
<h3 class="fn"><a name="currentBlock"></a><a href="qtextblock.html">QTextBlock</a> iterator::currentBlock () const</h3>
52
57
<p>Returns the current block the iterator points to. If the iterator points to a child frame, the returned block is invalid.</p>
53
58
<p>See also <a href="qtextframe-iterator.html#currentFrame">currentFrame</a>().</p>
 
59
<a name="//apple_ref/cpp/instm/QTextFrame::iterator/currentFrame" />
54
60
<h3 class="fn"><a name="currentFrame"></a><a href="qtextframe.html">QTextFrame</a> * iterator::currentFrame () const</h3>
55
61
<p>Returns the current frame pointed to by the iterator, or 0 if the iterator currently points to a block.</p>
56
62
<p>See also <a href="qtextframe-iterator.html#currentBlock">currentBlock</a>().</p>
 
63
<a name="//apple_ref/cpp/instm/QTextFrame::iterator/parentFrame" />
57
64
<h3 class="fn"><a name="parentFrame"></a><a href="qtextframe.html">QTextFrame</a> * iterator::parentFrame () const</h3>
58
65
<p>Returns the parent frame of the current frame.</p>
59
66
<p>See also <a href="qtextframe-iterator.html#currentFrame">currentFrame</a>() and <a href="qtextframe.html#parentFrame">QTextFrame::parentFrame</a>().</p>
 
67
<a name="//apple_ref/cpp/instm/QTextFrame::iterator/operator!=" />
60
68
<h3 class="fn"><a name="operator-not-eq"></a>bool iterator::operator!= ( const iterator &amp; <i>other</i> ) const</h3>
61
69
<p>Retuns true if the iterator is different from the <i>other</i> iterator; otherwise returns false.</p>
 
70
<a name="//apple_ref/cpp/instm/QTextFrame::iterator/operator++" />
62
71
<h3 class="fn"><a name="operator-2b-2b"></a>iterator &amp; iterator::operator++ ()</h3>
63
72
<p>Moves the iterator to the next frame or block.</p>
64
73
<p>See also <a href="qtextframe-iterator.html#currentBlock">currentBlock</a>() and <a href="qtextframe-iterator.html#currentFrame">currentFrame</a>().</p>
65
74
<h3 class="fn"><a name="operator-2b-2b-2"></a>iterator iterator::operator++ ( int )</h3>
66
75
<p>The postfix ++ operator (<tt>i++</tt>) advances the iterator to the next item in the text frame, and returns an iterator to the old item.</p>
 
76
<a name="//apple_ref/cpp/instm/QTextFrame::iterator/operator--" />
67
77
<h3 class="fn"><a name="operator--"></a>iterator &amp; iterator::operator-- ()</h3>
68
78
<p>Moves the iterator to the previous frame or block.</p>
69
79
<p>See also <a href="qtextframe-iterator.html#currentBlock">currentBlock</a>() and <a href="qtextframe-iterator.html#currentFrame">currentFrame</a>().</p>
70
80
<h3 class="fn"><a name="operator---2"></a>iterator iterator::operator-- ( int )</h3>
71
81
<p>The postfix -- operator (<tt>i--</tt>) makes the preceding item in the current frame, and returns an iterator to the old item.</p>
 
82
<a name="//apple_ref/cpp/instm/QTextFrame::iterator/operator=" />
72
83
<h3 class="fn"><a name="operator-eq"></a>iterator &amp; iterator::operator= ( const iterator &amp; <i>other</i> )</h3>
73
84
<p>Assigns <i>other</i> to this iterator and returns a reference to this iterator.</p>
 
85
<a name="//apple_ref/cpp/instm/QTextFrame::iterator/operator==" />
74
86
<h3 class="fn"><a name="operator-eq-eq"></a>bool iterator::operator== ( const iterator &amp; <i>other</i> ) const</h3>
75
87
<p>Retuns true if the iterator is the same as the <i>other</i> iterator; otherwise returns false.</p>
76
88
<p /><address><hr /><div align="center">
77
89
<table width="100%" cellspacing="0" border="0"><tr class="address">
78
 
<td width="30%" align="left">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies)</td>
79
 
<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>
80
 
<td width="30%" align="right"><div align="right">Qt 4.5.2</div></td>
81
 
</tr></table></div></address></body>
 
90
<td width="40%" align="left">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies)</td>
 
91
<td width="20%" align="center"><a href="trademarks.html">Trademarks</a></td>
 
92
<td width="40%" align="right"><div align="right">Qt 4.6.0</div></td>
 
93
<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>
82
94
</html>