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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>wxWidgets: wxConfigBase Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="page_container">
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0" style="width: 100%;">
<tbody>
<tr>
<td id="projectlogo">
<a href="http://www.wxwidgets.org/" target="_new">
<img alt="wxWidgets" src="logo.png"/>
</a>
</td>
<td style="padding-left: 0.5em; text-align: right;">
<span id="projectnumber">Version: 3.0.2</span>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.8.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Categories</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classwx_config_base-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">wxConfigBase Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__group__class__cfg.html">Application and System configuration</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <wx/config.h></code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for wxConfigBase:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classwx_config_base__inherit__graph.png" border="0" usemap="#wx_config_base_inherit__map" alt="Inheritance graph"/></div>
<map name="wx_config_base_inherit__map" id="wx_config_base_inherit__map">
<area shape="rect" id="node5" href="classwx_file_config.html" title="wxFileConfig implements wxConfigBase interface for storing and retrieving configuration information u..." alt="" coords="5,161,99,189"/><area shape="rect" id="node7" href="classwx_reg_config.html" title="wxRegConfig implements the wxConfigBase interface for storing and retrieving configuration informatio..." alt="" coords="123,161,219,189"/><area shape="rect" id="node2" href="classwx_object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="73,6,148,34"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classwx_config_base.html" title="wxConfigBase defines the basic interface of all config classes.">wxConfigBase</a> defines the basic interface of all config classes. </p>
<p>It cannot be used by itself (it is an abstract base class) and you will always use one of its derivations: <a class="el" href="classwx_file_config.html" title="wxFileConfig implements wxConfigBase interface for storing and retrieving configuration information u...">wxFileConfig</a>, <a class="el" href="classwx_reg_config.html" title="wxRegConfig implements the wxConfigBase interface for storing and retrieving configuration informatio...">wxRegConfig</a> or any other.</p>
<p>However, usually you don't even need to know the precise nature of the class you're working with but you would just use the <a class="el" href="classwx_config_base.html" title="wxConfigBase defines the basic interface of all config classes.">wxConfigBase</a> methods. This allows you to write the same code regardless of whether you're working with the registry under Windows or text-based config files under Unix. To make writing the portable code even easier, wxWidgets provides a typedef wxConfig which is mapped onto the native <a class="el" href="classwx_config_base.html" title="wxConfigBase defines the basic interface of all config classes.">wxConfigBase</a> implementation on the given platform: i.e. <a class="el" href="classwx_reg_config.html" title="wxRegConfig implements the wxConfigBase interface for storing and retrieving configuration informatio...">wxRegConfig</a> under Windows and <a class="el" href="classwx_file_config.html" title="wxFileConfig implements wxConfigBase interface for storing and retrieving configuration information u...">wxFileConfig</a> otherwise.</p>
<p>See <a class="el" href="overview_config.html">wxConfig Overview</a> for a description of all features of this class.</p>
<p>It is highly recommended to use static functions <a class="el" href="classwx_config_base.html#a61bfb04c1c133190b3e851b252ed1c60" title="Get the current config object.">Get()</a> and/or <a class="el" href="classwx_config_base.html#a8e2ca739326f32379d6816522a5d1907" title="Sets the config object as the current one, returns the pointer to the previous current object (both t...">Set()</a>, so please have a look at them.</p>
<p>Related Include Files:</p>
<ul>
<li><code><<a class="el" href="interface_2wx_2config_8h.html">wx/config.h</a>></code> - Let wxWidgets choose a wxConfig class for your platform. </li>
<li><code><wx/confbase.h></code> - Base config class. </li>
<li><code><<a class="el" href="fileconf_8h.html">wx/fileconf.h</a>></code> - <a class="el" href="classwx_file_config.html" title="wxFileConfig implements wxConfigBase interface for storing and retrieving configuration information u...">wxFileConfig</a> class. </li>
<li><code><<a class="el" href="regconf_8h.html">wx/msw/regconf.h</a>></code> - <a class="el" href="classwx_reg_config.html" title="wxRegConfig implements the wxConfigBase interface for storing and retrieving configuration informatio...">wxRegConfig</a> class, see also <a class="el" href="classwx_reg_key.html" title="wxRegKey is a class representing the Windows registry (it is only available under Windows)...">wxRegKey</a>.</li>
</ul>
<h1><a class="anchor" id="configbase_example"></a>
Example</h1>
<p>Here is how you would typically use this class:</p>
<div class="fragment"><div class="line"><span class="comment">// using wxConfig instead of writing wxFileConfig or wxRegConfig enhances</span></div>
<div class="line"><span class="comment">// portability of the code</span></div>
<div class="line">wxConfig *config = <span class="keyword">new</span> wxConfig(<span class="stringliteral">"MyAppName"</span>);</div>
<div class="line"></div>
<div class="line"><a class="code" href="classwx_string.html" title="String class for passing textual data to or receiving it from wxWidgets.">wxString</a> str;</div>
<div class="line"><span class="keywordflow">if</span> ( config->Read(<span class="stringliteral">"LastPrompt"</span>, &str) ) {</div>
<div class="line"> <span class="comment">// last prompt was found in the config file/registry and its value is</span></div>
<div class="line"> <span class="comment">// now in str</span></div>
<div class="line"> <span class="comment">// ...</span></div>
<div class="line">}</div>
<div class="line"><span class="keywordflow">else</span> {</div>
<div class="line"> <span class="comment">// no last prompt...</span></div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="comment">// another example: using default values and the full path instead of just</span></div>
<div class="line"><span class="comment">// key name: if the key is not found , the value 17 is returned</span></div>
<div class="line"><span class="keywordtype">long</span> value = config->ReadLong(<span class="stringliteral">"/LastRun/CalculatedValues/MaxValue"</span>, 17);</div>
<div class="line"></div>
<div class="line"><span class="comment">// at the end of the program we would save everything back</span></div>
<div class="line">config->Write(<span class="stringliteral">"LastPrompt"</span>, str);</div>
<div class="line">config->Write(<span class="stringliteral">"/LastRun/CalculatedValues/MaxValue"</span>, value);</div>
<div class="line"></div>
<div class="line"><span class="comment">// the changes will be written back automatically</span></div>
<div class="line"><span class="keyword">delete</span> config;</div>
</div><!-- fragment --><p>This basic example, of course, doesn't show all wxConfig features, such as enumerating, testing for existence and deleting the entries and groups of entries in the config file, its abilities to automatically store the default values or expand the environment variables on the fly. However, the main idea is that using this class is easy and that it should normally do what you expect it to.</p>
<dl class="section note"><dt>Note</dt><dd>In the documentation of this class, the words "config file" also mean "registry hive" for <a class="el" href="classwx_reg_config.html" title="wxRegConfig implements the wxConfigBase interface for storing and retrieving configuration informatio...">wxRegConfig</a> and, generally speaking, might mean any physical storage where a wxConfigBase-derived class stores its data.</dd></dl>
<h1><a class="anchor" id="configbase_static"></a>
Static Functions</h1>
<p>The static functions provided deal with the "default" config object. Although its usage is not at all mandatory it may be convenient to use a global config object instead of creating and deleting the local config objects each time you need one (especially because creating a <a class="el" href="classwx_file_config.html" title="wxFileConfig implements wxConfigBase interface for storing and retrieving configuration information u...">wxFileConfig</a> object might be a time consuming operation). In this case, you may create this global config object in the very start of the program and <a class="el" href="classwx_config_base.html#a8e2ca739326f32379d6816522a5d1907" title="Sets the config object as the current one, returns the pointer to the previous current object (both t...">Set()</a> it as the default. Then, from anywhere in your program, you may access it using the <a class="el" href="classwx_config_base.html#a61bfb04c1c133190b3e851b252ed1c60" title="Get the current config object.">Get()</a> function. This global wxConfig object will be deleted by wxWidgets automatically if it exists. Note that this implies that if you do delete this object yourself (usually in <a class="el" href="classwx_app_console.html#a5ee60051c92b0b2933258799626a0485" title="Override this member function for any processing which needs to be done as the application is about t...">wxApp::OnExit()</a>) you must use Set(<span class="literal">NULL</span>) to prevent wxWidgets from deleting it the second time.</p>
<p>As it happens, you may even further simplify the procedure described above: you may forget about calling <a class="el" href="classwx_config_base.html#a8e2ca739326f32379d6816522a5d1907" title="Sets the config object as the current one, returns the pointer to the previous current object (both t...">Set()</a>. When <a class="el" href="classwx_config_base.html#a61bfb04c1c133190b3e851b252ed1c60" title="Get the current config object.">Get()</a> is called and there is no current object, it will create one using <a class="el" href="classwx_config_base.html#aa7d633935adabe1bf11b5a028f8b3355" title="Create a new config object and sets it as the current one.">Create()</a> function. To disable this behaviour <a class="el" href="classwx_config_base.html#a0e8ad0cb0c5b374a99b99ea6212e496b" title="Calling this function will prevent Get() from automatically creating a new config object if the curre...">DontCreateOnDemand()</a> is provided.</p>
<dl class="section note"><dt>Note</dt><dd>You should use either <a class="el" href="classwx_config_base.html#a8e2ca739326f32379d6816522a5d1907" title="Sets the config object as the current one, returns the pointer to the previous current object (both t...">Set()</a> or <a class="el" href="classwx_config_base.html#a61bfb04c1c133190b3e851b252ed1c60" title="Get the current config object.">Get()</a> because wxWidgets library itself would take advantage of it and could save various information in it. For example <a class="el" href="classwx_font_mapper.html" title="wxFontMapper manages user-definable correspondence between logical font names and the fonts present o...">wxFontMapper</a> or Unix version of <a class="el" href="classwx_file_dialog.html" title="This class represents the file chooser dialog.">wxFileDialog</a> have the ability to use wxConfig class.</dd></dl>
<h1><a class="anchor" id="configbase_paths"></a>
Path Management</h1>
<p>As explained in the <a class="el" href="overview_config.html">config overview</a>, the config classes support a file system-like hierarchy of keys (files) and groups (directories). As in the file system case, to specify a key in the config class you must use a path to it. Config classes also support the notion of the current group, which makes it possible to use the relative paths. To clarify all this, here is an example (it is only for the sake of demonstration, it doesn't do anything sensible!):</p>
<div class="fragment"><div class="line">wxConfig *config = <span class="keyword">new</span> wxConfig(<span class="stringliteral">"FooBarApp"</span>);</div>
<div class="line"></div>
<div class="line"><span class="comment">// right now the current path is '/'</span></div>
<div class="line">conf->Write(<span class="stringliteral">"RootEntry"</span>, 1);</div>
<div class="line"></div>
<div class="line"><span class="comment">// go to some other place: if the group(s) don't exist, they will be created</span></div>
<div class="line">conf->SetPath(<span class="stringliteral">"/Group/Subgroup"</span>);</div>
<div class="line"></div>
<div class="line"><span class="comment">// create an entry in subgroup</span></div>
<div class="line">conf->Write(<span class="stringliteral">"SubgroupEntry"</span>, 3);</div>
<div class="line"></div>
<div class="line"><span class="comment">// '..' is understood</span></div>
<div class="line">conf->Write(<span class="stringliteral">"../GroupEntry"</span>, 2);</div>
<div class="line">conf->SetPath(<span class="stringliteral">".."</span>);</div>
<div class="line"></div>
<div class="line"><a class="code" href="group__group__funcmacro__debug.html#ga204cc264ee560b67e6c6467ba8ffee5f" title="Assert macro.">wxASSERT</a>( conf->ReadLong(<span class="stringliteral">"Subgroup/SubgroupEntry"</span>, 0) == 3 );</div>
<div class="line"></div>
<div class="line"><span class="comment">// use absolute path: it is allowed, too</span></div>
<div class="line"><a class="code" href="group__group__funcmacro__debug.html#ga204cc264ee560b67e6c6467ba8ffee5f" title="Assert macro.">wxASSERT</a>( conf->ReadLong(<span class="stringliteral">"/RootEntry"</span>, 0) == 1 );</div>
</div><!-- fragment --><p>It is highly recommended that you restore the path to its old value on function exit:</p>
<div class="fragment"><div class="line"><span class="keywordtype">void</span> foo(<a class="code" href="classwx_config_base.html" title="wxConfigBase defines the basic interface of all config classes.">wxConfigBase</a> *config)</div>
<div class="line">{</div>
<div class="line"> <a class="code" href="classwx_string.html" title="String class for passing textual data to or receiving it from wxWidgets.">wxString</a> strOldPath = config-><a class="code" href="classwx_config_base.html#a2c76e8a110cecc4d89d3af1565044e15" title="Retrieve the current path (always as absolute path).">GetPath</a>();</div>
<div class="line"></div>
<div class="line"> config-><a class="code" href="classwx_config_base.html#ad290d3fe7fad4f39a4bb2959db89b379" title="Set current path: if the first character is '/', it is the absolute path, otherwise it is a relative ...">SetPath</a>(<span class="stringliteral">"/Foo/Data"</span>);</div>
<div class="line"> <span class="comment">// ...</span></div>
<div class="line"></div>
<div class="line"> config-><a class="code" href="classwx_config_base.html#ad290d3fe7fad4f39a4bb2959db89b379" title="Set current path: if the first character is '/', it is the absolute path, otherwise it is a relative ...">SetPath</a>(strOldPath);</div>
<div class="line">}</div>
</div><!-- fragment --><p>Otherwise the assert in the following example will surely fail (we suppose here that the foo() function is the same as above except that it doesn’t save and restore the path):</p>
<div class="fragment"><div class="line"><span class="keywordtype">void</span> bar(<a class="code" href="classwx_config_base.html" title="wxConfigBase defines the basic interface of all config classes.">wxConfigBase</a> *config)</div>
<div class="line">{</div>
<div class="line"> config-><a class="code" href="classwx_config_base.html#ace24f1478e71ac309ecf1d9273f19ce3" title="Writes the wxString value to the config file and returns true on success.">Write</a>(<span class="stringliteral">"Test"</span>, 17);</div>
<div class="line"></div>
<div class="line"> foo(config);</div>
<div class="line"></div>
<div class="line"> <span class="comment">// we're reading "/Foo/Data/Test" here! -1 will probably be returned...</span></div>
<div class="line"> <a class="code" href="group__group__funcmacro__debug.html#ga204cc264ee560b67e6c6467ba8ffee5f" title="Assert macro.">wxASSERT</a>( config-><a class="code" href="classwx_config_base.html#ab876635fe7cefe7eae38a1ef330a4c49" title="Reads a long value from the key and returns it.">ReadLong</a>(<span class="stringliteral">"Test"</span>, -1) == 17 );</div>
<div class="line">}</div>
</div><!-- fragment --><p>Finally, the path separator in <a class="el" href="classwx_config_base.html" title="wxConfigBase defines the basic interface of all config classes.">wxConfigBase</a> and derived classes is always "/", regardless of the platform (i.e. it is not "\\" under Windows).</p>
<h1><a class="anchor" id="configbase_enumeration"></a>
Enumeration</h1>
<p>The enumeration functions allow you to enumerate all entries and groups in the config file. All functions here return <span class="literal">false</span> when there are no more items.</p>
<p>You must pass the same index to GetNext() and GetFirst() (don't modify it). Please note that it is not the index of the current item (you will have some great surprises with <a class="el" href="classwx_reg_config.html" title="wxRegConfig implements the wxConfigBase interface for storing and retrieving configuration informatio...">wxRegConfig</a> if you assume this) and you shouldn't even look at it: it is just a "cookie" which stores the state of the enumeration. It can't be stored inside the class because it would prevent you from running several enumerations simultaneously, that's why you must pass it explicitly.</p>
<p>Having said all this, enumerating the config entries/groups is very simple:</p>
<div class="fragment"><div class="line"><a class="code" href="classwx_config_base.html" title="wxConfigBase defines the basic interface of all config classes.">wxConfigBase</a> *config = ...;</div>
<div class="line"><a class="code" href="classwx_array_string.html" title="wxArrayString is an efficient container for storing wxString objects.">wxArrayString</a> aNames;</div>
<div class="line"></div>
<div class="line"><span class="comment">// enumeration variables</span></div>
<div class="line"><a class="code" href="classwx_string.html" title="String class for passing textual data to or receiving it from wxWidgets.">wxString</a> str;</div>
<div class="line"><span class="keywordtype">long</span> dummy;</div>
<div class="line"></div>
<div class="line"><span class="comment">// first enum all entries</span></div>
<div class="line"><span class="keywordtype">bool</span> bCont = config-><a class="code" href="classwx_config_base.html#a1f8338dd47972d196c6475e7e1140ae7" title="Gets the first entry.">GetFirstEntry</a>(str, dummy);</div>
<div class="line"><span class="keywordflow">while</span> ( bCont ) {</div>
<div class="line"> aNames.<a class="code" href="classwx_array_string.html#af06b61455118d83a24183c3a9f6854b1" title="Appends the given number of copies of the new item str to the array and returns the index of the firs...">Add</a>(str);</div>
<div class="line"></div>
<div class="line"> bCont = GetConfig()->GetNextEntry(str, dummy);</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="comment">// ... we have all entry names in aNames...</span></div>
<div class="line"></div>
<div class="line"><span class="comment">// now all groups...</span></div>
<div class="line">bCont = GetConfig()->GetFirstGroup(str, dummy);</div>
<div class="line"><span class="keywordflow">while</span> ( bCont ) {</div>
<div class="line"> aNames.<a class="code" href="classwx_array_string.html#af06b61455118d83a24183c3a9f6854b1" title="Appends the given number of copies of the new item str to the array and returns the index of the firs...">Add</a>(str);</div>
<div class="line"></div>
<div class="line"> bCont = GetConfig()->GetNextGroup(str, dummy);</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="comment">// ... we have all group (and entry) names in aNames...</span></div>
</div><!-- fragment --><p>There are also functions to get the number of entries/subgroups without actually enumerating them, but you will probably never need them.</p>
<h1><a class="anchor" id="configbase_keyaccess"></a>
Key Access</h1>
<p>The key access functions are the core of <a class="el" href="classwx_config_base.html" title="wxConfigBase defines the basic interface of all config classes.">wxConfigBase</a> class: they allow you to read and write config file data. All <a class="el" href="classwx_config_base.html#af89fb6c338f200bec028480ac0f3b1d8" title="Read a string from the key, returning true if the value was read.">Read()</a> functions take a default value which will be returned if the specified key is not found in the config file.</p>
<p>Currently, supported types of data are: <a class="el" href="classwx_string.html" title="String class for passing textual data to or receiving it from wxWidgets.">wxString</a>, <code>long</code>, <code>double</code>, <code>bool</code>, <a class="el" href="classwx_colour.html" title="A colour is an object representing a combination of Red, Green, and Blue (RGB) intensity values...">wxColour</a> and any other types for which the functions <a class="el" href="group__group__funcmacro__misc.html#ga0adf8026ea8ed126420a2e7ef9edc678" title="Converts the given wxColour into a string.">wxToString()</a> and <a class="el" href="group__group__funcmacro__misc.html#ga598ae7504c6436af325490b41f4b5e90" title="Converts string to a wxColour best represented by the given string.">wxFromString()</a> are defined.</p>
<p>Try not to read long values into string variables and vice versa: although it just might work with <a class="el" href="classwx_file_config.html" title="wxFileConfig implements wxConfigBase interface for storing and retrieving configuration information u...">wxFileConfig</a>, you will get a system error with <a class="el" href="classwx_reg_config.html" title="wxRegConfig implements the wxConfigBase interface for storing and retrieving configuration informatio...">wxRegConfig</a> because in the Windows registry the different types of entries are indeed used.</p>
<p>Final remark: the <em>szKey</em> parameter for all these functions can contain an arbitrary path (either relative or absolute), not just the key name.</p>
<h2></h2>
<div><span class="lib">Library:</span>  <span class="lib_text"><a class="el" href="page_libs.html#page_libs_wxbase">wxBase</a></span></div><div><span class="category">Category:</span>  <span class="category_text"><a class="el" href="group__group__class__cfg.html">Application and System configuration</a></span></div><dl class="section see"><dt>See Also</dt><dd><a class="el" href="classwx_config_path_changer.html" title="A handy little class which changes the current path in a wxConfig object and restores it in dtor...">wxConfigPathChanger</a> </dd></dl>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a499282208b4b9e90cbfe60de25745bc4"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a499282208b4b9e90cbfe60de25745bc4">EntryType</a> { <br/>
  <a class="el" href="classwx_config_base.html#a499282208b4b9e90cbfe60de25745bc4a186e69ade61db5ba7e5fc2366d2388fc">Type_Unknown</a>,
<br/>
  <a class="el" href="classwx_config_base.html#a499282208b4b9e90cbfe60de25745bc4afeb4cd8ae582520fd2d45ec35b316d0a">Type_String</a>,
<br/>
  <a class="el" href="classwx_config_base.html#a499282208b4b9e90cbfe60de25745bc4a5338e90a8c51020109928f3177c06caf">Type_Boolean</a>,
<br/>
  <a class="el" href="classwx_config_base.html#a499282208b4b9e90cbfe60de25745bc4abf7985582695bbed6da7d2de5b22b6e8">Type_Integer</a>,
<br/>
  <a class="el" href="classwx_config_base.html#a499282208b4b9e90cbfe60de25745bc4af1cafe0a03c8c929511258c31ea138cb">Type_Float</a>
<br/>
}</td></tr>
<tr class="separator:a499282208b4b9e90cbfe60de25745bc4"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a7c3ce1f79df2837bc532c0ff551e7bac"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a7c3ce1f79df2837bc532c0ff551e7bac">wxConfigBase</a> (const <a class="el" href="classwx_string.html">wxString</a> &appName=<a class="el" href="interface_2wx_2string_8h.html#a9a321d587166a30017b608dd2d234033">wxEmptyString</a>, const <a class="el" href="classwx_string.html">wxString</a> &vendorName=<a class="el" href="interface_2wx_2string_8h.html#a9a321d587166a30017b608dd2d234033">wxEmptyString</a>, const <a class="el" href="classwx_string.html">wxString</a> &localFilename=<a class="el" href="interface_2wx_2string_8h.html#a9a321d587166a30017b608dd2d234033">wxEmptyString</a>, const <a class="el" href="classwx_string.html">wxString</a> &globalFilename=<a class="el" href="interface_2wx_2string_8h.html#a9a321d587166a30017b608dd2d234033">wxEmptyString</a>, long style=0, const <a class="el" href="classwx_m_b_conv.html">wxMBConv</a> &conv=<a class="el" href="classwx_conv_auto.html">wxConvAuto</a>())</td></tr>
<tr class="memdesc:a7c3ce1f79df2837bc532c0ff551e7bac"><td class="mdescLeft"> </td><td class="mdescRight">This is the default and only constructor of the <a class="el" href="classwx_config_base.html" title="wxConfigBase defines the basic interface of all config classes.">wxConfigBase</a> class, and derived classes. <a href="#a7c3ce1f79df2837bc532c0ff551e7bac"></a><br/></td></tr>
<tr class="separator:a7c3ce1f79df2837bc532c0ff551e7bac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a43a12ede8b28e1a62820101105f380d0"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a43a12ede8b28e1a62820101105f380d0">~wxConfigBase</a> ()</td></tr>
<tr class="memdesc:a43a12ede8b28e1a62820101105f380d0"><td class="mdescLeft"> </td><td class="mdescRight">Empty but ensures that dtor of all derived classes is virtual. <a href="#a43a12ede8b28e1a62820101105f380d0"></a><br/></td></tr>
<tr class="separator:a43a12ede8b28e1a62820101105f380d0"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Path Management</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>See <a class="el" href="classwx_config_base.html#configbase_paths">Path Management</a> </p>
</div></td></tr>
<tr class="memitem:a2c76e8a110cecc4d89d3af1565044e15"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classwx_string.html">wxString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a2c76e8a110cecc4d89d3af1565044e15">GetPath</a> () const =0</td></tr>
<tr class="memdesc:a2c76e8a110cecc4d89d3af1565044e15"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the current path (always as absolute path). <a href="#a2c76e8a110cecc4d89d3af1565044e15"></a><br/></td></tr>
<tr class="separator:a2c76e8a110cecc4d89d3af1565044e15"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad290d3fe7fad4f39a4bb2959db89b379"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#ad290d3fe7fad4f39a4bb2959db89b379">SetPath</a> (const <a class="el" href="classwx_string.html">wxString</a> &strPath)=0</td></tr>
<tr class="memdesc:ad290d3fe7fad4f39a4bb2959db89b379"><td class="mdescLeft"> </td><td class="mdescRight">Set current path: if the first character is '/', it is the absolute path, otherwise it is a relative path. <a href="#ad290d3fe7fad4f39a4bb2959db89b379"></a><br/></td></tr>
<tr class="separator:ad290d3fe7fad4f39a4bb2959db89b379"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Enumeration</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>See <a class="el" href="classwx_config_base.html#configbase_enumeration">Enumeration</a> </p>
</div></td></tr>
<tr class="memitem:a1f8338dd47972d196c6475e7e1140ae7"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a1f8338dd47972d196c6475e7e1140ae7">GetFirstEntry</a> (<a class="el" href="classwx_string.html">wxString</a> &str, long &index) const =0</td></tr>
<tr class="memdesc:a1f8338dd47972d196c6475e7e1140ae7"><td class="mdescLeft"> </td><td class="mdescRight">Gets the first entry. <a href="#a1f8338dd47972d196c6475e7e1140ae7"></a><br/></td></tr>
<tr class="separator:a1f8338dd47972d196c6475e7e1140ae7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af111cb376665bd1b7fc77ae20d985a6d"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#af111cb376665bd1b7fc77ae20d985a6d">GetFirstGroup</a> (<a class="el" href="classwx_string.html">wxString</a> &str, long &index) const =0</td></tr>
<tr class="memdesc:af111cb376665bd1b7fc77ae20d985a6d"><td class="mdescLeft"> </td><td class="mdescRight">Gets the first group. <a href="#af111cb376665bd1b7fc77ae20d985a6d"></a><br/></td></tr>
<tr class="separator:af111cb376665bd1b7fc77ae20d985a6d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0c99d5eb83f8ebad82e1a13d1295f644"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a0c99d5eb83f8ebad82e1a13d1295f644">GetNextEntry</a> (<a class="el" href="classwx_string.html">wxString</a> &str, long &index) const =0</td></tr>
<tr class="memdesc:a0c99d5eb83f8ebad82e1a13d1295f644"><td class="mdescLeft"> </td><td class="mdescRight">Gets the next entry. <a href="#a0c99d5eb83f8ebad82e1a13d1295f644"></a><br/></td></tr>
<tr class="separator:a0c99d5eb83f8ebad82e1a13d1295f644"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a491e0d51c86d4facd8184969ea6d341c"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a491e0d51c86d4facd8184969ea6d341c">GetNextGroup</a> (<a class="el" href="classwx_string.html">wxString</a> &str, long &index) const =0</td></tr>
<tr class="memdesc:a491e0d51c86d4facd8184969ea6d341c"><td class="mdescLeft"> </td><td class="mdescRight">Gets the next group. <a href="#a491e0d51c86d4facd8184969ea6d341c"></a><br/></td></tr>
<tr class="separator:a491e0d51c86d4facd8184969ea6d341c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a993bdb14c4115ddc1458fb8bdc9de604"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a993bdb14c4115ddc1458fb8bdc9de604">GetNumberOfEntries</a> (bool bRecursive=false) const =0</td></tr>
<tr class="memdesc:a993bdb14c4115ddc1458fb8bdc9de604"><td class="mdescLeft"> </td><td class="mdescRight">Get number of entries in the current group. <a href="#a993bdb14c4115ddc1458fb8bdc9de604"></a><br/></td></tr>
<tr class="separator:a993bdb14c4115ddc1458fb8bdc9de604"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad695ef5dd7dee1b24c7813aa08599eb9"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#ad695ef5dd7dee1b24c7813aa08599eb9">GetNumberOfGroups</a> (bool bRecursive=false) const =0</td></tr>
<tr class="memdesc:ad695ef5dd7dee1b24c7813aa08599eb9"><td class="mdescLeft"> </td><td class="mdescRight">Get number of entries/subgroups in the current group, with or without its subgroups. <a href="#ad695ef5dd7dee1b24c7813aa08599eb9"></a><br/></td></tr>
<tr class="separator:ad695ef5dd7dee1b24c7813aa08599eb9"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Tests of Existence</div></td></tr>
<tr class="memitem:a2ff94abfcc4907c08f5c326b6c224abd"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a2ff94abfcc4907c08f5c326b6c224abd">Exists</a> (const <a class="el" href="classwx_string.html">wxString</a> &strName) const </td></tr>
<tr class="separator:a2ff94abfcc4907c08f5c326b6c224abd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab4035f97557760a9d9976371548324fb"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classwx_config_base.html#a499282208b4b9e90cbfe60de25745bc4">wxConfigBase::EntryType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#ab4035f97557760a9d9976371548324fb">GetEntryType</a> (const <a class="el" href="classwx_string.html">wxString</a> &name) const </td></tr>
<tr class="memdesc:ab4035f97557760a9d9976371548324fb"><td class="mdescLeft"> </td><td class="mdescRight">Returns the type of the given entry or <em>Unknown</em> if the entry doesn't exist. <a href="#ab4035f97557760a9d9976371548324fb"></a><br/></td></tr>
<tr class="separator:ab4035f97557760a9d9976371548324fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaca0748de0e2e2841aaec85f63403d3b"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#aaca0748de0e2e2841aaec85f63403d3b">HasEntry</a> (const <a class="el" href="classwx_string.html">wxString</a> &strName) const =0</td></tr>
<tr class="separator:aaca0748de0e2e2841aaec85f63403d3b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a27472b872af09e73597735d0938b007d"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a27472b872af09e73597735d0938b007d">HasGroup</a> (const <a class="el" href="classwx_string.html">wxString</a> &strName) const =0</td></tr>
<tr class="separator:a27472b872af09e73597735d0938b007d"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Miscellaneous Functions</div></td></tr>
<tr class="memitem:a2fc0ab0516143b52a239cd2d37165c24"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwx_string.html">wxString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a2fc0ab0516143b52a239cd2d37165c24">GetAppName</a> () const </td></tr>
<tr class="memdesc:a2fc0ab0516143b52a239cd2d37165c24"><td class="mdescLeft"> </td><td class="mdescRight">Returns the application name. <a href="#a2fc0ab0516143b52a239cd2d37165c24"></a><br/></td></tr>
<tr class="separator:a2fc0ab0516143b52a239cd2d37165c24"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afd80dbbeaf5767fcebce0b737a294853"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwx_string.html">wxString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#afd80dbbeaf5767fcebce0b737a294853">GetVendorName</a> () const </td></tr>
<tr class="memdesc:afd80dbbeaf5767fcebce0b737a294853"><td class="mdescLeft"> </td><td class="mdescRight">Returns the vendor name. <a href="#afd80dbbeaf5767fcebce0b737a294853"></a><br/></td></tr>
<tr class="separator:afd80dbbeaf5767fcebce0b737a294853"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Key Access</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>See <a class="el" href="classwx_config_base.html#configbase_keyaccess">Key Access</a> </p>
</div></td></tr>
<tr class="memitem:a0b8cfc81de4d2534e8ab980b0fc6b9b8"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a0b8cfc81de4d2534e8ab980b0fc6b9b8">Flush</a> (bool bCurrentOnly=false)=0</td></tr>
<tr class="memdesc:a0b8cfc81de4d2534e8ab980b0fc6b9b8"><td class="mdescLeft"> </td><td class="mdescRight">Permanently writes all changes (otherwise, they're only written from object's destructor). <a href="#a0b8cfc81de4d2534e8ab980b0fc6b9b8"></a><br/></td></tr>
<tr class="separator:a0b8cfc81de4d2534e8ab980b0fc6b9b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af89fb6c338f200bec028480ac0f3b1d8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#af89fb6c338f200bec028480ac0f3b1d8">Read</a> (const <a class="el" href="classwx_string.html">wxString</a> &key, <a class="el" href="classwx_string.html">wxString</a> *str) const </td></tr>
<tr class="memdesc:af89fb6c338f200bec028480ac0f3b1d8"><td class="mdescLeft"> </td><td class="mdescRight">Read a string from the key, returning <span class="literal">true</span> if the value was read. <a href="#af89fb6c338f200bec028480ac0f3b1d8"></a><br/></td></tr>
<tr class="separator:af89fb6c338f200bec028480ac0f3b1d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a93b700301e0b73f1b42f14497f2e6bc7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a93b700301e0b73f1b42f14497f2e6bc7">Read</a> (const <a class="el" href="classwx_string.html">wxString</a> &key, <a class="el" href="classwx_string.html">wxString</a> *str, const <a class="el" href="classwx_string.html">wxString</a> &defaultVal) const </td></tr>
<tr class="memdesc:a93b700301e0b73f1b42f14497f2e6bc7"><td class="mdescLeft"> </td><td class="mdescRight">Read a string from the key. <a href="#a93b700301e0b73f1b42f14497f2e6bc7"></a><br/></td></tr>
<tr class="separator:a93b700301e0b73f1b42f14497f2e6bc7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8f296b015c56b30ee2c669538c04e88a"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classwx_string.html">wxString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a8f296b015c56b30ee2c669538c04e88a">Read</a> (const <a class="el" href="classwx_string.html">wxString</a> &key, const <a class="el" href="classwx_string.html">wxString</a> &defaultVal) const </td></tr>
<tr class="memdesc:a8f296b015c56b30ee2c669538c04e88a"><td class="mdescLeft"> </td><td class="mdescRight">Another version of <a class="el" href="classwx_config_base.html#af89fb6c338f200bec028480ac0f3b1d8" title="Read a string from the key, returning true if the value was read.">Read()</a>, returning the string value directly. <a href="#a8f296b015c56b30ee2c669538c04e88a"></a><br/></td></tr>
<tr class="separator:a8f296b015c56b30ee2c669538c04e88a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa3b9fe04651ff429cb7699cbc60f5251"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#aa3b9fe04651ff429cb7699cbc60f5251">Read</a> (const <a class="el" href="classwx_string.html">wxString</a> &key, long *l) const </td></tr>
<tr class="memdesc:aa3b9fe04651ff429cb7699cbc60f5251"><td class="mdescLeft"> </td><td class="mdescRight">Reads a long value, returning <span class="literal">true</span> if the value was found. <a href="#aa3b9fe04651ff429cb7699cbc60f5251"></a><br/></td></tr>
<tr class="separator:aa3b9fe04651ff429cb7699cbc60f5251"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aed9f1b5f899b7df40b6e9982f05d1437"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#aed9f1b5f899b7df40b6e9982f05d1437">Read</a> (const <a class="el" href="classwx_string.html">wxString</a> &key, long *l, long defaultVal) const </td></tr>
<tr class="memdesc:aed9f1b5f899b7df40b6e9982f05d1437"><td class="mdescLeft"> </td><td class="mdescRight">Reads a long value, returning <span class="literal">true</span> if the value was found. <a href="#aed9f1b5f899b7df40b6e9982f05d1437"></a><br/></td></tr>
<tr class="separator:aed9f1b5f899b7df40b6e9982f05d1437"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b6ed21c1ee59e2c24456fc911da7371"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a7b6ed21c1ee59e2c24456fc911da7371">Read</a> (const <a class="el" href="classwx_string.html">wxString</a> &key, double *d) const </td></tr>
<tr class="memdesc:a7b6ed21c1ee59e2c24456fc911da7371"><td class="mdescLeft"> </td><td class="mdescRight">Reads a double value, returning <span class="literal">true</span> if the value was found. <a href="#a7b6ed21c1ee59e2c24456fc911da7371"></a><br/></td></tr>
<tr class="separator:a7b6ed21c1ee59e2c24456fc911da7371"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a455b51e0343a37e843b03adcdc91531d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a455b51e0343a37e843b03adcdc91531d">Read</a> (const <a class="el" href="classwx_string.html">wxString</a> &key, double *d, double defaultVal) const </td></tr>
<tr class="memdesc:a455b51e0343a37e843b03adcdc91531d"><td class="mdescLeft"> </td><td class="mdescRight">Reads a double value, returning <span class="literal">true</span> if the value was found. <a href="#a455b51e0343a37e843b03adcdc91531d"></a><br/></td></tr>
<tr class="separator:a455b51e0343a37e843b03adcdc91531d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f775f81568a80314d6b947a8ee06c1a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a2f775f81568a80314d6b947a8ee06c1a">Read</a> (const <a class="el" href="classwx_string.html">wxString</a> &key, float *f) const </td></tr>
<tr class="memdesc:a2f775f81568a80314d6b947a8ee06c1a"><td class="mdescLeft"> </td><td class="mdescRight">Reads a float value, returning <span class="literal">true</span> if the value was found. <a href="#a2f775f81568a80314d6b947a8ee06c1a"></a><br/></td></tr>
<tr class="separator:a2f775f81568a80314d6b947a8ee06c1a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aebbe5df968baea47a2722f5617c3e6f3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#aebbe5df968baea47a2722f5617c3e6f3">Read</a> (const <a class="el" href="classwx_string.html">wxString</a> &key, float *f, float defaultVal) const </td></tr>
<tr class="memdesc:aebbe5df968baea47a2722f5617c3e6f3"><td class="mdescLeft"> </td><td class="mdescRight">Reads a float value, returning <span class="literal">true</span> if the value was found. <a href="#aebbe5df968baea47a2722f5617c3e6f3"></a><br/></td></tr>
<tr class="separator:aebbe5df968baea47a2722f5617c3e6f3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae5a5e4486d889d3ba3d738f376ddd4fc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#ae5a5e4486d889d3ba3d738f376ddd4fc">Read</a> (const <a class="el" href="classwx_string.html">wxString</a> &key, bool *b) const </td></tr>
<tr class="memdesc:ae5a5e4486d889d3ba3d738f376ddd4fc"><td class="mdescLeft"> </td><td class="mdescRight">Reads a boolean value, returning <span class="literal">true</span> if the value was found. <a href="#ae5a5e4486d889d3ba3d738f376ddd4fc"></a><br/></td></tr>
<tr class="separator:ae5a5e4486d889d3ba3d738f376ddd4fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acd9d5f95b52a1cf59f63d0ba39879bb0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#acd9d5f95b52a1cf59f63d0ba39879bb0">Read</a> (const <a class="el" href="classwx_string.html">wxString</a> &key, bool *d, bool defaultVal) const </td></tr>
<tr class="memdesc:acd9d5f95b52a1cf59f63d0ba39879bb0"><td class="mdescLeft"> </td><td class="mdescRight">Reads a boolean value, returning <span class="literal">true</span> if the value was found. <a href="#acd9d5f95b52a1cf59f63d0ba39879bb0"></a><br/></td></tr>
<tr class="separator:acd9d5f95b52a1cf59f63d0ba39879bb0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeb402d8571388d67bf85d5abd0dd6641"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#aeb402d8571388d67bf85d5abd0dd6641">Read</a> (const <a class="el" href="classwx_string.html">wxString</a> &key, <a class="el" href="classwx_memory_buffer.html">wxMemoryBuffer</a> *buf) const </td></tr>
<tr class="memdesc:aeb402d8571388d67bf85d5abd0dd6641"><td class="mdescLeft"> </td><td class="mdescRight">Reads a binary block, returning <span class="literal">true</span> if the value was found. <a href="#aeb402d8571388d67bf85d5abd0dd6641"></a><br/></td></tr>
<tr class="separator:aeb402d8571388d67bf85d5abd0dd6641"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a453771fa3ba928f72d9ef6975c2e76de"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a453771fa3ba928f72d9ef6975c2e76de">Read</a> (const <a class="el" href="classwx_string.html">wxString</a> &key, T *value) const </td></tr>
<tr class="memdesc:a453771fa3ba928f72d9ef6975c2e76de"><td class="mdescLeft"> </td><td class="mdescRight">Reads a value of type T, for which function <a class="el" href="group__group__funcmacro__misc.html#ga598ae7504c6436af325490b41f4b5e90" title="Converts string to a wxColour best represented by the given string.">wxFromString()</a> is defined, returning <span class="literal">true</span> if the value was found. <a href="#a453771fa3ba928f72d9ef6975c2e76de"></a><br/></td></tr>
<tr class="separator:a453771fa3ba928f72d9ef6975c2e76de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac1206cb2c544b23fa9d2c983802114b5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#ac1206cb2c544b23fa9d2c983802114b5">Read</a> (const <a class="el" href="classwx_string.html">wxString</a> &key, T *value, const T &defaultVal) const </td></tr>
<tr class="memdesc:ac1206cb2c544b23fa9d2c983802114b5"><td class="mdescLeft"> </td><td class="mdescRight">Reads a value of type T, for which function <a class="el" href="group__group__funcmacro__misc.html#ga598ae7504c6436af325490b41f4b5e90" title="Converts string to a wxColour best represented by the given string.">wxFromString()</a> is defined, returning <span class="literal">true</span> if the value was found. <a href="#ac1206cb2c544b23fa9d2c983802114b5"></a><br/></td></tr>
<tr class="separator:ac1206cb2c544b23fa9d2c983802114b5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6c933c93b00ac59ffcf16f5a2e3c47a9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a6c933c93b00ac59ffcf16f5a2e3c47a9">ReadBool</a> (const <a class="el" href="classwx_string.html">wxString</a> &key, bool defaultVal) const </td></tr>
<tr class="memdesc:a6c933c93b00ac59ffcf16f5a2e3c47a9"><td class="mdescLeft"> </td><td class="mdescRight">Reads a bool value from the key and returns it. <a href="#a6c933c93b00ac59ffcf16f5a2e3c47a9"></a><br/></td></tr>
<tr class="separator:a6c933c93b00ac59ffcf16f5a2e3c47a9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a82413d25fca2d006def607f14b6d45f4"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a82413d25fca2d006def607f14b6d45f4">ReadDouble</a> (const <a class="el" href="classwx_string.html">wxString</a> &key, double defaultVal) const </td></tr>
<tr class="memdesc:a82413d25fca2d006def607f14b6d45f4"><td class="mdescLeft"> </td><td class="mdescRight">Reads a double value from the key and returns it. <a href="#a82413d25fca2d006def607f14b6d45f4"></a><br/></td></tr>
<tr class="separator:a82413d25fca2d006def607f14b6d45f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab876635fe7cefe7eae38a1ef330a4c49"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#ab876635fe7cefe7eae38a1ef330a4c49">ReadLong</a> (const <a class="el" href="classwx_string.html">wxString</a> &key, long defaultVal) const </td></tr>
<tr class="memdesc:ab876635fe7cefe7eae38a1ef330a4c49"><td class="mdescLeft"> </td><td class="mdescRight">Reads a long value from the key and returns it. <a href="#ab876635fe7cefe7eae38a1ef330a4c49"></a><br/></td></tr>
<tr class="separator:ab876635fe7cefe7eae38a1ef330a4c49"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac88afa67847dcf8a962e847dfaf5972a"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#ac88afa67847dcf8a962e847dfaf5972a">ReadObject</a> (const <a class="el" href="classwx_string.html">wxString</a> &key, T const &defaultVal) const </td></tr>
<tr class="memdesc:ac88afa67847dcf8a962e847dfaf5972a"><td class="mdescLeft"> </td><td class="mdescRight">Reads a value of type T (for which the function <a class="el" href="group__group__funcmacro__misc.html#ga598ae7504c6436af325490b41f4b5e90" title="Converts string to a wxColour best represented by the given string.">wxFromString()</a> must be defined) from the key and returns it. <a href="#ac88afa67847dcf8a962e847dfaf5972a"></a><br/></td></tr>
<tr class="separator:ac88afa67847dcf8a962e847dfaf5972a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ace24f1478e71ac309ecf1d9273f19ce3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#ace24f1478e71ac309ecf1d9273f19ce3">Write</a> (const <a class="el" href="classwx_string.html">wxString</a> &key, const <a class="el" href="classwx_string.html">wxString</a> &value)</td></tr>
<tr class="memdesc:ace24f1478e71ac309ecf1d9273f19ce3"><td class="mdescLeft"> </td><td class="mdescRight">Writes the <a class="el" href="classwx_string.html" title="String class for passing textual data to or receiving it from wxWidgets.">wxString</a> value to the config file and returns <span class="literal">true</span> on success. <a href="#ace24f1478e71ac309ecf1d9273f19ce3"></a><br/></td></tr>
<tr class="separator:ace24f1478e71ac309ecf1d9273f19ce3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a052e7e5df90589f8094f860a9bdfd8a8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a052e7e5df90589f8094f860a9bdfd8a8">Write</a> (const <a class="el" href="classwx_string.html">wxString</a> &key, long value)</td></tr>
<tr class="memdesc:a052e7e5df90589f8094f860a9bdfd8a8"><td class="mdescLeft"> </td><td class="mdescRight">Writes the long value to the config file and returns <span class="literal">true</span> on success. <a href="#a052e7e5df90589f8094f860a9bdfd8a8"></a><br/></td></tr>
<tr class="separator:a052e7e5df90589f8094f860a9bdfd8a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a108d7427200466a240f8ea835e74db7b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a108d7427200466a240f8ea835e74db7b">Write</a> (const <a class="el" href="classwx_string.html">wxString</a> &key, double value)</td></tr>
<tr class="memdesc:a108d7427200466a240f8ea835e74db7b"><td class="mdescLeft"> </td><td class="mdescRight">Writes the double value to the config file and returns <span class="literal">true</span> on success. <a href="#a108d7427200466a240f8ea835e74db7b"></a><br/></td></tr>
<tr class="separator:a108d7427200466a240f8ea835e74db7b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a97465083477038dc7d01e363c511f6cd"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a97465083477038dc7d01e363c511f6cd">Write</a> (const <a class="el" href="classwx_string.html">wxString</a> &key, bool value)</td></tr>
<tr class="memdesc:a97465083477038dc7d01e363c511f6cd"><td class="mdescLeft"> </td><td class="mdescRight">Writes the bool value to the config file and returns <span class="literal">true</span> on success. <a href="#a97465083477038dc7d01e363c511f6cd"></a><br/></td></tr>
<tr class="separator:a97465083477038dc7d01e363c511f6cd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a83efe80538c9f3e4056ae6d44d362f49"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a83efe80538c9f3e4056ae6d44d362f49">Write</a> (const <a class="el" href="classwx_string.html">wxString</a> &key, const <a class="el" href="classwx_memory_buffer.html">wxMemoryBuffer</a> &buf)</td></tr>
<tr class="memdesc:a83efe80538c9f3e4056ae6d44d362f49"><td class="mdescLeft"> </td><td class="mdescRight">Writes the <a class="el" href="classwx_memory_buffer.html" title="A wxMemoryBuffer is a useful data structure for storing arbitrary sized blocks of memory...">wxMemoryBuffer</a> value to the config file and returns <span class="literal">true</span> on success. <a href="#a83efe80538c9f3e4056ae6d44d362f49"></a><br/></td></tr>
<tr class="separator:a83efe80538c9f3e4056ae6d44d362f49"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9ac693bd370a81d7fd0cad255869a041"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a9ac693bd370a81d7fd0cad255869a041">Write</a> (const <a class="el" href="classwx_string.html">wxString</a> &key, T const &buf)</td></tr>
<tr class="memdesc:a9ac693bd370a81d7fd0cad255869a041"><td class="mdescLeft"> </td><td class="mdescRight">Writes the specified value to the config file and returns <span class="literal">true</span> on success. <a href="#a9ac693bd370a81d7fd0cad255869a041"></a><br/></td></tr>
<tr class="separator:a9ac693bd370a81d7fd0cad255869a041"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Rename Entries/Groups</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>These functions allow renaming entries or subgroups of the current group.</p>
<p>They will return <span class="literal">false</span> on error, typically because either the entry/group with the original name doesn't exist, because the entry/group with the new name already exists or because the function is not supported in this wxConfig implementation. </p>
</div></td></tr>
<tr class="memitem:a1871d5f0aec990c1552242203c5ed0c4"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a1871d5f0aec990c1552242203c5ed0c4">RenameEntry</a> (const <a class="el" href="classwx_string.html">wxString</a> &oldName, const <a class="el" href="classwx_string.html">wxString</a> &newName)=0</td></tr>
<tr class="memdesc:a1871d5f0aec990c1552242203c5ed0c4"><td class="mdescLeft"> </td><td class="mdescRight">Renames an entry in the current group. <a href="#a1871d5f0aec990c1552242203c5ed0c4"></a><br/></td></tr>
<tr class="separator:a1871d5f0aec990c1552242203c5ed0c4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f85e2947979146ccc77b42c15409834"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a4f85e2947979146ccc77b42c15409834">RenameGroup</a> (const <a class="el" href="classwx_string.html">wxString</a> &oldName, const <a class="el" href="classwx_string.html">wxString</a> &newName)=0</td></tr>
<tr class="memdesc:a4f85e2947979146ccc77b42c15409834"><td class="mdescLeft"> </td><td class="mdescRight">Renames a subgroup of the current group. <a href="#a4f85e2947979146ccc77b42c15409834"></a><br/></td></tr>
<tr class="separator:a4f85e2947979146ccc77b42c15409834"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Delete Entries/Groups</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>These functions delete entries and/or groups of entries from the config file.</p>
<p><a class="el" href="classwx_config_base.html#af2dd5ec6b56f89decf0e96b057c4846f" title="Delete the whole underlying object (disk file, registry key, ...).">DeleteAll()</a> is especially useful if you want to erase all traces of your program presence: for example, when you uninstall it. </p>
</div></td></tr>
<tr class="memitem:af2dd5ec6b56f89decf0e96b057c4846f"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#af2dd5ec6b56f89decf0e96b057c4846f">DeleteAll</a> ()=0</td></tr>
<tr class="memdesc:af2dd5ec6b56f89decf0e96b057c4846f"><td class="mdescLeft"> </td><td class="mdescRight">Delete the whole underlying object (disk file, registry key, ...). <a href="#af2dd5ec6b56f89decf0e96b057c4846f"></a><br/></td></tr>
<tr class="separator:af2dd5ec6b56f89decf0e96b057c4846f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4032a0432b4a7f956ec30dfc4f4b8593"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a4032a0432b4a7f956ec30dfc4f4b8593">DeleteEntry</a> (const <a class="el" href="classwx_string.html">wxString</a> &key, bool bDeleteGroupIfEmpty=true)=0</td></tr>
<tr class="memdesc:a4032a0432b4a7f956ec30dfc4f4b8593"><td class="mdescLeft"> </td><td class="mdescRight">Deletes the specified entry and the group it belongs to if it was the last key in it and the second parameter is <span class="literal">true</span>. <a href="#a4032a0432b4a7f956ec30dfc4f4b8593"></a><br/></td></tr>
<tr class="separator:a4032a0432b4a7f956ec30dfc4f4b8593"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac66bcb140f09c8cb522d3117aa1aa0e7"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#ac66bcb140f09c8cb522d3117aa1aa0e7">DeleteGroup</a> (const <a class="el" href="classwx_string.html">wxString</a> &key)=0</td></tr>
<tr class="memdesc:ac66bcb140f09c8cb522d3117aa1aa0e7"><td class="mdescLeft"> </td><td class="mdescRight">Delete the group (with all subgroups). <a href="#ac66bcb140f09c8cb522d3117aa1aa0e7"></a><br/></td></tr>
<tr class="separator:ac66bcb140f09c8cb522d3117aa1aa0e7"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Options</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>Some aspects of <a class="el" href="classwx_config_base.html" title="wxConfigBase defines the basic interface of all config classes.">wxConfigBase</a> behaviour can be changed during run-time.</p>
<p>The first of them is the expansion of environment variables in the string values read from the config file: for example, if you have the following in your config file:</p>
<div class="fragment"><div class="line"><span class="preprocessor"># config file for my program</span></div>
<div class="line"><span class="preprocessor"></span>UserData = $HOME/data</div>
<div class="line"></div>
<div class="line"><span class="preprocessor"># the following syntax is valid only under Windows</span></div>
<div class="line"><span class="preprocessor">UserData = %windir%\\data.dat</span></div>
</div><!-- fragment --><p>The call to Read("UserData") will return something like <code>"/home/zeitlin/data"</code> on linux for example.</p>
<p>Although this feature is very useful, it may be annoying if you read a value which contains '$' or '' symbols (% is used for environment variables expansion under Windows) which are not used for environment variable expansion. In this situation you may call SetExpandEnvVars(<span class="literal">false</span>) just before reading this value and SetExpandEnvVars(<span class="literal">true</span>) just after. Another solution would be to prefix the offending symbols with a backslash. </p>
</div></td></tr>
<tr class="memitem:a1d8cbd33d9d85caeea77de753cb25548"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a1d8cbd33d9d85caeea77de753cb25548">IsExpandingEnvVars</a> () const </td></tr>
<tr class="memdesc:a1d8cbd33d9d85caeea77de753cb25548"><td class="mdescLeft"> </td><td class="mdescRight">Returns <span class="literal">true</span> if we are expanding environment variables in key values. <a href="#a1d8cbd33d9d85caeea77de753cb25548"></a><br/></td></tr>
<tr class="separator:a1d8cbd33d9d85caeea77de753cb25548"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab1bc59054ac75ae688c61cd767ba6083"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#ab1bc59054ac75ae688c61cd767ba6083">IsRecordingDefaults</a> () const </td></tr>
<tr class="memdesc:ab1bc59054ac75ae688c61cd767ba6083"><td class="mdescLeft"> </td><td class="mdescRight">Returns <span class="literal">true</span> if we are writing defaults back to the config file. <a href="#ab1bc59054ac75ae688c61cd767ba6083"></a><br/></td></tr>
<tr class="separator:ab1bc59054ac75ae688c61cd767ba6083"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a8c651d2bdde14e6248b0cd85062476"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a3a8c651d2bdde14e6248b0cd85062476">SetExpandEnvVars</a> (bool bDoIt=true)</td></tr>
<tr class="memdesc:a3a8c651d2bdde14e6248b0cd85062476"><td class="mdescLeft"> </td><td class="mdescRight">Determine whether we wish to expand environment variables in key values. <a href="#a3a8c651d2bdde14e6248b0cd85062476"></a><br/></td></tr>
<tr class="separator:a3a8c651d2bdde14e6248b0cd85062476"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a80bff71cc742251419ba499ce7b4da3c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a80bff71cc742251419ba499ce7b4da3c">SetRecordDefaults</a> (bool bDoIt=true)</td></tr>
<tr class="memdesc:a80bff71cc742251419ba499ce7b4da3c"><td class="mdescLeft"> </td><td class="mdescRight">Sets whether defaults are recorded to the config file whenever an attempt to read the value which is not present in it is done. <a href="#a80bff71cc742251419ba499ce7b4da3c"></a><br/></td></tr>
<tr class="separator:a80bff71cc742251419ba499ce7b4da3c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classwx_object"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classwx_object')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classwx_object.html">wxObject</a></td></tr>
<tr class="memitem:acaa378363a28af421ab56ad7b46eadf0 inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#acaa378363a28af421ab56ad7b46eadf0">wxObject</a> ()</td></tr>
<tr class="memdesc:acaa378363a28af421ab56ad7b46eadf0 inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Default ctor; initializes to <span class="literal">NULL</span> the internal reference data. <a href="#acaa378363a28af421ab56ad7b46eadf0"></a><br/></td></tr>
<tr class="separator:acaa378363a28af421ab56ad7b46eadf0 inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4721b4dc9b7aff0f30904ba2ea3954cf inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a4721b4dc9b7aff0f30904ba2ea3954cf">wxObject</a> (const <a class="el" href="classwx_object.html">wxObject</a> &other)</td></tr>
<tr class="memdesc:a4721b4dc9b7aff0f30904ba2ea3954cf inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Copy ctor. <a href="#a4721b4dc9b7aff0f30904ba2ea3954cf"></a><br/></td></tr>
<tr class="separator:a4721b4dc9b7aff0f30904ba2ea3954cf inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2a51aa8bfbab47ca2f051bcf84b3f35b inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a2a51aa8bfbab47ca2f051bcf84b3f35b">~wxObject</a> ()</td></tr>
<tr class="memdesc:a2a51aa8bfbab47ca2f051bcf84b3f35b inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a2a51aa8bfbab47ca2f051bcf84b3f35b"></a><br/></td></tr>
<tr class="separator:a2a51aa8bfbab47ca2f051bcf84b3f35b inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab3a0c6f723cbaddb47be4e8dd98cc8e2 inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classwx_class_info.html">wxClassInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#ab3a0c6f723cbaddb47be4e8dd98cc8e2">GetClassInfo</a> () const </td></tr>
<tr class="memdesc:ab3a0c6f723cbaddb47be4e8dd98cc8e2 inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">This virtual function is redefined for every class that requires run-time type information, when using the <a class="el" href="group__group__funcmacro__rtti.html#ga20465fc7e022e29a5dacfad46e152e75" title="Used inside a class declaration to declare that the class should be made known to the class hierarchy...">wxDECLARE_CLASS</a> macro (or similar). <a href="#ab3a0c6f723cbaddb47be4e8dd98cc8e2"></a><br/></td></tr>
<tr class="separator:ab3a0c6f723cbaddb47be4e8dd98cc8e2 inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aabdb4fc957226544a8408167844e4f42 inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwx_object_ref_data.html">wxObjectRefData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#aabdb4fc957226544a8408167844e4f42">GetRefData</a> () const </td></tr>
<tr class="memdesc:aabdb4fc957226544a8408167844e4f42 inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <a class="el" href="classwx_object.html#a9e31954530a0abd54982effc443ed2b8" title="Pointer to an object which is the object's reference-counted data.">wxObject::m_refData</a> pointer, i.e. the data referenced by this object. <a href="#aabdb4fc957226544a8408167844e4f42"></a><br/></td></tr>
<tr class="separator:aabdb4fc957226544a8408167844e4f42 inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af40d580385cf4f8112fae7713404b01e inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#af40d580385cf4f8112fae7713404b01e">IsKindOf</a> (const <a class="el" href="classwx_class_info.html">wxClassInfo</a> *info) const </td></tr>
<tr class="memdesc:af40d580385cf4f8112fae7713404b01e inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether this class is a subclass of (or the same class as) the given class. <a href="#af40d580385cf4f8112fae7713404b01e"></a><br/></td></tr>
<tr class="separator:af40d580385cf4f8112fae7713404b01e inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a80a1a3fda7b14396a9ddd3d7a46a88bd inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a80a1a3fda7b14396a9ddd3d7a46a88bd">IsSameAs</a> (const <a class="el" href="classwx_object.html">wxObject</a> &obj) const </td></tr>
<tr class="memdesc:a80a1a3fda7b14396a9ddd3d7a46a88bd inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Returns <span class="literal">true</span> if this object has the same data pointer as <em>obj</em>. <a href="#a80a1a3fda7b14396a9ddd3d7a46a88bd"></a><br/></td></tr>
<tr class="separator:a80a1a3fda7b14396a9ddd3d7a46a88bd inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f6f1aa51fe9fc2b1415ca4211a90e9e inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a2f6f1aa51fe9fc2b1415ca4211a90e9e">Ref</a> (const <a class="el" href="classwx_object.html">wxObject</a> &clone)</td></tr>
<tr class="memdesc:a2f6f1aa51fe9fc2b1415ca4211a90e9e inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Makes this object refer to the data in <em>clone</em>. <a href="#a2f6f1aa51fe9fc2b1415ca4211a90e9e"></a><br/></td></tr>
<tr class="separator:a2f6f1aa51fe9fc2b1415ca4211a90e9e inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afab780710f2adc1bb33310e27590140b inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#afab780710f2adc1bb33310e27590140b">SetRefData</a> (<a class="el" href="classwx_object_ref_data.html">wxObjectRefData</a> *data)</td></tr>
<tr class="memdesc:afab780710f2adc1bb33310e27590140b inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Sets the <a class="el" href="classwx_object.html#a9e31954530a0abd54982effc443ed2b8" title="Pointer to an object which is the object's reference-counted data.">wxObject::m_refData</a> pointer. <a href="#afab780710f2adc1bb33310e27590140b"></a><br/></td></tr>
<tr class="separator:afab780710f2adc1bb33310e27590140b inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af51efc6b1ae632fc7f0cd7ebbce9fa36 inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#af51efc6b1ae632fc7f0cd7ebbce9fa36">UnRef</a> ()</td></tr>
<tr class="memdesc:af51efc6b1ae632fc7f0cd7ebbce9fa36 inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Decrements the reference count in the associated data, and if it is zero, deletes the data. <a href="#af51efc6b1ae632fc7f0cd7ebbce9fa36"></a><br/></td></tr>
<tr class="separator:af51efc6b1ae632fc7f0cd7ebbce9fa36 inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a74b40e42d19a4b9e9bec0b57d62a5725 inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a74b40e42d19a4b9e9bec0b57d62a5725">UnShare</a> ()</td></tr>
<tr class="memdesc:a74b40e42d19a4b9e9bec0b57d62a5725 inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">This is the same of <a class="el" href="classwx_object.html#a60204063f3cc3aa2fa1c7ff5bda9eb13" title="Ensure that this object's data is not shared with any other object.">AllocExclusive()</a> but this method is public. <a href="#a74b40e42d19a4b9e9bec0b57d62a5725"></a><br/></td></tr>
<tr class="separator:a74b40e42d19a4b9e9bec0b57d62a5725 inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a07b8f34f5afc5743195c5fed052f55d3 inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a07b8f34f5afc5743195c5fed052f55d3">operator delete</a> (void *buf)</td></tr>
<tr class="memdesc:a07b8f34f5afc5743195c5fed052f55d3 inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">The <em>delete</em> operator is defined for debugging versions of the library only, when the identifier <code><b>WXDEBUG</b></code> is defined. <a href="#a07b8f34f5afc5743195c5fed052f55d3"></a><br/></td></tr>
<tr class="separator:a07b8f34f5afc5743195c5fed052f55d3 inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a96fa423a1dbc212c8227a5d83825971f inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a96fa423a1dbc212c8227a5d83825971f">operator new</a> (size_t size, const <a class="el" href="classwx_string.html">wxString</a> &filename=NULL, int lineNum=0)</td></tr>
<tr class="memdesc:a96fa423a1dbc212c8227a5d83825971f inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">The <em>new</em> operator is defined for debugging versions of the library only, when the identifier <code><b>WXDEBUG</b></code> is defined. <a href="#a96fa423a1dbc212c8227a5d83825971f"></a><br/></td></tr>
<tr class="separator:a96fa423a1dbc212c8227a5d83825971f inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aa7d633935adabe1bf11b5a028f8b3355"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classwx_config_base.html">wxConfigBase</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#aa7d633935adabe1bf11b5a028f8b3355">Create</a> ()</td></tr>
<tr class="memdesc:aa7d633935adabe1bf11b5a028f8b3355"><td class="mdescLeft"> </td><td class="mdescRight">Create a new config object and sets it as the current one. <a href="#aa7d633935adabe1bf11b5a028f8b3355"></a><br/></td></tr>
<tr class="separator:aa7d633935adabe1bf11b5a028f8b3355"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0e8ad0cb0c5b374a99b99ea6212e496b"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a0e8ad0cb0c5b374a99b99ea6212e496b">DontCreateOnDemand</a> ()</td></tr>
<tr class="memdesc:a0e8ad0cb0c5b374a99b99ea6212e496b"><td class="mdescLeft"> </td><td class="mdescRight">Calling this function will prevent <em><a class="el" href="classwx_config_base.html#a61bfb04c1c133190b3e851b252ed1c60" title="Get the current config object.">Get()</a></em> from automatically creating a new config object if the current one is <span class="literal">NULL</span>. <a href="#a0e8ad0cb0c5b374a99b99ea6212e496b"></a><br/></td></tr>
<tr class="separator:a0e8ad0cb0c5b374a99b99ea6212e496b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a61bfb04c1c133190b3e851b252ed1c60"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classwx_config_base.html">wxConfigBase</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a61bfb04c1c133190b3e851b252ed1c60">Get</a> (bool CreateOnDemand=true)</td></tr>
<tr class="memdesc:a61bfb04c1c133190b3e851b252ed1c60"><td class="mdescLeft"> </td><td class="mdescRight">Get the current config object. <a href="#a61bfb04c1c133190b3e851b252ed1c60"></a><br/></td></tr>
<tr class="separator:a61bfb04c1c133190b3e851b252ed1c60"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8e2ca739326f32379d6816522a5d1907"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classwx_config_base.html">wxConfigBase</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_config_base.html#a8e2ca739326f32379d6816522a5d1907">Set</a> (<a class="el" href="classwx_config_base.html">wxConfigBase</a> *pConfig)</td></tr>
<tr class="memdesc:a8e2ca739326f32379d6816522a5d1907"><td class="mdescLeft"> </td><td class="mdescRight">Sets the config object as the current one, returns the pointer to the previous current object (both the parameter and returned value may be <span class="literal">NULL</span>). <a href="#a8e2ca739326f32379d6816522a5d1907"></a><br/></td></tr>
<tr class="separator:a8e2ca739326f32379d6816522a5d1907"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classwx_object"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classwx_object')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classwx_object.html">wxObject</a></td></tr>
<tr class="memitem:a60204063f3cc3aa2fa1c7ff5bda9eb13 inherit pro_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a60204063f3cc3aa2fa1c7ff5bda9eb13">AllocExclusive</a> ()</td></tr>
<tr class="memdesc:a60204063f3cc3aa2fa1c7ff5bda9eb13 inherit pro_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Ensure that this object's data is not shared with any other object. <a href="#a60204063f3cc3aa2fa1c7ff5bda9eb13"></a><br/></td></tr>
<tr class="separator:a60204063f3cc3aa2fa1c7ff5bda9eb13 inherit pro_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a95c6a5e4e1e03ff23c7b9efe4cff0c1a inherit pro_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classwx_object_ref_data.html">wxObjectRefData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a95c6a5e4e1e03ff23c7b9efe4cff0c1a">CreateRefData</a> () const </td></tr>
<tr class="memdesc:a95c6a5e4e1e03ff23c7b9efe4cff0c1a inherit pro_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. <a href="#a95c6a5e4e1e03ff23c7b9efe4cff0c1a"></a><br/></td></tr>
<tr class="separator:a95c6a5e4e1e03ff23c7b9efe4cff0c1a inherit pro_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1d39f1d3650fe0982c9a1abe7f9fe7b7 inherit pro_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classwx_object_ref_data.html">wxObjectRefData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a1d39f1d3650fe0982c9a1abe7f9fe7b7">CloneRefData</a> (const <a class="el" href="classwx_object_ref_data.html">wxObjectRefData</a> *data) const </td></tr>
<tr class="memdesc:a1d39f1d3650fe0982c9a1abe7f9fe7b7 inherit pro_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying <em>data</em>. <a href="#a1d39f1d3650fe0982c9a1abe7f9fe7b7"></a><br/></td></tr>
<tr class="separator:a1d39f1d3650fe0982c9a1abe7f9fe7b7 inherit pro_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_attribs_classwx_object"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classwx_object')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classwx_object.html">wxObject</a></td></tr>
<tr class="memitem:a9e31954530a0abd54982effc443ed2b8 inherit pro_attribs_classwx_object"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwx_object_ref_data.html">wxObjectRefData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a9e31954530a0abd54982effc443ed2b8">m_refData</a></td></tr>
<tr class="memdesc:a9e31954530a0abd54982effc443ed2b8 inherit pro_attribs_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to an object which is the object's reference-counted data. <a href="#a9e31954530a0abd54982effc443ed2b8"></a><br/></td></tr>
<tr class="separator:a9e31954530a0abd54982effc443ed2b8 inherit pro_attribs_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a499282208b4b9e90cbfe60de25745bc4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classwx_config_base.html#a499282208b4b9e90cbfe60de25745bc4">wxConfigBase::EntryType</a></td>
</tr>
</table>
</div><div class="memdoc">
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a499282208b4b9e90cbfe60de25745bc4a186e69ade61db5ba7e5fc2366d2388fc"></a>Type_Unknown</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a499282208b4b9e90cbfe60de25745bc4afeb4cd8ae582520fd2d45ec35b316d0a"></a>Type_String</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a499282208b4b9e90cbfe60de25745bc4a5338e90a8c51020109928f3177c06caf"></a>Type_Boolean</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a499282208b4b9e90cbfe60de25745bc4abf7985582695bbed6da7d2de5b22b6e8"></a>Type_Integer</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a499282208b4b9e90cbfe60de25745bc4af1cafe0a03c8c929511258c31ea138cb"></a>Type_Float</em> </td><td>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a7c3ce1f79df2837bc532c0ff551e7bac"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wxConfigBase::wxConfigBase </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>appName</em> = <code><a class="el" href="interface_2wx_2string_8h.html#a9a321d587166a30017b608dd2d234033">wxEmptyString</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>vendorName</em> = <code><a class="el" href="interface_2wx_2string_8h.html#a9a321d587166a30017b608dd2d234033">wxEmptyString</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>localFilename</em> = <code><a class="el" href="interface_2wx_2string_8h.html#a9a321d587166a30017b608dd2d234033">wxEmptyString</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>globalFilename</em> = <code><a class="el" href="interface_2wx_2string_8h.html#a9a321d587166a30017b608dd2d234033">wxEmptyString</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>style</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classwx_m_b_conv.html">wxMBConv</a> & </td>
<td class="paramname"><em>conv</em> = <code><a class="el" href="classwx_conv_auto.html">wxConvAuto</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This is the default and only constructor of the <a class="el" href="classwx_config_base.html" title="wxConfigBase defines the basic interface of all config classes.">wxConfigBase</a> class, and derived classes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">appName</td><td>The application name. If this is empty, the class will normally use <a class="el" href="classwx_app_console.html#a2bfe9c53c57d61f8b115705796f258eb" title="Returns the application name.">wxApp::GetAppName()</a> to set it. The application name is used in the registry key on Windows, and can be used to deduce the local filename parameter if that is missing. </td></tr>
<tr><td class="paramname">vendorName</td><td>The vendor name. If this is empty, it is assumed that no vendor name is wanted, if this is optional for the current config class. The vendor name is appended to the application name for <a class="el" href="classwx_reg_config.html" title="wxRegConfig implements the wxConfigBase interface for storing and retrieving configuration informatio...">wxRegConfig</a>. </td></tr>
<tr><td class="paramname">localFilename</td><td>Some config classes require a local filename. If this is not present, but required, the application name will be used instead. </td></tr>
<tr><td class="paramname">globalFilename</td><td>Some config classes require a global filename. If this is not present, but required, the application name will be used instead. </td></tr>
<tr><td class="paramname">style</td><td>Can be one of <code>wxCONFIG_USE_LOCAL_FILE</code> and <code>wxCONFIG_USE_GLOBAL_FILE</code>. <br/>
The style interpretation depends on the config class and is ignored by some implementations. For <a class="el" href="classwx_file_config.html" title="wxFileConfig implements wxConfigBase interface for storing and retrieving configuration information u...">wxFileConfig</a>, these styles determine whether a local or global config file is created or used: if <code>wxCONFIG_USE_GLOBAL_FILE</code> is used, then settings are read from the global config file and if <code>wxCONFIG_USE_LOCAL_FILE</code> is used, settings are read from and written to local config file (if they are both set, global file is read first, then local file, overwriting global settings). If the flag is present but the parameter is empty, the parameter will be set to a default. If the parameter is present but the style flag not, the relevant flag will be added to the style. For <a class="el" href="classwx_reg_config.html" title="wxRegConfig implements the wxConfigBase interface for storing and retrieving configuration informatio...">wxRegConfig</a>, the GLOBAL flag refers to the <code>HKLM</code> key while LOCAL one is for the usual <code>HKCU</code> one. <br/>
For <a class="el" href="classwx_file_config.html" title="wxFileConfig implements wxConfigBase interface for storing and retrieving configuration information u...">wxFileConfig</a> you can also add <code>wxCONFIG_USE_RELATIVE_PATH</code> by logically or'ing it to either of the _FILE options to tell <a class="el" href="classwx_file_config.html" title="wxFileConfig implements wxConfigBase interface for storing and retrieving configuration information u...">wxFileConfig</a> to use relative instead of absolute paths. <br/>
On non-VMS Unix systems, the default local configuration file is "~/.appname". However, this path may be also used as user data directory (see <a class="el" href="classwx_standard_paths.html#a4752213ef4d7bdc71170b9e5c3691f0f" title="Return the directory for the user-dependent application data files:">wxStandardPaths::GetUserDataDir()</a>) if the application has several data files. In this case <code>wxCONFIG_USE_SUBDIR</code> flag, which changes the default local configuration file to "~/.appname/appname" should be used. Notice that this flag is ignored if <em>localFilename</em> is provided. <code>wxCONFIG_USE_SUBDIR</code> is new since wxWidgets version 2.8.2. <br/>
For <a class="el" href="classwx_file_config.html" title="wxFileConfig implements wxConfigBase interface for storing and retrieving configuration information u...">wxFileConfig</a>, you can also add <code>wxCONFIG_USE_NO_ESCAPE_CHARACTERS</code> which will turn off character escaping for the values of entries stored in the config file: for example a foo key with some backslash characters will be stored as "foo=C:\mydir" instead of the usual storage of "foo=C:\\mydir". <br/>
The <code>wxCONFIG_USE_NO_ESCAPE_CHARACTERS</code> style can be helpful if your config file must be read or written to by a non-wxWidgets program (which might not understand the escape characters). Note, however, that if <code>wxCONFIG_USE_NO_ESCAPE_CHARACTERS</code> style is used, it is now your application's responsibility to ensure that there is no newline or other illegal characters in a value, before writing that value to the file. </td></tr>
<tr><td class="paramname">conv</td><td>This parameter is only used by <a class="el" href="classwx_file_config.html" title="wxFileConfig implements wxConfigBase interface for storing and retrieving configuration information u...">wxFileConfig</a> when compiled in Unicode mode. It specifies the encoding in which the configuration file is written.</td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>By default, environment variable expansion is on and recording defaults is off. </dd></dl>
</div>
</div>
<a class="anchor" id="a43a12ede8b28e1a62820101105f380d0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual wxConfigBase::~wxConfigBase </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Empty but ensures that dtor of all derived classes is virtual. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aa7d633935adabe1bf11b5a028f8b3355"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classwx_config_base.html">wxConfigBase</a>* wxConfigBase::Create </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new config object and sets it as the current one. </p>
<p>This function will create the most appropriate implementation of wxConfig available for the current platform. By default this means that the system registry will be used for storing the configuration information under MSW and a file under the user home directory (see <a class="el" href="classwx_standard_paths.html#a7c7cf595d94d29147360d031647476b0" title="Return the directory for the user config files:">wxStandardPaths::GetUserConfigDir()</a>) elsewhere.</p>
<p>If you prefer to use the configuration files everywhere, you can define <code>wxUSE_CONFIG_NATIVE</code> to 0 when compiling wxWidgets. Or you can simply always create <a class="el" href="classwx_file_config.html" title="wxFileConfig implements wxConfigBase interface for storing and retrieving configuration information u...">wxFileConfig</a> explicitly.</p>
<p>Finally, if you want to create a custom wxConfig subclass you may change this function behaviour by overriding <a class="el" href="classwx_app_traits.html#a548e252e1b2feec51a0e6f32cb69c8cd" title="Called by wxWidgets to create the default configuration object for the application.">wxAppTraits::CreateConfig()</a> to create it. An example when this could be useful could be an application which could be installed either normally (in which case the default behaviour of using <a class="el" href="classwx_reg_config.html" title="wxRegConfig implements the wxConfigBase interface for storing and retrieving configuration informatio...">wxRegConfig</a> is appropriate) or in a "portable" way in which case a <a class="el" href="classwx_file_config.html" title="wxFileConfig implements wxConfigBase interface for storing and retrieving configuration information u...">wxFileConfig</a> with a file in the program directory would be used and the choice would be done in CreateConfig() at run-time. </p>
</div>
</div>
<a class="anchor" id="af2dd5ec6b56f89decf0e96b057c4846f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool wxConfigBase::DeleteAll </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete the whole underlying object (disk file, registry key, ...). </p>
<p>Primarily for use by uninstallation routine. </p>
<p>Implemented in <a class="el" href="classwx_file_config.html#aeb7cd89ccb242ed30506e63fd79ed82f">wxFileConfig</a>.</p>
</div>
</div>
<a class="anchor" id="a4032a0432b4a7f956ec30dfc4f4b8593"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool wxConfigBase::DeleteEntry </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>bDeleteGroupIfEmpty</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Deletes the specified entry and the group it belongs to if it was the last key in it and the second parameter is <span class="literal">true</span>. </p>
<p>Implemented in <a class="el" href="classwx_file_config.html#a120130d8a59bbdadf510b658b4d45952">wxFileConfig</a>.</p>
</div>
</div>
<a class="anchor" id="ac66bcb140f09c8cb522d3117aa1aa0e7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool wxConfigBase::DeleteGroup </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>key</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete the group (with all subgroups). </p>
<p>If the current path is under the group being deleted it is changed to its deepest still existing component. E.g. if the current path is <code>"/A/B/C/D"</code> and the group <code>C</code> is deleted, the path becomes <code>"/A/B"</code>. </p>
<p>Implemented in <a class="el" href="classwx_file_config.html#aed9b867b366bb656ddd3fdf3108e726d">wxFileConfig</a>.</p>
</div>
</div>
<a class="anchor" id="a0e8ad0cb0c5b374a99b99ea6212e496b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void wxConfigBase::DontCreateOnDemand </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Calling this function will prevent <em><a class="el" href="classwx_config_base.html#a61bfb04c1c133190b3e851b252ed1c60" title="Get the current config object.">Get()</a></em> from automatically creating a new config object if the current one is <span class="literal">NULL</span>. </p>
<p>It might be useful to call it near the program end to prevent "accidental" creation of a new config object. </p>
</div>
</div>
<a class="anchor" id="a2ff94abfcc4907c08f5c326b6c224abd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxConfigBase::Exists </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>strName</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd><span class="literal">true</span> if either a group or an entry with a given name exists. </dd></dl>
</div>
</div>
<a class="anchor" id="a0b8cfc81de4d2534e8ab980b0fc6b9b8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool wxConfigBase::Flush </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>bCurrentOnly</em> = <code>false</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Permanently writes all changes (otherwise, they're only written from object's destructor). </p>
<p>Implemented in <a class="el" href="classwx_file_config.html#a237986fb7e05f7e5404dec1941da308d">wxFileConfig</a>.</p>
</div>
</div>
<a class="anchor" id="a61bfb04c1c133190b3e851b252ed1c60"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classwx_config_base.html">wxConfigBase</a>* wxConfigBase::Get </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>CreateOnDemand</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current config object. </p>
<p>If there is no current object and <em>CreateOnDemand</em> is <span class="literal">true</span>, this creates one (using <a class="el" href="classwx_config_base.html#aa7d633935adabe1bf11b5a028f8b3355" title="Create a new config object and sets it as the current one.">Create()</a>) unless <a class="el" href="classwx_config_base.html#a0e8ad0cb0c5b374a99b99ea6212e496b" title="Calling this function will prevent Get() from automatically creating a new config object if the curre...">DontCreateOnDemand()</a> was called previously. </p>
</div>
</div>
<a class="anchor" id="a2fc0ab0516143b52a239cd2d37165c24"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classwx_string.html">wxString</a> wxConfigBase::GetAppName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the application name. </p>
</div>
</div>
<a class="anchor" id="ab4035f97557760a9d9976371548324fb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classwx_config_base.html#a499282208b4b9e90cbfe60de25745bc4">wxConfigBase::EntryType</a> wxConfigBase::GetEntryType </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the type of the given entry or <em>Unknown</em> if the entry doesn't exist. </p>
<p>This function should be used to decide which version of <a class="el" href="classwx_config_base.html#af89fb6c338f200bec028480ac0f3b1d8" title="Read a string from the key, returning true if the value was read.">Read()</a> should be used because some of wxConfig implementations will complain about type mismatch otherwise: e.g., an attempt to read a string value from an integer key with <a class="el" href="classwx_reg_config.html" title="wxRegConfig implements the wxConfigBase interface for storing and retrieving configuration informatio...">wxRegConfig</a> will fail. </p>
</div>
</div>
<a class="anchor" id="a1f8338dd47972d196c6475e7e1140ae7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool wxConfigBase::GetFirstEntry </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long & </td>
<td class="paramname"><em>index</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the first entry. </p>
<p><b>wxPerl Note:</b> In wxPerl this method takes no parameters and returns a 3-element list (continue_flag, string, index_for_getnextentry). </p>
<p>Implemented in <a class="el" href="classwx_file_config.html#abccd0ec08228de5d433601eca2781b94">wxFileConfig</a>.</p>
</div>
</div>
<a class="anchor" id="af111cb376665bd1b7fc77ae20d985a6d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool wxConfigBase::GetFirstGroup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long & </td>
<td class="paramname"><em>index</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the first group. </p>
<p><b>wxPerl Note:</b> In wxPerl this method takes no parameters and returns a 3-element list (continue_flag, string, index_for_getnextentry). </p>
<p>Implemented in <a class="el" href="classwx_file_config.html#aecbc6a538ba2b9ad41620fbc00ef2a12">wxFileConfig</a>.</p>
</div>
</div>
<a class="anchor" id="a0c99d5eb83f8ebad82e1a13d1295f644"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool wxConfigBase::GetNextEntry </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long & </td>
<td class="paramname"><em>index</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the next entry. </p>
<p><b>wxPerl Note:</b> In wxPerl this method only takes the <em>index</em> parameter and returns a 3-element list (continue_flag, string, index_for_getnextentry). </p>
<p>Implemented in <a class="el" href="classwx_file_config.html#a37612450410cfad01a2ed52702875b37">wxFileConfig</a>.</p>
</div>
</div>
<a class="anchor" id="a491e0d51c86d4facd8184969ea6d341c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool wxConfigBase::GetNextGroup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long & </td>
<td class="paramname"><em>index</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the next group. </p>
<p><b>wxPerl Note:</b> In wxPerl this method only takes the <em>index</em> parameter and returns a 3-element list (continue_flag, string, index_for_getnextentry). </p>
<p>Implemented in <a class="el" href="classwx_file_config.html#a16fe0dba12a11a0ab3f7a7ceb6306528">wxFileConfig</a>.</p>
</div>
</div>
<a class="anchor" id="a993bdb14c4115ddc1458fb8bdc9de604"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t wxConfigBase::GetNumberOfEntries </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>bRecursive</em> = <code>false</code></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get number of entries in the current group. </p>
<p>Implemented in <a class="el" href="classwx_file_config.html#ad0738f455b2ea76e598d1e747576641d">wxFileConfig</a>.</p>
</div>
</div>
<a class="anchor" id="ad695ef5dd7dee1b24c7813aa08599eb9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t wxConfigBase::GetNumberOfGroups </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>bRecursive</em> = <code>false</code></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get number of entries/subgroups in the current group, with or without its subgroups. </p>
<p>Implemented in <a class="el" href="classwx_file_config.html#a5dc8869a67cea091376c19438586bdca">wxFileConfig</a>.</p>
</div>
</div>
<a class="anchor" id="a2c76e8a110cecc4d89d3af1565044e15"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classwx_string.html">wxString</a>& wxConfigBase::GetPath </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the current path (always as absolute path). </p>
<p>Implemented in <a class="el" href="classwx_file_config.html#a3b14df9f438cf17bcdf06eb0610d35da">wxFileConfig</a>.</p>
</div>
</div>
<a class="anchor" id="afd80dbbeaf5767fcebce0b737a294853"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classwx_string.html">wxString</a> wxConfigBase::GetVendorName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the vendor name. </p>
</div>
</div>
<a class="anchor" id="aaca0748de0e2e2841aaec85f63403d3b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool wxConfigBase::HasEntry </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>strName</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd><span class="literal">true</span> if the entry by this name exists. </dd></dl>
<p>Implemented in <a class="el" href="classwx_file_config.html#a6151f556961a8c627e1a9cc50ff37631">wxFileConfig</a>.</p>
</div>
</div>
<a class="anchor" id="a27472b872af09e73597735d0938b007d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool wxConfigBase::HasGroup </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>strName</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd><span class="literal">true</span> if the group by this name exists. </dd></dl>
<p>Implemented in <a class="el" href="classwx_file_config.html#a7e4498d31191ce0917b66094203db17f">wxFileConfig</a>.</p>
</div>
</div>
<a class="anchor" id="a1d8cbd33d9d85caeea77de753cb25548"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxConfigBase::IsExpandingEnvVars </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns <span class="literal">true</span> if we are expanding environment variables in key values. </p>
</div>
</div>
<a class="anchor" id="ab1bc59054ac75ae688c61cd767ba6083"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxConfigBase::IsRecordingDefaults </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns <span class="literal">true</span> if we are writing defaults back to the config file. </p>
</div>
</div>
<a class="anchor" id="af89fb6c338f200bec028480ac0f3b1d8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxConfigBase::Read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classwx_string.html">wxString</a> * </td>
<td class="paramname"><em>str</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Read a string from the key, returning <span class="literal">true</span> if the value was read. </p>
<p>If the key was not found, <em>str</em> is not changed.</p>
<p><b>wxPerl Note:</b> Not supported by wxPerl. </p>
</div>
</div>
<a class="anchor" id="a93b700301e0b73f1b42f14497f2e6bc7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxConfigBase::Read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classwx_string.html">wxString</a> * </td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>defaultVal</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Read a string from the key. </p>
<p>The default value is returned if the key was not found.</p>
<dl class="section return"><dt>Returns</dt><dd><span class="literal">true</span> if value was really read, <span class="literal">false</span> if the default was used.</dd></dl>
<p><b>wxPerl Note:</b> Not supported by wxPerl. </p>
</div>
</div>
<a class="anchor" id="a8f296b015c56b30ee2c669538c04e88a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classwx_string.html">wxString</a> wxConfigBase::Read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>defaultVal</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Another version of <a class="el" href="classwx_config_base.html#af89fb6c338f200bec028480ac0f3b1d8" title="Read a string from the key, returning true if the value was read.">Read()</a>, returning the string value directly. </p>
<p><b>wxPerl Note:</b> In wxPerl, this can be called as:</p>
<ul>
<li>Read(key): returns the empty string if no key is found</li>
<li>Read(key, default): returns the default value if no key is found </li>
</ul>
</div>
</div>
<a class="anchor" id="aa3b9fe04651ff429cb7699cbc60f5251"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxConfigBase::Read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long * </td>
<td class="paramname"><em>l</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a long value, returning <span class="literal">true</span> if the value was found. </p>
<p>If the value was not found, <em>l</em> is not changed.</p>
<p><b>wxPerl Note:</b> Not supported by wxPerl. </p>
</div>
</div>
<a class="anchor" id="aed9f1b5f899b7df40b6e9982f05d1437"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxConfigBase::Read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long * </td>
<td class="paramname"><em>l</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>defaultVal</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a long value, returning <span class="literal">true</span> if the value was found. </p>
<p>If the value was not found, <em>defaultVal</em> is used instead.</p>
<p><b>wxPerl Note:</b> In wxPerl, this can be called as:</p>
<ul>
<li>ReadInt(key): returns the 0 if no key is found</li>
<li>ReadInt(key, default): returns the default value if no key is found </li>
</ul>
</div>
</div>
<a class="anchor" id="a7b6ed21c1ee59e2c24456fc911da7371"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxConfigBase::Read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double * </td>
<td class="paramname"><em>d</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a double value, returning <span class="literal">true</span> if the value was found. </p>
<p>If the value was not found, <em>d</em> is not changed.</p>
<p><b>wxPerl Note:</b> Not supported by wxPerl. </p>
</div>
</div>
<a class="anchor" id="a455b51e0343a37e843b03adcdc91531d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxConfigBase::Read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double * </td>
<td class="paramname"><em>d</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>defaultVal</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a double value, returning <span class="literal">true</span> if the value was found. </p>
<p>If the value was not found, <em>defaultVal</em> is used instead.</p>
<p><b>wxPerl Note:</b> In wxPerl, this can be called as:</p>
<ul>
<li>ReadFloat(key): returns the 0.0 if no key is found</li>
<li>ReadFloat(key, default): returns the default value if no key is found </li>
</ul>
</div>
</div>
<a class="anchor" id="a2f775f81568a80314d6b947a8ee06c1a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxConfigBase::Read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float * </td>
<td class="paramname"><em>f</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a float value, returning <span class="literal">true</span> if the value was found. </p>
<p>If the value was not found, <em>f</em> is not changed.</p>
<p>Notice that the value is read as a double but must be in a valid range for floats for the function to return <span class="literal">true</span>.</p>
<dl class="section since"><dt>Since</dt><dd>2.9.1</dd></dl>
<p><b>wxPerl Note:</b> Not supported by wxPerl. </p>
</div>
</div>
<a class="anchor" id="aebbe5df968baea47a2722f5617c3e6f3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxConfigBase::Read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float * </td>
<td class="paramname"><em>f</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>defaultVal</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a float value, returning <span class="literal">true</span> if the value was found. </p>
<p>If the value was not found, <em>defaultVal</em> is used instead.</p>
<p>Notice that the value is read as a double but must be in a valid range for floats for the function to return <span class="literal">true</span>.</p>
<dl class="section since"><dt>Since</dt><dd>2.9.1</dd></dl>
<p><b>wxPerl Note:</b> Not supported by wxPerl. </p>
</div>
</div>
<a class="anchor" id="ae5a5e4486d889d3ba3d738f376ddd4fc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxConfigBase::Read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool * </td>
<td class="paramname"><em>b</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a boolean value, returning <span class="literal">true</span> if the value was found. </p>
<p>If the value was not found, <em>b</em> is not changed.</p>
<dl class="section since"><dt>Since</dt><dd>2.9.1</dd></dl>
<p><b>wxPerl Note:</b> Not supported by wxPerl. </p>
</div>
</div>
<a class="anchor" id="acd9d5f95b52a1cf59f63d0ba39879bb0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxConfigBase::Read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool * </td>
<td class="paramname"><em>d</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>defaultVal</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a boolean value, returning <span class="literal">true</span> if the value was found. </p>
<p>If the value was not found, <em>defaultVal</em> is used instead.</p>
<p><b>wxPerl Note:</b> In wxPerl, this can be called as:</p>
<ul>
<li>ReadBool(key): returns false if no key is found</li>
<li>ReadBool(key, default): returns the default value if no key is found </li>
</ul>
</div>
</div>
<a class="anchor" id="aeb402d8571388d67bf85d5abd0dd6641"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxConfigBase::Read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classwx_memory_buffer.html">wxMemoryBuffer</a> * </td>
<td class="paramname"><em>buf</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a binary block, returning <span class="literal">true</span> if the value was found. </p>
<p>If the value was not found, <em>buf</em> is not changed. </p>
</div>
</div>
<a class="anchor" id="a453771fa3ba928f72d9ef6975c2e76de"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxConfigBase::Read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T * </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a value of type T, for which function <a class="el" href="group__group__funcmacro__misc.html#ga598ae7504c6436af325490b41f4b5e90" title="Converts string to a wxColour best represented by the given string.">wxFromString()</a> is defined, returning <span class="literal">true</span> if the value was found. </p>
<p>If the value was not found, <em>value</em> is not changed. </p>
</div>
</div>
<a class="anchor" id="ac1206cb2c544b23fa9d2c983802114b5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxConfigBase::Read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T * </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T & </td>
<td class="paramname"><em>defaultVal</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a value of type T, for which function <a class="el" href="group__group__funcmacro__misc.html#ga598ae7504c6436af325490b41f4b5e90" title="Converts string to a wxColour best represented by the given string.">wxFromString()</a> is defined, returning <span class="literal">true</span> if the value was found. </p>
<p>If the value was not found, <em>defaultVal</em> is used instead. </p>
</div>
</div>
<a class="anchor" id="a6c933c93b00ac59ffcf16f5a2e3c47a9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxConfigBase::ReadBool </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>defaultVal</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a bool value from the key and returns it. </p>
<p><em>defaultVal</em> is returned if the key is not found. </p>
</div>
</div>
<a class="anchor" id="a82413d25fca2d006def607f14b6d45f4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double wxConfigBase::ReadDouble </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>defaultVal</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a double value from the key and returns it. </p>
<p><em>defaultVal</em> is returned if the key is not found. </p>
</div>
</div>
<a class="anchor" id="ab876635fe7cefe7eae38a1ef330a4c49"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long wxConfigBase::ReadLong </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>defaultVal</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a long value from the key and returns it. </p>
<p><em>defaultVal</em> is returned if the key is not found. </p>
</div>
</div>
<a class="anchor" id="ac88afa67847dcf8a962e847dfaf5972a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T wxConfigBase::ReadObject </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const & </td>
<td class="paramname"><em>defaultVal</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a value of type T (for which the function <a class="el" href="group__group__funcmacro__misc.html#ga598ae7504c6436af325490b41f4b5e90" title="Converts string to a wxColour best represented by the given string.">wxFromString()</a> must be defined) from the key and returns it. </p>
<p><em>defaultVal</em> is returned if the key is not found. </p>
</div>
</div>
<a class="anchor" id="a1871d5f0aec990c1552242203c5ed0c4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool wxConfigBase::RenameEntry </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>oldName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>newName</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Renames an entry in the current group. </p>
<p>The entries names (both the old and the new one) shouldn't contain backslashes, i.e. only simple names and not arbitrary paths are accepted by this function.</p>
<dl class="section return"><dt>Returns</dt><dd><span class="literal">false</span> if <em>oldName</em> doesn't exist or if <em>newName</em> already exists. </dd></dl>
<p>Implemented in <a class="el" href="classwx_file_config.html#a562a1b81e23d70c1921c2139dcf5580d">wxFileConfig</a>.</p>
</div>
</div>
<a class="anchor" id="a4f85e2947979146ccc77b42c15409834"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool wxConfigBase::RenameGroup </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>oldName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>newName</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Renames a subgroup of the current group. </p>
<p>The subgroup names (both the old and the new one) shouldn't contain backslashes, i.e. only simple names and not arbitrary paths are accepted by this function.</p>
<dl class="section return"><dt>Returns</dt><dd><span class="literal">false</span> if <em>oldName</em> doesn't exist or if <em>newName</em> already exists. </dd></dl>
<p>Implemented in <a class="el" href="classwx_file_config.html#a3827f9711a31782a2d4f1ea61e1ea592">wxFileConfig</a>.</p>
</div>
</div>
<a class="anchor" id="a8e2ca739326f32379d6816522a5d1907"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classwx_config_base.html">wxConfigBase</a>* wxConfigBase::Set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwx_config_base.html">wxConfigBase</a> * </td>
<td class="paramname"><em>pConfig</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the config object as the current one, returns the pointer to the previous current object (both the parameter and returned value may be <span class="literal">NULL</span>). </p>
</div>
</div>
<a class="anchor" id="a3a8c651d2bdde14e6248b0cd85062476"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wxConfigBase::SetExpandEnvVars </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>bDoIt</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determine whether we wish to expand environment variables in key values. </p>
</div>
</div>
<a class="anchor" id="ad290d3fe7fad4f39a4bb2959db89b379"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void wxConfigBase::SetPath </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>strPath</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set current path: if the first character is '/', it is the absolute path, otherwise it is a relative path. </p>
<p>'..' is supported. If <em>strPath</em> doesn't exist, it is created.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classwx_config_path_changer.html" title="A handy little class which changes the current path in a wxConfig object and restores it in dtor...">wxConfigPathChanger</a> </dd></dl>
<p>Implemented in <a class="el" href="classwx_file_config.html#ac2b05e8f651d7390e3c340e5c7feea0e">wxFileConfig</a>.</p>
</div>
</div>
<a class="anchor" id="a80bff71cc742251419ba499ce7b4da3c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wxConfigBase::SetRecordDefaults </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>bDoIt</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets whether defaults are recorded to the config file whenever an attempt to read the value which is not present in it is done. </p>
<p>If on (default is off) all default values for the settings used by the program are written back to the config file. This allows the user to see what config options may be changed and is probably useful only for <a class="el" href="classwx_file_config.html" title="wxFileConfig implements wxConfigBase interface for storing and retrieving configuration information u...">wxFileConfig</a>. </p>
</div>
</div>
<a class="anchor" id="ace24f1478e71ac309ecf1d9273f19ce3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxConfigBase::Write </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes the <a class="el" href="classwx_string.html" title="String class for passing textual data to or receiving it from wxWidgets.">wxString</a> value to the config file and returns <span class="literal">true</span> on success. </p>
</div>
</div>
<a class="anchor" id="a052e7e5df90589f8094f860a9bdfd8a8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxConfigBase::Write </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes the long value to the config file and returns <span class="literal">true</span> on success. </p>
</div>
</div>
<a class="anchor" id="a108d7427200466a240f8ea835e74db7b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxConfigBase::Write </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes the double value to the config file and returns <span class="literal">true</span> on success. </p>
<p>Notice that if floating point numbers are saved as strings (as is the case with the configuration files used by <a class="el" href="classwx_file_config.html" title="wxFileConfig implements wxConfigBase interface for storing and retrieving configuration information u...">wxFileConfig</a>), this function uses the C locale for writing out the number, i.e. it will always use a period as the decimal separator, irrespectively of the current locale. This behaviour is new since wxWidgets 2.9.1 as the current locale was used before, but the change should be transparent because both C and current locales are tried when reading the numbers back. </p>
</div>
</div>
<a class="anchor" id="a97465083477038dc7d01e363c511f6cd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxConfigBase::Write </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes the bool value to the config file and returns <span class="literal">true</span> on success. </p>
</div>
</div>
<a class="anchor" id="a83efe80538c9f3e4056ae6d44d362f49"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxConfigBase::Write </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classwx_memory_buffer.html">wxMemoryBuffer</a> & </td>
<td class="paramname"><em>buf</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes the <a class="el" href="classwx_memory_buffer.html" title="A wxMemoryBuffer is a useful data structure for storing arbitrary sized blocks of memory...">wxMemoryBuffer</a> value to the config file and returns <span class="literal">true</span> on success. </p>
</div>
</div>
<a class="anchor" id="a9ac693bd370a81d7fd0cad255869a041"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxConfigBase::Write </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const & </td>
<td class="paramname"><em>buf</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes the specified value to the config file and returns <span class="literal">true</span> on success. </p>
<p>The function <a class="el" href="group__group__funcmacro__misc.html#ga0adf8026ea8ed126420a2e7ef9edc678" title="Converts the given wxColour into a string.">wxToString()</a> must be defined for type <em>T</em>. </p>
</div>
</div>
</div><!-- contents -->
<address class="footer">
<small>
Generated on Thu Nov 27 2014 13:46:45 for wxWidgets by <a href="http://www.doxygen.org/index.html" target="_new">Doxygen</a> 1.8.2
</small>
</address>
<script src="wxwidgets.js" type="text/javascript"></script>
</div><!-- #page_container -->
</body>
</html>
|