KWallet::Wallet Class Reference
#include <kwallet.h>
Inheritance diagram for KWallet::Wallet:

Detailed Description
KDE WalletKDE Wallet Class.This class implements a generic system-wide Wallet for KDE. This is the ONLY public interface. The DCOP client is unsupported and considered to be private.
- Author:
- George Staikos <staikos@kde.org>
Definition at line 48 of file kwallet.h.
Public Types | |
enum | EntryType { Unknown = 0, Password, Stream, Map, Unused = 0xffff } |
enum | OpenType { Synchronous = 0, Asynchronous, Path, OpenTypeUnused = 0xff } |
Signals | |
void | walletClosed () |
void | folderUpdated (const QString &folder) |
void | folderListUpdated () |
void | folderRemoved (const QString &folder) |
void | walletOpened (bool success) |
DCOP Member Functions | |
ASYNC | slotWalletClosed (int handle) |
ASYNC | slotFolderUpdated (const QString &wallet, const QString &folder) |
ASYNC | slotFolderListUpdated (const QString &wallet) |
ASYNC | slotApplicationDisconnected (const QString &wallet, const QCString &application) |
ASYNC | walletOpenResult (int rc) |
Public Member Functions | |
virtual | ~Wallet () |
virtual int | sync () |
virtual int | lockWallet () |
virtual const QString & | walletName () const |
virtual bool | isOpen () const |
virtual void | requestChangePassword (WId w=0) |
virtual QStringList | folderList () |
virtual bool | hasFolder (const QString &f) |
virtual bool | setFolder (const QString &f) |
virtual bool | removeFolder (const QString &f) |
virtual bool | createFolder (const QString &f) |
virtual const QString & | currentFolder () const |
virtual QStringList | entryList () |
virtual int | renameEntry (const QString &oldName, const QString &newName) |
virtual int | readEntry (const QString &key, QByteArray &value) |
virtual int | readMap (const QString &key, QMap< QString, QString > &value) |
virtual int | readPassword (const QString &key, QString &value) |
int | readEntryList (const QString &key, QMap< QString, QByteArray > &value) |
int | readMapList (const QString &key, QMap< QString, QMap< QString, QString > > &value) |
int | readPasswordList (const QString &key, QMap< QString, QString > &value) |
virtual int | writeEntry (const QString &key, const QByteArray &value, EntryType entryType) |
virtual int | writeEntry (const QString &key, const QByteArray &value) |
virtual int | writeMap (const QString &key, const QMap< QString, QString > &value) |
virtual int | writePassword (const QString &key, const QString &value) |
virtual bool | hasEntry (const QString &key) |
virtual int | removeEntry (const QString &key) |
virtual EntryType | entryType (const QString &key) |
Static Public Member Functions | |
static QStringList | walletList () |
static bool | isEnabled () |
static bool | isOpen (const QString &name) |
static int | closeWallet (const QString &name, bool force) |
static int | deleteWallet (const QString &name) |
static bool | disconnectApplication (const QString &wallet, const QCString &app) |
static Wallet * | openWallet (const QString &name, WId w=0, OpenType ot=Synchronous) |
static QStringList | users (const QString &wallet) |
static const QString | LocalWallet () |
static const QString | NetworkWallet () |
static const QString | PasswordFolder () |
static const QString | FormDataFolder () |
static void | changePassword (const QString &name, WId w=0) |
static bool | folderDoesNotExist (const QString &wallet, const QString &folder) |
static bool | keyDoesNotExist (const QString &wallet, const QString &folder, const QString &key) |
Protected Member Functions | |
Wallet (int handle, const QString &name) | |
Wallet (const Wallet &) | |
virtual void | virtual_hook (int id, void *data) |
Constructor & Destructor Documentation
|
Construct a KWallet object.
Definition at line 75 of file kwallet.cc. |
|
Copy a KWallet object.
|
|
Destroy a KWallet object. Closes the wallet. Definition at line 106 of file kwallet.cc. |
Member Function Documentation
|
Request to the wallet service to change the password of the wallet
Definition at line 129 of file kwallet.cc. |
|
Close the wallet The wallet will only be closed if it is open but not in use (rare), or if it is forced closed.
Definition at line 154 of file kwallet.cc. |
|
Created the folder
Definition at line 331 of file kwallet.cc. |
|
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.
Definition at line 392 of file kwallet.cc. |
|
Delete the wallet The wallet will be forced closed first.
Definition at line 164 of file kwallet.cc. |
|
Disconnect the application
Definition at line 206 of file kwallet.cc. |
|
Return the list of keys of all entries in this folder.
Definition at line 299 of file kwallet.cc. |
|
Determine the type of the entry
Definition at line 628 of file kwallet.cc. |
|
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.
Definition at line 689 of file kwallet.cc. |
|
Obtain the list of all folders contained in the wallet.
Definition at line 283 of file kwallet.cc. |
|
Emitted when the folder list is changed in this wallet.
|
|
Emitted when a folder in this wallet is removed.
|
|
Emitted when a folder in this wallet is updated.
|
|
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. Definition at line 69 of file kwallet.cc. |
|
Determine if the current folder has they entry
Definition at line 596 of file kwallet.cc. |
|
Determine if the folder
Definition at line 315 of file kwallet.cc. |
|
Determine if the KDE wallet is enabled. Normally you do not need to use this because open() will just fail.
Definition at line 134 of file kwallet.cc. |
|
Determine if the current wallet is open, and is a valid wallet handle.
Definition at line 259 of file kwallet.cc. |
|
Determine if the wallet
Definition at line 144 of file kwallet.cc. |
|
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.
Definition at line 699 of file kwallet.cc. |
|
The name of the wallet used to store local passwords.
Definition at line 36 of file kwallet.cc. |
|
This closes and locks the current wallet. It will disconnect all applications using the wallet.
Definition at line 236 of file kwallet.cc. |
|
The name of the wallet used to store network passwords.
Definition at line 54 of file kwallet.cc. |
|
Open the wallet 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.
Definition at line 174 of file kwallet.cc. |
|
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. Definition at line 65 of file kwallet.cc. |
|
Read the entry The entry format is unknown except that it is either a QByteArray or a QDataStream, which effectively means that it is anything.
Definition at line 397 of file kwallet.cc. |
|
Read the entries matching The entry format is unknown except that it is either a QByteArray or a QDataStream, which effectively means that it is anything.
Definition at line 414 of file kwallet.cc. |
|
Read the map entry
Definition at line 447 of file kwallet.cc. |
|
Read the map entry
Definition at line 469 of file kwallet.cc. |
|
Read the password entry
Definition at line 495 of file kwallet.cc. |
|
Read the password entry
Definition at line 512 of file kwallet.cc. |
|
Remove the entry
Definition at line 612 of file kwallet.cc. |
|
Remove the folder
Definition at line 372 of file kwallet.cc. |
|
Rename the entry
Definition at line 431 of file kwallet.cc. |
|
Request to the wallet service to change the password of the current wallet.
Definition at line 264 of file kwallet.cc. |
|
Set the current working folder to The folder must exist, or this call will fail. Create a folder with createFolder().
Definition at line 349 of file kwallet.cc. |
|
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.
Definition at line 226 of file kwallet.cc. |
|
List the applications that are using the wallet
Definition at line 216 of file kwallet.cc. |
|
Emitted when this wallet is closed.
|
|
List all the wallets available.
Definition at line 119 of file kwallet.cc. |
|
The name of the current wallet.
Definition at line 254 of file kwallet.cc. |
|
Emitted when a wallet is opened in asynchronous mode.
|
|
Write
Definition at line 545 of file kwallet.cc. |
|
Write Be careful with this, it could cause inconsistency in the future since you can put an arbitrary entry type in place.
Definition at line 529 of file kwallet.cc. |
|
Write
Definition at line 561 of file kwallet.cc. |
|
Write
Definition at line 580 of file kwallet.cc. |
The documentation for this class was generated from the following files: