← 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.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.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: QTextFrame Class Reference</title>
 
7
  <title>Qt 4.6: QTextFrame 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" />
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">QTextFrame Class Reference<br /><span class="small-subtitle">[<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">QTextFrame Class Reference<br /><span class="small-subtitle">[<a href="qtgui.html">QtGui</a> module]</span>
16
17
</h1>
17
18
<p>The QTextFrame class represents a frame in a <a href="qtextdocument.html">QTextDocument</a>. <a href="#details">More...</a></p>
18
19
<pre> #include &lt;QTextFrame&gt;</pre><p>Inherits <a href="qtextobject.html">QTextObject</a>.</p>
19
20
<p>Inherited by <a href="qtexttable.html">QTextTable</a>.</p>
20
 
<p><b>Note:</b> All the functions in this class are <a href="threads.html#reentrant">reentrant</a>.</p>
 
21
<p><b>Note:</b> All functions in this class are <a href="threads-reentrancy.html#reentrant">reentrant</a>.</p>
21
22
<ul>
22
23
<li><a href="qtextframe-members.html">List of all members, including inherited members</a></li>
23
24
</ul>
 
25
<hr />
24
26
<a name="public-types"></a>
25
 
<h3>Public Types</h3>
26
 
<ul>
27
 
<li><div class="fn"></div>class <b><a href="qtextframe-iterator.html">iterator</a></b></li>
28
 
<li><div class="fn"></div>typedef <b><a href="qtextframe.html#Iterator-typedef">Iterator</a></b></li>
29
 
</ul>
 
27
<h2>Public Types</h2>
 
28
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
29
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><b><a href="qtextframe-iterator.html">iterator</a></b></td></tr>
 
30
<tr><td class="memItemLeft" align="right" valign="top">typedef </td><td class="memItemRight" valign="bottom"><b><a href="qtextframe.html#Iterator-typedef">Iterator</a></b></td></tr>
 
31
</table>
 
32
<hr />
30
33
<a name="public-functions"></a>
31
 
<h3>Public Functions</h3>
32
 
<ul>
33
 
<li><div class="fn"></div><b><a href="qtextframe.html#QTextFrame">QTextFrame</a></b> ( QTextDocument * <i>document</i> )</li>
34
 
<li><div class="fn"></div><b><a href="qtextframe.html#dtor.QTextFrame">~QTextFrame</a></b> ()</li>
35
 
<li><div class="fn"></div>iterator <b><a href="qtextframe.html#begin">begin</a></b> () const</li>
36
 
<li><div class="fn"></div>QList&lt;QTextFrame *&gt; <b><a href="qtextframe.html#childFrames">childFrames</a></b> () const</li>
37
 
<li><div class="fn"></div>iterator <b><a href="qtextframe.html#end">end</a></b> () const</li>
38
 
<li><div class="fn"></div>QTextCursor <b><a href="qtextframe.html#firstCursorPosition">firstCursorPosition</a></b> () const</li>
39
 
<li><div class="fn"></div>int <b><a href="qtextframe.html#firstPosition">firstPosition</a></b> () const</li>
40
 
<li><div class="fn"></div>QTextFrameFormat <b><a href="qtextframe.html#frameFormat">frameFormat</a></b> () const</li>
41
 
<li><div class="fn"></div>QTextCursor <b><a href="qtextframe.html#lastCursorPosition">lastCursorPosition</a></b> () const</li>
42
 
<li><div class="fn"></div>int <b><a href="qtextframe.html#lastPosition">lastPosition</a></b> () const</li>
43
 
<li><div class="fn"></div>QTextFrame * <b><a href="qtextframe.html#parentFrame">parentFrame</a></b> () const</li>
44
 
<li><div class="fn"></div>void <b><a href="qtextframe.html#setFrameFormat">setFrameFormat</a></b> ( const QTextFrameFormat &amp; <i>format</i> )</li>
45
 
</ul>
46
 
<ul>
47
 
<li><div class="fn"></div>4 public functions inherited from <a href="qtextobject.html#public-functions">QTextObject</a></li>
48
 
<li><div class="fn"></div>29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
 
34
<h2>Public Functions</h2>
 
35
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
36
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qtextframe.html#QTextFrame">QTextFrame</a></b> ( QTextDocument * <i>document</i> )</td></tr>
 
37
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qtextframe.html#dtor.QTextFrame">~QTextFrame</a></b> ()</td></tr>
 
38
<tr><td class="memItemLeft" align="right" valign="top">iterator </td><td class="memItemRight" valign="bottom"><b><a href="qtextframe.html#begin">begin</a></b> () const</td></tr>
 
39
<tr><td class="memItemLeft" align="right" valign="top">QList&lt;QTextFrame *&gt; </td><td class="memItemRight" valign="bottom"><b><a href="qtextframe.html#childFrames">childFrames</a></b> () const</td></tr>
 
40
<tr><td class="memItemLeft" align="right" valign="top">iterator </td><td class="memItemRight" valign="bottom"><b><a href="qtextframe.html#end">end</a></b> () const</td></tr>
 
41
<tr><td class="memItemLeft" align="right" valign="top">QTextCursor </td><td class="memItemRight" valign="bottom"><b><a href="qtextframe.html#firstCursorPosition">firstCursorPosition</a></b> () const</td></tr>
 
42
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qtextframe.html#firstPosition">firstPosition</a></b> () const</td></tr>
 
43
<tr><td class="memItemLeft" align="right" valign="top">QTextFrameFormat </td><td class="memItemRight" valign="bottom"><b><a href="qtextframe.html#frameFormat">frameFormat</a></b> () const</td></tr>
 
44
<tr><td class="memItemLeft" align="right" valign="top">QTextCursor </td><td class="memItemRight" valign="bottom"><b><a href="qtextframe.html#lastCursorPosition">lastCursorPosition</a></b> () const</td></tr>
 
45
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qtextframe.html#lastPosition">lastPosition</a></b> () const</td></tr>
 
46
<tr><td class="memItemLeft" align="right" valign="top">QTextFrame * </td><td class="memItemRight" valign="bottom"><b><a href="qtextframe.html#parentFrame">parentFrame</a></b> () const</td></tr>
 
47
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qtextframe.html#setFrameFormat">setFrameFormat</a></b> ( const QTextFrameFormat &amp; <i>format</i> )</td></tr>
 
48
</table>
 
49
<ul>
 
50
<li><div bar="2" class="fn"></div>4 public functions inherited from <a href="qtextobject.html#public-functions">QTextObject</a></li>
 
51
<li><div bar="2" class="fn"></div>29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
49
52
</ul>
50
53
<h3>Additional Inherited Members</h3>
51
54
<ul>
69
72
<p>See also <a href="qtextcursor.html">QTextCursor</a> and <a href="qtextdocument.html">QTextDocument</a>.</p>
70
73
<hr />
71
74
<h2>Member Type Documentation</h2>
 
75
<a name="//apple_ref/cpp/tdef/QTextFrame/Iterator" />
72
76
<h3 class="fn"><a name="Iterator-typedef"></a>typedef QTextFrame::Iterator</h3>
73
77
<p>Qt-style synonym for <a href="qtextframe-iterator.html">QTextFrame::iterator</a>.</p>
74
78
<hr />
75
79
<h2>Member Function Documentation</h2>
 
80
<a name="//apple_ref/cpp/instm/QTextFrame/QTextFrame" />
76
81
<h3 class="fn"><a name="QTextFrame"></a>QTextFrame::QTextFrame ( <a href="qtextdocument.html">QTextDocument</a> * <i>document</i> )</h3>
77
82
<p>Creates a new empty frame for the text <i>document</i>.</p>
 
83
<a name="//apple_ref/cpp/instm/QTextFrame/~QTextFrame" />
78
84
<h3 class="fn"><a name="dtor.QTextFrame"></a>QTextFrame::~QTextFrame ()</h3>
79
85
<p>Destroys the frame, and removes it from the document's layout.</p>
 
86
<a name="//apple_ref/cpp/instm/QTextFrame/begin" />
80
87
<h3 class="fn"><a name="begin"></a><a href="qtextframe-iterator.html">iterator</a> QTextFrame::begin () const</h3>
81
88
<p>Returns an iterator pointing to the first document element inside the frame.</p>
82
89
<p>See also <a href="qtextframe.html#end">end</a>().</p>
 
90
<a name="//apple_ref/cpp/instm/QTextFrame/childFrames" />
83
91
<h3 class="fn"><a name="childFrames"></a><a href="qlist.html">QList</a>&lt;QTextFrame *&gt; QTextFrame::childFrames () const</h3>
84
92
<p>Returns a (possibly empty) list of the frame's child frames.</p>
85
93
<p>See also <a href="qtextframe.html#parentFrame">parentFrame</a>().</p>
 
94
<a name="//apple_ref/cpp/instm/QTextFrame/end" />
86
95
<h3 class="fn"><a name="end"></a><a href="qtextframe-iterator.html">iterator</a> QTextFrame::end () const</h3>
87
96
<p>Returns an iterator pointing to the last document element inside the frame.</p>
88
97
<p>See also <a href="qtextframe.html#begin">begin</a>().</p>
 
98
<a name="//apple_ref/cpp/instm/QTextFrame/firstCursorPosition" />
89
99
<h3 class="fn"><a name="firstCursorPosition"></a><a href="qtextcursor.html">QTextCursor</a> QTextFrame::firstCursorPosition () const</h3>
90
100
<p>Returns the first cursor position inside the frame.</p>
91
101
<p>See also <a href="qtextframe.html#lastCursorPosition">lastCursorPosition</a>(), <a href="qtextframe.html#firstPosition">firstPosition</a>(), and <a href="qtextframe.html#lastPosition">lastPosition</a>().</p>
 
102
<a name="//apple_ref/cpp/instm/QTextFrame/firstPosition" />
92
103
<h3 class="fn"><a name="firstPosition"></a>int QTextFrame::firstPosition () const</h3>
93
104
<p>Returns the first document position inside the frame.</p>
94
105
<p>See also <a href="qtextframe.html#lastPosition">lastPosition</a>(), <a href="qtextframe.html#firstCursorPosition">firstCursorPosition</a>(), and <a href="qtextframe.html#lastCursorPosition">lastCursorPosition</a>().</p>
 
106
<a name="//apple_ref/cpp/instm/QTextFrame/frameFormat" />
95
107
<h3 class="fn"><a name="frameFormat"></a><a href="qtextframeformat.html">QTextFrameFormat</a> QTextFrame::frameFormat () const</h3>
96
108
<p>Returns the frame's format.</p>
97
109
<p>See also <a href="qtextframe.html#setFrameFormat">setFrameFormat</a>().</p>
 
110
<a name="//apple_ref/cpp/instm/QTextFrame/lastCursorPosition" />
98
111
<h3 class="fn"><a name="lastCursorPosition"></a><a href="qtextcursor.html">QTextCursor</a> QTextFrame::lastCursorPosition () const</h3>
99
112
<p>Returns the last cursor position inside the frame.</p>
100
113
<p>See also <a href="qtextframe.html#firstCursorPosition">firstCursorPosition</a>(), <a href="qtextframe.html#firstPosition">firstPosition</a>(), and <a href="qtextframe.html#lastPosition">lastPosition</a>().</p>
 
114
<a name="//apple_ref/cpp/instm/QTextFrame/lastPosition" />
101
115
<h3 class="fn"><a name="lastPosition"></a>int QTextFrame::lastPosition () const</h3>
102
116
<p>Returns the last document position inside the frame.</p>
103
117
<p>See also <a href="qtextframe.html#firstPosition">firstPosition</a>(), <a href="qtextframe.html#firstCursorPosition">firstCursorPosition</a>(), and <a href="qtextframe.html#lastCursorPosition">lastCursorPosition</a>().</p>
 
118
<a name="//apple_ref/cpp/instm/QTextFrame/parentFrame" />
104
119
<h3 class="fn"><a name="parentFrame"></a>QTextFrame * QTextFrame::parentFrame () const</h3>
105
120
<p>Returns the frame's parent frame. If the frame is the root frame of a document, this will return 0.</p>
106
121
<p>See also <a href="qtextframe.html#childFrames">childFrames</a>() and <a href="qtextdocument.html#rootFrame">QTextDocument::rootFrame</a>().</p>
 
122
<a name="//apple_ref/cpp/instm/QTextFrame/setFrameFormat" />
107
123
<h3 class="fn"><a name="setFrameFormat"></a>void QTextFrame::setFrameFormat ( const <a href="qtextframeformat.html">QTextFrameFormat</a> &amp; <i>format</i> )</h3>
108
124
<p>Sets the frame's <i>format</i>.</p>
109
125
<p>See also <a href="qtextframe.html#frameFormat">frameFormat</a>().</p>
110
126
<p /><address><hr /><div align="center">
111
127
<table width="100%" cellspacing="0" border="0"><tr class="address">
112
 
<td width="30%" align="left">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies)</td>
113
 
<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>
114
 
<td width="30%" align="right"><div align="right">Qt 4.5.2</div></td>
115
 
</tr></table></div></address></body>
 
128
<td width="40%" align="left">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies)</td>
 
129
<td width="20%" align="center"><a href="trademarks.html">Trademarks</a></td>
 
130
<td width="40%" align="right"><div align="right">Qt 4.6.0</div></td>
 
131
<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>
116
132
</html>