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
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
|
<?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.MarkInterface</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>MarkInterface Class Reference</h1>
<code>from PyKDE4.ktexteditor import *</code>
<p>
Namespace: <a href="../ktexteditor/KTextEditor.html">KTextEditor</a><br />
<h2>Detailed Description</h2>
<p>Mark extension interface for the Document.
</p>
<p>
<b>Introduction </b>
</p>
<p>
The MarkInterface provides methods to enable and disable marks in a
Document, a marked line can be visualized for example with a shaded
background color and/or a pixmap in the iconborder of the Document's View.
There are a number of predefined mark types, specified in
reservedMarkersCount(). Additionally it is possible to add custom marks
and set custom pixmaps.
</p>
<p>
<b>Accessing the Interface </b>
</p>
<p>
The MarkInterface is supposed to be an extension interface for a Document,
i.e. the Document inherits the interface provided that the
KTextEditor library in use implements the interface. Use qobject_cast to access
the interface:
<pre class="fragment">
// doc is of type KTextEditor.Document*
KTextEditor.MarkInterface *iface =
qobject_cast<KTextEditor.MarkInterface*>( doc );
if( iface ) {
// the implementation supports the interface
// do stuff
}
</pre>
</p>
<p>
<b>Handling Marks </b>
</p>
<p>
Get all marks in the document by calling marks(). Use clearMarks() to
remove all marks in the entire document. A single mark can be retrieved
with mark(). To remove all marks from a line call clearMark(). To add
and remove marks from a given line use addMark() and removeMark(). It is
also possible to replace all marks with setMark(), i.e. setMark() is the
same as a call of clearMark() followed by addMark(). The signals
marksChanged() and markChanged() are emitted whenever a line's marks
changed.
</p>
<p>
\attention A mark type is represented as an uint. An uint can have
several mark types combined (see above: logical OR). That means for
all functions/signals with an uint parameter, e.g. setMark(),
removeMark(), etc, the uint may contain multiple marks, i.e.
you can add and remove multiple marks simultaneously.
</p>
<p>
<b>User Defined Marks </b>
</p>
<p>
All marks that should be editable by the user can be specified with a mark
mask via setEditableMarks(). To set a description and pixmap of a mark type
call setMarkDescription() and setMarkPixmap().
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> KTextEditor.Document, KTextEditor.Mark
</dd></dl>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Christoph Cullmann <cullmann@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="#MarkChangeAction">MarkChangeAction</a> </td><td class="memItemRight" valign="bottom">{ MarkAdded, MarkRemoved }</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#MarkTypes">MarkTypes</a> </td><td class="memItemRight" valign="bottom">{ markType01, markType02, markType03, markType04, markType05, markType06, markType07, markType08, markType09, markType10, markType11, markType12, markType13, markType14, markType15, markType16, markType17, markType18, markType19, markType20, markType21, markType22, markType23, markType24, markType25, markType26, markType27, markType28, markType29, markType30, markType31, markType32, Bookmark, BreakpointActive, BreakpointReached, BreakpointDisabled, Execution, Warning, Error }</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="#MarkInterface">__init__</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#addMark">addMark</a> (self, int line, long markType)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#clearMark">clearMark</a> (self, int line)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#clearMarks">clearMarks</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#editableMarks">editableMarks</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#mark">mark</a> (self, int line)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#markChanged">markChanged</a> (self, <a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> document, <a href="../ktexteditor/KTextEditor.Mark.html">KTextEditor.Mark</a> mark, <a href="../ktexteditor/KTextEditor.MarkInterface.html#MarkChangeAction">KTextEditor.MarkInterface.MarkChangeAction</a> action)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#markDescription">markDescription</a> (self, <a href="../ktexteditor/KTextEditor.MarkInterface.html#MarkTypes">KTextEditor.MarkInterface.MarkTypes</a> mark)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QPixmap </td><td class="memItemRight" valign="bottom"><a class="el" href="#markPixmap">markPixmap</a> (self, <a href="../ktexteditor/KTextEditor.MarkInterface.html#MarkTypes">KTextEditor.MarkInterface.MarkTypes</a> mark)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">{int:<a href="../ktexteditor/KTextEditor.Mark.html">KTextEditor.Mark</a>} </td><td class="memItemRight" valign="bottom"><a class="el" href="#marks">marks</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#marksChanged">marksChanged</a> (self, <a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> document)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#removeMark">removeMark</a> (self, int line, long markType)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setEditableMarks">setEditableMarks</a> (self, long markMask)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setMark">setMark</a> (self, int line, long markType)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setMarkDescription">setMarkDescription</a> (self, <a href="../ktexteditor/KTextEditor.MarkInterface.html#MarkTypes">KTextEditor.MarkInterface.MarkTypes</a> mark, QString text)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setMarkPixmap">setMarkPixmap</a> (self, <a href="../ktexteditor/KTextEditor.MarkInterface.html#MarkTypes">KTextEditor.MarkInterface.MarkTypes</a> mark, QPixmap pixmap)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#reservedMarkersCount">reservedMarkersCount</a> ()</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="MarkInterface"></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"></div></div><a class="anchor" name="addMark"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> addMark</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">int </td>
<td class="paramname"><em>line</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>markType</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Add marks of type <b>markType</b> to <b>line.</b> Existing marks on this line
are preserved. If the mark <b>markType</b> already is set, nothing
happens.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>line</em> </td><td> line to set the mark
</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>markType</em> </td><td> mark type
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> removeMark(), setMark()
</dd></dl>
</p></div></div><a class="anchor" name="clearMark"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> clearMark</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">int </td>
<td class="paramname"><em>line</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Clear all marks set in the <b>line.</b>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>line</em> </td><td> line to clear marks
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> clearMarks(), removeMark(), addMark()
</dd></dl>
</p></div></div><a class="anchor" name="clearMarks"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> clearMarks</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Clear all marks in the entire document.
<dl class="see" compact><dt><b>See also:</b></dt><dd> clearMark(), removeMark()
</dd></dl>
</p></div></div><a class="anchor" name="editableMarks"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">long editableMarks</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Get, which marks can be toggled by the user.
The returned value is a mark mask containing all editable marks combined
with a logical OR.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> mark mask containing all editable marks
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> setEditableMarks()
</dd></dl>
</p></div></div><a class="anchor" name="mark"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">long mark</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">int </td>
<td class="paramname"><em>line</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Get all marks set on the <b>line.</b>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>line</em> </td><td> requested line
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> a uint representing of the marks set in <b>line</b> concatenated
by logical OR
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> addMark(), removeMark()
</dd></dl>
</p></div></div><a class="anchor" name="markChanged"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> markChanged</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.Document.html">KTextEditor.Document</a> </td>
<td class="paramname"><em>document</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Mark.html">KTextEditor.Mark</a> </td>
<td class="paramname"><em>mark</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.MarkInterface.html#MarkChangeAction">KTextEditor.MarkInterface.MarkChangeAction</a> </td>
<td class="paramname"><em>action</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>The <b>document</b> emits this signal whenever the <b>mark</b> changes.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>document</em> </td><td> the document which emitted the signal
</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>mark</em> </td><td> changed mark
</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>action</em> </td><td> action, either removed or added
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> marksChanged()
</dd></dl>
</p></div></div><a class="anchor" name="markDescription"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString markDescription</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.MarkInterface.html#MarkTypes">KTextEditor.MarkInterface.MarkTypes</a> </td>
<td class="paramname"><em>mark</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Get the <b>mark's</b> description to text.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>mark</em> </td><td> mark to set the description
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> text of the given <b>mark</b> or QString(), if the entry does not
exist
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> setMarkDescription(), setMarkPixmap()
</dd></dl>
</p></div></div><a class="anchor" name="markPixmap"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QPixmap markPixmap</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.MarkInterface.html#MarkTypes">KTextEditor.MarkInterface.MarkTypes</a> </td>
<td class="paramname"><em>mark</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Get the <b>mark's</b> pixmap.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>mark</em> </td><td> mark type. If the pixmap does not exist the resulting is null
(check with QPixmap.isNull()).
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> setMarkDescription()
</dd></dl>
</p></div></div><a class="anchor" name="marks"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">{int:<a href="../ktexteditor/KTextEditor.Mark.html">KTextEditor.Mark</a>} marks</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Get a hash holding all marks in the document.
The hash key for a mark is its line.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> a hash holding all marks in the document
</dd></dl>
</p></div></div><a class="anchor" name="marksChanged"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> marksChanged</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.Document.html">KTextEditor.Document</a> </td>
<td class="paramname"><em>document</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>The <b>document</b> emits this signal whenever a mark mask changed.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>document</em> </td><td> document which emitted this signal
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> markChanged()
</dd></dl>
</p></div></div><a class="anchor" name="removeMark"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> removeMark</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">int </td>
<td class="paramname"><em>line</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>markType</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Remove the mark mask of type <b>markType</b> from <b>line.</b>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>line</em> </td><td> line to remove the mark
</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>markType</em> </td><td> mark type to be removed
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> clearMark()
</dd></dl>
</p></div></div><a class="anchor" name="setEditableMarks"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setEditableMarks</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">long </td>
<td class="paramname"><em>markMask</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Set the mark mask the user is allowed to toggle to <b>markMask.</b>
I.e. concatenate all editable marks with a logical OR. If the user should
be able to add a bookmark and set a breakpoint with the context menu in
the icon pane, you have to call
<pre class="fragment">
// iface is of Type KTextEditor.MarkInterface*
// only make bookmark and breakpoint editable
iface->setEditableMarks( MarkInterface.Bookmark |
MarkInterface.BreakpointActive );
// or preserve last settings, and add bookmark and breakpoint
iface->setEditableMarks( iface->editableMarks() |
MarkInterface.Bookmark |
MarkInterface.BreakpointActive );
</pre>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>markMask</em> </td><td> bitmap pattern
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> editableMarks(), setMarkPixmap(), setMarkDescription()
</dd></dl>
</p></div></div><a class="anchor" name="setMark"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setMark</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">int </td>
<td class="paramname"><em>line</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>markType</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Set the <b>line's</b> mark types to <b>markType.</b>
If <b>line</b> already contains a mark of the given type it has no effect.
All other marks are deleted before the mark is set. You can achieve
the same by calling
<pre class="fragment">
clearMark(line);
addMark(line, markType);
</pre>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>line</em> </td><td> line to set the mark
</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>markType</em> </td><td> mark type
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> clearMark(), addMark(), mark()
</dd></dl>
</p></div></div><a class="anchor" name="setMarkDescription"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setMarkDescription</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.MarkInterface.html#MarkTypes">KTextEditor.MarkInterface.MarkTypes</a> </td>
<td class="paramname"><em>mark</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>text</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Set the <b>mark's</b> description to <b>text.</b>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>mark</em> </td><td> mark to set the description
</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>text</em> </td><td> new descriptive text
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> markDescription(), setMarkPixmap()
</dd></dl>
</p></div></div><a class="anchor" name="setMarkPixmap"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setMarkPixmap</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.MarkInterface.html#MarkTypes">KTextEditor.MarkInterface.MarkTypes</a> </td>
<td class="paramname"><em>mark</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QPixmap </td>
<td class="paramname"><em>pixmap</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Set the <b>mark's</b> pixmap to <b>pixmap.</b>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>mark</em> </td><td> mark to which the pixmap will be attached
</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>pixmap</em> </td><td> new pixmap
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> setMarkDescription()
</dd></dl>
</p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="reservedMarkersCount"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int reservedMarkersCount</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Get the number of predefined mark types we have so far.
<dl class="note" compact><dt><b>Note:</b></dt><dd> FIXME: If you change this you have to make sure katepart
supports the new size!
</dd></dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd> number of reserved marker types
</dd></dl>
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="MarkChangeAction"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">MarkChangeAction</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Possible actions on a mark.
<dl class="see" compact><dt><b>See also:</b></dt><dd> markChanged()
</dd></dl>
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>MarkAdded</em> = 0</td><td><tr><td valign="top"><em>MarkRemoved</em> = 1</td><td></table>
</dl>
</div></div><p><a class="anchor" name="MarkTypes"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">MarkTypes</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Predefined mark types.
</p>
<p>
To add a new standard mark type, edit this interface and document
the type.
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>markType01</em> = 0x1</td><td><tr><td valign="top"><em>markType02</em> = 0x2</td><td><tr><td valign="top"><em>markType03</em> = 0x4</td><td><tr><td valign="top"><em>markType04</em> = 0x8</td><td><tr><td valign="top"><em>markType05</em> = 0x10</td><td><tr><td valign="top"><em>markType06</em> = 0x20</td><td><tr><td valign="top"><em>markType07</em> = 0x40</td><td><tr><td valign="top"><em>markType08</em> = 0x80</td><td><tr><td valign="top"><em>markType09</em> = 0x100</td><td><tr><td valign="top"><em>markType10</em> = 0x200</td><td><tr><td valign="top"><em>markType11</em> = 0x400</td><td><tr><td valign="top"><em>markType12</em> = 0x800</td><td><tr><td valign="top"><em>markType13</em> = 0x1000</td><td><tr><td valign="top"><em>markType14</em> = 0x2000</td><td><tr><td valign="top"><em>markType15</em> = 0x4000</td><td><tr><td valign="top"><em>markType16</em> = 0x8000</td><td><tr><td valign="top"><em>markType17</em> = 0x10000</td><td><tr><td valign="top"><em>markType18</em> = 0x20000</td><td><tr><td valign="top"><em>markType19</em> = 0x40000</td><td><tr><td valign="top"><em>markType20</em> = 0x80000</td><td><tr><td valign="top"><em>markType21</em> = 0x100000</td><td><tr><td valign="top"><em>markType22</em> = 0x200000</td><td><tr><td valign="top"><em>markType23</em> = 0x400000</td><td><tr><td valign="top"><em>markType24</em> = 0x800000</td><td><tr><td valign="top"><em>markType25</em> = 0x1000000</td><td><tr><td valign="top"><em>markType26</em> = 0x2000000</td><td><tr><td valign="top"><em>markType27</em> = 0x4000000</td><td><tr><td valign="top"><em>markType28</em> = 0x8000000</td><td><tr><td valign="top"><em>markType29</em> = 0x10000000</td><td><tr><td valign="top"><em>markType30</em> = 0x20000000</td><td><tr><td valign="top"><em>markType31</em> = 0x40000000</td><td><tr><td valign="top"><em>markType32</em> = 0x80000000</td><td><tr><td valign="top"><em>Bookmark</em> = markType01</td><td><tr><td valign="top"><em>BreakpointActive</em> = markType02</td><td><tr><td valign="top"><em>BreakpointReached</em> = markType03</td><td><tr><td valign="top"><em>BreakpointDisabled</em> = markType04</td><td><tr><td valign="top"><em>Execution</em> = markType05</td><td><tr><td valign="top"><em>Warning</em> = markType06</td><td><tr><td valign="top"><em>Error</em> = markType07</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>
|
