1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
<?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" />
<!-- qtextobject.cpp -->
<title>Qt 4.8: QTextFragment Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="content">
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
</div>
<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><a href="qtgui.html">QtGui</a></li>
<li>QTextFragment</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">QTextFragment Class Reference</h1>
<!-- $$$QTextFragment-brief -->
<p>The QTextFragment class holds a piece of text in a <a href="qtextdocument.html">QTextDocument</a> with a single <a href="qtextcharformat.html">QTextCharFormat</a>. <a href="#details">More...</a></p>
<!-- @@@QTextFragment -->
<pre class="cpp"> <span class="preprocessor">#include <QTextFragment></span></pre><p><b>Note:</b> All functions in this class are <a href="threads-reentrancy.html#reentrant">reentrant</a>.</p>
<ul>
<li><a href="qtextfragment-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="qtextfragment.html#QTextFragment">QTextFragment</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qtextfragment.html#QTextFragment-3">QTextFragment</a></b> ( const QTextFragment & <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QTextCharFormat </td><td class="memItemRight bottomAlign"><b><a href="qtextfragment.html#charFormat">charFormat</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtextfragment.html#charFormatIndex">charFormatIndex</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtextfragment.html#contains">contains</a></b> ( int <i>position</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QGlyphRun> </td><td class="memItemRight bottomAlign"><b><a href="qtextfragment.html#glyphRuns">glyphRuns</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtextfragment.html#isValid">isValid</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtextfragment.html#length">length</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtextfragment.html#position">position</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qtextfragment.html#text">text</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtextfragment.html#operator-not-eq">operator!=</a></b> ( const QTextFragment & <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtextfragment.html#operator-lt">operator<</a></b> ( const QTextFragment & <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QTextFragment & </td><td class="memItemRight bottomAlign"><b><a href="qtextfragment.html#operator-eq">operator=</a></b> ( const QTextFragment & <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtextfragment.html#operator-eq-eq">operator==</a></b> ( const QTextFragment & <i>other</i> ) const</td></tr>
</table>
<a name="details"></a>
<!-- $$$QTextFragment-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QTextFragment class holds a piece of text in a <a href="qtextdocument.html">QTextDocument</a> with a single <a href="qtextcharformat.html">QTextCharFormat</a>.</p>
<p>A text fragment describes a piece of text that is stored with a single character format. Text in which the character format changes can be represented by sequences of text fragments with different formats.</p>
<p>If the user edits the text in a fragment and introduces a different character format, the fragment's text will be split at each point where the format changes, and new fragments will be created. For example, changing the style of some text in the middle of a sentence will cause the fragment to be broken into three separate fragments: the first and third with the same format as before, and the second with the new style. The first fragment will contain the text from the beginning of the sentence, the second will contain the text from the middle, and the third takes the text from the end of the sentence.</p>
<p class="centerAlign"><img src="images/qtextfragment-split.png" alt="" /></p><p>A fragment's text and character format can be obtained with the <a href="qtextfragment.html#text">text</a>() and <a href="qtextfragment.html#charFormat">charFormat</a>() functions. The <a href="qtextfragment.html#length">length</a>() function gives the length of the text in the fragment. <a href="qtextfragment.html#position">position</a>() gives the position in the document of the start of the fragment. To determine whether the fragment contains a particular position within the document, use the <a href="qtextfragment.html#contains">contains</a>() function.</p>
</div>
<p><b>See also </b><a href="qtextdocument.html">QTextDocument</a> and <a href="richtext-structure.html">Rich Text Document Structure</a>.</p>
<!-- @@@QTextFragment -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QTextFragment[overload1]$$$QTextFragment -->
<h3 class="fn"><a name="QTextFragment"></a>QTextFragment::<span class="name">QTextFragment</span> ()</h3>
<p>Creates a new empty text fragment.</p>
<!-- @@@QTextFragment -->
<!-- $$$QTextFragment$$$QTextFragmentconstQTextFragment& -->
<h3 class="fn"><a name="QTextFragment-3"></a>QTextFragment::<span class="name">QTextFragment</span> ( const <span class="type">QTextFragment</span> & <i>other</i> )</h3>
<p>Copies the content (text and format) of the <i>other</i> text fragment to this text fragment.</p>
<!-- @@@QTextFragment -->
<!-- $$$charFormat[overload1]$$$charFormat -->
<h3 class="fn"><a name="charFormat"></a><span class="type"><a href="qtextcharformat.html">QTextCharFormat</a></span> QTextFragment::<span class="name">charFormat</span> () const</h3>
<p>Returns the text fragment's character format.</p>
<p><b>See also </b><a href="qtextfragment.html#text">text</a>().</p>
<!-- @@@charFormat -->
<!-- $$$charFormatIndex[overload1]$$$charFormatIndex -->
<h3 class="fn"><a name="charFormatIndex"></a><span class="type">int</span> QTextFragment::<span class="name">charFormatIndex</span> () const</h3>
<p>Returns an index into the document's internal list of character formats for the text fragment's character format.</p>
<p><b>See also </b><a href="qtextdocument.html#allFormats">QTextDocument::allFormats</a>().</p>
<!-- @@@charFormatIndex -->
<!-- $$$contains[overload1]$$$containsint -->
<h3 class="fn"><a name="contains"></a><span class="type">bool</span> QTextFragment::<span class="name">contains</span> ( <span class="type">int</span> <i>position</i> ) const</h3>
<p>Returns true if the text fragment contains the text at the given <i>position</i> in the document; otherwise returns false.</p>
<!-- @@@contains -->
<!-- $$$glyphRuns[overload1]$$$glyphRuns -->
<h3 class="fn"><a name="glyphRuns"></a><span class="type"><a href="qlist.html">QList</a></span><<span class="type"><a href="qglyphrun.html">QGlyphRun</a></span>> QTextFragment::<span class="name">glyphRuns</span> () const</h3>
<p>Returns the glyphs of this text fragment. The positions of the glyphs are relative to the position of the <a href="qtextblock.html">QTextBlock</a>'s layout.</p>
<p><b>See also </b><a href="qglyphrun.html">QGlyphRun</a>, <a href="qtextblock.html#layout">QTextBlock::layout</a>(), <a href="qtextlayout.html#position">QTextLayout::position</a>(), and <a href="qpainter.html#drawGlyphRun">QPainter::drawGlyphRun</a>().</p>
<!-- @@@glyphRuns -->
<!-- $$$isValid[overload1]$$$isValid -->
<h3 class="fn"><a name="isValid"></a><span class="type">bool</span> QTextFragment::<span class="name">isValid</span> () const</h3>
<p>Returns true if this is a valid text fragment (i.e. has a valid position in a document); otherwise returns false.</p>
<!-- @@@isValid -->
<!-- $$$length[overload1]$$$length -->
<h3 class="fn"><a name="length"></a><span class="type">int</span> QTextFragment::<span class="name">length</span> () const</h3>
<p>Returns the number of characters in the text fragment.</p>
<p><b>See also </b><a href="qtextfragment.html#text">text</a>().</p>
<!-- @@@length -->
<!-- $$$position[overload1]$$$position -->
<h3 class="fn"><a name="position"></a><span class="type">int</span> QTextFragment::<span class="name">position</span> () const</h3>
<p>Returns the position of this text fragment in the document.</p>
<!-- @@@position -->
<!-- $$$text[overload1]$$$text -->
<h3 class="fn"><a name="text"></a><span class="type"><a href="qstring.html">QString</a></span> QTextFragment::<span class="name">text</span> () const</h3>
<p>Returns the text fragment's as plain text.</p>
<p><b>See also </b><a href="qtextfragment.html#length">length</a>() and <a href="qtextfragment.html#charFormat">charFormat</a>().</p>
<!-- @@@text -->
<!-- $$$operator!=[overload1]$$$operator!=constQTextFragment& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QTextFragment::<span class="name">operator!=</span> ( const <span class="type">QTextFragment</span> & <i>other</i> ) const</h3>
<p>Returns true if this text fragment is different (at a different position) from the <i>other</i> text fragment; otherwise returns false.</p>
<!-- @@@operator!= -->
<!-- $$$operator<[overload1]$$$operator<constQTextFragment& -->
<h3 class="fn"><a name="operator-lt"></a><span class="type">bool</span> QTextFragment::<span class="name">operator<</span> ( const <span class="type">QTextFragment</span> & <i>other</i> ) const</h3>
<p>Returns true if this text fragment appears earlier in the document than the <i>other</i> text fragment; otherwise returns false.</p>
<!-- @@@operator< -->
<!-- $$$operator=[overload1]$$$operator=constQTextFragment& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QTextFragment</span> & QTextFragment::<span class="name">operator=</span> ( const <span class="type">QTextFragment</span> & <i>other</i> )</h3>
<p>Assigns the content (text and format) of the <i>other</i> text fragment to this text fragment.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQTextFragment& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QTextFragment::<span class="name">operator==</span> ( const <span class="type">QTextFragment</span> & <i>other</i> ) const</h3>
<p>Returns true if this text fragment is the same (at the same position) as the <i>other</i> text fragment; otherwise returns false.</p>
<!-- @@@operator== -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2012 Nokia Corporation and/or its
subsidiaries. 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>
Nokia, Qt and their respective logos are trademarks of Nokia Corporation
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>
</body>
</html>
|
