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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
|
<?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" />
<!-- qtextlayout.cpp -->
<title>Qt 4.8: QTextLayout 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>QTextLayout</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-types">Public Types</a></li>
<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">QTextLayout Class Reference</h1>
<!-- $$$QTextLayout-brief -->
<p>The QTextLayout class is used to lay out and render text. <a href="#details">More...</a></p>
<!-- @@@QTextLayout -->
<pre class="cpp"> <span class="preprocessor">#include <QTextLayout></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="qtextlayout-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout-formatrange.html">FormatRange</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#CursorMode-enum">CursorMode</a></b> { SkipCharacters, SkipWords }</td></tr>
</table>
<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="qtextlayout.html#QTextLayout">QTextLayout</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#QTextLayout-2">QTextLayout</a></b> ( const QString & <i>text</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#QTextLayout-3">QTextLayout</a></b> ( const QString & <i>text</i>, const QFont & <i>font</i>, QPaintDevice * <i>paintdevice</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#dtor.QTextLayout">~QTextLayout</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<FormatRange> </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#additionalFormats">additionalFormats</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#beginLayout">beginLayout</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QRectF </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#boundingRect">boundingRect</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#cacheEnabled">cacheEnabled</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#clearAdditionalFormats">clearAdditionalFormats</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#clearLayout">clearLayout</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QTextLine </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#createLine">createLine</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt::CursorMoveStyle </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#cursorMoveStyle">cursorMoveStyle</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#draw">draw</a></b> ( QPainter * <i>p</i>, const QPointF & <i>pos</i>, const QVector<FormatRange> & <i>selections</i> = QVector<FormatRange> (), const QRectF & <i>clip</i> = QRectF() ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#drawCursor">drawCursor</a></b> ( QPainter * <i>painter</i>, const QPointF & <i>position</i>, int <i>cursorPosition</i>, int <i>width</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#drawCursor-2">drawCursor</a></b> ( QPainter * <i>painter</i>, const QPointF & <i>position</i>, int <i>cursorPosition</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#endLayout">endLayout</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QFont </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#font">font</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QGlyphRun> </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#glyphRuns">glyphRuns</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#isValidCursorPosition">isValidCursorPosition</a></b> ( int <i>pos</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#leftCursorPosition">leftCursorPosition</a></b> ( int <i>oldPos</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QTextLine </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#lineAt">lineAt</a></b> ( int <i>i</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#lineCount">lineCount</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QTextLine </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#lineForTextPosition">lineForTextPosition</a></b> ( int <i>pos</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#maximumWidth">maximumWidth</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#minimumWidth">minimumWidth</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#nextCursorPosition">nextCursorPosition</a></b> ( int <i>oldPos</i>, CursorMode <i>mode</i> = SkipCharacters ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPointF </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#position">position</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#preeditAreaPosition">preeditAreaPosition</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#preeditAreaText">preeditAreaText</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#previousCursorPosition">previousCursorPosition</a></b> ( int <i>oldPos</i>, CursorMode <i>mode</i> = SkipCharacters ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#rightCursorPosition">rightCursorPosition</a></b> ( int <i>oldPos</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#setAdditionalFormats">setAdditionalFormats</a></b> ( const QList<FormatRange> & <i>formatList</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#setCacheEnabled">setCacheEnabled</a></b> ( bool <i>enable</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#setCursorMoveStyle">setCursorMoveStyle</a></b> ( Qt::CursorMoveStyle <i>style</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#setFont">setFont</a></b> ( const QFont & <i>font</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#setPosition">setPosition</a></b> ( const QPointF & <i>p</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#setPreeditArea">setPreeditArea</a></b> ( int <i>position</i>, const QString & <i>text</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#setText">setText</a></b> ( const QString & <i>string</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#setTextOption">setTextOption</a></b> ( const QTextOption & <i>option</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#text">text</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QTextOption </td><td class="memItemRight bottomAlign"><b><a href="qtextlayout.html#textOption">textOption</a></b> () const</td></tr>
</table>
<a name="details"></a>
<!-- $$$QTextLayout-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QTextLayout class is used to lay out and render text.</p>
<p>It offers many features expected from a modern text layout engine, including Unicode compliant rendering, line breaking and handling of cursor positioning. It can also produce and render device independent layout, something that is important for WYSIWYG applications.</p>
<p>The class has a rather low level API and unless you intend to implement your own text rendering for some specialized widget, you probably won't need to use it directly.</p>
<p>QTextLayout can be used with both plain and rich text.</p>
<p>QTextLayout can be used to create a sequence of <a href="qtextline.html">QTextLine</a> instances with given widths and can position them independently on the screen. Once the layout is done, these lines can be drawn on a paint device.</p>
<p>The text to be laid out can be provided in the constructor or set with <a href="qtextlayout.html#setText">setText</a>().</p>
<p>The layout can be seen as a sequence of <a href="qtextline.html">QTextLine</a> objects; use <a href="qtextlayout.html#createLine">createLine</a>() to create a <a href="qtextline.html">QTextLine</a> instance, and <a href="qtextlayout.html#lineAt">lineAt</a>() or <a href="qtextlayout.html#lineForTextPosition">lineForTextPosition</a>() to retrieve created lines.</p>
<p>Here is a code snippet that demonstrates the layout phase:</p>
<pre class="cpp"> <span class="type">int</span> leading <span class="operator">=</span> fontMetrics<span class="operator">.</span>leading();
<span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> height <span class="operator">=</span> <span class="number">0</span>;
textLayout<span class="operator">.</span><a href="qtextlayout.html#beginLayout">beginLayout</a>();
<span class="keyword">while</span> (<span class="number">1</span>) {
<span class="type"><a href="qtextline.html">QTextLine</a></span> line <span class="operator">=</span> textLayout<span class="operator">.</span>createLine();
<span class="keyword">if</span> (<span class="operator">!</span>line<span class="operator">.</span>isValid())
<span class="keyword">break</span>;
line<span class="operator">.</span>setLineWidth(lineWidth);
height <span class="operator">+</span><span class="operator">=</span> leading;
line<span class="operator">.</span>setPosition(<span class="type"><a href="qpointf.html">QPointF</a></span>(<span class="number">0</span><span class="operator">,</span> height));
height <span class="operator">+</span><span class="operator">=</span> line<span class="operator">.</span>height();
}
textLayout<span class="operator">.</span><a href="qtextlayout.html#endLayout">endLayout</a>();</pre>
<p>The text can then be rendered by calling the layout's <a href="qtextlayout.html#draw">draw</a>() function:</p>
<pre class="cpp"> <span class="type"><a href="qpainter.html">QPainter</a></span> painter(<span class="keyword">this</span>);
textLayout<span class="operator">.</span><a href="qtextlayout.html#draw">draw</a>(<span class="operator">&</span>painter<span class="operator">,</span> <span class="type"><a href="qpoint.html">QPoint</a></span>(<span class="number">0</span><span class="operator">,</span> <span class="number">0</span>));</pre>
<p>For a given position in the text you can find a valid cursor position with <a href="qtextlayout.html#isValidCursorPosition">isValidCursorPosition</a>(), <a href="qtextlayout.html#nextCursorPosition">nextCursorPosition</a>(), and <a href="qtextlayout.html#previousCursorPosition">previousCursorPosition</a>().</p>
<p>The QTextLayout itself can be positioned with <a href="qtextlayout.html#setPosition">setPosition</a>(); it has a <a href="qtextlayout.html#boundingRect">boundingRect</a>(), and a <a href="qtextlayout.html#minimumWidth">minimumWidth</a>() and a <a href="qtextlayout.html#maximumWidth">maximumWidth</a>().</p>
</div>
<p><b>See also </b><a href="qstatictext.html">QStaticText</a>.</p>
<!-- @@@QTextLayout -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$CursorMode$$$SkipCharacters$$$SkipWords -->
<h3 class="fn"><a name="CursorMode-enum"></a>enum QTextLayout::<span class="name">CursorMode</span></h3>
<table class="valuelist"><tr><th class="tblConst">Constant</th><th class="tblVal">Value</th></tr>
<tr><td class="topAlign"><tt>QTextLayout::SkipCharacters</tt></td><td class="topAlign"><tt>0</tt></td></tr>
<tr><td class="topAlign"><tt>QTextLayout::SkipWords</tt></td><td class="topAlign"><tt>1</tt></td></tr>
</table>
<!-- @@@CursorMode -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QTextLayout[overload1]$$$QTextLayout -->
<h3 class="fn"><a name="QTextLayout"></a>QTextLayout::<span class="name">QTextLayout</span> ()</h3>
<p>Constructs an empty text layout.</p>
<p><b>See also </b><a href="qtextlayout.html#setText">setText</a>().</p>
<!-- @@@QTextLayout -->
<!-- $$$QTextLayout$$$QTextLayoutconstQString& -->
<h3 class="fn"><a name="QTextLayout-2"></a>QTextLayout::<span class="name">QTextLayout</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>text</i> )</h3>
<p>Constructs a text layout to lay out the given <i>text</i>.</p>
<!-- @@@QTextLayout -->
<!-- $$$QTextLayout$$$QTextLayoutconstQString&constQFont&QPaintDevice* -->
<h3 class="fn"><a name="QTextLayout-3"></a>QTextLayout::<span class="name">QTextLayout</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>text</i>, const <span class="type"><a href="qfont.html">QFont</a></span> & <i>font</i>, <span class="type"><a href="qpaintdevice.html">QPaintDevice</a></span> * <i>paintdevice</i> = 0 )</h3>
<p>Constructs a text layout to lay out the given <i>text</i> with the specified <i>font</i>.</p>
<p>All the metric and layout calculations will be done in terms of the paint device, <i>paintdevice</i>. If <i>paintdevice</i> is 0 the calculations will be done in screen metrics.</p>
<!-- @@@QTextLayout -->
<!-- $$$~QTextLayout[overload1]$$$~QTextLayout -->
<h3 class="fn"><a name="dtor.QTextLayout"></a>QTextLayout::<span class="name">~QTextLayout</span> ()</h3>
<p>Destructs the layout.</p>
<!-- @@@~QTextLayout -->
<!-- $$$additionalFormats[overload1]$$$additionalFormats -->
<h3 class="fn"><a name="additionalFormats"></a><span class="type"><a href="qlist.html">QList</a></span><<span class="type"><a href="qtextlayout-formatrange.html">FormatRange</a></span>> QTextLayout::<span class="name">additionalFormats</span> () const</h3>
<p>Returns the list of additional formats supported by the text layout.</p>
<p><b>See also </b><a href="qtextlayout.html#setAdditionalFormats">setAdditionalFormats</a>() and <a href="qtextlayout.html#clearAdditionalFormats">clearAdditionalFormats</a>().</p>
<!-- @@@additionalFormats -->
<!-- $$$beginLayout[overload1]$$$beginLayout -->
<h3 class="fn"><a name="beginLayout"></a><span class="type">void</span> QTextLayout::<span class="name">beginLayout</span> ()</h3>
<p>Begins the layout process.</p>
<p><b>See also </b><a href="qtextlayout.html#endLayout">endLayout</a>().</p>
<!-- @@@beginLayout -->
<!-- $$$boundingRect[overload1]$$$boundingRect -->
<h3 class="fn"><a name="boundingRect"></a><span class="type"><a href="qrectf.html">QRectF</a></span> QTextLayout::<span class="name">boundingRect</span> () const</h3>
<p>The smallest rectangle that contains all the lines in the layout.</p>
<!-- @@@boundingRect -->
<!-- $$$cacheEnabled[overload1]$$$cacheEnabled -->
<h3 class="fn"><a name="cacheEnabled"></a><span class="type">bool</span> QTextLayout::<span class="name">cacheEnabled</span> () const</h3>
<p>Returns true if the complete layout information is cached; otherwise returns false.</p>
<p><b>See also </b><a href="qtextlayout.html#setCacheEnabled">setCacheEnabled</a>().</p>
<!-- @@@cacheEnabled -->
<!-- $$$clearAdditionalFormats[overload1]$$$clearAdditionalFormats -->
<h3 class="fn"><a name="clearAdditionalFormats"></a><span class="type">void</span> QTextLayout::<span class="name">clearAdditionalFormats</span> ()</h3>
<p>Clears the list of additional formats supported by the text layout.</p>
<p><b>See also </b><a href="qtextlayout.html#additionalFormats">additionalFormats</a>() and <a href="qtextlayout.html#setAdditionalFormats">setAdditionalFormats</a>().</p>
<!-- @@@clearAdditionalFormats -->
<!-- $$$clearLayout[overload1]$$$clearLayout -->
<h3 class="fn"><a name="clearLayout"></a><span class="type">void</span> QTextLayout::<span class="name">clearLayout</span> ()</h3>
<p>Clears the line information in the layout. After having called this function, <a href="qtextlayout.html#lineCount">lineCount</a>() returns 0.</p>
<p>This function was introduced in Qt 4.4.</p>
<!-- @@@clearLayout -->
<!-- $$$createLine[overload1]$$$createLine -->
<h3 class="fn"><a name="createLine"></a><span class="type"><a href="qtextline.html">QTextLine</a></span> QTextLayout::<span class="name">createLine</span> ()</h3>
<p>Returns a new text line to be laid out if there is text to be inserted into the layout; otherwise returns an invalid text line.</p>
<p>The text layout creates a new line object that starts after the last line in the layout, or at the beginning if the layout is empty. The layout maintains an internal cursor, and each line is filled with text from the cursor position onwards when the <a href="qtextline.html#setLineWidth">QTextLine::setLineWidth</a>() function is called.</p>
<p>Once <a href="qtextline.html#setLineWidth">QTextLine::setLineWidth</a>() is called, a new line can be created and filled with text. Repeating this process will lay out the whole block of text contained in the <a href="qtextlayout.html">QTextLayout</a>. If there is no text left to be inserted into the layout, the <a href="qtextline.html">QTextLine</a> returned will not be valid (isValid() will return false).</p>
<!-- @@@createLine -->
<!-- $$$cursorMoveStyle[overload1]$$$cursorMoveStyle -->
<h3 class="fn"><a name="cursorMoveStyle"></a><span class="type"><a href="qt.html#CursorMoveStyle-enum">Qt::CursorMoveStyle</a></span> QTextLayout::<span class="name">cursorMoveStyle</span> () const</h3>
<p>The cursor movement style of this <a href="qtextlayout.html">QTextLayout</a>. The default is <a href="qt.html#CursorMoveStyle-enum">Qt::LogicalMoveStyle</a>.</p>
<p>This function was introduced in Qt 4.8.</p>
<p><b>See also </b><a href="qtextlayout.html#setCursorMoveStyle">setCursorMoveStyle</a>().</p>
<!-- @@@cursorMoveStyle -->
<!-- $$$draw[overload1]$$$drawQPainter*constQPointF&constQVector<FormatRange>&constQRectF& -->
<h3 class="fn"><a name="draw"></a><span class="type">void</span> QTextLayout::<span class="name">draw</span> ( <span class="type"><a href="qpainter.html">QPainter</a></span> * <i>p</i>, const <span class="type"><a href="qpointf.html">QPointF</a></span> & <i>pos</i>, const <span class="type"><a href="qvector.html">QVector</a></span><<span class="type"><a href="qtextlayout-formatrange.html">FormatRange</a></span>> & <i>selections</i> = QVector<FormatRange> (), const <span class="type"><a href="qrectf.html">QRectF</a></span> & <i>clip</i> = QRectF() ) const</h3>
<p>Draws the whole layout on the painter <i>p</i> at the position specified by <i>pos</i>. The rendered layout includes the given <i>selections</i> and is clipped within the rectangle specified by <i>clip</i>.</p>
<!-- @@@draw -->
<!-- $$$drawCursor[overload1]$$$drawCursorQPainter*constQPointF&intint -->
<h3 class="fn"><a name="drawCursor"></a><span class="type">void</span> QTextLayout::<span class="name">drawCursor</span> ( <span class="type"><a href="qpainter.html">QPainter</a></span> * <i>painter</i>, const <span class="type"><a href="qpointf.html">QPointF</a></span> & <i>position</i>, <span class="type">int</span> <i>cursorPosition</i>, <span class="type">int</span> <i>width</i> ) const</h3>
<p>Draws a text cursor with the current pen and the specified <i>width</i> at the given <i>position</i> using the <i>painter</i> specified. The corresponding position within the text is specified by <i>cursorPosition</i>.</p>
<!-- @@@drawCursor -->
<!-- $$$drawCursor$$$drawCursorQPainter*constQPointF&int -->
<h3 class="fn"><a name="drawCursor-2"></a><span class="type">void</span> QTextLayout::<span class="name">drawCursor</span> ( <span class="type"><a href="qpainter.html">QPainter</a></span> * <i>painter</i>, const <span class="type"><a href="qpointf.html">QPointF</a></span> & <i>position</i>, <span class="type">int</span> <i>cursorPosition</i> ) const</h3>
<p>This is an overloaded function.</p>
<p>Draws a text cursor with the current pen at the given <i>position</i> using the <i>painter</i> specified. The corresponding position within the text is specified by <i>cursorPosition</i>.</p>
<!-- @@@drawCursor -->
<!-- $$$endLayout[overload1]$$$endLayout -->
<h3 class="fn"><a name="endLayout"></a><span class="type">void</span> QTextLayout::<span class="name">endLayout</span> ()</h3>
<p>Ends the layout process.</p>
<p><b>See also </b><a href="qtextlayout.html#beginLayout">beginLayout</a>().</p>
<!-- @@@endLayout -->
<!-- $$$font[overload1]$$$font -->
<h3 class="fn"><a name="font"></a><span class="type"><a href="qfont.html">QFont</a></span> QTextLayout::<span class="name">font</span> () const</h3>
<p>Returns the current font that is used for the layout, or a default font if none is set.</p>
<p><b>See also </b><a href="qtextlayout.html#setFont">setFont</a>().</p>
<!-- @@@font -->
<!-- $$$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>> QTextLayout::<span class="name">glyphRuns</span> () const</h3>
<p>Returns the glyph indexes and positions for all glyphs in this <a href="qtextlayout.html">QTextLayout</a>. This is an expensive function, and should not be called in a time sensitive context.</p>
<p>This function was introduced in Qt 4.8.</p>
<p><b>See also </b><a href="qtextlayout.html#draw">draw</a>() and <a href="qpainter.html#drawGlyphRun">QPainter::drawGlyphRun</a>().</p>
<!-- @@@glyphRuns -->
<!-- $$$isValidCursorPosition[overload1]$$$isValidCursorPositionint -->
<h3 class="fn"><a name="isValidCursorPosition"></a><span class="type">bool</span> QTextLayout::<span class="name">isValidCursorPosition</span> ( <span class="type">int</span> <i>pos</i> ) const</h3>
<p>/ Returns true if position <i>pos</i> is a valid cursor position.</p>
<p>In a Unicode context some positions in the text are not valid cursor positions, because the position is inside a Unicode surrogate or a grapheme cluster.</p>
<p>A grapheme cluster is a sequence of two or more Unicode characters that form one indivisible entity on the screen. For example the latin character `Ä' can be represented in Unicode by two characters, `A' (0x41), and the combining diaresis (0x308). A text cursor can only validly be positioned before or after these two characters, never between them since that wouldn't make sense. In indic languages every syllable forms a grapheme cluster.</p>
<!-- @@@isValidCursorPosition -->
<!-- $$$leftCursorPosition[overload1]$$$leftCursorPositionint -->
<h3 class="fn"><a name="leftCursorPosition"></a><span class="type">int</span> QTextLayout::<span class="name">leftCursorPosition</span> ( <span class="type">int</span> <i>oldPos</i> ) const</h3>
<p>Returns the cursor position to the left of <i>oldPos</i>, next to it. The position is dependent on the visual position of characters, after bi-directional reordering.</p>
<p>This function was introduced in Qt 4.8.</p>
<p><b>See also </b><a href="qtextlayout.html#rightCursorPosition">rightCursorPosition</a>() and <a href="qtextlayout.html#previousCursorPosition">previousCursorPosition</a>().</p>
<!-- @@@leftCursorPosition -->
<!-- $$$lineAt[overload1]$$$lineAtint -->
<h3 class="fn"><a name="lineAt"></a><span class="type"><a href="qtextline.html">QTextLine</a></span> QTextLayout::<span class="name">lineAt</span> ( <span class="type">int</span> <i>i</i> ) const</h3>
<p>Returns the <i>i</i>-th line of text in this text layout.</p>
<p><b>See also </b><a href="qtextlayout.html#lineCount">lineCount</a>() and <a href="qtextlayout.html#lineForTextPosition">lineForTextPosition</a>().</p>
<!-- @@@lineAt -->
<!-- $$$lineCount[overload1]$$$lineCount -->
<h3 class="fn"><a name="lineCount"></a><span class="type">int</span> QTextLayout::<span class="name">lineCount</span> () const</h3>
<p>Returns the number of lines in this text layout.</p>
<p><b>See also </b><a href="qtextlayout.html#lineAt">lineAt</a>().</p>
<!-- @@@lineCount -->
<!-- $$$lineForTextPosition[overload1]$$$lineForTextPositionint -->
<h3 class="fn"><a name="lineForTextPosition"></a><span class="type"><a href="qtextline.html">QTextLine</a></span> QTextLayout::<span class="name">lineForTextPosition</span> ( <span class="type">int</span> <i>pos</i> ) const</h3>
<p>Returns the line that contains the cursor position specified by <i>pos</i>.</p>
<p><b>See also </b><a href="qtextlayout.html#isValidCursorPosition">isValidCursorPosition</a>() and <a href="qtextlayout.html#lineAt">lineAt</a>().</p>
<!-- @@@lineForTextPosition -->
<!-- $$$maximumWidth[overload1]$$$maximumWidth -->
<h3 class="fn"><a name="maximumWidth"></a><span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> QTextLayout::<span class="name">maximumWidth</span> () const</h3>
<p>The maximum width the layout could expand to; this is essentially the width of the entire text.</p>
<p><b>Warning:</b> This function only returns a valid value after the layout has been done.</p>
<p><b>See also </b><a href="qtextlayout.html#minimumWidth">minimumWidth</a>().</p>
<!-- @@@maximumWidth -->
<!-- $$$minimumWidth[overload1]$$$minimumWidth -->
<h3 class="fn"><a name="minimumWidth"></a><span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> QTextLayout::<span class="name">minimumWidth</span> () const</h3>
<p>The minimum width the layout needs. This is the width of the layout's smallest non-breakable substring.</p>
<p><b>Warning:</b> This function only returns a valid value after the layout has been done.</p>
<p><b>See also </b><a href="qtextlayout.html#maximumWidth">maximumWidth</a>().</p>
<!-- @@@minimumWidth -->
<!-- $$$nextCursorPosition[overload1]$$$nextCursorPositionintCursorMode -->
<h3 class="fn"><a name="nextCursorPosition"></a><span class="type">int</span> QTextLayout::<span class="name">nextCursorPosition</span> ( <span class="type">int</span> <i>oldPos</i>, <span class="type"><a href="qtextlayout.html#CursorMode-enum">CursorMode</a></span> <i>mode</i> = SkipCharacters ) const</h3>
<p>Returns the next valid cursor position after <i>oldPos</i> that respects the given cursor <i>mode</i>. Returns value of <i>oldPos</i>, if <i>oldPos</i> is not a valid cursor position.</p>
<p><b>See also </b><a href="qtextlayout.html#isValidCursorPosition">isValidCursorPosition</a>() and <a href="qtextlayout.html#previousCursorPosition">previousCursorPosition</a>().</p>
<!-- @@@nextCursorPosition -->
<!-- $$$position[overload1]$$$position -->
<h3 class="fn"><a name="position"></a><span class="type"><a href="qpointf.html">QPointF</a></span> QTextLayout::<span class="name">position</span> () const</h3>
<p>The global position of the layout. This is independent of the bounding rectangle and of the layout process.</p>
<p>This function was introduced in Qt 4.2.</p>
<p><b>See also </b><a href="qtextlayout.html#setPosition">setPosition</a>().</p>
<!-- @@@position -->
<!-- $$$preeditAreaPosition[overload1]$$$preeditAreaPosition -->
<h3 class="fn"><a name="preeditAreaPosition"></a><span class="type">int</span> QTextLayout::<span class="name">preeditAreaPosition</span> () const</h3>
<p>Returns the position of the area in the text layout that will be processed before editing occurs.</p>
<p><b>See also </b><a href="qtextlayout.html#preeditAreaText">preeditAreaText</a>().</p>
<!-- @@@preeditAreaPosition -->
<!-- $$$preeditAreaText[overload1]$$$preeditAreaText -->
<h3 class="fn"><a name="preeditAreaText"></a><span class="type"><a href="qstring.html">QString</a></span> QTextLayout::<span class="name">preeditAreaText</span> () const</h3>
<p>Returns the text that is inserted in the layout before editing occurs.</p>
<p><b>See also </b><a href="qtextlayout.html#preeditAreaPosition">preeditAreaPosition</a>().</p>
<!-- @@@preeditAreaText -->
<!-- $$$previousCursorPosition[overload1]$$$previousCursorPositionintCursorMode -->
<h3 class="fn"><a name="previousCursorPosition"></a><span class="type">int</span> QTextLayout::<span class="name">previousCursorPosition</span> ( <span class="type">int</span> <i>oldPos</i>, <span class="type"><a href="qtextlayout.html#CursorMode-enum">CursorMode</a></span> <i>mode</i> = SkipCharacters ) const</h3>
<p>Returns the first valid cursor position before <i>oldPos</i> that respects the given cursor <i>mode</i>. Returns value of <i>oldPos</i>, if <i>oldPos</i> is not a valid cursor position.</p>
<p><b>See also </b><a href="qtextlayout.html#isValidCursorPosition">isValidCursorPosition</a>() and <a href="qtextlayout.html#nextCursorPosition">nextCursorPosition</a>().</p>
<!-- @@@previousCursorPosition -->
<!-- $$$rightCursorPosition[overload1]$$$rightCursorPositionint -->
<h3 class="fn"><a name="rightCursorPosition"></a><span class="type">int</span> QTextLayout::<span class="name">rightCursorPosition</span> ( <span class="type">int</span> <i>oldPos</i> ) const</h3>
<p>Returns the cursor position to the right of <i>oldPos</i>, next to it. The position is dependent on the visual position of characters, after bi-directional reordering.</p>
<p>This function was introduced in Qt 4.8.</p>
<p><b>See also </b><a href="qtextlayout.html#leftCursorPosition">leftCursorPosition</a>() and <a href="qtextlayout.html#nextCursorPosition">nextCursorPosition</a>().</p>
<!-- @@@rightCursorPosition -->
<!-- $$$setAdditionalFormats[overload1]$$$setAdditionalFormatsconstQList<FormatRange>& -->
<h3 class="fn"><a name="setAdditionalFormats"></a><span class="type">void</span> QTextLayout::<span class="name">setAdditionalFormats</span> ( const <span class="type"><a href="qlist.html">QList</a></span><<span class="type"><a href="qtextlayout-formatrange.html">FormatRange</a></span>> & <i>formatList</i> )</h3>
<p>Sets the additional formats supported by the text layout to <i>formatList</i>.</p>
<p><b>See also </b><a href="qtextlayout.html#additionalFormats">additionalFormats</a>() and <a href="qtextlayout.html#clearAdditionalFormats">clearAdditionalFormats</a>().</p>
<!-- @@@setAdditionalFormats -->
<!-- $$$setCacheEnabled[overload1]$$$setCacheEnabledbool -->
<h3 class="fn"><a name="setCacheEnabled"></a><span class="type">void</span> QTextLayout::<span class="name">setCacheEnabled</span> ( <span class="type">bool</span> <i>enable</i> )</h3>
<p>Enables caching of the complete layout information if <i>enable</i> is true; otherwise disables layout caching. Usually <a href="qtextlayout.html">QTextLayout</a> throws most of the layouting information away after a call to <a href="qtextlayout.html#endLayout">endLayout</a>() to reduce memory consumption. If you however want to draw the laid out text directly afterwards enabling caching might speed up drawing significantly.</p>
<p><b>See also </b><a href="qtextlayout.html#cacheEnabled">cacheEnabled</a>().</p>
<!-- @@@setCacheEnabled -->
<!-- $$$setCursorMoveStyle[overload1]$$$setCursorMoveStyleQt::CursorMoveStyle -->
<h3 class="fn"><a name="setCursorMoveStyle"></a><span class="type">void</span> QTextLayout::<span class="name">setCursorMoveStyle</span> ( <span class="type"><a href="qt.html#CursorMoveStyle-enum">Qt::CursorMoveStyle</a></span> <i>style</i> )</h3>
<p>Set the cursor movement style. If the <a href="qtextlayout.html">QTextLayout</a> is backed by a document, you can ignore this and use the option in <a href="qtextdocument.html">QTextDocument</a>, this option is for widgets like <a href="qlineedit.html">QLineEdit</a> or custom widgets without a <a href="qtextdocument.html">QTextDocument</a>. Default value is <a href="qt.html#CursorMoveStyle-enum">Qt::LogicalMoveStyle</a>.</p>
<p>This function was introduced in Qt 4.8.</p>
<p><b>See also </b><a href="qtextlayout.html#cursorMoveStyle">cursorMoveStyle</a>().</p>
<!-- @@@setCursorMoveStyle -->
<!-- $$$setFont[overload1]$$$setFontconstQFont& -->
<h3 class="fn"><a name="setFont"></a><span class="type">void</span> QTextLayout::<span class="name">setFont</span> ( const <span class="type"><a href="qfont.html">QFont</a></span> & <i>font</i> )</h3>
<p>Sets the layout's font to the given <i>font</i>. The layout is invalidated and must be laid out again.</p>
<p><b>See also </b><a href="qtextlayout.html#font">font</a>().</p>
<!-- @@@setFont -->
<!-- $$$setPosition[overload1]$$$setPositionconstQPointF& -->
<h3 class="fn"><a name="setPosition"></a><span class="type">void</span> QTextLayout::<span class="name">setPosition</span> ( const <span class="type"><a href="qpointf.html">QPointF</a></span> & <i>p</i> )</h3>
<p>Moves the text layout to point <i>p</i>.</p>
<p><b>See also </b><a href="qtextlayout.html#position">position</a>().</p>
<!-- @@@setPosition -->
<!-- $$$setPreeditArea[overload1]$$$setPreeditAreaintconstQString& -->
<h3 class="fn"><a name="setPreeditArea"></a><span class="type">void</span> QTextLayout::<span class="name">setPreeditArea</span> ( <span class="type">int</span> <i>position</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>text</i> )</h3>
<p>Sets the <i>position</i> and <i>text</i> of the area in the layout that is processed before editing occurs.</p>
<p><b>See also </b><a href="qtextlayout.html#preeditAreaPosition">preeditAreaPosition</a>() and <a href="qtextlayout.html#preeditAreaText">preeditAreaText</a>().</p>
<!-- @@@setPreeditArea -->
<!-- $$$setText[overload1]$$$setTextconstQString& -->
<h3 class="fn"><a name="setText"></a><span class="type">void</span> QTextLayout::<span class="name">setText</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>string</i> )</h3>
<p>Sets the layout's text to the given <i>string</i>. The layout is invalidated and must be laid out again.</p>
<p>Notice that when using this <a href="qtextlayout.html">QTextLayout</a> as part of a <a href="qtextdocument.html">QTextDocument</a> this method will have no effect.</p>
<p><b>See also </b><a href="qtextlayout.html#text">text</a>().</p>
<!-- @@@setText -->
<!-- $$$setTextOption[overload1]$$$setTextOptionconstQTextOption& -->
<h3 class="fn"><a name="setTextOption"></a><span class="type">void</span> QTextLayout::<span class="name">setTextOption</span> ( const <span class="type"><a href="qtextoption.html">QTextOption</a></span> & <i>option</i> )</h3>
<p>Sets the text option structure that controls the layout process to the given <i>option</i>.</p>
<p><b>See also </b><a href="qtextlayout.html#textOption">textOption</a>().</p>
<!-- @@@setTextOption -->
<!-- $$$text[overload1]$$$text -->
<h3 class="fn"><a name="text"></a><span class="type"><a href="qstring.html">QString</a></span> QTextLayout::<span class="name">text</span> () const</h3>
<p>Returns the layout's text.</p>
<p><b>See also </b><a href="qtextlayout.html#setText">setText</a>().</p>
<!-- @@@text -->
<!-- $$$textOption[overload1]$$$textOption -->
<h3 class="fn"><a name="textOption"></a><span class="type"><a href="qtextoption.html">QTextOption</a></span> QTextLayout::<span class="name">textOption</span> () const</h3>
<p>Returns the current text option used to control the layout process.</p>
<p><b>See also </b><a href="qtextlayout.html#setTextOption">setTextOption</a>().</p>
<!-- @@@textOption -->
</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>
|
