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
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
|
<?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>KNotification</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>KNotification Class Reference</h1>
<code>from PyKDE4.kdeui import *</code>
<p>
Inherits: QObject<br />
<h2>Detailed Description</h2>
<p>KNotification is used to notify the user of an event.
</p>
<p>
<b>introduction </b>
</p>
<p>
There are two main kinds of notifications:
</p>
<p>
<li> Feedback events: </li>
For notifying the user that he/she just performed an operation, like maximizing a
window. This allows us to play sounds when a dialog appears.
This is an instant notification. It ends automatically after a small timeout.
</p>
<p>
<li> persistant notifications: </li>
Notify when the user received a new message, or when something else important happened
the user has to know about. This notification has a start and a end. It begins when
the event actually occurs, and finishes when the message is acknowledged or read.
</p>
<p>
Example of a persistent notification in an instant messaging application:
The application emits the notification when the message is actually received, and closes it only
when the user has read the message (when the message window has received the focus) using the close() slot
Persistent notifications must have the Persistent flag.
</p>
<p>
By default a notification will use the application name as title, but you
can also provide a brief text in the title and a more precise description in
the body text. This is especially useful for notifications coming from
applications which should be considered "part of the system", like a battery
monitor or a network connection manager.
For example a battery indicator could use "Low Battery" as a title and "Only
12 minutes left." as a body text.
</p>
<p>
In order to perform a notification, you need to create a description file, which contains
default parameters of the notification, and use KNotification.event at the place in the
application code where the notification occurs.
The returned KNotification pointer may be used to connect signals or slots
</p>
<p>
<b>The global config file </b>
Your application should install a file called:
<em>$KDEDIR/share/apps/appname/appname.notifyrc</em>
</p>
<p>
You can do this with the following CMake command:
install( FILES appname.notifyrc DESTINATION ${DATA_INSTALL_DIR}/appname))
</p>
<p>
This file contains mainly 3 parts
<ol><li>\ref global "Global information"</li>
<li>\ref context "Context information"</li>
<li>\ref events "Definition of individual events"</li></ol>
</p>
<p>
The global part looks like that
<pre>
[Global]
IconName=Filename
Comment=Friendly Name of app
Name=Name of app
</pre>
The icon filename is just the name, without extension, it's found with the KIconLoader.
The Comment field will be used in KControl to describe the application.
The Name field is optional and may be used as the application name for popup,
if Name is not present, Comment is used instead
</p>
<p>
This part consists of hints for the configuration widget
<pre>
[Context/group]
Name=Group name
Comment=The name of the group for contacts
</p>
<p>
[Context/folder]
Name=Group name
</pre>
The second part of the groupname is the context identifier.
It should not contain special characters.
The Name field is the one the user will see (and which is translated)
</p>
<p>
The definition of the events forms the most important part of the config file
<pre>
[Event/newmail]
Name=New email
Comment=You have got a new email
Contexts=folder,group
Action=Sound|Popup
</p>
<p>
[Event/contactOnline]
Name=Contact goes online
Comment=One of your contact has been connected
Contexts=group
Sound=filetoplay.ogg
Action=None
</pre>
These are the default settings for each notifiable event.
Action is the string representing the action. Actions can be added to
the KNotify daemon as plugins, by deriving from KNotifyPlugin.
At the time of writing, the following actions are available: Taskbar,
Sound, Popup, Logfile, KTTS, Execute.
Actions can be combined by seperating them with '|'.
</p>
<p>
Contexts is a comma separated list of possible context for this event.
</p>
<p>
<b>The user's config file </b>
</p>
<p>
This is an implementation detail, and is described here for your information.
</p>
<p>
In the config file, there are two parts: the event configuration, and the context information
These are hints for the configuration dialog. They contain both the internal id of the context, and the user visible string.
<pre>
[Context/group]
Values=1:Friends,2:Work,3:Family
</pre>
This contains the configuration of events for the user.
It contains the same fields as the description file.
The key of groups is in the form
<em>Event/&lt;EventName&gt;/&lt;ContextName&gt;/&lt;ContextValue&gt;</em>
<pre>
[Event/contactOnline]
Action=Sound
Sound=/usr/share/sounds/super.ogg
</p>
<p>
[Event/contactOnline/group/1]
Action=Popup|Sound
</pre>
</p>
<p>
<b>Example of code </b>
</p>
<p>
This portion of code will fire the event for the "contactOnline" event
</p>
<p>
<pre class="fragment">
KNotification *notification= new KNotification ( "contactOnline", widget );
notification->setText( i18n("The contact <i>%1</i> has gone online", contact->name() );
notification->setPixmap( contact->pixmap() );
notification->setActions( QStringList( i18n( "Open chat" ) ) );
foreach( const QString &group , contact->groups() ) {
notification->addContext( "group" , group ) ;
}
connect(notification, SIGNAL(activated(unsigned int )), contact , SLOT(slotOpenChat()) );
notification->sendEvent();
</pre>
</p>
<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Olivier Goffart <ogoffart at 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="#NotificationFlag">NotificationFlag</a> </td><td class="memItemRight" valign="bottom">{ RaiseWidgetOnActivation, CloseOnTimeout, Persistent, CloseWhenWidgetActivated, Persistant, DefaultEvent }</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#StandardEvent">StandardEvent</a> </td><td class="memItemRight" valign="bottom">{ Notification, Warning, Error, Catastrophe }</td></tr>
<tr><td colspan="2"><br><h2>Signals</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#action1Activated">action1Activated</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#action2Activated">action2Activated</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#action3Activated">action3Activated</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#activated">activated</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#activated">activated</a> (long action)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#closed">closed</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ignored">ignored</a> ()</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="#KNotification">__init__</a> (self, QString eventId, QWidget widget=0, <a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> flags=KNotification.CloseOnTimeout)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KNotification">__init__</a> (self, QString eventId, <a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> flags, QObject parent=NULL)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#actions">actions</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#activate">activate</a> (self, long action=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#addContext">addContext</a> (self, (QString,QString) context)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#addContext">addContext</a> (self, QString context_key, QString context_value)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#close">close</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[(QString,QString)] </td><td class="memItemRight" valign="bottom"><a class="el" href="#contexts">contexts</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#deref">deref</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#eventFilter">eventFilter</a> (self, QObject watched, QEvent event)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#eventId">eventId</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#flags">flags</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QPixmap </td><td class="memItemRight" valign="bottom"><a class="el" href="#pixmap">pixmap</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#raiseWidget">raiseWidget</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ref">ref</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#sendEvent">sendEvent</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setActions">setActions</a> (self, QStringList actions)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setComponentData">setComponentData</a> (self, <a href="../kdecore/KComponentData.html">KComponentData</a> componentData)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setContexts">setContexts</a> (self, [(QString,QString)] contexts)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setFlags">setFlags</a> (self, <a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> flags)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setPixmap">setPixmap</a> (self, QPixmap pix)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setText">setText</a> (self, QString text)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setTitle">setTitle</a> (self, QString title)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setWidget">setWidget</a> (self, QWidget widget)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#text">text</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#title">title</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#update">update</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QWidget </td><td class="memItemRight" valign="bottom"><a class="el" href="#widget">widget</a> (self)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#beep">beep</a> (QString reason=QString(), QWidget widget=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KNotification.html">KNotification</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#event">event</a> (QString eventId, QString text=QString(), QPixmap pixmap=QPixmap(), QWidget widget=0, <a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> flags=KNotification.CloseOnTimeout, <a href="../kdecore/KComponentData.html">KComponentData</a> componentData=KComponentData())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KNotification.html">KNotification</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#event">event</a> (<a href="../kdeui/KNotification.html#StandardEvent">KNotification.StandardEvent</a> eventId, QString text=QString(), QPixmap pixmap=QPixmap(), QWidget widget=0, <a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> flags=KNotification.CloseOnTimeout)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KNotification.html">KNotification</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#event">event</a> (QString eventId, QString title, QString text, QPixmap pixmap=QPixmap(), QWidget widget=0, <a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> flags=KNotification.CloseOnTimeout, <a href="../kdecore/KComponentData.html">KComponentData</a> componentData=KComponentData())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KNotification.html">KNotification</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#event">event</a> (<a href="../kdeui/KNotification.html#StandardEvent">KNotification.StandardEvent</a> eventId, QString title, QString text, QPixmap pixmap=QPixmap(), QWidget widget=0, <a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> flags=KNotification.CloseOnTimeout)</td></tr>
</table>
<hr><h2>Signal Documentation</h2><a class="anchor" name="action1Activated"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> action1Activated</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Convenience signal that is emitted when the first action is activated.
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("action1Activated()"), target_slot)</code></dd></dl></div></div><a class="anchor" name="action2Activated"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> action2Activated</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("action2Activated()"), target_slot)</code></dd></dl></div></div><a class="anchor" name="action3Activated"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> action3Activated</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("action3Activated()"), target_slot)</code></dd></dl></div></div><a class="anchor" name="activated"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> activated</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Emit when an action has been activated.
</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> will be 0 is the default aciton was activated, or any action id
</td></tr>
</table></dl>
<p>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("activated()"), target_slot)</code></dd></dl></div></div><a class="anchor" name="activated"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> activated</td>
<td>(</td>
<td class="paramtype">long </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"><p>Emit when an action has been activated.
</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> will be 0 is the default aciton was activated, or any action id
</td></tr>
</table></dl>
<p>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("activated(unsigned int)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="closed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> closed</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Emitted when the notification is closed. Both when it is activated or if it is just ignored.
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("closed()"), target_slot)</code></dd></dl></div></div><a class="anchor" name="ignored"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> ignored</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>The notification has been ignored
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("ignored()"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="KNotification"></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">QString </td>
<td class="paramname"><em>eventId</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>widget=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> </td>
<td class="paramname"><em>flags=KNotification.CloseOnTimeout</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Create a new notification.
</p>
<p>
You have to use sendEvent to show the notification.
</p>
<p>
The pointer is automatically deleted when the event is closed.
</p>
<p>
Make sure you use one of the NotificationFlags CloseOnTimeOut or
CloseWhenWidgetActivated, if not,
you have to close the notification yourself.
</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>eventId</em> </td><td> is the name of the event
<tr><td></td><td valign="top"><em>widget</em> </td><td> is a widget where the notification reports to
<tr><td></td><td valign="top"><em>flags</em> </td><td> is a bitmask of NotificationFlag
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="KNotification"></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">QString </td>
<td class="paramname"><em>eventId</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> </td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QObject </td>
<td class="paramname"><em>parent=NULL</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Create a new notification.
</p>
<p>
You have to use sendEvent to show the notification.
</p>
<p>
The pointer is automatically deleted when the event is closed.
</p>
<p>
Make sure you use one of the NotificationFlags CloseOnTimeOut or
CloseWhenWidgetActivated, if not,
you have to close the notification yourself.
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
</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>eventId</em> </td><td> is the name of the event
<tr><td></td><td valign="top"><em>flags</em> </td><td> is a bitmask of NotificationFlag
<tr><td></td><td valign="top"><em>parent</em> </td><td> parent object
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="actions"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QStringList actions</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><dl class="return" compact><dt><b>Returns:</b></dt><dd> the list of actions
</dd></dl>
</p></div></div><a class="anchor" name="activate"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> activate</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>action=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Activate the action specified action
If the action is zero, then the default action is activated
</p></div></div><a class="anchor" name="addContext"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> addContext</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">(QString,QString) </td>
<td class="paramname"><em>context</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>context_key</em> </td><td> is the key of the context
<tr><td></td><td valign="top"><em>context_value</em> </td><td> is the value of the context
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="addContext"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> addContext</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">QString </td>
<td class="paramname"><em>context_key</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>context_value</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>context_key</em> </td><td> is the key of the context
<tr><td></td><td valign="top"><em>context_value</em> </td><td> is the value of the context
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="close"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> close</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>Close the notification without activating it.
</p>
<p>
This will delete the notification.
</p></div></div><a class="anchor" name="contexts"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[(QString,QString)] contexts</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><dl class="return" compact><dt><b>Returns:</b></dt><dd> the list of contexts, see KNotification.Context
</dd></dl>
</p></div></div><a class="anchor" name="deref"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> deref</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>remove a reference made with ref()
the notification may be closed when calling this.
<dl class="see" compact><dt><b>See also:</b></dt><dd> ref
</dd></dl>
</p></div></div><a class="anchor" name="eventFilter"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool eventFilter</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">QObject </td>
<td class="paramname"><em>watched</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QEvent </td>
<td class="paramname"><em>event</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>reimplemented for internal reasons
</p></div></div><a class="anchor" name="eventId"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString eventId</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><dl class="return" compact><dt><b>Returns:</b></dt><dd> the name of the event
</dd></dl>
</p></div></div><a class="anchor" name="flags"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> flags</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><dl class="return" compact><dt><b>Returns:</b></dt><dd> the notification flags.
</dd></dl>
</p></div></div><a class="anchor" name="pixmap"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QPixmap pixmap</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><dl class="return" compact><dt><b>Returns:</b></dt><dd> the pixmap shown in the popup
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> setPixmap
</dd></dl>
</p></div></div><a class="anchor" name="raiseWidget"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> raiseWidget</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>Raise the widget.
This will change the desktop, activate the window, and the tab if needed.
</p></div></div><a class="anchor" name="ref"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> ref</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>The notification will automatically be closed if all presentations are finished.
if you want to show your own presentation in your application, you should use this
function, so it will not be automatically closed when there is nothing to show.
</p>
<p>
don't forgot to deref, or the notification may be never closed if there is no timeout.
<dl class="see" compact><dt><b>See also:</b></dt><dd> ref
</dd></dl>
</p></div></div><a class="anchor" name="sendEvent"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> sendEvent</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>Emit or re-emit the event.
</p></div></div><a class="anchor" name="setActions"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setActions</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">QStringList </td>
<td class="paramname"><em>actions</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 list of actions link shown in the popup.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>actions</em> </td><td> the list of actions
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setComponentData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setComponentData</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="../kdecore/KComponentData.html">KComponentData</a> </td>
<td class="paramname"><em>componentData</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>The componentData is used to determine the location of the config file. By default, kapp is used
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>componentData</em> </td><td> the new componentData
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setContexts"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setContexts</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">[(QString,QString)] </td>
<td class="paramname"><em>contexts</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 list of contexts, see KNotification.Context
</p>
<p>
The list of contexts must be set before calling sendEvent;
</p></div></div><a class="anchor" name="setFlags"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setFlags</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="../kdeui/KNotification.html">KNotification.NotificationFlags</a> </td>
<td class="paramname"><em>flags</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 notification flags.
should be called before sendEvent().
</p></div></div><a class="anchor" name="setPixmap"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setPixmap</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">QPixmap </td>
<td class="paramname"><em>pix</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 pixmap that will be shown in the popup.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>pix</em> </td><td> the pixmap
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setText"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setText</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">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"><p>Set the notification text that will appear in the popup.
</p>
<p>
The text is shown in a QLabel, you should make sure to escape any html that is needed.
You can use some of the qt basic html tags.
</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>text</em> </td><td> the text
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setTitle"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setTitle</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">QString </td>
<td class="paramname"><em>title</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 title of the notification popup.
If no title is set, the application name 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>title</em> </td><td> the title
</td></tr> </table></dl>
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
</dd></dl>
</p></div></div><a class="anchor" name="setWidget"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setWidget</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">QWidget </td>
<td class="paramname"><em>widget</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 widget associated to the notification.
The notification is reparented to the new widget.
<dl class="see" compact><dt><b>See also:</b></dt><dd> widget()
</dd></dl> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>widget</em> </td><td> the new widget
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="text"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString text</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><dl class="return" compact><dt><b>Returns:</b></dt><dd> the notification text
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> setText
</dd></dl>
</p></div></div><a class="anchor" name="title"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString title</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><dl class="return" compact><dt><b>Returns:</b></dt><dd> the notification title
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> setTitle
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
</dd></dl>
</p></div></div><a class="anchor" name="update"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> update</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><dl class="internal" compact><dt><b>Internal:</b></dt><dd>
update the texts, the icon, and the actions of one existing notification
</dd></dl>
</p></div></div><a class="anchor" name="widget"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QWidget widget</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>the widget associated to the notification
</p>
<p>
If the widget is destroyed, the notification will be automatically cancelled.
If the widget is activated, the notification will be automatically closed if the NotificationFlags specify that
</p>
<p>
When the notification is activated, the widget might be raised.
Depending on the configuration, the taskbar entry of the window containing the widget may blink.
</p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="beep"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> beep</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>reason=QString()</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>widget=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>This is a simple substitution for QApplication.beep()
</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>reason</em> </td><td> a short text explaining what has happened (may be empty)
<tr><td></td><td valign="top"><em>widget</em> </td><td> the widget the notification refers to
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="event"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdeui/KNotification.html">KNotification</a> event</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>eventId</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>text=QString()</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QPixmap </td>
<td class="paramname"><em>pixmap=QPixmap()</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>widget=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> </td>
<td class="paramname"><em>flags=KNotification.CloseOnTimeout</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KComponentData.html">KComponentData</a> </td>
<td class="paramname"><em>componentData=KComponentData()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>emit a standard event
</p>
<p>
</p>
<p>
This will emit a standard event
</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>eventId</em> </td><td> is the name of the event
<tr><td></td><td valign="top"><em>title</em> </td><td> is title of the notification to show in the popup.
<tr><td></td><td valign="top"><em>text</em> </td><td> is the text of the notification to show in the popup
<tr><td></td><td valign="top"><em>pixmap</em> </td><td> is a picture which may be shown in the popup
<tr><td></td><td valign="top"><em>widget</em> </td><td> is a widget where the notification reports to
<tr><td></td><td valign="top"><em>flags</em> </td><td> is a bitmask of NotificationFlag
</td></tr> </table></dl>
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
</dd></dl>
</p></div></div><a class="anchor" name="event"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdeui/KNotification.html">KNotification</a> event</td>
<td>(</td>
<td class="paramtype"><a href="../kdeui/KNotification.html#StandardEvent">KNotification.StandardEvent</a> </td>
<td class="paramname"><em>eventId</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>text=QString()</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QPixmap </td>
<td class="paramname"><em>pixmap=QPixmap()</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>widget=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> </td>
<td class="paramname"><em>flags=KNotification.CloseOnTimeout</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>emit a standard event
</p>
<p>
</p>
<p>
This will emit a standard event
</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>eventId</em> </td><td> is the name of the event
<tr><td></td><td valign="top"><em>title</em> </td><td> is title of the notification to show in the popup.
<tr><td></td><td valign="top"><em>text</em> </td><td> is the text of the notification to show in the popup
<tr><td></td><td valign="top"><em>pixmap</em> </td><td> is a picture which may be shown in the popup
<tr><td></td><td valign="top"><em>widget</em> </td><td> is a widget where the notification reports to
<tr><td></td><td valign="top"><em>flags</em> </td><td> is a bitmask of NotificationFlag
</td></tr> </table></dl>
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
</dd></dl>
</p></div></div><a class="anchor" name="event"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdeui/KNotification.html">KNotification</a> event</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>eventId</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>title</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 class="memname"></td>
<td></td>
<td class="paramtype">QPixmap </td>
<td class="paramname"><em>pixmap=QPixmap()</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>widget=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> </td>
<td class="paramname"><em>flags=KNotification.CloseOnTimeout</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KComponentData.html">KComponentData</a> </td>
<td class="paramname"><em>componentData=KComponentData()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>emit a standard event
</p>
<p>
</p>
<p>
This will emit a standard event
</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>eventId</em> </td><td> is the name of the event
<tr><td></td><td valign="top"><em>title</em> </td><td> is title of the notification to show in the popup.
<tr><td></td><td valign="top"><em>text</em> </td><td> is the text of the notification to show in the popup
<tr><td></td><td valign="top"><em>pixmap</em> </td><td> is a picture which may be shown in the popup
<tr><td></td><td valign="top"><em>widget</em> </td><td> is a widget where the notification reports to
<tr><td></td><td valign="top"><em>flags</em> </td><td> is a bitmask of NotificationFlag
</td></tr> </table></dl>
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
</dd></dl>
</p></div></div><a class="anchor" name="event"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdeui/KNotification.html">KNotification</a> event</td>
<td>(</td>
<td class="paramtype"><a href="../kdeui/KNotification.html#StandardEvent">KNotification.StandardEvent</a> </td>
<td class="paramname"><em>eventId</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>title</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 class="memname"></td>
<td></td>
<td class="paramtype">QPixmap </td>
<td class="paramname"><em>pixmap=QPixmap()</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>widget=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> </td>
<td class="paramname"><em>flags=KNotification.CloseOnTimeout</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>emit a standard event
</p>
<p>
</p>
<p>
This will emit a standard event
</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>eventId</em> </td><td> is the name of the event
<tr><td></td><td valign="top"><em>title</em> </td><td> is title of the notification to show in the popup.
<tr><td></td><td valign="top"><em>text</em> </td><td> is the text of the notification to show in the popup
<tr><td></td><td valign="top"><em>pixmap</em> </td><td> is a picture which may be shown in the popup
<tr><td></td><td valign="top"><em>widget</em> </td><td> is a widget where the notification reports to
<tr><td></td><td valign="top"><em>flags</em> </td><td> is a bitmask of NotificationFlag
</td></tr> </table></dl>
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
</dd></dl>
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="NotificationFlag"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">NotificationFlag</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Sometimes the user may want different notifications for the same event,
depending the source of the event. Example, you want to be notified for mails
that arrive in your folder "personal inbox" but not for those in "spam" folder
</p>
<p>
A notification context is a pair of two strings.
The first string is a key from what the context is. example "group" or
"filter" (not translated).
The second is the id of the context. In our example, the group id or the
filter id in the applications.
These strings are the ones present in the config file, and are in theory not
shown in the user interface.
</p>
<p>
The order of contexts in the list is is important, the most important context
should be placed first. They are processed in that order when the notification occurs.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> event
</dd></dl>
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>RaiseWidgetOnActivation</em> = 0x01</td><td><tr><td valign="top"><em>CloseOnTimeout</em> = 0x00</td><td><tr><td valign="top"><em>Persistent</em> = 0x02</td><td><tr><td valign="top"><em>CloseWhenWidgetActivated</em> = 0x04</td><td><tr><td valign="top"><em>Persistant</em> = Persistent</td><td><tr><td valign="top"><em>DefaultEvent</em> = 0xF000</td><td></table>
</dl>
</div></div><p><a class="anchor" name="StandardEvent"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">StandardEvent</td>
</tr>
</table>
</div>
<div class="memdoc"><p>default events you can use in the event function
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>Notification</em> </td><td><tr><td valign="top"><em>Warning</em> </td><td><tr><td valign="top"><em>Error</em> </td><td><tr><td valign="top"><em>Catastrophe</em> </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>
|
