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
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
|
/* This file is part of the KDE libraries
Copyright (C) 1997 Matthias Kalle Dalheimer (kalle@kde.org)
Copyright (c) 1998, 1999 KDE Team
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef _KAPP_H
#define _KAPP_H
// Version macros. Never put this further down.
#include "tdeversion.h"
#include "tdelibs_export.h"
class KConfig;
class KCharsets;
class DCOPClient;
class DCOPObject;
#include <tqtglobaldefines.h>
typedef unsigned long Atom;
#if !defined(Q_WS_X11)
typedef void Display;
#endif
#include <tqapplication.h>
#include <tqpixmap.h>
#include <kinstance.h>
struct _IceConn;
class TQPopupMenu;
class TQStrList;
class KSessionManaged;
class KStyle;
class KURL;
#define kapp KApplication::kApplication()
class KApplicationPrivate;
/**
* Controls and provides information to all KDE applications.
*
* Only one object of this class can be instantiated in a single app.
* This instance is always accessible via the 'kapp' global variable.
* See cut() for an example.
*
* This class provides the following services to all KDE applications.
*
* @li It controls the event queue (see TQApplication ).
* @li It provides the application with KDE resources such as
* accelerators, common menu entries, a KConfig object. session
* management events, help invocation etc.
* @li Installs a signal handler for the SIGCHLD signal in order to
* avoid zombie children. If you want to catch this signal yourself or
* don't want it to be caught at all, you have set a new signal handler
* (or SIG_IGN) after KApplication's constructor has run.
* @li Installs an empty signal handler for the SIGPIPE signal using
* installSigpipeHandler(). If you want to catch this signal
* yourself, you have set a new signal handler after KApplication's
* constructor has run.
* @li It can start new services
*
*
* The way a service gets started depends on the 'X-DCOP-ServiceType'
* entry in the desktop file of the service:
*
* There are three possibilities:
* @li X-DCOP-ServiceType=None (default)
* Always start a new service,
* don't wait till the service registers with dcop.
* @li X-DCOP-ServiceType=Multi
* Always start a new service,
* wait until the service has registered with dcop.
* @li X-DCOP-ServiceType=Unique
* Only start the service if it isn't already running,
* wait until the service has registered with dcop.
*
* @short Controls and provides information to all KDE applications.
* @author Matthias Kalle Dalheimer <kalle@kde.org>
*/
class TDECORE_EXPORT KApplication : public TQApplication, public KInstance
{
Q_OBJECT
public:
/** Position of the caption (presumably in the application window's
* title bar). This enum appears to be unused.
*
* @todo Find out if this is used anywhere.
*/
enum CaptionLayout {
CaptionAppLast=1 /**< Display the application name last (before document name). */,
CaptionAppFirst /**< Display the application name first. */ ,
CaptionNoApp /**< Do not display application name at all. */
};
/**
* This constructor takes aboutData and command line
* arguments from KCmdLineArgs.
*
* If ARGB (transparent) widgets are to be used in your application,
* please use
* KApplication app(KApplication::openX11RGBADisplay());
* or
* KApplication app(KApplication::openX11RGBADisplay(), useStyles);
*
* @param allowStyles Set to false to disable the loading on plugin based
* styles. This is only useful to applications that do not display a GUI
* normally. If you do create an application with @p allowStyles set to false
* it normally runs in the background but under special circumstances
* displays widgets. Call enableStyles() before displaying any widgets.
*
* @param GUIenabled Set to false to disable all GUI stuff. This implies
* no styles either.
*/
KApplication( bool allowStyles=true, bool GUIenabled=true);
#ifdef Q_WS_X11
/**
* Constructor. Parses command-line arguments. Use this constructor when you
* you want ARGB support to be automatically detected and enabled.
*
* @param display Will be passed to Qt as the X display. The display must be
* valid and already opened.
*
* @param allowStyles Set to false to disable the loading on plugin based
* styles. This is only useful to applications that do not display a GUI
* normally. If you do create an application with @p allowStyles set to false
* that normally runs in the background but under special circumstances
* displays widgets call enableStyles() before displaying any widgets.
*
* @since KDE 3.5
*
* @see RGBADisplay()
*/
KApplication(Display *display, bool allowStyles);
/**
* Constructor. Parses command-line arguments. Use this constructor when you
* you want ARGB support to be automatically detected and enabled.
*
* @param display Will be passed to Qt as the X display. The display must be
* valid and already opened.
*
* @param disable_argb Set to true to disable ARGB visuals in this application.
*
* @param display Will be passed to Qt as the X display. The display must be
* valid and already opened.
*
* @param visual A pointer to the X11 visual that should be used by the
* appliction. Note that only TrueColor visuals are supported on depths
* greater than 8 bpp. If this parameter is NULL, the default visual will
* be used instead.
*
* @param allowStyles Set to false to disable the loading on plugin based
* styles. This is only useful to applications that do not display a GUI
* normally. If you do create an application with @p allowStyles set to false
* that normally runs in the background but under special circumstances
* displays widgets call enableStyles() before displaying any widgets.
*
* @since KDE 3.5
*
* @see RGBADisplay()
*/
KApplication(Display *display, bool disable_argb, Qt::HANDLE visual, Qt::HANDLE colormap, bool allowStyles);
/**
* Constructor. Parses command-line arguments. Use this constructor when you
* you need to use a non-default visual or colormap.
*
* @param display Will be passed to Qt as the X display. The display must be
* valid and already opened.
*
* @param visual A pointer to the X11 visual that should be used by the
* appliction. Note that only TrueColor visuals are supported on depths
* greater than 8 bpp. If this parameter is NULL, the default visual will
* be used instead.
*
* @param colormap The colormap that should be used by the application. If
* this parameter is 0, the default colormap will be used instead.
*
* @param allowStyles Set to false to disable the loading on plugin based
* styles. This is only useful to applications that do not display a GUI
* normally. If you do create an application with @p allowStyles set to false
* that normally runs in the background but under special circumstances
* displays widgets call enableStyles() before displaying any widgets.
*
* @since KDE 3.3
*/
KApplication(Display *display, Qt::HANDLE visual = 0, Qt::HANDLE colormap = 0,
bool allowStyles=true);
/**
* Constructor. Parses command-line arguments. Use this constructor to use KApplication
* in a Motif or Xt program.
*
* @param display Will be passed to Qt as the X display. The display must be valid and already
* opened.
*
* @param argc command line argument count
*
* @param argv command line argument value(s)
*
* @param rAppName application name. Will be used for finding the
* associated message files and icon files, and as the default
* registration name for DCOP. This is a mandatory parameter.
*
* @param allowStyles Set to false to disable the loading on plugin based
* styles. This is only useful to applications that do not display a GUI
* normally. If you do create an application with @p allowStyles set to false
* that normally runs in the background but under special circumstances
* displays widgets call enableStyles() before displaying any widgets.
*
* @param GUIenabled Set to false to disable all GUI stuff. This implies
* no styles either.
*/
KApplication(Display *display, int& argc, char** argv, const TQCString& rAppName,
bool allowStyles=true, bool GUIenabled=true);
#endif
/**
* @deprecated do not use it at all, it will make your application crash, use KCmdLineArgs
*
* Constructor. Parses command-line arguments.
*
* @param argc command line argument count
*
* @param argv command line argument value(s)
*
* @param rAppName application name. Will be used for finding the
* associated message files and icon files, and as the default
* registration name for DCOP. This is a mandatory parameter.
*
* @param allowStyles Set to false to disable the loading on plugin based
* styles. This is only useful to applications that do not display a GUI
* normally. If you do create an application with @p allowStyles set to false
* that normally runs in the background but under special circumstances
* displays widgets call enableStyles() before displaying any widgets.
*
* @param GUIenabled Set to false to disable all GUI stuff. This implies
* no styles either.
*/
// REMOVE FOR KDE 4.0 - using it only gives crashing applications because
// KCmdLineArgs::init isn't called
KApplication(int& argc, char** argv,
const TQCString& rAppName, bool allowStyles=true, bool GUIenabled=true) KDE_DEPRECATED;
/**
* Add Qt and KDE command line options to KCmdLineArgs.
*/
static void addCmdLineOptions();
virtual ~KApplication();
/**
* Returns the current application object.
*
* This is similar to the global TQApplication pointer tqApp. It
* allows access to the single global KApplication object, since
* more than one cannot be created in the same application. It
* saves you the trouble of having to pass the pointer explicitly
* to every function that may require it.
* @return the current application object
*/
static KApplication* kApplication() { return KApp; }
/**
* Returns the application session config object.
*
* @return A pointer to the application's instance specific
* KConfig object.
* @see KConfig
*/
KConfig* sessionConfig();
/**
* Is the application restored from the session manager?
*
* @return If true, this application was restored by the session manager.
* Note that this may mean the config object returned by
* sessionConfig() contains data saved by a session closedown.
* @see sessionConfig()
*/
bool isRestored() const { return TQApplication::isSessionRestored(); }
/**
* Disables session management for this application.
*
* Useful in case your application is started by the
* initial "startkde" script.
*/
void disableSessionManagement();
/**
* Enables again session management for this application, formerly
* disabled by calling disableSessionManagement(). You usually
* shouldn't call this function, as the session management is enabled
* by default.
*/
void enableSessionManagement();
/**
* The possible values for the @p confirm parameter of requestShutDown().
*/
enum ShutdownConfirm {
/**
* Obey the user's confirmation setting.
*/
ShutdownConfirmDefault = -1,
/**
* Don't confirm, shutdown without asking.
*/
ShutdownConfirmNo = 0,
/**
* Always confirm, ask even if the user turned it off.
*/
ShutdownConfirmYes = 1
};
/**
* The possible values for the @p sdtype parameter of requestShutDown().
*/
enum ShutdownType {
/**
* Select previous action or the default if it's the first time.
*/
ShutdownTypeDefault = -1,
/**
* Only log out.
*/
ShutdownTypeNone = 0,
/**
* Log out and reboot the machine.
*/
ShutdownTypeReboot = 1,
/**
* Log out and halt the machine.
*/
ShutdownTypeHalt = 2
};
/**
* The possible values for the @p sdmode parameter of requestShutDown().
*/
enum ShutdownMode {
/**
* Select previous mode or the default if it's the first time.
*/
ShutdownModeDefault = -1,
/**
* Schedule a shutdown (halt or reboot) for the time all active sessions
* have exited.
*/
ShutdownModeSchedule = 0,
/**
* Shut down, if no sessions are active. Otherwise do nothing.
*/
ShutdownModeTryNow = 1,
/**
* Force shutdown. Kill any possibly active sessions.
*/
ShutdownModeForceNow = 2,
/**
* Pop up a dialog asking the user what to do if sessions are still active.
*/
ShutdownModeInteractive = 3
};
/**
* Asks the session manager to shut the session down.
*
* Using @p confirm == ShutdownConfirmYes or @p sdtype != ShutdownTypeDefault or
* @p sdmode != ShutdownModeDefault causes the use of ksmserver's DCOP
* interface. The remaining two combinations use the standard XSMP and
* will work with any session manager compliant with it.
*
* @param confirm Whether to ask the user if he really wants to log out.
* ShutdownConfirm
* @param sdtype The action to take after logging out. ShutdownType
* @param sdmode If/When the action should be taken. ShutdownMode
* @return true on success, false if the session manager could not be
* contacted.
*/
bool requestShutDown( ShutdownConfirm confirm = ShutdownConfirmDefault,
ShutdownType sdtype = ShutdownTypeDefault,
ShutdownMode sdmode = ShutdownModeDefault );
/**
* Propagates the network address of the session manager in the
* SESSION_MANAGER environment variable so that child processes can
* pick it up.
*
* If SESSION_MANAGER isn't defined yet, the address is searched in
* $HOME/.KSMserver.
*
* This function is called by clients that are started outside the
* session ( i.e. before ksmserver is started), but want to launch
* other processes that should participate in the session. Examples
* are kdesktop or kicker.
*/
void propagateSessionManager();
/**
* Reimplemented for internal purposes, mainly the highlevel
* handling of session management with KSessionManaged.
* @internal
*/
void commitData( TQSessionManager& sm );
/**
* Reimplemented for internal purposes, mainly the highlevel
* handling of session management with KSessionManaged.
* @internal
*/
void saveState( TQSessionManager& sm );
/**
* Returns true if the application is currently saving its session
* data (most probably before KDE logout). This is intended for use
* mainly in KMainWindow::queryClose() and KMainWindow::queryExit().
*
* @see KMainWindow::queryClose
* @see KMainWindow::queryExit
* @since 3.1.1
*/
bool sessionSaving() const;
/**
* Returns a pointer to a DCOPClient for the application.
* If a client does not exist yet, it is created when this
* function is called.
* @return the DCOPClient for the application
*/
static DCOPClient *dcopClient();
/**
* Disable automatic dcop registration
* Must be called before creating a KApplication instance to have an effect.
*/
static void disableAutoDcopRegistration();
/**
* Returns a TQPixmap with the application icon.
* @return the application icon
*/
TQPixmap icon() const;
/**
* Returns the name of the application icon.
* @return the icon's name
*/
TQString iconName() const;
/**
* Returns the mini-icon for the application as a TQPixmap.
* @return the application's mini icon
*/
TQPixmap miniIcon() const;
/**
* Returns the name of the mini-icon for the application.
* @return the mini icon's name
*/
TQString miniIconName() const;
/**
* Sets the top widget of the application.
* This means basically applying the right window caption and
* icon. An application may have several top widgets. You don't
* need to call this function manually when using KMainWindow.
*
* @param topWidget A top widget of the application.
*
* @see icon(), caption()
**/
void setTopWidget( TQWidget *topWidget );
/**
* Invokes the KHelpCenter HTML help viewer from docbook sources.
*
* @param anchor This has to be a defined anchor in your
* docbook sources. If empty the main index
* is loaded
* @param appname This allows you to show the help of another
* application. If empty the current name() is
* used
* @param startup_id for app startup notification, "0" for none,
* "" ( empty string ) is the default
*/
void invokeHelp( const TQString& anchor,
const TQString& appname,
const TQCString& startup_id ) const;
// KDE4 merge with above with startup_id = ""
void invokeHelp( const TQString& anchor = TQString::null,
const TQString& appname = TQString::null ) const;
/**
* @deprecated
* Invoke the khelpcenter HTML help viewer from HTML sources.
* Please use invokeHelp() instead.
*
* @param aFilename The filename that is to be loaded. Its
* location is computed automatically
* according to the KFSSTND. If @p aFilename
* is empty, the logical appname with .html
* appended to it is used.
* @param aTopic This allows context-sensitive help. Its
* value will be appended to the filename,
* prefixed with a "#" (hash) character.
*/
void invokeHTMLHelp( const TQString& aFilename, const TQString& aTopic = TQString::null ) const KDE_DEPRECATED;
/**
* Convenience method; invokes the standard email application.
*
* @param address The destination address
* @param subject Subject string. Can be TQString::null.
* @param startup_id for app startup notification, "0" for none,
* "" ( empty string ) is the default
*/
void invokeMailer( const TQString &address, const TQString &subject, const TQCString& startup_id );
// KDE4 merge with above with startup_id = ""
void invokeMailer( const TQString &address, const TQString &subject );
/**
* Invokes the standard email application.
*
* @param mailtoURL A mailto URL.
* @param startup_id for app startup notification, "0" for none,
* "" ( empty string ) is the default
* @param allowAttachments whether attachments specified in mailtoURL should be honoured.
The default is false; do not honour requests for attachments.
*/
void invokeMailer( const KURL &mailtoURL, const TQCString& startup_id, bool allowAttachments );
// KDE4 merge with above with allowAttachments = false
void invokeMailer( const KURL &mailtoURL, const TQCString& startup_id );
// KDE4 merge with above with startup_id = ""
void invokeMailer( const KURL &mailtoURL );
/**
* Convenience method; invokes the standard email application.
*
* All parameters are optional.
*
* @param to The destination address.
* @param cc The Cc field
* @param bcc The Bcc field
* @param subject Subject string
* @param body A string containing the body of the mail (exclusive with messageFile)
* @param messageFile A file (URL) containing the body of the mail (exclusive with body) - currently unsupported
* @param attachURLs List of URLs to be attached to the mail.
* @param startup_id for app startup notification, "0" for none,
* "" ( empty string ) is the default
*/
void invokeMailer(const TQString &to, const TQString &cc, const TQString &bcc,
const TQString &subject, const TQString &body,
const TQString &messageFile, const TQStringList &attachURLs,
const TQCString& startup_id );
// KDE4 merge with above with startup_id = ""
void invokeMailer(const TQString &to, const TQString &cc, const TQString &bcc,
const TQString &subject, const TQString &body,
const TQString &messageFile = TQString::null, const TQStringList &attachURLs = TQStringList());
public slots:
/**
* Invokes the standard browser.
* Note that you should only do this when you know for sure that the browser can
* handle the URL (i.e. its mimetype). In doubt, if the URL can point to an image
* or anything else than directory or HTML, prefer to use new KRun( url ).
*
* @param url The destination address
* @param startup_id for app startup notification, "0" for none,
* "" ( empty string ) is the default
*/
void invokeBrowser( const TQString &url, const TQCString& startup_id );
// KDE4 merge with above with startup_id = ""
/**
* Invoke the standard browser. Uses a @p startup_id of "" (empty)
* and is otherwise the same as the above function.
*/
void invokeBrowser( const TQString &url );
/**
* If the widget with focus provides a cut() slot, call that slot. Thus for a
* simple application cut can be implemented as:
* \code
* KStdAction::cut( kapp, TQT_SLOT( cut() ), actionCollection() );
* \endcode
*/
void cut();
/**
* If the widget with focus provides a copy() slot, call that slot. Thus for a
* simple application copy can be implemented as:
* \code
* KStdAction::copy( kapp, TQT_SLOT( copy() ), actionCollection() );
* \endcode
*/
void copy();
/**
* If the widget with focus provides a paste() slot, call that slot. Thus for a
* simple application copy can be implemented as:
* \code
* KStdAction::paste( kapp, TQT_SLOT( paste() ), actionCollection() );
* \endcode
*/
void paste();
/**
* If the widget with focus provides a clear() slot, call that slot. Thus for a
* simple application clear() can be implemented as:
* \code
* new KAction( i18n( "Clear" ), "editclear", 0, kapp, TQT_SLOT( clear() ), actionCollection(), "clear" );
* \endcode
*
* Note that for some widgets, this may not provide the intended bahavior. For
* example if you make use of the code above and a KListView has the focus, clear()
* will clear all of the items in the list. If this is not the intened behavior
* and you want to make use of this slot, you can subclass KListView and reimplement
* this slot. For example the following code would implement a KListView without this
* behavior:
*
* \code
* class MyListView : public KListView {
* Q_OBJECT
* public:
* MyListView( TQWidget * parent = 0, const char * name = 0, WFlags f = 0 ) : KListView( parent, name, f ) {}
* virtual ~MyListView() {}
* public slots:
* virtual void clear() {}
* };
* \endcode
*/
void clear();
/**
* If the widget with focus provides a selectAll() slot, call that slot. Thus for a
* simple application select all can be implemented as:
* \code
* KStdAction::selectAll( kapp, TQT_SLOT( selectAll() ), actionCollection() );
* \endcode
*/
void selectAll();
/**
* Broadcast a received keycode to all listening KDE applications
* The primary use for this feature is to connect hotkeys such as
* XF86Display to their respective KGlobalAccel functions while
* the screen is locked by kdesktop_lock.
*/
void broadcastKeyCode(unsigned int keyCode);
public:
/**
* Returns the DCOP name of the service launcher. This will be something like
* klaucher_$host_$uid.
* @return the name of the service launcher
*/
static TQCString launcher();
/**
* Starts a service based on the (translated) name of the service.
* E.g. "Web Browser"
*
* @param _name the name of the service
* @param URL if not empty this URL is passed to the service
* @param error On failure, @p error contains a description of the error
* that occurred. If the pointer is 0, the argument will be
* ignored
* @param dcopService On success, @p dcopService contains the DCOP name
* under which this service is available. If empty, the service does
* not provide DCOP services. If the pointer is 0 the argument
* will be ignored
* @param pid On success, the process id of the new service will be written
* here. If the pointer is 0, the argument will be ignored.
* @param startup_id for app startup notification, "0" for none,
* "" ( empty string ) is the default
* @param noWait if set, the function does not wait till the service is running.
* @return an error code indicating success (== 0) or failure (> 0).
*/
static int startServiceByName( const TQString& _name, const TQString &URL,
TQString *error=0, TQCString *dcopService=0, int *pid=0, const TQCString &startup_id = "", bool noWait = false );
/**
* Starts a service based on the (translated) name of the service.
* E.g. "Web Browser"
*
* @param _name the name of the service
* @param URLs if not empty these URLs will be passed to the service
* @param error On failure, @p error contains a description of the error
* that occurred. If the pointer is 0, the argument will be
* ignored
* @param dcopService On success, @p dcopService contains the DCOP name
* under which this service is available. If empty, the service does
* not provide DCOP services. If the pointer is 0 the argument
* will be ignored
* @param pid On success, the process id of the new service will be written
* here. If the pointer is 0, the argument will be ignored.
* @param startup_id for app startup notification, "0" for none,
* "" ( empty string ) is the default
* @param noWait if set, the function does not wait till the service is running.
* @return an error code indicating success (== 0) or failure (> 0).
*/
static int startServiceByName( const TQString& _name, const TQStringList &URLs=TQStringList(),
TQString *error=0, TQCString *dcopService=0, int *pid=0, const TQCString &startup_id = "", bool noWait = false );
/**
* Starts a service based on the desktop path of the service.
* E.g. "Applications/konqueror.desktop" or "/home/user/bla/myfile.desktop"
*
* @param _name the path of the desktop file
* @param URL if not empty this URL is passed to the service
* @param error On failure, @p error contains a description of the error
* that occurred. If the pointer is 0, the argument will be
* ignored
* @param dcopService On success, @p dcopService contains the DCOP name
* under which this service is available. If empty, the service does
* not provide DCOP services. If the pointer is 0 the argument
* will be ignored
* @param pid On success, the process id of the new service will be written
* here. If the pointer is 0, the argument will be ignored.
* @param startup_id for app startup notification, "0" for none,
* "" ( empty string ) is the default
* @param noWait if set, the function does not wait till the service is running.
* @return an error code indicating success (== 0) or failure (> 0).
*/
static int startServiceByDesktopPath( const TQString& _name, const TQString &URL,
TQString *error=0, TQCString *dcopService=0, int *pid = 0, const TQCString &startup_id = "", bool noWait = false );
/**
* Starts a service based on the desktop path of the service.
* E.g. "Applications/konqueror.desktop" or "/home/user/bla/myfile.desktop"
*
* @param _name the path of the desktop file
* @param URLs if not empty these URLs will be passed to the service
* @param error On failure, @p error contains a description of the error
* that occurred. If the pointer is 0, the argument will be
* ignored
* @param dcopService On success, @p dcopService contains the DCOP name
* under which this service is available. If empty, the service does
* not provide DCOP services. If the pointer is 0 the argument
* will be ignored
* @param pid On success, the process id of the new service will be written
* here. If the pointer is 0, the argument will be ignored.
* @param startup_id for app startup notification, "0" for none,
* "" ( empty string ) is the default
* @param noWait if set, the function does not wait till the service is running.
* @return an error code indicating success (== 0) or failure (> 0).
*/
static int startServiceByDesktopPath( const TQString& _name, const TQStringList &URLs=TQStringList(),
TQString *error=0, TQCString *dcopService=0, int *pid = 0, const TQCString &startup_id = "", bool noWait = false );
/**
* Starts a service based on the desktop name of the service.
* E.g. "konqueror"
*
* @param _name the desktop name of the service
* @param URL if not empty this URL is passed to the service
* @param error On failure, @p error contains a description of the error
* that occurred. If the pointer is 0, the argument will be
* ignored
* @param dcopService On success, @p dcopService contains the DCOP name
* under which this service is available. If empty, the service does
* not provide DCOP services. If the pointer is 0 the argument
* will be ignored
* @param pid On success, the process id of the new service will be written
* here. If the pointer is 0, the argument will be ignored.
* @param startup_id for app startup notification, "0" for none,
* "" ( empty string ) is the default
* @param noWait if set, the function does not wait till the service is running.
* @return an error code indicating success (== 0) or failure (> 0).
*/
static int startServiceByDesktopName( const TQString& _name, const TQString &URL,
TQString *error=0, TQCString *dcopService=0, int *pid = 0, const TQCString &startup_id = "", bool noWait = false );
/**
* Starts a service based on the desktop name of the service.
* E.g. "konqueror"
*
* @param _name the desktop name of the service
* @param URLs if not empty these URLs will be passed to the service
* @param error On failure, @p error contains a description of the error
* that occurred. If the pointer is 0, the argument will be
* ignored
* @param dcopService On success, @p dcopService contains the DCOP name
* under which this service is available. If empty, the service does
* not provide DCOP services. If the pointer is 0 the argument
* will be ignored
* @param pid On success, the process id of the new service will be written
* here. If the pointer is 0, the argument will be ignored.
* @param startup_id for app startup notification, "0" for none,
* "" ( empty string ) is the default
* @param noWait if set, the function does not wait till the service is running.
* @return an error code indicating success (== 0) or failure (> 0).
*/
static int startServiceByDesktopName( const TQString& _name, const TQStringList &URLs=TQStringList(),
TQString *error=0, TQCString *dcopService=0, int *pid = 0, const TQCString &startup_id = "", bool noWait = false );
/**
* Starts a program via tdeinit.
*
* program name and arguments are converted to according to the
* local encoding and passed as is to tdeinit.
*
* @param name Name of the program to start
* @param args Arguments to pass to the program
* @param error On failure, @p error contains a description of the error
* that occurred. If the pointer is 0, the argument will be
* ignored
* @param pid On success, the process id of the new service will be written
* here. If the pointer is 0, the argument will be ignored.
* @param startup_id for app startup notification, "0" for none,
* "" ( empty string ) is the default
* @return an error code indicating success (== 0) or failure (> 0).
*/
static int tdeinitExec( const TQString& name, const TQStringList &args,
TQString *error, int *pid, const TQCString& startup_id );
// KDE4 merge with above with startup_id = ""
static int tdeinitExec( const TQString& name, const TQStringList &args=TQStringList(),
TQString *error=0, int *pid = 0 );
/**
* Starts a program via tdeinit and wait for it to finish.
*
* Like tdeinitExec(), but it waits till the program is finished.
* As such it behaves similar to the system(...) function.
*
* @param name Name of the program to start
* @param args Arguments to pass to the program
* @param error On failure, @p error contains a description of the error
* that occurred. If the pointer is 0, the argument will be
* ignored
* @param pid On success, the process id of the new service will be written
* here. If the pointer is 0, the argument will be ignored.
* @param startup_id for app startup notification, "0" for none,
* "" ( empty string ) is the default
* @return an error code indicating success (== 0) or failure (> 0).
*/
static int tdeinitExecWait( const TQString& name, const TQStringList &args,
TQString *error, int *pid, const TQCString& startup_id );
// KDE4 merge with above with startup_id = ""
static int tdeinitExecWait( const TQString& name, const TQStringList &args=TQStringList(),
TQString *error=0, int *pid = 0 );
/**
* Returns a text for the window caption.
*
* This may be set by
* "-caption", otherwise it will be equivalent to the name of the
* executable.
* @return the text for the window caption
*/
TQString caption() const;
/**
* @deprecated
*/
KDE_DEPRECATED KStyle* kstyle() const { return 0; }
/**
* Builds a caption that contains the application name along with the
* userCaption using a standard layout.
*
* To make a compliant caption
* for your window, simply do: @p setCaption(kapp->makeStdCaption(yourCaption));
*
* @param userCaption The caption string you want to display in the
* window caption area. Do not include the application name!
* @param withAppName Indicates that the method shall include or ignore
* the application name when making the caption string. You are not
* compliant if you set this to @p false.
* @param modified If true, a 'modified' sign will be included in the
* returned string. This is useful when indicating that a file is
* modified, i.e., it contains data that has not been saved.
* @return the created caption
*/
TQString makeStdCaption( const TQString &userCaption,
bool withAppName=true, bool modified=false ) const;
/**
* Get a file name in order to make a temporary copy of your document.
*
* @param pFilename The full path to the current file of your
* document.
* @return A new filename for auto-saving.
*/
TQString tempSaveName( const TQString& pFilename ) const;
/**
* Check whether an auto-save file exists for the document you want to
* open.
*
* @param pFilename The full path to the document you want to open.
* @param bRecover This gets set to true if there was a recover
* file.
* @return The full path of the file to open.
*/
TQString checkRecoverFile( const TQString& pFilename, bool& bRecover ) const;
#if defined(Q_WS_X11)
/**
* @internal
* Get the X11 display
* @return the X11 Display
*/
Display *getDisplay() { return display; }
#endif
/**
* @internal
* Gets X11 composition information
*/
void getX11RGBAInformation(Display *dpy);
/**
* Gets the availability of a composition manager such as kompmgr
* Note that at least one application must have called detectCompositionManagerAvailable
* while the current X display was active in order for this method to return valid results.
* @see detectCompositionManagerAvailable()
* @return whether the composition manager is enabled
*/
static bool isCompositionManagerAvailable();
/**
* Detects the availability of a composition manager such as kompmgr
* Note that calling this method will probably cause the screen to flicker.
* @see isCompositionManagerAvailable()
* @param force_available If set, force TDE to assume a composition manager is available
* @param available Whether or not the composition manager is available (only used if force_available is TRUE)
* @return whether the composition manager is enabled
*/
bool detectCompositionManagerAvailable(bool force_available=false, bool available=true);
/**
* @internal
* Opens the display
* This can be used to initialize a KApplication with RGBA support like this:
* KApplication app(KApplication::openX11RGBADisplay());
* or
* KApplication app(KApplication::openX11RGBADisplay(), useStyles);
*/
static Display* openX11RGBADisplay();
/**
* Returns the X11 display visual
*
* @return A pointer to the X11 display visual
*/
Qt::HANDLE getX11RGBAVisual(Display *dpy);
/**
* Returns the X11 display colormap
*
* @return An X11 display colormap object
*/
Qt::HANDLE getX11RGBAColormap(Display *dpy);
/**
* Returns whether or not X11 composition is available
*
* You must first call getX11RGBAInformation()
*
* Note that getX11RGBAInformation() has already
* been called if you used the default KApplication
* constructor.
*
* Additionally, at least one application must have called
* detectCompositionManagerAvailable while the current X
* display was active in order for this method to return
* valid results.
*
* @return true if composition is available
*/
bool isX11CompositionAvailable();
/**
* Enables style plugins.
*
* This is useful only to applications that normally
* do not display a GUI and create the KApplication with
* allowStyles set to false.
*/
void enableStyles();
/**
* Disables style plugins.
*
* Current style plugins do not get unloaded.
*
* This is only useful when used in combination with enableStyles().
*/
void disableStyles();
/**
* Installs widget filter as global X11 event filter.
*
* The widget
* filter receives XEvents in its standard TQWidget::x11Event() function.
*
* Warning: Only do this when absolutely necessary. An installed X11 filter
* can slow things down.
**/
void installX11EventFilter( TQWidget* filter );
/**
* Removes global X11 event filter previously installed by
* installX11EventFilter().
*/
void removeX11EventFilter( const TQWidget* filter );
/**
* Generates a uniform random number.
* @return A truly unpredictable number in the range [0, RAND_MAX)
*/
static int random();
/**
* Generates a random string. It operates in the range [A-Za-z0-9]
* @param length Generate a string of this length.
* @return the random string
*/
static TQString randomString(int length);
/**
* Adds a message type to the KIPC event mask. You can only add "system
* messages" to the event mask. These are the messages with id < 32.
* Messages with id >= 32 are user messages.
* @param id The message id. See KIPC::Message.
* @see KIPC
* @see removeKipcEventMask()
* @see kipcMessage()
*/
void addKipcEventMask(int id);
/**
* Removes a message type from the KIPC event mask. This message will
* not be handled anymore.
* @param id The message id.
* @see KIPC
* @see addKipcEventMask()
* @see kipcMessage()
*/
void removeKipcEventMask(int id);
/**
* Returns the app startup notification identifier for this running
* application.
* @return the startup notification identifier
*/
TQCString startupId() const;
/**
* @internal
* Sets a new value for the application startup notification window property for newly
* created toplevel windows.
* @param startup_id the startup notification identifier
* @see KStartupInfo::setNewStartupId
*/
void setStartupId( const TQCString& startup_id );
/**
* Updates the last user action timestamp to the given time, or to the current time,
* if 0 is given. Do not use unless you're really sure what you're doing.
* Consult focus stealing prevention section in tdebase/twin/README.
* @since 3.2
*/
void updateUserTimestamp( unsigned long time = 0 );
/**
* Returns the last user action timestamp or 0 if no user activity has taken place yet.
* @since 3.2.3
* @see updateuserTimestamp
*/
unsigned long userTimestamp() const;
/**
* Updates the last user action timestamp in the application registered to DCOP with dcopId
* to the given time, or to this application's user time, if 0 is given.
* Use before causing user interaction in the remote application, e.g. invoking a dialog
* in the application using a DCOP call.
* Consult focus stealing prevention section in tdebase/twin/README.
* @since 3.3
*/
void updateRemoteUserTimestamp( const TQCString& dcopId, unsigned long time = 0 );
/**
* Returns the argument to --geometry if any, so the geometry can be set
* wherever necessary
* @return the geometry argument, or TQString::null if there is none
*/
TQString geometryArgument() const;
/**
* Install a Qt SQL property map with entries for all KDE widgets
* Call this in any application using KDE widgets in TQSqlForm or TQDataView.
*/
void installKDEPropertyMap();
/**
* Returns whether a certain action is authorized
* @param genericAction The name of a generic action
* @return true if the action is authorized
*/
bool authorize(const TQString &genericAction);
/**
* Returns whether a certain KAction is authorized.
*
* @param action The name of a KAction action. The name is prepended
* with "action/" before being passed to authorize()
* @return true if the KAction is authorized
*/
bool authorizeKAction(const char *action);
/**
* Returns whether a certain URL related action is authorized.
*
* @param action The name of the action. Known actions are
* list (may be listed (e.g. in file selection dialog)),
* link (may be linked to),
* open (may open) and
* redirect (may be redirected to)
* @param baseURL The url where the action originates from
* @param destURL The object of the action
* @return true when the action is authorized, false otherwise.
* @since 3.1
*/
bool authorizeURLAction(const TQString &action, const KURL &baseURL, const KURL &destURL);
/**
* Allow a certain URL action. This can be useful if your application
* needs to ensure access to an application specific directory that may
* otherwise be subject to KIOSK restrictions.
* @param action The name of the action.
* @param _baseURL The url where the action originates from
* @param _destURL The object of the action
* @since 3.2
*/
void allowURLAction(const TQString &action, const KURL &_baseURL, const KURL &_destURL);
/**
* Returns whether access to a certain control module is authorized.
*
* @param menuId identifying the control module, e.g. kde-mouse.desktop
* @return true if access to the module is authorized, false otherwise.
* @since 3.2
*/
bool authorizeControlModule(const TQString &menuId);
/**
* Returns whether access to a certain control modules is authorized.
*
* @param menuIds list of menu-ids of control module,
* an example of a menu-id is kde-mouse.desktop.
* @return Those control modules for which access has been authorized.
* @since 3.2
*/
TQStringList authorizeControlModules(const TQStringList &menuIds);
/**
* Returns the state of the currently pressed keyboard modifiers (e.g. shift, control, etc.)
* and mouse buttons, similarly to TQKeyEvent::state() and TQMouseEvent::state().
* You usually should simply use the information provided by TQKeyEvent and TQMouseEvent,
* but it can be useful to query for the status of the modifiers at another moment
* (e.g. some KDE apps do that upon a drop event).
* @return the keyboard modifiers and mouse buttons state
* @since 3.4
*/
static ButtonState keyboardMouseState();
// Same values as ShiftMask etc. in X.h
enum { ShiftModifier = 1<<0,
LockModifier = 1<<1,
ControlModifier = 1<<2,
Modifier1 = 1<<3,
Modifier2 = 1<<4,
Modifier3 = 1<<5,
Modifier4 = 1<<6,
Modifier5 = 1<<7 };
/**
* @deprecated Use keyboardMouseState()
* @since 3.1
*/
static uint keyboardModifiers() KDE_DEPRECATED;
/** @deprecated Same values as Button1Mask etc. in X.h */
enum { Button1Pressed = 1<<8,
Button2Pressed = 1<<9,
Button3Pressed = 1<<10,
Button4Pressed = 1<<11,
Button5Pressed = 1<<12 };
/**
* @deprecated Use keyboardMouseState()
* @since 3.1
*/
static uint mouseState() KDE_DEPRECATED;
public slots:
/**
* Tells KApplication about one more operation that should be finished
* before the application exits. The standard behavior is to exit on the
* "last window closed" event, but some events should outlive the last window closed
* (e.g. a file copy for a file manager, or 'compacting folders on exit' for a mail client).
*/
void ref();
/**
* Tells KApplication that one operation such as those described in ref() just finished.
* The application exits if the counter is back to 0.
*/
void deref();
protected:
/**
* @internal Used by KUniqueApplication
*/
KApplication( bool allowStyles, bool GUIenabled, KInstance* _instance );
#ifdef Q_WS_X11
/**
* @internal Used by KUniqueApplication
*/
KApplication( Display *display, Qt::HANDLE visual, Qt::HANDLE colormap,
bool allowStyles, KInstance* _instance );
/**
* Used to catch X11 events
*/
bool x11EventFilter( XEvent * );
Display *display;
#endif
Atom kipcCommAtom;
int kipcEventMask;
/// Current application object.
static KApplication *KApp;
int pArgc;
/**
* This method is used internally to determine which edit slots are implemented
* by the widget that has the focus, and to invoke those slots if available.
*
* @param slot is the slot as returned using the TQT_SLOT() macro, for example TQT_SLOT( cut() )
*
* This method can be used in KApplication subclasses to implement application wide
* edit actions not supported by the KApplication class. For example (in your subclass):
*
* \code
* void MyApplication::deselect()
* {
* invokeEditSlot( TQT_SLOT( deselect() ) );
* }
* \endcode
*
* Now in your application calls to MyApplication::deselect() will call this slot on the
* focused widget if it provides this slot. You can combine this with KAction with:
*
* \code
* KStdAction::deselect( static_cast<MyApplication *>( kapp ), TQT_SLOT( cut() ), actionCollection() );
* \endcode
*
* @see cut()
* @see copy()
* @see paste()
* @see clear()
* @see selectAll()
*
* @since 3.2
*/
void invokeEditSlot( const char *slot );
private slots:
void dcopFailure(const TQString &);
void dcopBlockUserInput( bool );
void x11FilterDestroyed();
void checkAppStartedSlot();
private:
TQString sessionConfigName() const;
KConfig* pSessionConfig; //instance specific application config object
static DCOPClient *s_DCOPClient; // app specific application communication client
static bool s_dcopClientNeedsPostInit;
TQString aCaption; // the name for the window title
bool bSessionManagement;
struct oldPixmapType { TQPixmap a, b; };
mutable union {
struct {
TQPixmap *icon, *miniIcon;
} pm;
char unused[sizeof(oldPixmapType)];
} aIconPixmap; // KDE4: remove me
TQString aIconName;
TQString aMiniIconName;
bool useStyles;
TQWidget *smw;
void init( bool GUIenabled );
void parseCommandLine( ); // Handle KDE arguments (Using KCmdLineArgs)
void read_app_startup_id();
void dcopAutoRegistration();
void dcopClientPostInit();
void initUrlActionRestrictions();
bool argb_visual;
#if defined(Q_WS_X11)
Qt::HANDLE argb_x11_visual;
Qt::HANDLE argb_x11_colormap;
#endif
public:
/**
* @internal
*/
bool notify(TQObject *receiver, TQEvent *event);
/**
@internal
*/
int xErrhandler( Display*, void* );
/**
@internal
*/
int xioErrhandler( Display* );
/**
* @internal
*/
void iceIOErrorHandler( _IceConn *conn );
/**
* @internal
*/
static bool loadedByKdeinit;
/**
* @internal
*/
static void startKdeinit();
/**
* Valid values for the settingsChanged signal
*/
enum SettingsCategory { SETTINGS_MOUSE, SETTINGS_COMPLETION, SETTINGS_PATHS,
SETTINGS_POPUPMENU, SETTINGS_QT, SETTINGS_SHORTCUTS };
/**
* Used to obtain the TQPalette that will be used to set the application palette.
*
* This is only useful for configuration modules such as krdb and should not be
* used in normal circumstances.
* @return the QPalette
* @since 3.1
*/
static TQPalette createApplicationPalette();
/**
* @internal
* Raw access for use by KDM.
*/
static TQPalette createApplicationPalette( KConfig *config, int contrast );
/**
* Installs a handler for the SIGPIPE signal. It is thrown when you write to
* a pipe or socket that has been closed.
* The handler is installed automatically in the constructor, but you may
* need it if your application or component does not have a KApplication
* instance.
*/
static void installSigpipeHandler();
/**
* @internal
* Whether widgets can be used.
*
* @since 3.2
*/
static bool guiEnabled();
signals:
/**
* Emitted when KApplication has changed its palette due to a KControl request.
*
* Normally, widgets will update their palette automatically, but you
* should connect to this to program special behavior.
*/
void kdisplayPaletteChanged();
/**
* Emitted when KApplication has changed its GUI style in response to a KControl request.
*
* Normally, widgets will update their styles automatically (as they would
* respond to an explicit setGUIStyle() call), but you should connect to
* this to program special behavior.
*/
void kdisplayStyleChanged();
/**
* Emitted when KApplication has changed its font in response to a KControl request.
*
* Normally widgets will update their fonts automatically, but you should
* connect to this to monitor global font changes, especially if you are
* using explicit fonts.
*
* Note: If you derive from a QWidget-based class, a faster method is to
* reimplement TQWidget::fontChange(). This is the preferred way
* to get informed about font updates.
*/
void kdisplayFontChanged();
/**
* Emitted when KApplication has changed either its GUI style, its font or its palette
* in response to a kdisplay request. Normally, widgets will update their styles
* automatically, but you should connect to this to program special
* behavior. */
void appearanceChanged();
/**
* Emitted when the settings for toolbars have been changed. KToolBar will know what to do.
*/
void toolbarAppearanceChanged(int);
/**
* Emitted when the desktop background has been changed by @p kcmdisplay.
*
* @param desk The desktop whose background has changed.
*/
void backgroundChanged(int desk);
/**
* Emitted when the global settings have been changed - see KGlobalSettings
* KApplication takes care of calling reparseConfiguration on KGlobal::config()
* so that applications/classes using this only have to re-read the configuration
* @param category the category among the enum above
*/
void settingsChanged(int category);
/**
* Emitted when the global icon settings have been changed.
* @param group the new group
*/
void iconChanged(int group);
/**
* Emitted when a KIPC user message has been received.
* @param id the message id
* @param data the data
* @see KIPC
* @see KIPC::Message
* @see addKipcEventMask
* @see removeKipcEventMask
*/
void kipcMessage(int id, int data);
/**
Session management asks you to save the state of your application.
This signal is provided for compatibility only. For new
applications, simply use KMainWindow. By reimplementing
KMainWindow::queryClose(), KMainWindow::saveProperties() and
KMainWindow::readProperties() you can simply handle session
management for applications with multiple toplevel windows.
For purposes without KMainWindow, create an instance of
KSessionManaged and reimplement the functions
KSessionManaged::commitData() and/or
KSessionManaged::saveState()
If you still want to use this signal, here is what you should do:
Connect to this signal in order to save your data. Do NOT
manipulate the UI in that slot, it is blocked by the session
manager.
Use the sessionConfig() KConfig object to store all your
instance specific data.
Do not do any closing at this point! The user may still select
Cancel wanting to continue working with your
application. Cleanups could be done after shutDown() (see
the following).
*/
void saveYourself();
/** Your application is killed. Either by your program itself,
@p xkill or (the usual case) by KDE's logout.
The signal is particularly useful if your application has to do some
last-second cleanups. Note that no user interaction is possible at
this state.
*/
void shutDown();
/**
* @internal
* Used to notify KIconLoader objects that they need to reload.
*/
void updateIconLoaders();
/**
* @internal
* Used to send KGlobalAccel objects a new keypress from physical hotkeys.
*/
void coreFakeKeyPress(unsigned int keyCode);
private:
void propagateSettings(SettingsCategory category);
void kdisplaySetPalette();
void kdisplaySetStyle();
void kdisplaySetFont();
void applyGUIStyle();
static void sigpipeHandler(int);
int captionLayout;
KApplication(const KApplication&);
KApplication& operator=(const KApplication&);
protected:
virtual void virtual_hook( int id, void* data );
private:
KApplicationPrivate* d;
};
/**
* \relates KGlobal
* Check, if a file may be accessed in a given mode.
* This is a wrapper around the access() system call.
* checkAccess() calls access() with the given parameters.
* If this is OK, checkAccess() returns true. If not, and W_OK
* is part of mode, it is checked if there is write access to
* the directory. If yes, checkAccess() returns true.
* In all other cases checkAccess() returns false.
*
* Other than access() this function EXPLICITLY ignores non-existant
* files if checking for write access.
*
* @param pathname The full path of the file you want to test
* @param mode The access mode, as in the access() system call.
* @return Whether the access is allowed, true = Access allowed
*/
TDECORE_EXPORT bool checkAccess(const TQString& pathname, int mode);
class KSessionManagedPrivate;
/**
Provides highlevel access to session management on a per-object
base.
KSessionManaged makes it possible to provide implementations for
TQApplication::commitData() and TQApplication::saveState(), without
subclassing KApplication. KMainWindow internally makes use of this.
You don't need to do anything with this class when using
KMainWindow. Instead, use KMainWindow::saveProperties(),
KMainWindow::readProperties(), KMainWindow::queryClose(),
KMainWindow::queryExit() and friends.
@short Highlevel access to session management.
@author Matthias Ettrich <ettrich@kde.org>
*/
class TDECORE_EXPORT KSessionManaged
{
public:
KSessionManaged();
virtual ~KSessionManaged();
/**
See TQApplication::saveState() for documentation.
This function is just a convenience version to avoid subclassing KApplication.
Return true to indicate a successful state save or false to
indicate a problem and to halt the shutdown process (will
implicitly call sm.cancel() ).
*/
virtual bool saveState( TQSessionManager& sm );
/**
See TQApplication::commitData() for documentation.
This function is just a convenience version to avoid subclassing KApplication.
Return true to indicate a successful commit of data or false to
indicate a problem and to halt the shutdown process (will
implicitly call sm.cancel() ).
*/
virtual bool commitData( TQSessionManager& sm );
protected:
virtual void virtual_hook( int id, void* data );
private:
KSessionManagedPrivate *d;
};
#endif
|