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

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) |
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 | |
QStringList | walletList () |
bool | isEnabled () |
bool | isOpen (const QString &name) |
int | closeWallet (const QString &name, bool force) |
int | deleteWallet (const QString &name) |
bool | disconnectApplication (const QString &wallet, const QCString &app) |
Wallet * | openWallet (const QString &name, WId w=0, OpenType ot=Synchronous) |
QStringList | users (const QString &wallet) |
const QString | LocalWallet () |
const QString | NetworkWallet () |
const QString | PasswordFolder () |
const QString | FormDataFolder () |
void | changePassword (const QString &name, WId w=0) |
bool | folderDoesNotExist (const QString &wallet, const QString &folder) |
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) |
Detailed Description
KDE Wallet KDE 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 44 of file kwallet.h.
Constructor & Destructor Documentation
|
Construct a KWallet object.
Definition at line 64 of file kwallet.cc. References DCOPRef::app(), DCOPRef::call(), DCOPRef::dcopClient(), DCOPReply::get(), DCOPReply::isValid(), DCOPRef::obj(), and DCOPClient::setNotifications(). |
|
Copy a KWallet object.
|
|
Destroy a KWallet object. Closes the wallet. Definition at line 95 of file kwallet.cc. References DCOPRef::call(). |
Member Function Documentation
|
List all the wallets available.
Definition at line 108 of file kwallet.cc. References DCOPReply::get(), and DCOPReply::isValid(). |
|
Determine if the KDE wallet is enabled. Normally you do not need to use this because open() will just fail.
Definition at line 123 of file kwallet.cc. References DCOPReply::get(), and DCOPReply::isValid(). |
|
Determine if the wallet
Definition at line 133 of file kwallet.cc. References DCOPReply::get(), and DCOPReply::isValid(). |
|
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 143 of file kwallet.cc. References DCOPReply::get(), and DCOPReply::isValid(). |
|
Delete the wallet The wallet will be forced closed first.
Definition at line 153 of file kwallet.cc. References DCOPReply::get(), and DCOPReply::isValid(). |
|
Disconnect the application
Definition at line 195 of file kwallet.cc. References DCOPReply::get(), and DCOPReply::isValid(). |
|
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 163 of file kwallet.cc. References QWidget::close(), DCOPReply::get(), DCOPReply::isValid(), and DCOPObject::objId(). |
|
List the applications that are using the wallet
Definition at line 205 of file kwallet.cc. References DCOPReply::get(), and DCOPReply::isValid(). |
|
The name of the wallet used to store local passwords.
Definition at line 37 of file kwallet.cc. |
|
The name of the wallet used to store network passwords.
Definition at line 47 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 54 of file kwallet.cc. |
|
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 58 of file kwallet.cc. |
|
Request to the wallet service to change the password of the wallet
Definition at line 118 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 215 of file kwallet.cc. References DCOPRef::call(). |
|
This closes and locks the current wallet. It will disconnect all applications using the wallet.
Definition at line 225 of file kwallet.cc. References DCOPRef::call(), DCOPReply::get(), and DCOPReply::isValid(). |
|
The name of the current wallet.
Definition at line 243 of file kwallet.cc. |
|
Determine if the current wallet is open, and is a valid wallet handle.
Definition at line 248 of file kwallet.cc. |
|
Request to the wallet service to change the password of the current wallet.
Definition at line 253 of file kwallet.cc. References DCOPRef::send(). |
|
Obtain the list of all folders contained in the wallet.
Definition at line 272 of file kwallet.cc. References DCOPRef::call(), DCOPReply::get(), and DCOPReply::isValid(). |
|
Determine if the folder
Definition at line 304 of file kwallet.cc. References DCOPRef::call(), DCOPReply::get(), and DCOPReply::isValid(). Referenced by createFolder(), and setFolder(). |
|
Set the current working folder to The folder must exist, or this call will fail. Create a folder with createFolder().
Definition at line 338 of file kwallet.cc. References hasFolder(). Referenced by removeFolder(). |
|
Remove the folder
Definition at line 361 of file kwallet.cc. References DCOPRef::call(), DCOPReply::get(), DCOPReply::isValid(), and setFolder(). |
|
Created the folder
Definition at line 320 of file kwallet.cc. References DCOPRef::call(), DCOPReply::get(), hasFolder(), and DCOPReply::isValid(). |
|
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 381 of file kwallet.cc. |
|
Return the list of keys of all entries in this folder.
Definition at line 288 of file kwallet.cc. References DCOPRef::call(), DCOPReply::get(), and DCOPReply::isValid(). |
|
Rename the entry
Definition at line 403 of file kwallet.cc. References DCOPRef::call(), DCOPReply::get(), and DCOPReply::isValid(). |
|
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 386 of file kwallet.cc. References DCOPRef::call(), DCOPReply::get(), and DCOPReply::isValid(). |
|
Read the map entry
Definition at line 419 of file kwallet.cc. References DCOPRef::call(), DCOPReply::get(), and DCOPReply::isValid(). |
|
Read the password entry
Definition at line 441 of file kwallet.cc. References DCOPRef::call(), DCOPReply::get(), and DCOPReply::isValid(). |
|
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 458 of file kwallet.cc. References DCOPRef::call(), DCOPReply::get(), and DCOPReply::isValid(). |
|
Write
Definition at line 474 of file kwallet.cc. References DCOPRef::call(), DCOPReply::get(), and DCOPReply::isValid(). |
|
Write
Definition at line 490 of file kwallet.cc. References DCOPRef::call(), DCOPReply::get(), and DCOPReply::isValid(). |
|
Write
Definition at line 509 of file kwallet.cc. References DCOPRef::call(), DCOPReply::get(), and DCOPReply::isValid(). |
|
Determine if the current folder has they entry
Definition at line 525 of file kwallet.cc. References DCOPRef::call(), DCOPReply::get(), and DCOPReply::isValid(). |
|
Remove the entry
Definition at line 541 of file kwallet.cc. References DCOPRef::call(), DCOPReply::get(), and DCOPReply::isValid(). |
|
Determine the type of the entry
Definition at line 557 of file kwallet.cc. References DCOPRef::call(), DCOPReply::get(), and DCOPReply::isValid(). |
|
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 618 of file kwallet.cc. References DCOPReply::get(), and DCOPReply::isValid(). |
|
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 628 of file kwallet.cc. References DCOPReply::get(), and DCOPReply::isValid(). |
|
Emitted when this wallet is closed.
|
|
Emitted when a folder in this wallet is updated.
|
|
Emitted when the folder list is changed in this wallet.
|
|
Emitted when a folder in this wallet is removed.
|
|
Emitted when a wallet is opened in asynchronous mode.
|
The documentation for this class was generated from the following files: