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
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
|
/*
This file is part of the KDE libraries
Copyright (c) 1999 Preston Brown <[email protected]>
Copyright (c) 1997 Matthias Kalle Dalheimer <[email protected]>
Copyright (c) 2001 Waldo Bastian <[email protected]>
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 _KCONFIGBASE_H
#define _KCONFIGBASE_H
#include <tqobject.h>
#include <tqcolor.h>
#include <tqfont.h>
#include <tqdatetime.h>
#include <tqstrlist.h>
#include <tqstringlist.h>
#include <tqvariant.h>
#include <tqmap.h>
#include "tdeconfigdata.h"
#include "tdelibs_export.h"
class TDEConfigBackEnd;
class TDEConfigBasePrivate;
class TDEConfigGroup;
/**
* @short KDE Configuration Management abstract base class
*
* This class forms the base for all %KDE configuration. It is an
* abstract base class, meaning that you cannot directly instantiate
* objects of this class. Either use TDEConfig (for usual %KDE
* configuration) or KSimpleConfig (for special needs as in ksamba), or
* even TDESharedConfig (stores values in shared memory).
*
* All configuration entries are key, value pairs. Each entry also
* belongs to a specific group of related entries. All configuration
* entries that do not explicitly specify which group they are in are
* in a special group called the default group.
*
* If there is a $ character in an entry, TDEConfigBase tries to expand
* environment variable and uses its value instead of its name. You
* can avoid this feature by having two consecutive $ characters in
* your config file which get expanded to one.
*
* \note the '=' char is not allowed in keys and the ']' char is not allowed in
* a group name.
*
* @author Kalle Dalheimer <[email protected]>, Preston Brown <[email protected]>
* @see TDEGlobal#config()
* @see TDEConfig
* @see KSimpleConfig
* @see TDESharedConfig
*/
class TDECORE_EXPORT TDEConfigBase : public TQObject
{
Q_OBJECT
friend class TDEConfigBackEnd;
friend class TDEConfigINIBackEnd;
friend class TDEConfigGroup;
public:
/**
* Construct a TDEConfigBase object.
*/
TDEConfigBase();
/**
* Destructs the TDEConfigBase object.
*/
virtual ~TDEConfigBase();
/**
* Specifies the group in which keys will be read and written.
*
* Subsequent
* calls to readEntry() and writeEntry() will be applied only in the
* activated group.
*
* Switch back to the default group by passing a null string.
* @param group The name of the new group.
*/
void setGroup( const TQString& group );
/**
* Sets the group to the "Desktop Entry" group used for
* desktop configuration files for applications, mime types, etc.
*/
void setDesktopGroup();
/**
* Returns the name of the group in which we are
* searching for keys and from which we are retrieving entries.
*
* @return The current group.
*/
TQString group() const;
/**
* Returns true if the specified group is known about.
*
* @param group The group to search for.
* @return true if the group exists.
*/
bool hasGroup(const TQString &group) const;
/**
* Returns a list of groups that are known about.
*
* @return The list of groups.
**/
virtual TQStringList groupList() const = 0;
/**
* Returns a the current locale.
*
* @return A string representing the current locale.
*/
TQString locale() const;
/**
* Reads the value of an entry specified by @p pKey in the current group.
* If you want to read a path, please use readPathEntry().
*
* @param pKey The key to search for.
* @param aDefault A default value returned if the key was not found.
* @return The value for this key. Can be TQString::null if aDefault is null.
*/
TQString readEntry(const TQString& pKey,
const TQString& aDefault = TQString::null ) const;
/**
* Reads the value of an entry specified by @p pKey in the current group.
*
* @param pKey The key to search for.
* @param aDefault A default value returned if the key was not found.
* @return The value for this key. Can be TQString::null if aDefault is null.
*/
TQString readEntry(const char *pKey,
const TQString& aDefault = TQString::null ) const;
/**
* Reads the value of an entry specified by @p pKey in the current group.
* The value is treated as if it is of the given type.
*
* Note that only the following TQVariant types are allowed : String,
* StringList, List, Font, Point, Rect, Size, Color, Int, UInt, Bool,
* Double, DateTime and Date.
* @deprecated
*
* @param pKey The key to search for.
* @return An invalid TQVariant if the key was not found or if the
* read value cannot be converted to the given TQVariant::Type.
*/
TQVariant readPropertyEntry( const TQString& pKey, TQVariant::Type ) const;
/**
* Reads the value of an entry specified by @p pKey in the current group.
* The value is treated as if it is of the given type.
*
* Note that only the following TQVariant types are allowed : String,
* StringList, List, Font, Point, Rect, Size, Color, Int, UInt, Bool,
* Double, DateTime and Date.
*
* @deprecated
*
* @param pKey The key to search for.
* @return An invalid TQVariant if the key was not found or if the
* read value cannot be converted to the given TQVariant::Type.
*/
TQVariant readPropertyEntry( const char *pKey, TQVariant::Type ) const;
/**
* Reads the value of an entry specified by @p pKey in the current group.
* The value is treated as if it is of the type of the given default value.
*
* Note that only the following TQVariant types are allowed : String,
* StringList, List, Font, Point, Rect, Size, Color, Int, UInt, Bool,
* Double, DateTime and Date.
*
* @param pKey The key to search for.
* @param aDefault A default value returned if the key was not found or
* if the read value cannot be converted to the TQVariant::Type.
* @return The value for the key or the default value if the key was not
* found.
*/
TQVariant readPropertyEntry( const TQString& pKey,
const TQVariant &aDefault) const;
/**
* Reads the value of an entry specified by @p pKey in the current group.
* The value is treated as if it is of the type of the given default value.
*
* Note that only the following TQVariant types are allowed : String,
* StringList, List, Font, Point, Rect, Size, Color, Int, UInt, Bool,
* Double, DateTime and Date.
*
* @param pKey The key to search for.
* @param aDefault A default value returned if the key was not found or
* if the read value cannot be converted to the TQVariant::Type.
* @return The value for the key or the default value if the key was not
* found.
*/
TQVariant readPropertyEntry( const char *pKey,
const TQVariant &aDefault) const;
/**
* Reads a list of strings.
*
* @deprecated
*
* @param pKey The key to search for
* @param list In this object, the read list will be returned.
* @param sep The list separator (default ",")
* @return The number of entries in the list.
*/
int readListEntry( const TQString& pKey, TQStrList &list, char sep = ',' ) const;
/**
* Reads a list of strings.
*
* @deprecated
*
* @param pKey The key to search for
* @param list In this object, the read list will be returned.
* @param sep The list separator (default ",")
* @return The number of entries in the list.
*/
int readListEntry( const char *pKey, TQStrList &list, char sep = ',' ) const;
/**
* Reads a list of strings.
*
* @param pKey The key to search for.
* @param sep The list separator (default is ",").
* @return The list. Empty if the entry does not exist.
*/
TQStringList readListEntry( const TQString& pKey, char sep = ',' ) const;
/**
* Reads a list of strings.
*
* @param pKey The key to search for.
* @param sep The list separator (default is ",").
* @return The list. Empty if the entry does not exist.
*/
TQStringList readListEntry( const char *pKey, char sep = ',' ) const;
/**
* Reads a list of strings, but returns a default if the key
* did not exist.
* @param pKey The key to search for.
* @param aDefault The default value to use if the key does not exist.
* @param sep The list separator (default is ",").
* @return The list. Contains @p aDefault if the Key does not exist.
* @since 3.3
*/
TQStringList readListEntry( const char* pKey, const TQStringList& aDefault,
char sep = ',' ) const;
/**
* Reads a list of Integers.
*
* @param pKey The key to search for.
* @return The list. Empty if the entry does not exist.
*/
TQValueList<int> readIntListEntry( const TQString& pKey ) const;
/**
* Reads a list of Integers.
*
* @param pKey The key to search for.
* @return The list. Empty if the entry does not exist.
*/
TQValueList<int> readIntListEntry( const char *pKey ) const;
/**
* Reads a path.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it as a path. This means, dollar expansion is activated
* for this value, so that e.g. $HOME gets expanded.
*
* @param pKey The key to search for.
* @param aDefault A default value returned if the key was not found.
* @return The value for this key. Can be TQString::null if aDefault is null.
*/
TQString readPathEntry( const TQString& pKey, const TQString & aDefault = TQString::null ) const;
/**
* Reads a path.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it as a path. This means, dollar expansion is activated
* for this value, so that e.g. $HOME gets expanded.
*
* @param pKey The key to search for.
* @param aDefault A default value returned if the key was not found.
* @return The value for this key. Can be TQString::null if aDefault is null.
*/
TQString readPathEntry( const char *pKey, const TQString & aDefault = TQString::null ) const;
/**
* Reads a list of string paths.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it as a list of paths. This means, dollar expansion is activated
* for this value, so that e.g. $HOME gets expanded.
*
* @param pKey The key to search for.
* @param sep The list separator (default is ",").
* @return The list. Empty if the entry does not exist.
* @since 3.1.3
*/
TQStringList readPathListEntry( const TQString& pKey, char sep = ',' ) const;
/**
* Reads a list of string paths.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it as a list of paths. This means, dollar expansion is activated
* for this value, so that e.g. $HOME gets expanded.
*
* @param pKey The key to search for.
* @param sep The list separator (default is ",").
* @return The list. Empty if the entry does not exist.
* @since 3.1.3
*/
TQStringList readPathListEntry( const char *pKey, char sep = ',' ) const;
/**
* Reads a numerical value.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it numerically.
*
* @param pKey The key to search for.
* @param nDefault A default value returned if the key was not found or if
* the read value cannot be interpreted.
* @return The value for this key.
*/
int readNumEntry( const TQString& pKey, int nDefault = 0 ) const;
/**
* Reads a numerical value.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it numerically.
*
* @param pKey The key to search for.
* @param nDefault A default value returned if the key was not found or if
* the read value cannot be interpreted.
* @return The value for this key.
*/
int readNumEntry( const char *pKey, int nDefault = 0 ) const;
/**
* Reads an unsigned numerical value.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it numerically.
*
* @param pKey The key to search for.
* @param nDefault A default value returned if the key was not found or if
* the read value cannot be interpreted.
* @return The value for this key.
*/
unsigned int readUnsignedNumEntry( const TQString& pKey, unsigned int nDefault = 0 ) const;
/**
* Reads an unsigned numerical value.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it numerically.
*
* @param pKey The key to search for.
* @param nDefault A default value returned if the key was not found or if
* the read value cannot be interpreted.
* @return The value for this key.
*/
unsigned int readUnsignedNumEntry( const char *pKey, unsigned int nDefault = 0 ) const;
/**
* Reads a numerical value.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it numerically.
*
* @param pKey The key to search for.
* @param nDefault A default value returned if the key was not found or if
* the read value cannot be interpreted.
* @return The value for this key.
*/
long readLongNumEntry( const TQString& pKey, long nDefault = 0 ) const;
/**
* Reads a numerical value.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it numerically.
*
* @param pKey The key to search for.
* @param nDefault A default value returned if the key was not found or if
* the read value cannot be interpreted.
* @return The value for this key.
*/
long readLongNumEntry( const char *pKey, long nDefault = 0 ) const;
/**
* Read an unsigned numerical value.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it numerically.
*
* @param pKey The key to search for.
* @param nDefault A default value returned if the key was not found or if
* the read value cannot be interpreted.
* @return The value for this key.
*/
unsigned long readUnsignedLongNumEntry( const TQString& pKey, unsigned long nDefault = 0 ) const;
/**
* Read an unsigned numerical value.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it numerically.
*
* @param pKey The key to search for.
* @param nDefault A default value returned if the key was not found or if
* the read value cannot be interpreted.
* @return The value for this key.
*/
unsigned long readUnsignedLongNumEntry( const char *pKey, unsigned long nDefault = 0 ) const;
/**
* Reads a 64-bit numerical value.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it numerically.
*
* @param pKey The key to search for.
* @param nDefault A default value returned if the key was not found or if
* the read value cannot be interpreted.
* @return The value for this key.
*/
TQ_INT64 readNum64Entry( const TQString& pKey, TQ_INT64 nDefault = 0 ) const;
/**
* Reads a 64-bit numerical value.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it numerically.
*
* @param pKey The key to search for.
* @param nDefault A default value returned if the key was not found or if
* the read value cannot be interpreted.
* @return The value for this key.
*/
TQ_INT64 readNum64Entry( const char *pKey, TQ_INT64 nDefault = 0 ) const;
/**
* Read an 64-bit unsigned numerical value.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it numerically.
*
* @param pKey The key to search for.
* @param nDefault A default value returned if the key was not found or if
* the read value cannot be interpreted.
* @return The value for this key.
*/
TQ_UINT64 readUnsignedNum64Entry( const TQString& pKey, TQ_UINT64 nDefault = 0 ) const;
/**
* Read an 64-bit unsigned numerical value.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it numerically.
*
* @param pKey The key to search for.
* @param nDefault A default value returned if the key was not found or if
* the read value cannot be interpreted.
* @return The value for this key.
*/
TQ_UINT64 readUnsignedNum64Entry( const char *pKey, TQ_UINT64 nDefault = 0 ) const;
/**
* Reads a floating point value.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it numerically.
*
* @param pKey The key to search for.
* @param nDefault A default value returned if the key was not found or if
* the read value cannot be interpreted.
* @return The value for this key.
*/
double readDoubleNumEntry( const TQString& pKey, double nDefault = 0.0 ) const;
/**
* Reads a floating point value.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it numerically.
*
* @param pKey The key to search for.
* @param nDefault A default value returned if the key was not found or if
* the read value cannot be interpreted.
* @return The value for this key.
*/
double readDoubleNumEntry( const char *pKey, double nDefault = 0.0 ) const;
/**
* Reads a TQFont value.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it as a font object.
*
* @param pKey The key to search for.
* @param pDefault A default value (null TQFont by default) returned if the
* key was not found or if the read value cannot be interpreted.
* @return The value for this key.
*/
TQFont readFontEntry( const TQString& pKey, const TQFont* pDefault = 0L ) const;
/**
* Reads a TQFont value.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it as a font object.
*
* @param pKey The key to search for.
* @param pDefault A default value (null TQFont by default) returned if the
* key was not found or if the read value cannot be interpreted.
* @return The value for this key.
*/
TQFont readFontEntry( const char *pKey, const TQFont* pDefault = 0L ) const;
/**
* Reads a boolean entry.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it as a boolean value. Currently "on", "yes", "1" and
* "true" are accepted as true, everything else if false.
*
* @param pKey The key to search for
* @param bDefault A default value returned if the key was not found.
* @return The value for this key.
*/
bool readBoolEntry( const TQString& pKey, bool bDefault = false ) const;
/**
* Reads a boolean entry.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it as a boolean value. Currently "on", "yes", "1" and
* "true" are accepted as true, everything else if false.
*
* @param pKey The key to search for
* @param bDefault A default value returned if the key was not found.
* @return The value for this key.
*/
bool readBoolEntry( const char *pKey, bool bDefault = false ) const;
/**
* Reads a TQRect entry.
*
* Read the value of an entry specified by pKey in the current group
* and interpret it as a TQRect object.
*
* @param pKey The key to search for
* @param pDefault A default value (null TQRect by default) returned if the
* key was not found or if the read value cannot be interpreted.
* @return The value for this key.
*/
TQRect readRectEntry( const TQString& pKey, const TQRect* pDefault = 0L ) const;
/**
* Reads a TQRect entry.
*
* Read the value of an entry specified by pKey in the current group
* and interpret it as a TQRect object.
*
* @param pKey The key to search for
* @param pDefault A default value (null TQRect by default) returned if the
* key was not found or if the read value cannot be interpreted.
* @return The value for this key.
*/
TQRect readRectEntry( const char *pKey, const TQRect* pDefault = 0L ) const;
/**
* Reads a TQPoint entry.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it as a TQPoint object.
*
* @param pKey The key to search for
* @param pDefault A default value (null TQPoint by default) returned if the
* key was not found or if the read value cannot be interpreted.
* @return The value for this key.
*/
TQPoint readPointEntry( const TQString& pKey, const TQPoint* pDefault = 0L ) const;
/**
* Reads a TQPoint entry.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it as a TQPoint object.
*
* @param pKey The key to search for
* @param pDefault A default value (null TQPoint by default) returned if the
* key was not found or if the read value cannot be interpreted.
* @return The value for this key.
*/
TQPoint readPointEntry( const char *pKey, const TQPoint* pDefault = 0L ) const;
/**
* Reads a TQSize entry.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it as a TQSize object.
*
* @param pKey The key to search for
* @param pDefault A default value (null TQSize by default) returned if the
* key was not found or if the read value cannot be interpreted.
* @return The value for this key.
*/
TQSize readSizeEntry( const TQString& pKey, const TQSize* pDefault = 0L ) const;
/**
* Reads a TQSize entry.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it as a TQSize object.
*
* @param pKey The key to search for
* @param pDefault A default value (null TQSize by default) returned if the
* key was not found or if the read value cannot be interpreted.
* @return The value for this key.
*/
TQSize readSizeEntry( const char *pKey, const TQSize* pDefault = 0L ) const;
/**
* Reads a TQColor entry.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it as a color.
*
* @param pKey The key to search for.
* @param pDefault A default value (null TQColor by default) returned if the
* key was not found or if the value cannot be interpreted.
* @return The value for this key.
*/
TQColor readColorEntry( const TQString& pKey, const TQColor* pDefault = 0L ) const;
/**
* Reads a TQColor entry.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it as a color.
*
* @param pKey The key to search for.
* @param pDefault A default value (null TQColor by default) returned if the
* key was not found or if the value cannot be interpreted.
* @return The value for this key.
*/
TQColor readColorEntry( const char *pKey, const TQColor* pDefault = 0L ) const;
/**
* Reads a TQDateTime entry.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it as a date and time.
*
* @param pKey The key to search for.
* @param pDefault A default value ( currentDateTime() by default)
* returned if the key was not found or if the read value cannot be
* interpreted.
* @return The value for this key.
*/
TQDateTime readDateTimeEntry( const TQString& pKey, const TQDateTime* pDefault = 0L ) const;
/**
* Reads a TQDateTime entry.
*
* Read the value of an entry specified by @p pKey in the current group
* and interpret it as a date and time.
*
* @param pKey The key to search for.
* @param pDefault A default value ( currentDateTime() by default)
* returned if the key was not found or if the read value cannot be
* interpreted.
* @return The value for this key.
*/
TQDateTime readDateTimeEntry( const char *pKey, const TQDateTime* pDefault = 0L ) const;
/**
* Reads the value of an entry specified by @p pKey in the current group.
* The untranslated entry is returned, you normally do not need this.
*
* @param pKey The key to search for.
* @param aDefault A default value returned if the key was not found.
* @return The value for this key.
*/
TQString readEntryUntranslated( const TQString& pKey,
const TQString& aDefault = TQString::null ) const;
/**
* Reads the value of an entry specified by @p pKey in the current group.
* The untranslated entry is returned, you normally do not need this.
*
* @param pKey The key to search for.
* @param aDefault A default value returned if the key was not found.
* @return The value for this key.
*/
TQString readEntryUntranslated( const char *pKey,
const TQString& aDefault = TQString::null ) const;
/**
* Writes a key/value pair.
*
* This is stored in the most specific config file when destroying the
* config object or when calling sync().
*
* If you want to write a path, please use writePathEntry().
*
* @param pKey The key to write.
* @param pValue The value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will
* not be written to disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the
* global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const TQString& pKey, const TQString& pValue,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Writes a key/value pair.
*
* This is stored in the most specific config file when destroying the
* config object or when calling sync().
*
* @param pKey The key to write.
* @param pValue The value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will
* not be written to disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the
* global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const char *pKey, const TQString& pValue,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* writeEntry() Overridden to accept a property.
*
* Note: Unlike the other writeEntry() functions, the old value is
* _not_ returned here!
*
* @param pKey The key to write
* @param rValue The property to write
* @param bPersistent If @p bPersistent is false, the entry's dirty flag
* will not be set and thus the entry will not be
* written to disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the
* global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*
* @see writeEntry()
*/
void writeEntry( const TQString& pKey, const TQVariant& rValue,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* writeEntry() Overridden to accept a property.
*
* Note: Unlike the other writeEntry() functions, the old value is
* _not_ returned here!
*
* @param pKey The key to write
* @param rValue The property to write
* @param bPersistent If @p bPersistent is false, the entry's dirty flag
* will not be set and thus the entry will not be
* written to disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the
* global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*
* @see writeEntry()
*/
void writeEntry( const char *pKey, const TQVariant& rValue,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* writeEntry() overridden to accept a list of strings.
*
* Note: Unlike the other writeEntry() functions, the old value is
* _not_ returned here!
*
* @param pKey The key to write
* @param rValue The list to write
* @param sep The list separator (default is ",").
* @param bPersistent If @p bPersistent is false, the entry's dirty flag
* will not be set and thus the entry will not be
* written to disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the
* global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*
* @see writeEntry()
*/
void writeEntry( const TQString& pKey, const TQStrList &rValue,
char sep = ',', bool bPersistent = true, bool bGlobal = false, bool bNLS = false );
/**
* writeEntry() overridden to accept a list of strings.
*
* Note: Unlike the other writeEntry() functions, the old value is
* _not_ returned here!
*
* @param pKey The key to write
* @param rValue The list to write
* @param sep The list separator (default is ",").
* @param bPersistent If @p bPersistent is false, the entry's dirty flag
* will not be set and thus the entry will not be
* written to disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the
* global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*
* @see writeEntry()
*/
void writeEntry( const char *pKey, const TQStrList &rValue,
char sep = ',', bool bPersistent = true, bool bGlobal = false, bool bNLS = false );
/**
* writeEntry() overridden to accept a list of strings.
*
* Note: Unlike the other writeEntry() functions, the old value is
* _not_ returned here!
*
* @param pKey The key to write
* @param rValue The list to write
* @param sep The list separator (default is ",").
* @param bPersistent If @p bPersistent is false, the entry's dirty flag
* will not be set and thus the entry will not be
* written to disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the
* global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*
* @see writeEntry()
*/
void writeEntry( const TQString& pKey, const TQStringList &rValue,
char sep = ',', bool bPersistent = true, bool bGlobal = false, bool bNLS = false );
/**
* writeEntry() overridden to accept a list of strings.
*
* Note: Unlike the other writeEntry() functions, the old value is
* _not_ returned here!
*
* @param pKey The key to write
* @param rValue The list to write
* @param sep The list separator (default is ",").
* @param bPersistent If @p bPersistent is false, the entry's dirty flag
* will not be set and thus the entry will not be
* written to disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the
* global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*
* @see writeEntry()
*/
void writeEntry( const char *pKey, const TQStringList &rValue,
char sep = ',', bool bPersistent = true, bool bGlobal = false, bool bNLS = false );
/**
* writeEntry() overridden to accept a list of Integers.
*
* Note: Unlike the other writeEntry() functions, the old value is
* _not_ returned here!
*
* @param pKey The key to write
* @param rValue The list to write
* @param bPersistent If @p bPersistent is false, the entry's dirty flag
* will not be set and thus the entry will not be
* written to disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the
* global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*
* @see writeEntry()
*/
void writeEntry( const TQString& pKey, const TQValueList<int>& rValue,
bool bPersistent = true, bool bGlobal = false, bool bNLS = false );
/**
* writeEntry() overridden to accept a list of Integers.
*
* Note: Unlike the other writeEntry() functions, the old value is
* _not_ returned here!
*
* @param pKey The key to write
* @param rValue The list to write
* @param bPersistent If @p bPersistent is false, the entry's dirty flag
* will not be set and thus the entry will not be
* written to disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the
* global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*
* @see writeEntry()
*/
void writeEntry( const char *pKey, const TQValueList<int>& rValue,
bool bPersistent = true, bool bGlobal = false, bool bNLS = false );
/**
* Write a (key/value) pair.
*
* This is stored to the most specific config file when destroying the
* config object or when calling sync().
*
* @param pKey The key to write.
* @param pValue The value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will
* not be written to disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the
* global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const TQString& pKey, const char *pValue,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false )
{ writeEntry(pKey, TQString::fromLatin1(pValue), bPersistent, bGlobal, bNLS); }
/**
* Write a (key/value) pair.
*
* This is stored to the most specific config file when destroying the
* config object or when calling sync().
*
* @param pKey The key to write.
* @param pValue The value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will
* not be written to disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the
* global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const char *pKey, const char *pValue,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false )
{ writeEntry(pKey, TQString::fromLatin1(pValue), bPersistent, bGlobal, bNLS); }
/**
* Write a (key/value) pair.
* Same as above, but writes a numerical value.
*
* @param pKey The key to write.
* @param nValue The value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the
* global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const TQString& pKey, int nValue,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Write a (key/value) pair.
* Same as above, but writes a numerical value.
*
* @param pKey The key to write.
* @param nValue The value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the
* global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const char *pKey, int nValue,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Writes a (key/value) pair.
* Same as above, but writes an unsigned numerical value.
*
* @param pKey The key to write.
* @param nValue The value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the
* global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const TQString& pKey, unsigned int nValue,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Writes a (key/value) pair.
* Same as above, but writes an unsigned numerical value.
*
* @param pKey The key to write.
* @param nValue The value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the
* global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const char *pKey, unsigned int nValue,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Writes a (key/value) pair.
* Same as above, but write a long numerical value.
*
* @param pKey The key to write.
* @param nValue The value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const TQString& pKey, long nValue,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Writes a (key/value) pair.
* Same as above, but write a long numerical value.
*
* @param pKey The key to write.
* @param nValue The value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const char *pKey, long nValue,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Writes a (key/value) pair.
* Same as above, but writes an unsigned long numerical value.
*
* @param pKey The key to write.
* @param nValue The value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const TQString& pKey, unsigned long nValue,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Writes a (key/value) pair.
* Same as above, but writes an unsigned long numerical value.
*
* @param pKey The key to write.
* @param nValue The value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const char *pKey, unsigned long nValue,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Writes a (key/value) pair.
* Same as above, but write a 64-bit numerical value.
*
* @param pKey The key to write.
* @param nValue The value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const TQString& pKey, TQ_INT64 nValue,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Writes a (key/value) pair.
* Same as above, but write a long numerical value.
*
* @param pKey The key to write.
* @param nValue The value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const char *pKey, TQ_INT64 nValue,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Writes a (key/value) pair.
* Same as above, but writes an unsigned 64-bit numerical value.
*
* @param pKey The key to write.
* @param nValue The value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const TQString& pKey, TQ_UINT64 nValue,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Writes a (key/value) pair.
* Same as above, but writes an unsigned 64-bit numerical value.
*
* @param pKey The key to write.
* @param nValue The value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const char *pKey, TQ_UINT64 nValue,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Writes a (key/value) pair.
* Same as above, but writes a floating-point value.
* @param pKey The key to write.
* @param nValue The value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the global KDE config file.
* @param format @p format determines the format to which the value
* is converted. Default is 'g'.
* @param precision @p precision sets the precision with which the
* value is converted. Default is 6 as in TQString.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const TQString& pKey, double nValue,
bool bPersistent = true, bool bGlobal = false,
char format = 'g', int precision = 6,
bool bNLS = false );
/**
* Writes a (key/value) pair.
* Same as above, but writes a floating-point value.
* @param pKey The key to write.
* @param nValue The value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the global KDE config file.
* @param format @p format determines the format to which the value
* is converted. Default is 'g'.
* @param precision @p precision sets the precision with which the
* value is converted. Default is 6 as in TQString.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const char *pKey, double nValue,
bool bPersistent = true, bool bGlobal = false,
char format = 'g', int precision = 6,
bool bNLS = false );
/**
* Writes a (key/value) pair.
* Same as above, but writes a boolean value.
*
* @param pKey The key to write.
* @param bValue The value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const TQString& pKey, bool bValue,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Writes a (key/value) pair.
* Same as above, but writes a boolean value.
*
* @param pKey The key to write.
* @param bValue The value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const char *pKey, bool bValue,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Writes a (key/value) pair.
* Same as above, but writes a font value.
*
* @param pKey The key to write.
* @param rFont The font value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const TQString& pKey, const TQFont& rFont,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Writes a (key/value) pair.
* Same as above, but writes a font value.
*
* @param pKey The key to write.
* @param rFont The font value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const char *pKey, const TQFont& rFont,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Writes a (key/value) pair.
* Same as above, but write a color entry.
*
* Note: Unlike the other writeEntry() functions, the old value is
* _not_ returned here!
*
* @param pKey The key to write.
* @param rColor The color value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const TQString& pKey, const TQColor& rColor,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Writes a (key/value) pair.
* Same as above, but write a color entry.
*
* Note: Unlike the other writeEntry() functions, the old value is
* _not_ returned here!
*
* @param pKey The key to write.
* @param rColor The color value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const char *pKey, const TQColor& rColor,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Writes a (key/value) pair.
* Same as above, but writes a date and time entry.
*
* Note: Unlike the other writeEntry() functions, the old value is
* @em not returned here!
*
* @param pKey The key to write.
* @param rDateTime The date and time value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const TQString& pKey, const TQDateTime& rDateTime,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Writes a (key/value) pair.
* Same as above, but writes a date and time entry.
*
* Note: Unlike the other writeEntry() functions, the old value is
* @em not returned here!
*
* @param pKey The key to write.
* @param rDateTime The date and time value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const char *pKey, const TQDateTime& rDateTime,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Writes a (key/value) pair.
* Same as above, but writes a rectangle.
*
* Note: Unlike the other writeEntry() functions, the old value is
* _not_ returned here!
*
* @param pKey The key to write.
* @param rValue The rectangle value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const TQString& pKey, const TQRect& rValue,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Writes a (key/value) pair.
* Same as above, but writes a rectangle.
*
* Note: Unlike the other writeEntry() functions, the old value is
* _not_ returned here!
*
* @param pKey The key to write.
* @param rValue The rectangle value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const char *pKey, const TQRect& rValue,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Writes a (key/value) pair.
* Same as above, but writes a point.
*
* Note: Unlike the other writeEntry() functions, the old value is
* _not_ returned here!
*
* @param pKey The key to write.
* @param rValue The point value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const TQString& pKey, const TQPoint& rValue,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Writes a (key/value) pair.
* Same as above, but writes a point.
*
* Note: Unlike the other writeEntry() functions, the old value is
* _not_ returned here!
*
* @param pKey The key to write.
* @param rValue The point value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const char *pKey, const TQPoint& rValue,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Writes a (key/value) pair.
* Same as above, but writes a size.
*
* Note: Unlike the other writeEntry() functions, the old value is
* _not_ returned here!
*
* @param pKey The key to write.
* @param rValue The size value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const TQString& pKey, const TQSize& rValue,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Writes a (key/value) pair.
* Same as above, but writes a size.
*
* Note: Unlike the other writeEntry() functions, the old value is
* _not_ returned here!
*
* @param pKey The key to write.
* @param rValue The size value to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writeEntry( const char *pKey, const TQSize& rValue,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Writes a file path.
*
* It is checked whether the path is located under $HOME. If so the
* path is written out with the user's home-directory replaced with
* $HOME. The path should be read back with readPathEntry()
*
* @param pKey The key to write.
* @param path The path to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writePathEntry( const TQString& pKey, const TQString & path,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Writes a file path.
*
* It is checked whether the path is located under $HOME. If so the
* path is written out with the user's home-directory replaced with
* $HOME. The path should be read back with readPathEntry()
*
* @param pKey The key to write.
* @param path The path to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*/
void writePathEntry( const char *pKey, const TQString & path,
bool bPersistent = true, bool bGlobal = false,
bool bNLS = false );
/**
* Writes a file path.
*
* It is checked whether the path is located under $HOME. If so the
* path is written out with the user's home-directory replaced with
* $HOME. The path should be read back with readPathEntry()
*
* @param pKey The key to write.
* @param path The path to write.
* @param bPersistent If @p bPersistent is false, the entry's dirty
* flag will not be set and thus the entry will not be written to
* disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
* @param expand If @p expand is true, environment variables will be
* expanded on read.
*/
void writePathEntry( const char *pKey, const TQString & path,
bool bPersistent, bool bGlobal,
bool bNLS, bool expand );
/**
* writePathEntry() overridden to accept a list of paths (strings).
*
* It is checked whether the paths are located under $HOME. If so each of
* the paths are written out with the user's home-directory replaced with
* $HOME. The paths should be read back with readPathListEntry()
*
* @param pKey The key to write
* @param rValue The list to write
* @param sep The list separator (default is ",").
* @param bPersistent If @p bPersistent is false, the entry's dirty flag
* will not be set and thus the entry will not be
* written to disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the
* global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*
* @see writePathEntry()
* @see readPathListEntry()
* @since 3.1.3
*/
void writePathEntry( const TQString& pKey, const TQStringList &rValue,
char sep = ',', bool bPersistent = true, bool bGlobal = false, bool bNLS = false );
/**
* writePathEntry() overridden to accept a list of paths (strings).
*
* It is checked whether the paths are located under $HOME. If so each of
* the paths are written out with the user's home-directory replaced with
* $HOME. The paths should be read back with readPathListEntry()
*
* @param pKey The key to write
* @param rValue The list to write
* @param sep The list separator (default is ",").
* @param bPersistent If @p bPersistent is false, the entry's dirty flag
* will not be set and thus the entry will not be
* written to disk at deletion time.
* @param bGlobal If @p bGlobal is true, the pair is not saved to the
* application specific config file, but to the
* global KDE config file.
* @param bNLS If @p bNLS is true, the locale tag is added to the key
* when writing it back.
*
* @see writePathEntry()
* @see readPathListEntry()
* @since 3.1.3
*/
void writePathEntry( const char *pKey, const TQStringList &rValue,
char sep = ',', bool bPersistent = true, bool bGlobal = false, bool bNLS = false );
/**
* Deletes the entry specified by @p pKey in the current group.
*
* @param pKey The key to delete.
* @param bGlobal If @p bGlobal is true, the pair is not removed from the
* application specific config file, but to the global KDE config file.
* @param bNLS If @p bNLS is true, the key with the locale tag is removed.
*/
void deleteEntry( const TQString& pKey,
bool bNLS = false, bool bGlobal = false);
/**
* Deletes the entry specified by @p pKey in the current group.
*
* @param pKey The key to delete.
* @param bGlobal If @p bGlobal is true, the pair is not removed from the
* application specific config file, but from the global KDE config file.
* @param bNLS If @p bNLS is true, the key with the locale tag is removed.
*/
void deleteEntry( const char *pKey,
bool bNLS = false, bool bGlobal = false);
/**
* Deletes a configuration entry group
*
* If the group is not empty and bDeep is false, nothing gets
* deleted and false is returned.
* If this group is the current group and it is deleted, the
* current group is undefined and should be set with setGroup()
* before the next operation on the configuration object.
*
* @param group The name of the group
* @param bDeep Specify whether non-empty groups should be completely
* deleted (including their entries).
* @param bGlobal If @p bGlobal is true, the group is not removed from the
* application specific config file, but from the global KDE config file.
* @return If the group is not empty and bDeep is false,
* deleteGroup returns false.
*/
bool deleteGroup( const TQString& group, bool bDeep = true, bool bGlobal = false );
/**
* Turns on or off "dollar expansion" (see TDEConfigBase introduction)
* when reading config entries.
* Dollar sign expansion is initially OFF.
*
* @param _bExpand Tf true, dollar expansion is turned on.
*/
void setDollarExpansion( bool _bExpand = true ) { bExpand = _bExpand; }
/**
* Returns whether dollar expansion is on or off. It is initially OFF.
*
* @return true if dollar expansion is on.
*/
bool isDollarExpansion() const { return bExpand; }
/**
* Mark the config object as "clean," i.e. don't write dirty entries
* at destruction time. If @p bDeep is false, only the global dirty
* flag of the TDEConfig object gets cleared. If you then call
* writeEntry() again, the global dirty flag is set again and all
* dirty entries will be written at a subsequent sync() call.
*
* Classes that derive from TDEConfigBase should override this
* method and implement storage-specific behavior, as well as
* calling the TDEConfigBase::rollback() explicitly in the initializer.
*
* @param bDeep If true, the dirty flags of all entries are cleared,
* as well as the global dirty flag.
*/
virtual void rollback( bool bDeep = true );
/**
* Flushes all changes that currently reside only in memory
* back to disk / permanent storage. Dirty configuration entries are
* written to the most specific file available.
*
* Asks the back end to flush out all pending writes, and then calls
* rollback(). No changes are made if the object has @p readOnly
* status.
*
* You should call this from your destructor in derivative classes.
*
* @see rollback(), #isReadOnly()
*/
virtual void sync();
/**
* Checks whether the config file has any dirty (modified) entries.
* @return true if the config file has any dirty (modified) entries.
*/
bool isDirty() const { return bDirty; }
/**
* Sets the config object's read-only status.
*
* @param _ro If true, the config object will not write out any
* changes to disk even if it is destroyed or sync() is called.
*
*/
virtual void setReadOnly(bool _ro) { bReadOnly = _ro; }
/**
* Returns the read-only status of the config object.
*
* @return The read-only status.
*/
bool isReadOnly() const { return bReadOnly; }
/**
* Checks whether the key has an entry in the currently active group.
* Use this to determine whether a key is not specified for the current
* group (hasKey() returns false). Keys with null data are considered
* nonexistent.
*
* @param key The key to search for.
* @return If true, the key is available.
*/
bool hasKey( const TQString& key ) const;
/**
* Returns a map (tree) of entries for all entries in a particular
* group. Only the actual entry string is returned, none of the
* other internal data should be included.
*
* @param group A group to get keys from.
* @return A map of entries in the group specified, indexed by key.
* The returned map may be empty if the group is not found.
* @see QMap
*/
virtual TQMap<TQString, TQString> entryMap(const TQString &group) const = 0;
/**
* Reparses all configuration files. This is useful for programs
* that use stand alone graphical configuration tools. The base
* method implemented here only clears the group list and then
* appends the default group.
*
* Derivative classes should clear any internal data structures and
* then simply call parseConfigFiles() when implementing this
* method.
*
* @see parseConfigFiles()
*/
virtual void reparseConfiguration() = 0;
/**
* Checks whether this configuration file can be modified.
* @return whether changes may be made to this configuration file.
*/
bool isImmutable() const;
/**
* Checks whether it is possible to change the given group.
* @param group the group to check
* @return whether changes may be made to @p group in this configuration
* file.
*/
bool groupIsImmutable(const TQString &group) const;
/**
* Checks whether it is possible to change the given entry.
* @param key the key to check
* @return whether the entry @p key may be changed in the current group
* in this configuration file.
*/
bool entryIsImmutable(const TQString &key) const;
/**
* Possible return values for getConfigState().
*
* @see getConfigState()
*/
enum ConfigState { NoAccess, ReadOnly, ReadWrite };
/**
* Returns the state of the app-config object.
*
* Possible return values
* are NoAccess (the application-specific config file could not be
* opened neither read-write nor read-only), ReadOnly (the
* application-specific config file is opened read-only, but not
* read-write) and ReadWrite (the application-specific config
* file is opened read-write).
*
* @see ConfigState()
* @return the state of the app-config object
*/
ConfigState getConfigState() const;
/**
* Check whether the config files are writable.
* @param warnUser Warn the user if the configuration files are not writable.
* @return Indicates that all of the configuration files used are writable.
* @since 3.2
*/
bool checkConfigFilesWritable(bool warnUser);
/**
* When set, all readEntry and readXXXEntry calls return the system
* wide (default) values instead of the user's preference.
* This is off by default.
* @since 3.2
*/
void setReadDefaults(bool b);
/**
* @returns true if all readEntry and readXXXEntry calls return the system
* wide (default) values instead of the user's preference.
* @since 3.2
*/
bool readDefaults() const;
/**
* Reverts the entry with key @p key in the current group in the
* application specific config file to either the system wide (default)
* value or the value specified in the global KDE config file.
*
* To revert entries in the global KDE config file, the global KDE config
* file should be opened explicitly in a separate config object.
*
* @param key The key of the entry to revert.
* @since 3.2
*/
void revertToDefault(const TQString &key);
/**
* Returns whether a default is specified for an entry in either the
* system wide configuration file or the global KDE config file.
*
* If an application computes a default value at runtime for
* a certain entry, e.g. like:
* \code
* TQColor computedDefault = kapp->palette().color(TQPalette::Active, TQColorGroup::Text)
* TQColor color = config->readEntry(key, computedDefault);
* \encode
*
* Then it may wish to make the following check before
* writing back changes:
* \code
* if ( (value == computedDefault) && !config->hasDefault(key) )
* config->revertToDefault(key)
* else
* config->writeEntry(key, value)
* \endcode
*
* This ensures that as long as the entry is not modified to differ from
* the computed default, the application will keep using the computed default
* and will follow changes the computed default makes over time.
* @param key The key of the entry to check.
* @since 3.2
*/
bool hasDefault(const TQString &key) const;
protected:
/**
* Reads the locale and put in the configuration data struct.
* Note that this should be done in the constructor, but this is not
* possible due to some mutual dependencies in TDEApplication::init()
*/
void setLocale();
/**
* Sets the global dirty flag of the config object
*
* @param _bDirty How to mark the object's dirty status
*/
virtual void setDirty(bool _bDirty = true) { bDirty = _bDirty; }
/**
* Parses all configuration files for a configuration object.
*
* The actual parsing is done by the associated TDEConfigBackEnd.
*/
virtual void parseConfigFiles();
/**
* Returns a map (tree) of the entries in the specified group.
* This may or may not return all entries that belong to the
* config object. The only guarantee that you are given is that
* any entries that are dirty (i.e. modified and not yet written back
* to the disk) will be contained in the map. Some derivative
* classes may choose to return everything.
*
* Do not use this function, the implementation / return type are
* subject to change.
*
* @param pGroup The group to provide a KEntryMap for.
* @return The map of the entries in the group.
* @internal
*/
virtual KEntryMap internalEntryMap( const TQString& pGroup ) const = 0;
/**
* Returns a map (tree) of the entries in the tree.
*
* Do not use this function, the implementation / return type are
* subject to change.
*
* @return A map of the entries in the tree.
*
* @internal
*
*/
virtual KEntryMap internalEntryMap() const = 0;
/**
* Inserts a (key/value) pair into the internal storage mechanism of
* the configuration object. Classes that derive from TDEConfigBase
* will need to implement this method in a storage-specific manner.
*
* Do not use this function, the implementation / return type are
* subject to change.
*
* @param _key The key to insert. It contains information both on
* the group of the key and the key itself. If the key already
* exists, the old value will be replaced.
* @param _data the KEntry that is to be stored.
* @param _checkGroup When false, assume that the group already exists.
* @internal
*/
virtual void putData(const KEntryKey &_key, const KEntry &_data, bool _checkGroup = true) = 0;
/**
* Looks up an entry in the config object's internal structure.
* Classes that derive from TDEConfigBase will need to implement this
* method in a storage-specific manner.
*
* Do not use this function, the implementation and return type are
* subject to change.
*
* @param _key The key to look up It contains information both on
* the group of the key and the entry's key itself.
* @return The KEntry value (data) found for the key. @p KEntry.aValue
* will be the null string if nothing was located.
* @internal
*/
virtual KEntry lookupData(const KEntryKey &_key) const = 0;
virtual bool internalHasGroup(const TQCString &group) const = 0;
/**
* A back end for loading/saving to disk in a particular format.
*/
TDEConfigBackEnd *backEnd;
public:
/**
* Overloaded public methods:
*/
void setGroup( const TQCString &pGroup );
void setGroup( const char *pGroup );
bool hasGroup(const TQCString &_pGroup) const;
bool hasGroup(const char *_pGroup) const;
bool hasKey( const char *pKey ) const;
protected:
TQCString readEntryUtf8( const char *pKey) const;
bool hasTranslatedKey( const char *pKey ) const;
/**
* The currently selected group. */
TQCString mGroup;
/**
* The locale to retrieve keys under if possible, i.e en_US or fr. */
TQCString aLocaleString;
/**
* Indicates whether there are any dirty entries in the config object
* that need to be written back to disk. */
bool bDirty;
bool bLocaleInitialized;
bool bReadOnly; // currently only used by KSimpleConfig
mutable bool bExpand; // whether dollar expansion is used
protected:
virtual void virtual_hook( int id, void* data );
private:
class TDEConfigBasePrivate;
TDEConfigBasePrivate *d;
void writeEntry( const char *pKey, const TQString &rValue,
bool bPersistent, bool bGlobal, bool bNLS, bool bExpand );
void writeEntry( const char *pKey, const TQStringList &rValue,
char sep, bool bPersistent, bool bGlobal, bool bNLS, bool bExpand );
};
class TDEConfigGroupSaverPrivate;
/**
* Helper class to facilitate working with TDEConfig / KSimpleConfig
* groups.
*
* Careful programmers always set the group of a
* TDEConfig KSimpleConfig object to the group they want to read from
* and set it back to the old one of afterwards. This is usually
* written as:
* \code
*
* TQString oldgroup config->group();
* config->setGroup( "TheGroupThatIWant" );
* ...
* config->writeEntry( "Blah", "Blubb" );
*
* config->setGroup( oldgroup );
* \endcode
*
* In order to facilitate this task, you can use
* TDEConfigGroupSaver. Simply construct such an object ON THE STACK
* when you want to switch to a new group. Then, when the object goes
* out of scope, the group will automatically be restored. If you
* want to use several different groups within a function or method,
* you can still use TDEConfigGroupSaver: Simply enclose all work with
* one group (including the creation of the TDEConfigGroupSaver object)
* in one block.
*
* @deprecated This class is deprecated and will be removed in KDE 4.
* TDEConfigGroup provides similar functionality in a more object oriented
* way.
*
* @author Matthias Kalle Dalheimer <[email protected]>
* @see TDEConfigBase, TDEConfig, KSimpleConfig, TDEConfigGroup
* @short Helper class for easier use of TDEConfig/KSimpleConfig groups
*/
class TDECORE_EXPORT TDEConfigGroupSaver // KDE4 remove
{
public:
/**
* Constructor. You pass a pointer to the TDEConfigBase-derived
* object you want to work with and a string indicating the _new_
* group.
*
* @param config The TDEConfigBase-derived object this
* TDEConfigGroupSaver works on.
* @param group The new group that the config object should switch to.
*/
TDEConfigGroupSaver( TDEConfigBase* config, TQString group )
/* KDE 4 : make the second parameter const TQString & */
: _config(config), _oldgroup(config->group())
{ _config->setGroup( group ); }
TDEConfigGroupSaver( TDEConfigBase* config, const char *group )
: _config(config), _oldgroup(config->group())
{ _config->setGroup( group ); }
TDEConfigGroupSaver( TDEConfigBase* config, const TQCString &group )
: _config(config), _oldgroup(config->group())
{ _config->setGroup( group ); }
~TDEConfigGroupSaver() { _config->setGroup( _oldgroup ); }
TDEConfigBase* config() { return _config; };
private:
TDEConfigBase* _config;
TQString _oldgroup;
TDEConfigGroupSaver(const TDEConfigGroupSaver&);
TDEConfigGroupSaver& operator=(const TDEConfigGroupSaver&);
TDEConfigGroupSaverPrivate *d;
};
class TDEConfigGroupPrivate;
/**
* A TDEConfigBase derived class for one specific group in a TDEConfig object.
*/
class TDECORE_EXPORT TDEConfigGroup: public TDEConfigBase
{
public:
/**
* Construct a config group corresponding to @p group in @p master.
* @p group is the group name encoded in UTF-8.
*/
TDEConfigGroup(TDEConfigBase *master, const TQCString &group);
/**
* This is an overloaded constructor provided for convenience.
* It behaves essentially like the above function.
*
* Construct a config group corresponding to @p group in @p master
*/
TDEConfigGroup(TDEConfigBase *master, const TQString &group);
/**
* This is an overloaded constructor provided for convenience.
* It behaves essentially like the above function.
*
* Construct a config group corresponding to @p group in @p master
* @p group is the group name encoded in UTF-8.
*/
TDEConfigGroup(TDEConfigBase *master, const char * group);
/**
* Delete all entries in the entire group
* @param bGlobal If @p bGlobal is true, the entries are not removed
* from the application specific config file, but from the global
* KDE config file.
*/
void deleteGroup(bool bGlobal = false);
/**
* Checks whether it is possible to change this group.
* @return whether changes may be made to this group in this configuration
* file.
* @since 3.4
*/
bool groupIsImmutable() const;
// The following functions are reimplemented:
virtual void setDirty(bool _bDirty);
virtual void putData(const KEntryKey &_key, const KEntry &_data, bool _checkGroup = true);
virtual KEntry lookupData(const KEntryKey &_key) const;
virtual void sync();
private:
// Hide the following members:
void setGroup() { }
void setDesktopGroup() { }
void group() { }
void hasGroup() { }
void setReadOnly(bool) { }
void isDirty() { }
// The following members are not used.
virtual TQStringList groupList() const { return TQStringList(); }
virtual void rollback(bool) { }
virtual void reparseConfiguration() { }
virtual TQMap<TQString, TQString> entryMap(const TQString &) const
{ return TQMap<TQString,TQString>(); }
virtual KEntryMap internalEntryMap( const TQString&) const
{ return KEntryMap(); }
virtual KEntryMap internalEntryMap() const
{ return KEntryMap(); }
virtual bool internalHasGroup(const TQCString &) const
{ return false; }
void getConfigState() { }
TDEConfigBase *mMaster;
protected:
virtual void virtual_hook( int id, void* data );
private:
TDEConfigGroupPrivate* d;
};
#endif
|