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
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>KWallet.Wallet</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
<div id="header_top">
<div>
<div>
<img alt ="" src="../common/top-kde.jpg"/>
KDE 4.9 PyKDE API Reference
</div>
</div>
</div>
<div id="header_bottom">
<div id="location">
<ul>
<li>KDE's Python API</li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h1>Wallet Class Reference</h1>
<code>from PyKDE4.kdeui import *</code>
<p>
Inherits: QObject<br />
Namespace: <a href="../kdeui/KWallet.html">KWallet</a><br />
<h2>Detailed Description</h2>
<p>KDE Wallet
</p>
<p>
This class implements a generic system-wide Wallet for KDE. This is the
ONLY public interface.
</p>
<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd> George Staikos <staikos@kde.org> </dd></dl>
KDE Wallet Class
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#EntryType">EntryType</a> </td><td class="memItemRight" valign="bottom">{ Unknown, Password, Stream, Map, Unused }</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#OpenType">OpenType</a> </td><td class="memItemRight" valign="bottom">{ Synchronous, Asynchronous, Path, OpenTypeUnused }</td></tr>
<tr><td colspan="2"><br><h2>Signals</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#folderListUpdated">folderListUpdated</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#folderRemoved">folderRemoved</a> (QString folder)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#folderUpdated">folderUpdated</a> (QString folder)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#walletClosed">walletClosed</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#walletOpened">walletOpened</a> (bool success)</td></tr>
<tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#Wallet">__init__</a> (self, int handle, QString name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#createFolder">createFolder</a> (self, QString f)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#currentFolder">currentFolder</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#entryList">entryList</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KWallet.Wallet.html#EntryType">KWallet.Wallet.EntryType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#entryType">entryType</a> (self, QString key)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#folderList">folderList</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#hasEntry">hasEntry</a> (self, QString key)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#hasFolder">hasFolder</a> (self, QString f)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isOpen">isOpen</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#lockWallet">lockWallet</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int, QByteArray value </td><td class="memItemRight" valign="bottom"><a class="el" href="#readEntry">readEntry</a> (self, QString key)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int, {QString:QByteArray} value </td><td class="memItemRight" valign="bottom"><a class="el" href="#readEntryList">readEntryList</a> (self, QString key)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int, {QString:QString} value </td><td class="memItemRight" valign="bottom"><a class="el" href="#readMap">readMap</a> (self, QString key)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int, QString value </td><td class="memItemRight" valign="bottom"><a class="el" href="#readPassword">readPassword</a> (self, QString key)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int, {QString:QString} value </td><td class="memItemRight" valign="bottom"><a class="el" href="#readPasswordList">readPasswordList</a> (self, QString key)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#removeEntry">removeEntry</a> (self, QString key)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#removeFolder">removeFolder</a> (self, QString f)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#renameEntry">renameEntry</a> (self, QString oldName, QString newName)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#requestChangePassword">requestChangePassword</a> (self, long w)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#setFolder">setFolder</a> (self, QString f)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#sync">sync</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#walletName">walletName</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#writeEntry">writeEntry</a> (self, QString key, QByteArray value, <a href="../kdeui/KWallet.Wallet.html#EntryType">KWallet.Wallet.EntryType</a> entryType)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#writeEntry">writeEntry</a> (self, QString key, QByteArray value)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#writeMap">writeMap</a> (self, QString key, {QString:QString} value)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#writePassword">writePassword</a> (self, QString key, QString value)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#FormDataFolder">FormDataFolder</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#LocalWallet">LocalWallet</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#NetworkWallet">NetworkWallet</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#PasswordFolder">PasswordFolder</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#changePassword">changePassword</a> (QString name, long w)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#closeWallet">closeWallet</a> (QString name, bool force)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#deleteWallet">deleteWallet</a> (QString name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#disconnectApplication">disconnectApplication</a> (QString wallet, QString app)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#folderDoesNotExist">folderDoesNotExist</a> (QString wallet, QString folder)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isEnabled">isEnabled</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isOpen">isOpen</a> (QString name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isUsingKSecretsService">isUsingKSecretsService</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#keyDoesNotExist">keyDoesNotExist</a> (QString wallet, QString folder, QString key)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KWallet.Wallet.html">KWallet.Wallet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#openWallet">openWallet</a> (QString name, long w, <a href="../kdeui/KWallet.Wallet.html#OpenType">KWallet.Wallet.OpenType</a> ot=KWallet.Wallet.Synchronous)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#users">users</a> (QString wallet)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#walletList">walletList</a> ()</td></tr>
</table>
<hr><h2>Signal Documentation</h2><a class="anchor" name="folderListUpdated"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> folderListUpdated</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Emitted when the folder list is changed in this wallet.
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("folderListUpdated()"), target_slot)</code></dd></dl></div></div><a class="anchor" name="folderRemoved"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> folderRemoved</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>folder</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Emitted when a folder in this wallet is removed.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>folder</em> </td><td> The folder that was removed.
</td></tr>
</table></dl>
<p>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("folderRemoved(const QString&)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="folderUpdated"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> folderUpdated</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>folder</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Emitted when a folder in this wallet is updated.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>folder</em> </td><td> The folder that was updated.
</td></tr>
</table></dl>
<p>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("folderUpdated(const QString&)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="walletClosed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> walletClosed</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Emitted when this wallet is closed.
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("walletClosed()"), target_slot)</code></dd></dl></div></div><a class="anchor" name="walletOpened"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> walletOpened</td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>success</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Emitted when a wallet is opened in asynchronous mode.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>success</em> </td><td> True if the wallet was opened successfully.
</td></tr>
</table></dl>
<p>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("walletOpened(bool)"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="Wallet"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>name</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Construct a KWallet object.
<dl class="internal" compact><dt><b>Internal:</b></dt><dd>
</dd></dl> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>handle</em> </td><td> The handle for the wallet.
<tr><td></td><td valign="top"><em>name</em> </td><td> The name of the wallet.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="createFolder"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool createFolder</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>f</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Created the folder <b>f.</b>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>f</em> </td><td> the name of the folder to create
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns true if the folder was successfully created.
</dd></dl>
</p></div></div><a class="anchor" name="currentFolder"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString currentFolder</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Determine the current working folder in the wallet.
If the folder name is empty, it is working in the global
folder, which is valid but discouraged.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns the current working folder.
</dd></dl>
</p></div></div><a class="anchor" name="entryList"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QStringList entryList</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Return the list of keys of all entries in this folder.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns an empty list if the wallet is not open, or
if the folder is empty.
</dd></dl>
</p></div></div><a class="anchor" name="entryType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdeui/KWallet.Wallet.html#EntryType">KWallet.Wallet.EntryType</a> entryType</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>key</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Determine the type of the entry <b>key</b> in this folder.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>key</em> </td><td> The key to look up.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns an enumerated type representing the type
of the entry.
</dd></dl>
</p></div></div><a class="anchor" name="folderList"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QStringList folderList</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Obtain the list of all folders contained in the wallet.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns an empty list if the wallet is not open.
</dd></dl>
</p></div></div><a class="anchor" name="hasEntry"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool hasEntry</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>key</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Determine if the current folder has they entry <b>key.</b>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>key</em> </td><td> The key to search for.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns true if the folder contains <b>key.</b>
</dd></dl>
</p></div></div><a class="anchor" name="hasFolder"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool hasFolder</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>f</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Determine if the folder <b>f</b> exists in the wallet.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>f</em> </td><td> the name of the folder to check for
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns true if the folder exists in the wallet.
</dd></dl>
</p></div></div><a class="anchor" name="isOpen"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isOpen</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Determine if the current wallet is open, and is a valid
wallet handle.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns true if the wallet handle is valid and open.
</dd></dl>
</p></div></div><a class="anchor" name="lockWallet"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int lockWallet</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>This closes and locks the current wallet. It will
disconnect all applications using the wallet.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns 0 on success, non-zero on error.
</dd></dl>
</p></div></div><a class="anchor" name="readEntry"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int, QByteArray value readEntry</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>key</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Read the entry <b>key</b> from the current folder.
The entry format is unknown except that it is either a
QByteArray or a QDataStream, which effectively means that
it is anything.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>key</em> </td><td> The key of the entry to read.
<tr><td></td><td valign="top"><em>value</em> </td><td> A buffer to fill with the value.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns 0 on success, non-zero on error.
</dd></dl>
</p></div></div><a class="anchor" name="readEntryList"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int, {QString:QByteArray} value readEntryList</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>key</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Read the entries matching <b>key</b> from the current folder.
The entry format is unknown except that it is either a
QByteArray or a QDataStream, which effectively means that
it is anything.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>key</em> </td><td> The key of the entry to read. Wildcards
are supported.
<tr><td></td><td valign="top"><em>value</em> </td><td> A buffer to fill with the value. The key in
the map is the entry key.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns 0 on success, non-zero on error.
</dd></dl>
</p></div></div><a class="anchor" name="readMap"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int, {QString:QString} value readMap</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>key</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Read the map entry <b>key</b> from the current folder.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>key</em> </td><td> The key of the entry to read.
<tr><td></td><td valign="top"><em>value</em> </td><td> A map buffer to fill with the value.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns 0 on success, non-zero on error. Will
return an error if the key was not originally
written as a map.
</dd></dl>
</p></div></div><a class="anchor" name="readPassword"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int, QString value readPassword</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>key</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Read the password entry <b>key</b> from the current folder.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>key</em> </td><td> The key of the entry to read.
<tr><td></td><td valign="top"><em>value</em> </td><td> A password buffer to fill with the value.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns 0 on success, non-zero on error. Will
return an error if the key was not originally
written as a password.
</dd></dl>
</p></div></div><a class="anchor" name="readPasswordList"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int, {QString:QString} value readPasswordList</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>key</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Read the password entry <b>key</b> from the current folder.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>key</em> </td><td> The key of the entry to read. Wildcards
are supported.
<tr><td></td><td valign="top"><em>value</em> </td><td> A buffer to fill with the value. The key in
the map is the entry key.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns 0 on success, non-zero on error. Will
return an error if the key was not originally
written as a password.
</dd></dl>
</p></div></div><a class="anchor" name="removeEntry"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int removeEntry</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>key</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Remove the entry <b>key</b> from the current folder.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>key</em> </td><td> The key to remove.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns 0 on success, non-zero on error.
</dd></dl>
</p></div></div><a class="anchor" name="removeFolder"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool removeFolder</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>f</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Remove the folder <b>f</b> and all its entries from the wallet.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>f</em> </td><td> the name of the folder to remove
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns true if the folder was successfully removed.
</dd></dl>
</p></div></div><a class="anchor" name="renameEntry"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int renameEntry</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>oldName</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>newName</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Rename the entry <b>oldName</b> to <b>newName.</b>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>oldName</em> </td><td> The original key of the entry.
<tr><td></td><td valign="top"><em>newName</em> </td><td> The new key of the entry.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns 0 on success, non-zero on error.
</dd></dl>
</p></div></div><a class="anchor" name="requestChangePassword"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> requestChangePassword</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>w</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Request to the wallet service to change the password of
the current wallet.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>w</em> </td><td> The window id to associate any dialogs with. You can pass
0 if you don't have a window the password dialog should
associate with.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setFolder"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool setFolder</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>f</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set the current working folder to <b>f.</b> The folder must
exist, or this call will fail. Create a folder with
createFolder().
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>f</em> </td><td> the name of the folder to make the working folder
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns true if the folder was successfully set.
</dd></dl>
</p></div></div><a class="anchor" name="sync"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int sync</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>This syncs the wallet file on disk with what is in memory.
You don't normally need to use this. It happens
automatically on close.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns 0 on success, non-zero on error.
</dd></dl>
</p></div></div><a class="anchor" name="walletName"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString walletName</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>The name of the current wallet.
</p></div></div><a class="anchor" name="writeEntry"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int writeEntry</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QByteArray </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KWallet.Wallet.html#EntryType">KWallet.Wallet.EntryType</a> </td>
<td class="paramname"><em>entryType</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Write <b>key</b> = <b>value</b> as a binary entry to the current
folder.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>key</em> </td><td> The key of the new entry.
<tr><td></td><td valign="top"><em>value</em> </td><td> The value of the entry.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns 0 on success, non-zero on error.
</dd></dl>
</p></div></div><a class="anchor" name="writeEntry"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int writeEntry</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QByteArray </td>
<td class="paramname"><em>value</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Write <b>key</b> = <b>value</b> as a binary entry to the current
folder.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>key</em> </td><td> The key of the new entry.
<tr><td></td><td valign="top"><em>value</em> </td><td> The value of the entry.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns 0 on success, non-zero on error.
</dd></dl>
</p></div></div><a class="anchor" name="writeMap"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int writeMap</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">{QString:QString} </td>
<td class="paramname"><em>value</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Write <b>key</b> = <b>value</b> as a map to the current folder.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>key</em> </td><td> The key of the new entry.
<tr><td></td><td valign="top"><em>value</em> </td><td> The value of the map.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns 0 on success, non-zero on error.
</dd></dl>
</p></div></div><a class="anchor" name="writePassword"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int writePassword</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>value</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Write <b>key</b> = <b>value</b> as a password to the current folder.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>key</em> </td><td> The key of the new entry.
<tr><td></td><td valign="top"><em>value</em> </td><td> The value of the password.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns 0 on success, non-zero on error.
</dd></dl>
</p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="FormDataFolder"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString FormDataFolder</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>The standardized name of the form data folder.
It is automatically created when a wallet is created, but
the user may still delete it so you should check for its
existence and recreate it if necessary and desired.
</p></div></div><a class="anchor" name="LocalWallet"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString LocalWallet</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>The name of the wallet used to store local passwords.
</p></div></div><a class="anchor" name="NetworkWallet"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString NetworkWallet</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>The name of the wallet used to store network passwords.
</p></div></div><a class="anchor" name="PasswordFolder"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString PasswordFolder</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>The standardized name of the password folder.
It is automatically created when a wallet is created, but
the user may still delete it so you should check for its
existence and recreate it if necessary and desired.
</p></div></div><a class="anchor" name="changePassword"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> changePassword</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>w</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Request to the wallet service to change the password of
the wallet <b>name.</b>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>name</em> </td><td> The the wallet to change the password of.
<tr><td></td><td valign="top"><em>w</em> </td><td> The window id to associate any dialogs with. You can pass
0 if you don't have a window the password dialog should
associate with.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="closeWallet"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int closeWallet</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>force</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Close the wallet <b>name.</b> The wallet will only be closed
if it is open but not in use (rare), or if it is forced
closed.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>name</em> </td><td> The name of the wallet to close.
<tr><td></td><td valign="top"><em>force</em> </td><td> Set true to force the wallet closed even if it
is in use by others.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns 0 on success, non-zero on error.
</dd></dl>
</p></div></div><a class="anchor" name="deleteWallet"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int deleteWallet</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>name</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Delete the wallet <b>name.</b> The wallet will be forced closed
first.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>name</em> </td><td> The name of the wallet to delete.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns 0 on success, non-zero on error.
</dd></dl>
</p></div></div><a class="anchor" name="disconnectApplication"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool disconnectApplication</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>wallet</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>app</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Disconnect the application <b>app</b> from <b>wallet.</b>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>wallet</em> </td><td> The name of the wallet to disconnect.
<tr><td></td><td valign="top"><em>app</em> </td><td> The name of the application to disconnect.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns true on success, false on error.
</dd></dl>
</p></div></div><a class="anchor" name="folderDoesNotExist"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool folderDoesNotExist</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>wallet</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>folder</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Determine if a folder does not exist in a wallet. This
does not require decryption of the wallet.
This is a handy optimization to avoid prompting the user
if your data is certainly not in the wallet.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>wallet</em> </td><td> The wallet to look in.
<tr><td></td><td valign="top"><em>folder</em> </td><td> The folder to look up.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns true if the folder does NOT exist in the
wallet, or the wallet does not exist.
</dd></dl>
</p></div></div><a class="anchor" name="isEnabled"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isEnabled</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Determine if the KDE wallet is enabled. Normally you do
not need to use this because openWallet() will just fail.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns true if the wallet enabled, else false.
</dd></dl>
</p></div></div><a class="anchor" name="isOpen"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isOpen</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>name</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Determine if the current wallet is open, and is a valid
wallet handle.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns true if the wallet handle is valid and open.
</dd></dl>
</p></div></div><a class="anchor" name="isUsingKSecretsService"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isUsingKSecretsService</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Determine if the KWallet API is using the KSecretsService infrastructure
This can ben changed in system settings
<dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns true if the KSecretsService infrastructure is active
</dd></dl>
</p></div></div><a class="anchor" name="keyDoesNotExist"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool keyDoesNotExist</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>wallet</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>folder</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>key</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Determine if an entry in a folder does not exist in a
wallet. This does not require decryption of the wallet.
This is a handy optimization to avoid prompting the user
if your data is certainly not in the wallet.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>wallet</em> </td><td> The wallet to look in.
<tr><td></td><td valign="top"><em>folder</em> </td><td> The folder to look in.
<tr><td></td><td valign="top"><em>key</em> </td><td> The key to look up.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns true if the key does NOT exist in the
wallet, or the folder or wallet does not exist.
</dd></dl>
</p></div></div><a class="anchor" name="openWallet"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdeui/KWallet.Wallet.html">KWallet.Wallet</a> openWallet</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>w</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KWallet.Wallet.html#OpenType">KWallet.Wallet.OpenType</a> </td>
<td class="paramname"><em>ot=KWallet.Wallet.Synchronous</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Open the wallet <b>name.</b> The user will be prompted to
allow your application to open the wallet, and may be
prompted for a password. You are responsible for deleting
this object when you are done with it.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>name</em> </td><td> The name of the wallet to open.
<tr><td></td><td valign="top"><em>ot</em> </td><td> If Asynchronous, the call will return
immediately with a non-null pointer to an
invalid wallet. You must immediately connect
the walletOpened() signal to a slot so that
you will know when it is opened, or when it
fails.
<tr><td></td><td valign="top"><em>w</em> </td><td> The window id to associate any dialogs with. You can pass
0 if you don't have a window the password dialog should
associate with.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns a pointer to the wallet if successful,
or a null pointer on error or if rejected.
</dd></dl>
</p></div></div><a class="anchor" name="users"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QStringList users</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>wallet</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>List the applications that are using the wallet <b>wallet.</b>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>wallet</em> </td><td> The wallet to query.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns a list of all DCOP application IDs using
the wallet.
</dd></dl>
</p></div></div><a class="anchor" name="walletList"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QStringList walletList</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>List all the wallets available.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns a list of the names of all wallets that are
open.
</dd></dl>
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="EntryType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">EntryType</td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>Unknown</em> = 0</td><td><tr><td valign="top"><em>Password</em> </td><td><tr><td valign="top"><em>Stream</em> </td><td><tr><td valign="top"><em>Map</em> </td><td><tr><td valign="top"><em>Unused</em> = 0xffff</td><td></table>
</dl>
</div></div><p><a class="anchor" name="OpenType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">OpenType</td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>Synchronous</em> = 0</td><td><tr><td valign="top"><em>Asynchronous</em> </td><td><tr><td valign="top"><em>Path</em> </td><td><tr><td valign="top"><em>OpenTypeUnused</em> = 0xff</td><td></table>
</dl>
</div></div><p>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>
</div>
</div>
<div class="clearer"/>
</div>
<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div></div>
</body>
</html>
|