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
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>KTextEditor.Attribute</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
<div id="header_top">
<div>
<div>
<img alt ="" src="../common/top-kde.jpg"/>
KDE 4.9 PyKDE API Reference
</div>
</div>
</div>
<div id="header_bottom">
<div id="location">
<ul>
<li>KDE's Python API</li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h1>Attribute Class Reference</h1>
<code>from PyKDE4.ktexteditor import *</code>
<p>
Inherits: QTextCharFormat → QTextFormat<br />
Namespace: <a href="../ktexteditor/KTextEditor.html">KTextEditor</a><br />
<h2>Detailed Description</h2>
<p>A class which provides customized text decorations.
</p>
<p>
The Attribute class extends QTextCharFormat, the class which Qt
uses internally to provide formatting information to characters
in a text document.
</p>
<p>
In addition to its inherited properties, it provides support for:
<li> several customized text formatting properties </li>
<li> dynamic highlighting of associated ranges of text </li>
<li> binding of actions with associated ranges of text (note: not currently implemented) </li>
</p>
<p>
Implementations are not required to support all properties.
In particular, several properties are not supported for dynamic
highlighting (notably: font() and fontBold()).
</p>
<p>
Unfortunately, as QTextFormat's setProperty() is not virtual,
changes that are made to this attribute cannot automatically be
redrawn. Once you have finished changing properties, you should
call changed() to force redrawing of affected ranges of text.
</p>
<p>
\sa SmartInterface
</p>
<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Hamish Rodda <rodda@kde.org> </dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#ActivationType">ActivationType</a> </td><td class="memItemRight" valign="bottom">{ ActivateMouseIn, ActivateCaretIn }</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#CustomProperties">CustomProperties</a> </td><td class="memItemRight" valign="bottom">{ Outline, SelectedForeground, SelectedBackground, BackgroundFillWhitespace, AttributeDynamicEffect, AttributeInternalProperty, AttributeUserProperty }</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#Effect">Effect</a> </td><td class="memItemRight" valign="bottom">{ EffectNone, EffectFadeIn, EffectFadeOut, EffectPulse, EffectCycleGradient }</td></tr>
<tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#Attribute">__init__</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#Attribute">__init__</a> (self, <a href="../ktexteditor/KTextEditor.Attribute.html">KTextEditor.Attribute</a> a)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[<a href="../kdeui/KAction.html">KAction</a>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#associatedActions">associatedActions</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#backgroundFillWhitespace">backgroundFillWhitespace</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#clear">clear</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#clearAssociatedActions">clearAssociatedActions</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">KSharedPtr<KTextEditor::Attribute> </td><td class="memItemRight" valign="bottom"><a class="el" href="#dynamicAttribute">dynamicAttribute</a> (self, <a href="../ktexteditor/KTextEditor.Attribute.html#ActivationType">KTextEditor.Attribute.ActivationType</a> type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.Attribute.html">KTextEditor.Attribute.Effects</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#effects">effects</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#fontBold">fontBold</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#hasAnyProperty">hasAnyProperty</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.Attribute.html">KTextEditor.Attribute</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#operator +=">operator +=</a> (self, <a href="../ktexteditor/KTextEditor.Attribute.html">KTextEditor.Attribute</a> a)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QBrush </td><td class="memItemRight" valign="bottom"><a class="el" href="#outline">outline</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QBrush </td><td class="memItemRight" valign="bottom"><a class="el" href="#selectedBackground">selectedBackground</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QBrush </td><td class="memItemRight" valign="bottom"><a class="el" href="#selectedForeground">selectedForeground</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setBackgroundFillWhitespace">setBackgroundFillWhitespace</a> (self, bool fillWhitespace)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setDynamicAttribute">setDynamicAttribute</a> (self, <a href="../ktexteditor/KTextEditor.Attribute.html#ActivationType">KTextEditor.Attribute.ActivationType</a> type, KSharedPtr<KTextEditor::Attribute> attribute)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setEffects">setEffects</a> (self, <a href="../ktexteditor/KTextEditor.Attribute.html">KTextEditor.Attribute.Effects</a> effects)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setFontBold">setFontBold</a> (self, bool bold=1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setOutline">setOutline</a> (self, QBrush brush)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setSelectedBackground">setSelectedBackground</a> (self, QBrush brush)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setSelectedForeground">setSelectedForeground</a> (self, QBrush foreground)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="Attribute"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Default constructor. The resulting Attribute has no properties set to begin with.
</p></div></div><a class="anchor" name="Attribute"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Attribute.html">KTextEditor.Attribute</a> </td>
<td class="paramname"><em>a</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Copy constructor.
</p></div></div><a class="anchor" name="associatedActions"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[<a href="../kdeui/KAction.html">KAction</a>] associatedActions</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns a list of currently associated KAction%s.
</p></div></div><a class="anchor" name="backgroundFillWhitespace"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool backgroundFillWhitespace</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Determine whether background color is drawn over whitespace. Defaults to true if not set.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> whether the background color should be drawn over whitespace
</dd></dl>
</p></div></div><a class="anchor" name="clear"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> clear</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Clear all set properties.
</p></div></div><a class="anchor" name="clearAssociatedActions"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> clearAssociatedActions</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Clears all associations between KAction%s and this attribute.
</p></div></div><a class="anchor" name="dynamicAttribute"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">KSharedPtr<KTextEditor::Attribute> dynamicAttribute</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Attribute.html#ActivationType">KTextEditor.Attribute.ActivationType</a> </td>
<td class="paramname"><em>type</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Return the attribute to use when the event referred to by <b>type</b> occurs.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>type</em> </td><td> the activation type for which to return the Attribute.
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the attribute to be used for events specified by <b>type,</b> or null if none is set.
</dd></dl>
</p></div></div><a class="anchor" name="effects"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../ktexteditor/KTextEditor.Attribute.html">KTextEditor.Attribute.Effects</a> effects</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="fontBold"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool fontBold</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Find out if the font weight is set to QFont.Bold.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the font weight is exactly QFont.Bold, otherwise false
</dd></dl> </p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> QTextCharFormat.fontWeight()
</dd></dl>
</p></div></div><a class="anchor" name="hasAnyProperty"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool hasAnyProperty</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Determine if any properties are set.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if any properties are set, otherwise false
</dd></dl>
</p></div></div><a class="anchor" name="operator +="></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../ktexteditor/KTextEditor.Attribute.html">KTextEditor.Attribute</a> operator +=</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Attribute.html">KTextEditor.Attribute</a> </td>
<td class="paramname"><em>a</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Addition assignment operator. Use this to merge another Attribute with this Attribute.
Where both attributes have a particular property set, the property in <b>a</b> will
be used.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>a</em> </td><td> attribute to merge into this attribute.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="outline"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QBrush outline</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Get the brush used to draw an outline around text, if any.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> brush to be used to draw an outline, or Qt.NoBrush if no outline is set.
</dd></dl>
</p></div></div><a class="anchor" name="selectedBackground"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QBrush selectedBackground</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Get the brush used to draw the background of selected text, if any.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> brush to be used to draw the background of selected text, or Qt.NoBrush if not set
</dd></dl>
</p></div></div><a class="anchor" name="selectedForeground"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QBrush selectedForeground</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Get the brush used to draw text when it is selected, if any.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> brush to be used to draw selected text, or Qt.NoBrush if not set
</dd></dl>
</p></div></div><a class="anchor" name="setBackgroundFillWhitespace"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setBackgroundFillWhitespace</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>fillWhitespace</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set whether background color is drawn over whitespace. Defaults to true if not set.
</p>
<p>
Use <b>clearProperty(BackgroundFillWhitespace)</b> to clear.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>fillWhitespace</em> </td><td> whether the background should be drawn over whitespace.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setDynamicAttribute"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setDynamicAttribute</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Attribute.html#ActivationType">KTextEditor.Attribute.ActivationType</a> </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">KSharedPtr<KTextEditor::Attribute> </td>
<td class="paramname"><em>attribute</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set the attribute to use when the event referred to by <b>type</b> occurs.
</p>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> Nested dynamic attributes are ignored.
</dd></dl> </p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>type</em> </td><td> the activation type to set the attribute for
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>attribute</em> </td><td> the attribute to assign. As attribute is refcounted, ownership is not an issue.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setEffects"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setEffects</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Attribute.html">KTextEditor.Attribute.Effects</a> </td>
<td class="paramname"><em>effects</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="setFontBold"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setFontBold</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>bold=1</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set the font weight to QFont.Bold. If <b>bold</b> is <b>false,</b> the weight will be set to 0 (normal).
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>bold</em> </td><td> whether the font weight should be bold or not.
</td></tr>
</table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> QTextCharFormat.setFontWeight()
</dd></dl>
</p></div></div><a class="anchor" name="setOutline"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setOutline</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QBrush </td>
<td class="paramname"><em>brush</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set a brush to be used to draw an outline around text.
</p>
<p>
Use <b>clearProperty(Outline)</b> to clear.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>brush</em> </td><td> brush to be used to draw an outline.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setSelectedBackground"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setSelectedBackground</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QBrush </td>
<td class="paramname"><em>brush</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set a brush to be used to draw the background of selected text, if any.
</p>
<p>
Use <b>clearProperty(SelectedBackground)</b> to clear.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>brush</em> </td><td> brush to be used to draw the background of selected text
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setSelectedForeground"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setSelectedForeground</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QBrush </td>
<td class="paramname"><em>foreground</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set a brush to be used to draw selected text.
</p>
<p>
Use <b>clearProperty(SelectedForeground)</b> to clear.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>foreground</em> </td><td> brush to be used to draw selected text.
</td></tr>
</table></dl>
<p>
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="ActivationType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">ActivationType</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Several automatic activation mechanisms exist for associated attributes.
Using this you can conveniently have your ranges highlighted when either
the mouse or cursor enter the range.
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>ActivateMouseIn</em> = 0</td><td><tr><td valign="top"><em>ActivateCaretIn</em> </td><td></table>
</dl>
</div></div><p><a class="anchor" name="CustomProperties"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">CustomProperties</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Custom property types, which may or may not be supported by implementations.
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>Outline</em> = QTextFormat::UserProperty</td><td><tr><td valign="top"><em>SelectedForeground</em> </td><td><tr><td valign="top"><em>SelectedBackground</em> </td><td><tr><td valign="top"><em>BackgroundFillWhitespace</em> </td><td><tr><td valign="top"><em>AttributeDynamicEffect</em> = 0x10A00</td><td><tr><td valign="top"><em>AttributeInternalProperty</em> = 0x10E00</td><td><tr><td valign="top"><em>AttributeUserProperty</em> = 0x110000</td><td></table>
</dl>
</div></div><p><a class="anchor" name="Effect"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">Effect</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Dynamic effects for display.
To do: Pulse and CycleGradient are unclear.
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>EffectNone</em> = 0x0</td><td><tr><td valign="top"><em>EffectFadeIn</em> = 0x1</td><td><tr><td valign="top"><em>EffectFadeOut</em> = 0x2</td><td><tr><td valign="top"><em>EffectPulse</em> = 0x4</td><td><tr><td valign="top"><em>EffectCycleGradient</em> = 0x8</td><td></table>
</dl>
</div></div><p>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>
</div>
</div>
<div class="clearer"/>
</div>
<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div></div>
</body>
</html>
|
