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
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html><head><title>QTextFormat Class Reference</title><style>h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
td.postheader { font-family: sans-serif }
tr.address { font-family: sans-serif }
body { background: #ffffff; color: black; }
</style></head><body><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr /><td align="left" valign="top" width="32"><img align="left" border="0" height="32" src="images/rb-logo.png" width="32" /></td><td width="1">  </td><td class="postheader" valign="center"><a href="../pyqt4ref.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="modules.html"><font color="#004faf">Modules</font></a></td></table><h1 align="center">QTextFormat Class Reference<br /><sup><sup>[<a href="qtgui.html">QtGui</a> module]</sup></sup></h1><p>The QTextFormat class provides formatting information for a <a href="qtextdocument.html">QTextDocument</a>. <a href="#details">More...</a></p>
<p>Inherited by <a href="qtextblockformat.html">QTextBlockFormat</a>, <a href="qtextcharformat.html">QTextCharFormat</a>, <a href="qtextframeformat.html">QTextFrameFormat</a> and <a href="qtextlistformat.html">QTextListFormat</a>.</p><h3>Types</h3><ul><li><div class="fn" />enum <b><a href="qtextformat.html#FormatType-enum">FormatType</a></b> { InvalidFormat, BlockFormat, CharFormat, ListFormat, ..., UserFormat }</li><li><div class="fn" />enum <b><a href="qtextformat.html#ObjectTypes-enum">ObjectTypes</a></b> { NoObject, ImageObject, TableObject, UserObject }</li><li><div class="fn" />enum <b><a href="qtextformat.html#Property-enum">Property</a></b> { ObjectIndex, CssFloat, LayoutDirection, OutlinePen, ..., UserProperty }</li></ul><h3>Methods</h3><ul><li><div class="fn" /><b><a href="qtextformat.html#QTextFormat">__init__</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qtextformat.html#QTextFormat-2">__init__</a></b> (<i>self</i>, int <i>type</i>)</li><li><div class="fn" /><b><a href="qtextformat.html#QTextFormat-3">__init__</a></b> (<i>self</i>, QTextFormat <i>rhs</i>)</li><li><div class="fn" /><b><a href="qtextformat.html#QTextFormat-4">__init__</a></b> (<i>self</i>, QVariant)</li><li><div class="fn" />QBrush <b><a href="qtextformat.html#background">background</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qtextformat.html#boolProperty">boolProperty</a></b> (<i>self</i>, int <i>propertyId</i>)</li><li><div class="fn" />QBrush <b><a href="qtextformat.html#brushProperty">brushProperty</a></b> (<i>self</i>, int <i>propertyId</i>)</li><li><div class="fn" /><b><a href="qtextformat.html#clearBackground">clearBackground</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qtextformat.html#clearForeground">clearForeground</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qtextformat.html#clearProperty">clearProperty</a></b> (<i>self</i>, int <i>propertyId</i>)</li><li><div class="fn" />QColor <b><a href="qtextformat.html#colorProperty">colorProperty</a></b> (<i>self</i>, int <i>propertyId</i>)</li><li><div class="fn" />float <b><a href="qtextformat.html#doubleProperty">doubleProperty</a></b> (<i>self</i>, int <i>propertyId</i>)</li><li><div class="fn" />QBrush <b><a href="qtextformat.html#foreground">foreground</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qtextformat.html#hasProperty">hasProperty</a></b> (<i>self</i>, int <i>propertyId</i>)</li><li><div class="fn" />int <b><a href="qtextformat.html#intProperty">intProperty</a></b> (<i>self</i>, int <i>propertyId</i>)</li><li><div class="fn" />bool <b><a href="qtextformat.html#isBlockFormat">isBlockFormat</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qtextformat.html#isCharFormat">isCharFormat</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qtextformat.html#isFrameFormat">isFrameFormat</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qtextformat.html#isImageFormat">isImageFormat</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qtextformat.html#isListFormat">isListFormat</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qtextformat.html#isTableFormat">isTableFormat</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qtextformat.html#isValid">isValid</a></b> (<i>self</i>)</li><li><div class="fn" />Qt.LayoutDirection <b><a href="qtextformat.html#layoutDirection">layoutDirection</a></b> (<i>self</i>)</li><li><div class="fn" />QTextLength <b><a href="qtextformat.html#lengthProperty">lengthProperty</a></b> (<i>self</i>, int <i>propertyId</i>)</li><li><div class="fn" />QTextLength-list <b><a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a></b> (<i>self</i>, int <i>propertyId</i>)</li><li><div class="fn" /><b><a href="qtextformat.html#merge">merge</a></b> (<i>self</i>, QTextFormat <i>other</i>)</li><li><div class="fn" />int <b><a href="qtextformat.html#objectIndex">objectIndex</a></b> (<i>self</i>)</li><li><div class="fn" />int <b><a href="qtextformat.html#objectType">objectType</a></b> (<i>self</i>)</li><li><div class="fn" />QPen <b><a href="qtextformat.html#penProperty">penProperty</a></b> (<i>self</i>, int <i>propertyId</i>)</li><li><div class="fn" />int-QVariant-dict <b><a href="qtextformat.html#properties">properties</a></b> (<i>self</i>)</li><li><div class="fn" />QVariant <b><a href="qtextformat.html#property">property</a></b> (<i>self</i>, int <i>propertyId</i>)</li><li><div class="fn" /><b><a href="qtextformat.html#setBackground">setBackground</a></b> (<i>self</i>, QBrush <i>brush</i>)</li><li><div class="fn" /><b><a href="qtextformat.html#setForeground">setForeground</a></b> (<i>self</i>, QBrush <i>brush</i>)</li><li><div class="fn" /><b><a href="qtextformat.html#setLayoutDirection">setLayoutDirection</a></b> (<i>self</i>, Qt.LayoutDirection <i>direction</i>)</li><li><div class="fn" /><b><a href="qtextformat.html#setObjectIndex">setObjectIndex</a></b> (<i>self</i>, int <i>object</i>)</li><li><div class="fn" /><b><a href="qtextformat.html#setObjectType">setObjectType</a></b> (<i>self</i>, int <i>atype</i>)</li><li><div class="fn" /><b><a href="qtextformat.html#setProperty">setProperty</a></b> (<i>self</i>, int <i>propertyId</i>, QVariant <i>value</i>)</li><li><div class="fn" /><b><a href="qtextformat.html#setProperty-2">setProperty</a></b> (<i>self</i>, int <i>propertyId</i>, QTextLength-list <i>lengths</i>)</li><li><div class="fn" />QString <b><a href="qtextformat.html#stringProperty">stringProperty</a></b> (<i>self</i>, int <i>propertyId</i>)</li><li><div class="fn" />QTextBlockFormat <b><a href="qtextformat.html#toBlockFormat">toBlockFormat</a></b> (<i>self</i>)</li><li><div class="fn" />QTextCharFormat <b><a href="qtextformat.html#toCharFormat">toCharFormat</a></b> (<i>self</i>)</li><li><div class="fn" />QTextFrameFormat <b><a href="qtextformat.html#toFrameFormat">toFrameFormat</a></b> (<i>self</i>)</li><li><div class="fn" />QTextImageFormat <b><a href="qtextformat.html#toImageFormat">toImageFormat</a></b> (<i>self</i>)</li><li><div class="fn" />QTextListFormat <b><a href="qtextformat.html#toListFormat">toListFormat</a></b> (<i>self</i>)</li><li><div class="fn" />QTextTableFormat <b><a href="qtextformat.html#toTableFormat">toTableFormat</a></b> (<i>self</i>)</li><li><div class="fn" />int <b><a href="qtextformat.html#type">type</a></b> (<i>self</i>)</li></ul><h3>Special Methods</h3><ul><li><div class="fn" />bool <b><a href="qtextformat.html#__eq__">__eq__</a></b> (<i>self</i>, QTextFormat <i>rhs</i>)</li><li><div class="fn" />bool <b><a href="qtextformat.html#__ne__">__ne__</a></b> (<i>self</i>, QTextFormat <i>rhs</i>)</li></ul><a name="details" /><hr /><h2>Detailed Description</h2><p>The QTextFormat class provides formatting information for a <a href="qtextdocument.html">QTextDocument</a>.</p>
<p>A QTextFormat is a generic class used for describing the format of parts of a <a href="qtextdocument.html">QTextDocument</a>. The derived classes <a href="qtextcharformat.html">QTextCharFormat</a>, <a href="qtextblockformat.html">QTextBlockFormat</a>, <a href="qtextlistformat.html">QTextListFormat</a>, and <a href="qtexttableformat.html">QTextTableFormat</a> are usually more useful, and describe the formatting that is applied to specific parts of the document.</p>
<p>A format has a <tt>FormatType</tt> which specifies the kinds of thing it can format; e.g. a block of text, a list, a table, etc. A format also has various properties (some specific to particular format types), as described by the Property enum. Every property has a corresponding Property.</p>
<p>The format type is given by <a href="qtextformat.html#type">type</a>(), and the format can be tested with <a href="qtextformat.html#isCharFormat">isCharFormat</a>(), <a href="qtextformat.html#isBlockFormat">isBlockFormat</a>(), <a href="qtextformat.html#isListFormat">isListFormat</a>(), <a href="qtextformat.html#isTableFormat">isTableFormat</a>(), <a href="qtextformat.html#isFrameFormat">isFrameFormat</a>(), and <a href="qtextformat.html#isImageFormat">isImageFormat</a>(). If the type is determined, it can be retrieved with <a href="qtextformat.html#toCharFormat">toCharFormat</a>(), <a href="qtextformat.html#toBlockFormat">toBlockFormat</a>(), <a href="qtextformat.html#toListFormat">toListFormat</a>(), <a href="qtextformat.html#toTableFormat">toTableFormat</a>(), <a href="qtextformat.html#toFrameFormat">toFrameFormat</a>(), and <a href="qtextformat.html#toImageFormat">toImageFormat</a>().</p>
<p>A format's properties can be set with the <a href="qtextformat.html#setProperty">setProperty</a>() functions, and retrieved with <a href="qtextformat.html#boolProperty">boolProperty</a>(), <a href="qtextformat.html#intProperty">intProperty</a>(), <a href="qtextformat.html#doubleProperty">doubleProperty</a>(), and <a href="qtextformat.html#stringProperty">stringProperty</a>() as appropriate. All the property IDs used in the format can be retrieved with allPropertyIds(). One format can be merged into another using <a href="qtextformat.html#merge">merge</a>().</p>
<p>A format's object index can be set with <a href="qtextformat.html#setObjectIndex">setObjectIndex</a>(), and retrieved with <a href="qtextformat.html#objectIndex">objectIndex</a>(). These methods can be used to associate the format with a <a href="qtextobject.html">QTextObject</a>. It is used to represent lists, frames, and tables inside the document.</p>
<p>See also <a href="text.html">Text Related Classes</a>.</p>
<hr /><h2>Type Documentation</h2><h3 class="fn"><a name="FormatType-enum" />QTextFormat.FormatType</h3><table border="1" cellpadding="2" cellspacing="1" width="40%">
<tr>
<th width="60%">Constant</th>
<th width="40%">Value</th>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.InvalidFormat</tt></td>
<td align="center" valign="top"><tt>-1</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.BlockFormat</tt></td>
<td align="center" valign="top"><tt>1</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.CharFormat</tt></td>
<td align="center" valign="top"><tt>2</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.ListFormat</tt></td>
<td align="center" valign="top"><tt>3</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.TableFormat</tt></td>
<td align="center" valign="top"><tt>4</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.FrameFormat</tt></td>
<td align="center" valign="top"><tt>5</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.UserFormat</tt></td>
<td align="center" valign="top"><tt>100</tt></td>
</tr>
</table>
<br />
<br />
<h3 class="fn"><a name="ObjectTypes-enum" />QTextFormat.ObjectTypes</h3><table border="1" cellpadding="2" cellspacing="1" width="100%">
<tr>
<th width="25%">Constant</th>
<th width="15%">Value</th>
<th width="60%">Description</th>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.NoObject</tt></td>
<td align="center" valign="top"><tt>0</tt></td>
<td valign="top"> </td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.ImageObject</tt></td>
<td align="center" valign="top"><tt>1</tt></td>
<td valign="top"> </td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.TableObject</tt></td>
<td align="center" valign="top"><tt>2</tt></td>
<td valign="top"> </td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.UserObject</tt></td>
<td align="center" valign="top"><tt>0x1000</tt></td>
<td valign="top">The first object that can be used for application-specific purposes.</td>
</tr>
</table>
<br />
<br />
<h3 class="fn"><a name="Property-enum" />QTextFormat.Property</h3><table border="1" cellpadding="2" cellspacing="1" width="40%">
<tr>
<th width="60%">Constant</th>
<th width="40%">Value</th>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.ObjectIndex</tt></td>
<td align="center" valign="top"><tt>0x0</tt></td>
</tr>
</table>
<br />
<br />
<p>Paragraph and character properties</p>
<table border="1" cellpadding="2" cellspacing="1" width="100%">
<tr>
<th width="25%">Constant</th>
<th width="15%">Value</th>
<th width="60%">Description</th>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.CssFloat</tt></td>
<td align="center" valign="top"><tt>0x0800</tt></td>
<td valign="top"> </td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.LayoutDirection</tt></td>
<td align="center" valign="top"><tt>0x0801</tt></td>
<td valign="top">The layout direction of the text in the document (<a href="qt.html#LayoutDirection-enum">Qt.LayoutDirection</a>).</td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.OutlinePen</tt></td>
<td align="center" valign="top"><tt>0x810</tt></td>
<td valign="top"> </td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.ForegroundBrush</tt></td>
<td align="center" valign="top"><tt>0x821</tt></td>
<td valign="top"> </td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.BackgroundBrush</tt></td>
<td align="center" valign="top"><tt>0x820</tt></td>
<td valign="top"> </td>
</tr>
</table>
<br />
<br />
<p>Paragraph properties</p>
<table border="1" cellpadding="2" cellspacing="1" width="40%">
<tr>
<th width="60%">Constant</th>
<th width="40%">Value</th>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.BlockAlignment</tt></td>
<td align="center" valign="top"><tt>0x1010</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.BlockTopMargin</tt></td>
<td align="center" valign="top"><tt>0x1030</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.BlockBottomMargin</tt></td>
<td align="center" valign="top"><tt>0x1031</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.BlockLeftMargin</tt></td>
<td align="center" valign="top"><tt>0x1032</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.BlockRightMargin</tt></td>
<td align="center" valign="top"><tt>0x1033</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.TextIndent</tt></td>
<td align="center" valign="top"><tt>0x1034</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.BlockIndent</tt></td>
<td align="center" valign="top"><tt>0x1040</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.BlockNonBreakableLines</tt></td>
<td align="center" valign="top"><tt>0x1050</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.BlockTrailingHorizontalRulerWidth</tt></td>
<td align="center" valign="top"><tt>0x1060</tt></td>
</tr>
</table>
<br />
<br />
<p>Character properties</p>
<table border="1" cellpadding="2" cellspacing="1" width="40%">
<tr>
<th width="60%">Constant</th>
<th width="40%">Value</th>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.FontFamily</tt></td>
<td align="center" valign="top"><tt>0x2000</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.FontPointSize</tt></td>
<td align="center" valign="top"><tt>0x2001</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.FontSizeIncrement</tt></td>
<td align="center" valign="top"><tt>FontSizeAdjustment</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.FontWeight</tt></td>
<td align="center" valign="top"><tt>0x2003</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.FontItalic</tt></td>
<td align="center" valign="top"><tt>0x2004</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.FontUnderline</tt></td>
<td align="center" valign="top"><tt>0x2005</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.FontOverline</tt></td>
<td align="center" valign="top"><tt>0x2006</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.FontStrikeOut</tt></td>
<td align="center" valign="top"><tt>0x2007</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.FontFixedPitch</tt></td>
<td align="center" valign="top"><tt>0x2008</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.FontPixelSize</tt></td>
<td align="center" valign="top"><tt>0x2009</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.TextUnderlineColor</tt></td>
<td align="center" valign="top"><tt>0x2010</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.TextVerticalAlignment</tt></td>
<td align="center" valign="top"><tt>0x2021</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.TextOutline</tt></td>
<td align="center" valign="top"><tt>0x2022</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.IsAnchor</tt></td>
<td align="center" valign="top"><tt>0x2030</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.AnchorHref</tt></td>
<td align="center" valign="top"><tt>0x2031</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.AnchorName</tt></td>
<td align="center" valign="top"><tt>0x2032</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.ObjectType</tt></td>
<td align="center" valign="top"><tt>0x2f00</tt></td>
</tr>
</table>
<br />
<br />
<p>List properties</p>
<table border="1" cellpadding="2" cellspacing="1" width="40%">
<tr>
<th width="60%">Constant</th>
<th width="40%">Value</th>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.ListStyle</tt></td>
<td align="center" valign="top"><tt>0x3000</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.ListIndent</tt></td>
<td align="center" valign="top"><tt>0x3001</tt></td>
</tr>
</table>
<br />
<br />
<p>Table and frame properties</p>
<table border="1" cellpadding="2" cellspacing="1" width="40%">
<tr>
<th width="60%">Constant</th>
<th width="40%">Value</th>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.TableColumns</tt></td>
<td align="center" valign="top"><tt>0x4100</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.FrameBorder</tt></td>
<td align="center" valign="top"><tt>0x4000</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.FrameMargin</tt></td>
<td align="center" valign="top"><tt>0x4001</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.FramePadding</tt></td>
<td align="center" valign="top"><tt>0x4002</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.FrameWidth</tt></td>
<td align="center" valign="top"><tt>0x4003</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.FrameHeight</tt></td>
<td align="center" valign="top"><tt>0x4004</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.TableColumnWidthConstraints</tt></td>
<td align="center" valign="top"><tt>0x4101</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.TableCellSpacing</tt></td>
<td align="center" valign="top"><tt>0x4102</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.TableCellPadding</tt></td>
<td align="center" valign="top"><tt>0x4103</tt></td>
</tr>
</table>
<br />
<br />
<p>Table cell properties</p>
<table border="1" cellpadding="2" cellspacing="1" width="40%">
<tr>
<th width="60%">Constant</th>
<th width="40%">Value</th>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.TableCellRowSpan</tt></td>
<td align="center" valign="top"><tt>0x4810</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.TableCellColumnSpan</tt></td>
<td align="center" valign="top"><tt>0x4811</tt></td>
</tr>
</table>
<br />
<br />
<p>Image properties</p>
<table border="1" cellpadding="2" cellspacing="1" width="40%">
<tr>
<th width="60%">Constant</th>
<th width="40%">Value</th>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.ImageName</tt></td>
<td align="center" valign="top"><tt>0x5000</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.ImageWidth</tt></td>
<td align="center" valign="top"><tt>0x5010</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.ImageHeight</tt></td>
<td align="center" valign="top"><tt>0x5011</tt></td>
</tr>
<tr>
<td valign="top"><tt>QTextFormat.UserProperty</tt></td>
<td align="center" valign="top"><tt>0x100000</tt></td>
</tr>
</table>
<br />
<br />
<hr /><h2>Method Documentation</h2><h3 class="fn"><a name="QTextFormat" />QTextFormat.__init__ (<i>self</i>)</h3><p>Creates a new text format with an <tt>InvalidFormat</tt>.</p>
<p>See also <a href="qtextformat.html#FormatType-enum">FormatType</a>.</p>
<h3 class="fn"><a name="QTextFormat-2" />QTextFormat.__init__ (<i>self</i>, int <i>type</i>)</h3><p>Creates a new text format of the given <i>type</i>.</p>
<p>See also <a href="qtextformat.html#FormatType-enum">FormatType</a>.</p>
<h3 class="fn"><a name="QTextFormat-3" />QTextFormat.__init__ (<i>self</i>, <a href="qtextformat.html">QTextFormat</a> <i>rhs</i>)</h3><p>Creates a new text format with the same attributes at the <i>other</i> text format.</p>
<h3 class="fn"><a name="QTextFormat-4" />QTextFormat.__init__ (<i>self</i>, <a href="qvariant.html">QVariant</a>)</h3><h3 class="fn"><a name="background" /><a href="qbrush.html">QBrush</a> QTextFormat.background (<i>self</i>)</h3><p>Returns the brush used to paint the document's background.</p>
<p>See also <a href="qtextformat.html#setBackground">setBackground</a>(), <a href="qtextformat.html#clearBackground">clearBackground</a>(), and <a href="qtextformat.html#foreground">foreground</a>().</p>
<h3 class="fn"><a name="boolProperty" />bool QTextFormat.boolProperty (<i>self</i>, int <i>propertyId</i>)</h3><p>Returns the value of the property specified by <i>propertyId</i>. If the property isn't of QTextFormat.Bool type, false is returned instead.</p>
<p>See also <a href="qtextformat.html#setProperty">setProperty</a>(), <a href="qtextformat.html#intProperty">intProperty</a>(), <a href="qtextformat.html#doubleProperty">doubleProperty</a>(), <a href="qtextformat.html#stringProperty">stringProperty</a>(), <a href="qtextformat.html#colorProperty">colorProperty</a>(), <a href="qtextformat.html#lengthProperty">lengthProperty</a>(), <a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a>(), and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<h3 class="fn"><a name="brushProperty" /><a href="qbrush.html">QBrush</a> QTextFormat.brushProperty (<i>self</i>, int <i>propertyId</i>)</h3><p>Returns the value of the property given by <i>propertyId</i>; if the property isn't of <a href="qvariant.html#Type-enum">QVariant.Brush</a> type, <a href="qt.html#BrushStyle-enum">Qt.NoBrush</a> is returned instead.</p>
<p>See also <a href="qtextformat.html#setProperty">setProperty</a>(), <a href="qtextformat.html#boolProperty">boolProperty</a>(), <a href="qtextformat.html#intProperty">intProperty</a>(), <a href="qtextformat.html#doubleProperty">doubleProperty</a>(), <a href="qtextformat.html#stringProperty">stringProperty</a>(), <a href="qtextformat.html#lengthProperty">lengthProperty</a>(), <a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a>(), and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<h3 class="fn"><a name="clearBackground" />QTextFormat.clearBackground (<i>self</i>)</h3><p>Clears the brush used to paint the document's background. The default brush will be used.</p>
<p>See also <a href="qtextformat.html#background">background</a>(), <a href="qtextformat.html#setBackground">setBackground</a>(), and <a href="qtextformat.html#clearForeground">clearForeground</a>().</p>
<h3 class="fn"><a name="clearForeground" />QTextFormat.clearForeground (<i>self</i>)</h3><p>Clears the brush used to paint the document's foreground. The default brush will be used.</p>
<p>See also <a href="qtextformat.html#foreground">foreground</a>(), <a href="qtextformat.html#setForeground">setForeground</a>(), and <a href="qtextformat.html#clearBackground">clearBackground</a>().</p>
<h3 class="fn"><a name="clearProperty" />QTextFormat.clearProperty (<i>self</i>, int <i>propertyId</i>)</h3><p>Clears the value of the property given by <i>propertyId</i></p>
<h3 class="fn"><a name="colorProperty" /><a href="qcolor.html">QColor</a> QTextFormat.colorProperty (<i>self</i>, int <i>propertyId</i>)</h3><p>Returns the value of the property given by <i>propertyId</i>; if the property isn't of <a href="qvariant.html#Type-enum">QVariant.Color</a> type, an invalid color is returned instead.</p>
<p>See also <a href="qtextformat.html#setProperty">setProperty</a>(), <a href="qtextformat.html#boolProperty">boolProperty</a>(), <a href="qtextformat.html#intProperty">intProperty</a>(), <a href="qtextformat.html#doubleProperty">doubleProperty</a>(), <a href="qtextformat.html#stringProperty">stringProperty</a>(), <a href="qtextformat.html#lengthProperty">lengthProperty</a>(), <a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a>(), and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<h3 class="fn"><a name="doubleProperty" />float QTextFormat.doubleProperty (<i>self</i>, int <i>propertyId</i>)</h3><p>Returns the value of the property specified by <i>propertyId</i>. If the property isn't of <a href="qvariant.html#Type-enum">QVariant.Double</a> type, 0 is returned instead.</p>
<p>See also <a href="qtextformat.html#setProperty">setProperty</a>(), <a href="qtextformat.html#boolProperty">boolProperty</a>(), <a href="qtextformat.html#intProperty">intProperty</a>(), <a href="qtextformat.html#stringProperty">stringProperty</a>(), <a href="qtextformat.html#colorProperty">colorProperty</a>(), <a href="qtextformat.html#lengthProperty">lengthProperty</a>(), <a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a>(), and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<h3 class="fn"><a name="foreground" /><a href="qbrush.html">QBrush</a> QTextFormat.foreground (<i>self</i>)</h3><p>Returns the brush used to render foreground details, such as text, frame outlines, and table borders.</p>
<p>See also <a href="qtextformat.html#setForeground">setForeground</a>(), <a href="qtextformat.html#clearForeground">clearForeground</a>(), and <a href="qtextformat.html#background">background</a>().</p>
<h3 class="fn"><a name="hasProperty" />bool QTextFormat.hasProperty (<i>self</i>, int <i>propertyId</i>)</h3><p>Returns true if the text format has a property with the given <i>propertyId</i>; otherwise returns false.</p>
<p>See also <a href="qtextformat.html#properties">properties</a>() and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<h3 class="fn"><a name="intProperty" />int QTextFormat.intProperty (<i>self</i>, int <i>propertyId</i>)</h3><p>Returns the value of the property specified by <i>propertyId</i>. If the property is not of QTextFormat.Integer type, 0 is returned instead.</p>
<p>See also <a href="qtextformat.html#setProperty">setProperty</a>(), <a href="qtextformat.html#boolProperty">boolProperty</a>(), <a href="qtextformat.html#doubleProperty">doubleProperty</a>(), <a href="qtextformat.html#stringProperty">stringProperty</a>(), <a href="qtextformat.html#colorProperty">colorProperty</a>(), <a href="qtextformat.html#lengthProperty">lengthProperty</a>(), <a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a>(), and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<h3 class="fn"><a name="isBlockFormat" />bool QTextFormat.isBlockFormat (<i>self</i>)</h3><p>Returns true if this text format is a <tt>BlockFormat</tt>; otherwise returns false.</p>
<h3 class="fn"><a name="isCharFormat" />bool QTextFormat.isCharFormat (<i>self</i>)</h3><p>Returns true if this text format is a <tt>CharFormat</tt>; otherwise returns false.</p>
<h3 class="fn"><a name="isFrameFormat" />bool QTextFormat.isFrameFormat (<i>self</i>)</h3><p>Returns true if this text format is a <tt>FrameFormat</tt>; otherwise returns false.</p>
<h3 class="fn"><a name="isImageFormat" />bool QTextFormat.isImageFormat (<i>self</i>)</h3><p>Returns true if this text format is an image format; otherwise returns false.</p>
<h3 class="fn"><a name="isListFormat" />bool QTextFormat.isListFormat (<i>self</i>)</h3><p>Returns true if this text format is a <tt>ListFormat</tt>; otherwise returns false.</p>
<h3 class="fn"><a name="isTableFormat" />bool QTextFormat.isTableFormat (<i>self</i>)</h3><p>Returns true if this text format is a <tt>TableFormat</tt>; otherwise returns false.</p>
<h3 class="fn"><a name="isValid" />bool QTextFormat.isValid (<i>self</i>)</h3><p>Returns true if the format is valid (i.e. is not <a href="qtextformat.html#FormatType-enum">InvalidFormat</a>); otherwise returns false.</p>
<h3 class="fn"><a name="layoutDirection" /><a href="qt.html#LayoutDirection-enum">Qt.LayoutDirection</a> QTextFormat.layoutDirection (<i>self</i>)</h3><p>Returns the document's layout direction.</p>
<p>See also <a href="qtextformat.html#setLayoutDirection">setLayoutDirection</a>().</p>
<h3 class="fn"><a name="lengthProperty" /><a href="qtextlength.html">QTextLength</a> QTextFormat.lengthProperty (<i>self</i>, int <i>propertyId</i>)</h3><p>Returns the value of the property given by <i>propertyId</i>.</p>
<p>See also <a href="qtextformat.html#setProperty">setProperty</a>(), <a href="qtextformat.html#boolProperty">boolProperty</a>(), <a href="qtextformat.html#intProperty">intProperty</a>(), <a href="qtextformat.html#doubleProperty">doubleProperty</a>(), <a href="qtextformat.html#stringProperty">stringProperty</a>(), <a href="qtextformat.html#colorProperty">colorProperty</a>(), <a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a>(), and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<h3 class="fn"><a name="lengthVectorProperty" />QTextLength-list QTextFormat.lengthVectorProperty (<i>self</i>, int <i>propertyId</i>)</h3><p>Returns the value of the property given by <i>propertyId</i>. If the property isn't of QTextFormat.LengthVector type, an empty length vector is returned instead.</p>
<p>See also <a href="qtextformat.html#setProperty">setProperty</a>(), <a href="qtextformat.html#boolProperty">boolProperty</a>(), <a href="qtextformat.html#intProperty">intProperty</a>(), <a href="qtextformat.html#doubleProperty">doubleProperty</a>(), <a href="qtextformat.html#stringProperty">stringProperty</a>(), <a href="qtextformat.html#colorProperty">colorProperty</a>(), <a href="qtextformat.html#lengthProperty">lengthProperty</a>(), and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<h3 class="fn"><a name="merge" />QTextFormat.merge (<i>self</i>, <a href="qtextformat.html">QTextFormat</a> <i>other</i>)</h3><p>Merges the <i>other</i> format with this format; where there are conflicts the <i>other</i> format takes precedence.</p>
<h3 class="fn"><a name="objectIndex" />int QTextFormat.objectIndex (<i>self</i>)</h3><p>Returns the index of the format object, or -1 if the format object is invalid.</p>
<p>See also <a href="qtextformat.html#setObjectIndex">setObjectIndex</a>().</p>
<h3 class="fn"><a name="objectType" />int QTextFormat.objectType (<i>self</i>)</h3><p>Returns the text format's object type. See <tt>ObjectTypes</tt>.</p>
<p>See also <a href="qtextformat.html#setObjectType">setObjectType</a>().</p>
<h3 class="fn"><a name="penProperty" /><a href="qpen.html">QPen</a> QTextFormat.penProperty (<i>self</i>, int <i>propertyId</i>)</h3><p>Returns the value of the property given by <i>propertyId</i>; if the property isn't of <a href="qvariant.html#Type-enum">QVariant.Pen</a> type, <a href="qt.html#PenStyle-enum">Qt.NoPen</a> is returned instead.</p>
<p>See also <a href="qtextformat.html#setProperty">setProperty</a>(), <a href="qtextformat.html#boolProperty">boolProperty</a>(), <a href="qtextformat.html#intProperty">intProperty</a>(), <a href="qtextformat.html#doubleProperty">doubleProperty</a>(), <a href="qtextformat.html#stringProperty">stringProperty</a>(), <a href="qtextformat.html#lengthProperty">lengthProperty</a>(), <a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a>(), and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<h3 class="fn"><a name="properties" />int-QVariant-dict QTextFormat.properties (<i>self</i>)</h3><p>Returns a map with all properties of this text format.</p>
<h3 class="fn"><a name="property" /><a href="qvariant.html">QVariant</a> QTextFormat.property (<i>self</i>, int <i>propertyId</i>)</h3><p>Returns the property specified by the given <i>propertyId</i>.</p>
<p>See also <a href="qtextformat.html#setProperty">setProperty</a>().</p>
<h3 class="fn"><a name="setBackground" />QTextFormat.setBackground (<i>self</i>, <a href="qbrush.html">QBrush</a> <i>brush</i>)</h3><p>Sets the brush use to paint the document's background to the <i>brush</i> specified.</p>
<p>See also <a href="qtextformat.html#background">background</a>(), <a href="qtextformat.html#clearBackground">clearBackground</a>(), and <a href="qtextformat.html#setForeground">setForeground</a>().</p>
<h3 class="fn"><a name="setForeground" />QTextFormat.setForeground (<i>self</i>, <a href="qbrush.html">QBrush</a> <i>brush</i>)</h3><p>Sets the foreground brush to the specified <i>brush</i>. The foreground brush is mostly used to render text.</p>
<p>See also <a href="qtextformat.html#foreground">foreground</a>(), <a href="qtextformat.html#clearForeground">clearForeground</a>(), and <a href="qtextformat.html#setBackground">setBackground</a>().</p>
<h3 class="fn"><a name="setLayoutDirection" />QTextFormat.setLayoutDirection (<i>self</i>, <a href="qt.html#LayoutDirection-enum">Qt.LayoutDirection</a> <i>direction</i>)</h3><p>Sets the document's layout direction to the specified <i>direction</i>.</p>
<p>See also <a href="qtextformat.html#layoutDirection">layoutDirection</a>().</p>
<h3 class="fn"><a name="setObjectIndex" />QTextFormat.setObjectIndex (<i>self</i>, int <i>object</i>)</h3><p>Sets the format object's object <i>index</i>.</p>
<p>See also <a href="qtextformat.html#objectIndex">objectIndex</a>().</p>
<h3 class="fn"><a name="setObjectType" />QTextFormat.setObjectType (<i>self</i>, int <i>atype</i>)</h3><p>Sets the text format's object <i>type</i>. See <tt>ObjectTypes</tt>.</p>
<p>See also <a href="qtextformat.html#objectType">objectType</a>().</p>
<h3 class="fn"><a name="setProperty" />QTextFormat.setProperty (<i>self</i>, int <i>propertyId</i>, <a href="qvariant.html">QVariant</a> <i>value</i>)</h3><p>Sets the property specified by the <i>propertyId</i> to the given <i>value</i>.</p>
<p>See also <a href="qtextformat.html#property">property</a>().</p>
<h3 class="fn"><a name="setProperty-2" />QTextFormat.setProperty (<i>self</i>, int <i>propertyId</i>, QTextLength-list <i>lengths</i>)</h3><p>This is an overloaded member function, provided for convenience.</p>
<p>Sets the value of the property given by <i>propertyId</i> to <i>value</i>.</p>
<p>See also <a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a>() and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<h3 class="fn"><a name="stringProperty" /><a href="qstring.html">QString</a> QTextFormat.stringProperty (<i>self</i>, int <i>propertyId</i>)</h3><p>Returns the value of the property given by <i>propertyId</i>; if the property isn't of <a href="qvariant.html#Type-enum">QVariant.String</a> type, an empty string is returned instead.</p>
<p>See also <a href="qtextformat.html#setProperty">setProperty</a>(), <a href="qtextformat.html#boolProperty">boolProperty</a>(), <a href="qtextformat.html#intProperty">intProperty</a>(), <a href="qtextformat.html#doubleProperty">doubleProperty</a>(), <a href="qtextformat.html#colorProperty">colorProperty</a>(), <a href="qtextformat.html#lengthProperty">lengthProperty</a>(), <a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a>(), and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<h3 class="fn"><a name="toBlockFormat" /><a href="qtextblockformat.html">QTextBlockFormat</a> QTextFormat.toBlockFormat (<i>self</i>)</h3><p>Returns this format as a block format.</p>
<h3 class="fn"><a name="toCharFormat" /><a href="qtextcharformat.html">QTextCharFormat</a> QTextFormat.toCharFormat (<i>self</i>)</h3><p>Returns this format as a character format.</p>
<h3 class="fn"><a name="toFrameFormat" /><a href="qtextframeformat.html">QTextFrameFormat</a> QTextFormat.toFrameFormat (<i>self</i>)</h3><p>Returns this format as a frame format.</p>
<h3 class="fn"><a name="toImageFormat" /><a href="qtextimageformat.html">QTextImageFormat</a> QTextFormat.toImageFormat (<i>self</i>)</h3><p>Returns this format as an image format.</p>
<h3 class="fn"><a name="toListFormat" /><a href="qtextlistformat.html">QTextListFormat</a> QTextFormat.toListFormat (<i>self</i>)</h3><p>Returns this format as a list format.</p>
<h3 class="fn"><a name="toTableFormat" /><a href="qtexttableformat.html">QTextTableFormat</a> QTextFormat.toTableFormat (<i>self</i>)</h3><p>Returns this format as a table format.</p>
<h3 class="fn"><a name="type" />int QTextFormat.type (<i>self</i>)</h3><p>Returns the type of this format.</p>
<p>See also <a href="qtextformat.html#ObjectTypes-enum">ObjectTypes</a>.</p>
<h3 class="fn"><a name="__eq__" />bool QTextFormat.__eq__ (<i>self</i>, <a href="qtextformat.html">QTextFormat</a> <i>rhs</i>)</h3><h3 class="fn"><a name="__ne__" />bool QTextFormat.__ne__ (<i>self</i>, <a href="qtextformat.html">QTextFormat</a> <i>rhs</i>)</h3><address><hr /><div align="center"><table border="0" cellspacing="0" width="100%"><tr class="address"><td width="25%">PyQt 4.0.1 for X11</td><td align="center" width="50%">Copyright © <a href="http://www.riverbankcomputing.com">Riverbank Computing Ltd</a> and <a href="http://www.trolltech.com">Trolltech AS</a> 2006</td><td align="right" width="25%">Qt 4.1.4</td></tr></table></div></address></body></html>
|
