KWallet::Wallet Class Reference

#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	folderListUpdated ()
void	folderRemoved (const QString &folder)
void	folderUpdated (const QString &folder)
void	walletClosed ()
void	walletOpened (bool success)

Public Member Functions
virtual	~Wallet ()
virtual bool	createFolder (const QString &f)
virtual const QString &	currentFolder () const
virtual QStringList	entryList ()
virtual EntryType	entryType (const QString &key)
virtual QStringList	folderList ()
virtual bool	hasEntry (const QString &key)
virtual bool	hasFolder (const QString &f)
virtual bool	isOpen () const
virtual int	lockWallet ()
virtual int	readEntry (const QString &key, QByteArray &value)
int	readEntryList (const QString &key, QMap< QString, QByteArray > &value)
virtual int	readMap (const QString &key, QMap< QString, QString > &value)
int	readMapList (const QString &key, QMap< QString, QMap< QString, QString > > &value)
virtual int	readPassword (const QString &key, QString &value)
int	readPasswordList (const QString &key, QMap< QString, QString > &value)
virtual int	removeEntry (const QString &key)
virtual bool	removeFolder (const QString &f)
virtual int	renameEntry (const QString &oldName, const QString &newName)
virtual void	requestChangePassword (WId w)
virtual bool	setFolder (const QString &f)
virtual int	sync ()
virtual const QString &	walletName () const
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)

Static Public Member Functions
static void	changePassword (const QString &name, WId w)
static int	closeWallet (const QString &name, bool force)
static int	deleteWallet (const QString &name)
static bool	disconnectApplication (const QString &wallet, const QString &app)
static bool	folderDoesNotExist (const QString &wallet, const QString &folder)
static const QString	FormDataFolder ()
static bool	isEnabled ()
static bool	isOpen (const QString &name)
static bool	isUsingKSecretsService ()
static bool	keyDoesNotExist (const QString &wallet, const QString &folder, const QString &key)
static const QString	LocalWallet ()
static const QString	NetworkWallet ()
static Wallet *	openWallet (const QString &name, WId w, OpenType ot=Synchronous)
static const QString	PasswordFolder ()
static QStringList	users (const QString &wallet)
static QStringList	walletList ()

Protected Member Functions
	Wallet (int handle, const QString &name)
	Wallet (const Wallet &)
virtual void	virtual_hook (int id, void *data)

Detailed Description

KDE Wallet.

This class implements a generic system-wide Wallet for KDE. This is the ONLY public interface.

Author

George Staikos staik.nosp@m.os@k.nosp@m.de.or.nosp@m.g KDE Wallet Class

Definition at line 62 of file kwallet.h.

Member Enumeration Documentation

enum KWallet::Wallet::EntryType

Enumerator
Unknown
Password
Stream
Map
Unused

Definition at line 80 of file kwallet.h.

enum KWallet::Wallet::OpenType

Enumerator
Synchronous
Asynchronous
Path
OpenTypeUnused

Definition at line 135 of file kwallet.h.

Constructor & Destructor Documentation

Wallet::Wallet ( int  handle, const QString &  name  )

protected

Construct a KWallet object.

Parameters

handle	The handle for the wallet.
name	The name of the wallet.

Definition at line 243 of file kwallet.cpp.

KWallet::Wallet::Wallet ( const Wallet &  )

protected

Copy a KWallet object.

Wallet::~Wallet ( )

virtual

Destroy a KWallet object.

Closes the wallet.

Definition at line 272 of file kwallet.cpp.

Member Function Documentation

void Wallet::changePassword ( const QString &  name, WId  w  )

static

Request to the wallet service to change the password of the wallet name.

Parameters

name	The the wallet to change the password of.
w	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.

Definition at line 328 of file kwallet.cpp.

int Wallet::closeWallet ( const QString &  name, bool  force  )

static

Close the wallet name.

The wallet will only be closed if it is open but not in use (rare), or if it is forced closed.

Parameters

name	The name of the wallet to close.
force	Set true to force the wallet closed even if it is in use by others.

Returns

Returns 0 on success, non-zero on error.

Definition at line 403 of file kwallet.cpp.

bool Wallet::createFolder ( const QString &  f )

virtual

Created the folder f.

Parameters

f	the name of the folder to create

Returns

Returns true if the folder was successfully created.

Definition at line 846 of file kwallet.cpp.

const QString & Wallet::currentFolder ( ) const

virtual

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.

Returns

Returns the current working folder.

Definition at line 965 of file kwallet.cpp.

int Wallet::deleteWallet ( const QString &  name )

static

Delete the wallet name.

The wallet will be forced closed first.

Parameters

name	The name of the wallet to delete.

Returns

Returns 0 on success, non-zero on error.

Definition at line 426 of file kwallet.cpp.

bool Wallet::disconnectApplication ( const QString &  wallet, const QString &  app  )

static

Disconnect the application app from wallet.

Parameters

wallet	The name of the wallet to disconnect.
app	The name of the application to disconnect.

Returns

Returns true on success, false on error.

Definition at line 557 of file kwallet.cpp.

QStringList Wallet::entryList ( )

virtual

Return the list of keys of all entries in this folder.

Returns

Returns an empty list if the wallet is not open, or if the folder is empty.

Definition at line 774 of file kwallet.cpp.

Wallet::EntryType Wallet::entryType ( const QString &  key )

virtual

Determine the type of the entry key in this folder.

Parameters

key	The key to look up.

Returns

Returns an enumerated type representing the type of the entry.

Definition at line 1468 of file kwallet.cpp.

bool Wallet::folderDoesNotExist ( const QString &  wallet, const QString &  folder  )

static

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.

Parameters

wallet	The wallet to look in.
folder	The folder to look up.

Returns

Returns true if the folder does NOT exist in the wallet, or the wallet does not exist.

Definition at line 1600 of file kwallet.cpp.

QStringList Wallet::folderList ( )

virtual

Obtain the list of all folders contained in the wallet.

Returns

Returns an empty list if the wallet is not open.

Definition at line 724 of file kwallet.cpp.

void KWallet::Wallet::folderListUpdated ( )

signal

Emitted when the folder list is changed in this wallet.

void KWallet::Wallet::folderRemoved ( const QString &  folder )

signal

Emitted when a folder in this wallet is removed.

Parameters

folder

The folder that was removed.

void KWallet::Wallet::folderUpdated ( const QString &  folder )

signal

Emitted when a folder in this wallet is updated.

Parameters

folder

The folder that was updated.

const QString Wallet::FormDataFolder ( )

static

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 142 of file kwallet.cpp.

bool Wallet::hasEntry ( const QString &  key )

virtual

Determine if the current folder has they entry key.

Parameters

key	The key to search for.

Returns

Returns true if the folder contains key.

Definition at line 1410 of file kwallet.cpp.

bool Wallet::hasFolder ( const QString &  f )

virtual

Determine if the folder f exists in the wallet.

Parameters

f	the name of the folder to check for

Returns

Returns true if the folder exists in the wallet.

Definition at line 817 of file kwallet.cpp.

bool Wallet::isEnabled ( )

static

Determine if the KDE wallet is enabled.

Normally you do not need to use this because openWallet() will just fail.

Returns

Returns true if the wallet enabled, else false.

Definition at line 352 of file kwallet.cpp.

bool Wallet::isOpen ( const QString &  name )

static

Determine if the wallet name is open by any application.

Parameters

name	The name of the wallet to check.

Returns

Returns true if the wallet is open, else false.

Definition at line 374 of file kwallet.cpp.

bool Wallet::isOpen ( ) const

virtual

Determine if the current wallet is open, and is a valid wallet handle.

Returns

Returns true if the wallet handle is valid and open.

Definition at line 663 of file kwallet.cpp.

bool KWallet::Wallet::isUsingKSecretsService ( )

static

Determine if the KWallet API is using the KSecretsService infrastructure This can ben changed in system settings.

Returns

Returns true if the KSecretsService infrastructure is active

Definition at line 104 of file kwallet.cpp.

bool Wallet::keyDoesNotExist ( const QString &  wallet, const QString &  folder, const QString &  key  )

static

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.

Parameters

wallet	The wallet to look in.
folder	The folder to look in.
key	The key to look up.

Returns

Returns true if the key does NOT exist in the wallet, or the folder or wallet does not exist.

Definition at line 1629 of file kwallet.cpp.

const QString Wallet::LocalWallet ( )

static

The name of the wallet used to store local passwords.

Definition at line 109 of file kwallet.cpp.

int Wallet::lockWallet ( )

virtual

This closes and locks the current wallet.

It will disconnect all applications using the wallet.

Returns

Returns 0 on success, non-zero on error.

Definition at line 621 of file kwallet.cpp.

const QString Wallet::NetworkWallet ( )

static

The name of the wallet used to store network passwords.

Definition at line 127 of file kwallet.cpp.

Wallet * Wallet::openWallet ( const QString &  name, WId  w, OpenType  ot = Synchronous  )

static

Open the wallet name.

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.

Parameters

name	The name of the wallet to open.
ot	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.
w	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.

Returns

Returns a pointer to the wallet if successful, or a null pointer on error or if rejected.

Definition at line 452 of file kwallet.cpp.

const QString Wallet::PasswordFolder ( )

static

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 138 of file kwallet.cpp.

int Wallet::readEntry ( const QString &  key, QByteArray &  value  )

virtual

Read the entry key 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.

Parameters

key	The key of the entry to read.
value	A buffer to fill with the value.

Returns

Returns 0 on success, non-zero on error.

Definition at line 1031 of file kwallet.cpp.

int Wallet::readEntryList	(	const QString &	key,
		QMap< QString, QByteArray > &	value
	)

Read the entries matching key 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.

Parameters

key	The key of the entry to read. Wildcards are supported.
value	A buffer to fill with the value. The key in the map is the entry key.

Returns

Returns 0 on success, non-zero on error.

Definition at line 1075 of file kwallet.cpp.

int Wallet::readMap ( const QString &  key, QMap< QString, QString > &  value  )

virtual

Read the map entry key from the current folder.

Parameters

key	The key of the entry to read.
value	A map buffer to fill with the value.

Returns

Returns 0 on success, non-zero on error. Will return an error if the key was not originally written as a map.

Definition at line 1143 of file kwallet.cpp.

int Wallet::readMapList	(	const QString &	key,
		QMap< QString, QMap< QString, QString > > &	value
	)

Read the map entry key from the current folder.

Parameters

key	The key of the entry to read. Wildcards are supported.
value	A buffer to fill with the value. The key in the map is the entry key.

Returns

Returns 0 on success, non-zero on error. Will return an error if the key was not originally written as a map.

Definition at line 1195 of file kwallet.cpp.

int Wallet::readPassword ( const QString &  key, QString &  value  )

virtual

Read the password entry key from the current folder.

Parameters

key	The key of the entry to read.
value	A password buffer to fill with the value.

Returns

Returns 0 on success, non-zero on error. Will return an error if the key was not originally written as a password.

Definition at line 1233 of file kwallet.cpp.

int Wallet::readPasswordList	(	const QString &	key,
		QMap< QString, QString > &	value
	)

Read the password entry key from the current folder.

Parameters

key	The key of the entry to read. Wildcards are supported.
value	A buffer to fill with the value. The key in the map is the entry key.

Returns

Returns 0 on success, non-zero on error. Will return an error if the key was not originally written as a password.

Definition at line 1274 of file kwallet.cpp.

int Wallet::removeEntry ( const QString &  key )

virtual

Remove the entry key from the current folder.

Parameters

key	The key to remove.

Returns

Returns 0 on success, non-zero on error.

Definition at line 1436 of file kwallet.cpp.

bool Wallet::removeFolder ( const QString &  f )

virtual

Remove the folder f and all its entries from the wallet.

Parameters

f	the name of the folder to remove

Returns

Returns true if the folder was successfully removed.

Definition at line 914 of file kwallet.cpp.

int Wallet::renameEntry ( const QString &  oldName, const QString &  newName  )

virtual

Rename the entry oldName to newName.

Parameters

oldName	The original key of the entry.
newName	The new key of the entry.

Returns

Returns 0 on success, non-zero on error.

Definition at line 1108 of file kwallet.cpp.

void Wallet::requestChangePassword ( WId  w )

virtual

Request to the wallet service to change the password of the current wallet.

Parameters

w	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.

Definition at line 677 of file kwallet.cpp.

bool Wallet::setFolder ( const QString &  f )

virtual

Set the current working folder to f.

The folder must exist, or this call will fail. Create a folder with createFolder().

Parameters

f	the name of the folder to make the working folder

Returns

Returns true if the folder was successfully set.

Definition at line 879 of file kwallet.cpp.

int Wallet::sync ( )

virtual

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.

Returns

Returns 0 on success, non-zero on error.

Definition at line 602 of file kwallet.cpp.

QStringList Wallet::users ( const QString &  wallet )

static

List the applications that are using the wallet wallet.

Parameters

wallet

The wallet to query.

Returns

Returns a list of all DCOP application IDs using the wallet.

Definition at line 580 of file kwallet.cpp.

void Wallet::virtual_hook ( int  id, void *  data  )

protectedvirtual

Definition at line 1655 of file kwallet.cpp.

void KWallet::Wallet::walletClosed ( )

signal

Emitted when this wallet is closed.

QStringList Wallet::walletList ( )

static

List all the wallets available.

Returns

Returns a list of the names of all wallets that are open.

Definition at line 299 of file kwallet.cpp.

const QString & Wallet::walletName ( ) const

virtual

The name of the current wallet.

Definition at line 658 of file kwallet.cpp.

void KWallet::Wallet::walletOpened ( bool  success )

signal

Emitted when a wallet is opened in asynchronous mode.

Parameters

success

True if the wallet was opened successfully.

int Wallet::writeEntry ( const QString &  key, const QByteArray &  value, EntryType  entryType  )

virtual

Write key = value as a binary entry to the current folder.

Be careful with this, it could cause inconsistency in the future since you can put an arbitrary entry type in place.

Parameters

key	The key of the new entry.
value	The value of the entry.
entryType	The type of the entry.

Returns

Returns 0 on success, non-zero on error.

Definition at line 1305 of file kwallet.cpp.

int Wallet::writeEntry ( const QString &  key, const QByteArray &  value  )

virtual

Write key = value as a binary entry to the current folder.

Parameters

key	The key of the new entry.
value	The value of the entry.

Returns

Returns 0 on success, non-zero on error.

Definition at line 1330 of file kwallet.cpp.

int Wallet::writeMap ( const QString &  key, const QMap< QString, QString > &  value  )

virtual

Write key = value as a map to the current folder.

Parameters

key	The key of the new entry.
value	The value of the map.

Returns

Returns 0 on success, non-zero on error.

Definition at line 1355 of file kwallet.cpp.

int Wallet::writePassword ( const QString &  key, const QString &  value  )

virtual

Write key = value as a password to the current folder.

Parameters

key	The key of the new entry.
value	The value of the password.

Returns

Returns 0 on success, non-zero on error.

Definition at line 1385 of file kwallet.cpp.

---

The documentation for this class was generated from the following files:

• kwallet.h
• kwallet.cpp
• kwallet_mac.cpp