• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kwallet
 

kwallet

  • KWallet
  • Wallet
Public Types | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions
KWallet::Wallet Class Reference

#include <kwallet.h>

Inheritance diagram for KWallet::Wallet:
DCOPObject

List of all members.

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 TQString &folder)
void folderListUpdated ()
void folderRemoved (const TQString &folder)
void walletOpened (bool success)

Public Member Functions

virtual ~Wallet ()
virtual int sync ()
virtual int lockWallet ()
virtual const TQString & walletName () const
virtual bool isOpen () const
virtual void requestChangePassword (WId w=0)
virtual TQStringList folderList ()
virtual bool hasFolder (const TQString &f)
virtual bool setFolder (const TQString &f)
virtual bool removeFolder (const TQString &f)
virtual bool createFolder (const TQString &f)
virtual const TQString & currentFolder () const
virtual TQStringList entryList ()
virtual int renameEntry (const TQString &oldName, const TQString &newName)
virtual int readEntry (const TQString &key, TQByteArray &value)
virtual int readMap (const TQString &key, TQMap< TQString, TQString > &value)
virtual int readPassword (const TQString &key, TQString &value)
int readEntryList (const TQString &key, TQMap< TQString, TQByteArray > &value)
int readMapList (const TQString &key, TQMap< TQString, TQMap< TQString, TQString > > &value)
int readPasswordList (const TQString &key, TQMap< TQString, TQString > &value)
virtual int writeEntry (const TQString &key, const TQByteArray &value, EntryType entryType)
virtual int writeEntry (const TQString &key, const TQByteArray &value)
virtual int writeMap (const TQString &key, const TQMap< TQString, TQString > &value)
virtual int writePassword (const TQString &key, const TQString &value)
virtual bool hasEntry (const TQString &key)
virtual int removeEntry (const TQString &key)
virtual EntryType entryType (const TQString &key)

Static Public Member Functions

static TQStringList walletList ()
static bool isEnabled ()
static bool isOpen (const TQString &name)
static int closeWallet (const TQString &name, bool force)
static int deleteWallet (const TQString &name)
static bool disconnectApplication (const TQString &wallet, const TQCString &app)
static Wallet * openWallet (const TQString &name, WId w=0, OpenType ot=Synchronous)
static TQStringList users (const TQString &wallet)
static const TQString LocalWallet ()
static const TQString NetworkWallet ()
static const TQString PasswordFolder ()
static const TQString FormDataFolder ()
static void changePassword (const TQString &name, WId w=0)
static bool folderDoesNotExist (const TQString &wallet, const TQString &folder)
static bool keyDoesNotExist (const TQString &wallet, const TQString &folder, const TQString &key)

Protected Member Functions

 Wallet (int handle, const TQString &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. The DCOP client is unsupported and considered to be private.

Author:
George Staikos <staikos@kde.org> KDE Wallet Class

Definition at line 53 of file kwallet.h.


Constructor & Destructor Documentation

Wallet::Wallet ( int  handle,
const TQString &  name 
) [protected]

Construct a KWallet object.

Definition at line 75 of file kwallet.cc.

KWallet::Wallet::Wallet ( const Wallet &  ) [protected]

Copy a KWallet object.

Wallet::~Wallet ( ) [virtual]

Destroy a KWallet object.

Closes the wallet.

Definition at line 106 of file kwallet.cc.


Member Function Documentation

void Wallet::changePassword ( const TQString &  name,
WId  w = 0 
) [static]

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

Parameters:
nameThe the wallet to change the password of.
wThe window id to associate any dialogs with.

Definition at line 129 of file kwallet.cc.

int Wallet::closeWallet ( const TQString &  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:
nameThe name of the wallet to close.
forceSet 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 154 of file kwallet.cc.

bool Wallet::createFolder ( const TQString &  f) [virtual]

Created the folder f.

Parameters:
fthe name of the folder to create
Returns:
Returns true if the folder was successfully created.

Definition at line 331 of file kwallet.cc.

const TQString & 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 392 of file kwallet.cc.

int Wallet::deleteWallet ( const TQString &  name) [static]

Delete the wallet name.

The wallet will be forced closed first.

Parameters:
nameThe name of the wallet to delete.
Returns:
Returns 0 on success, non-zero on error.

Definition at line 164 of file kwallet.cc.

bool Wallet::disconnectApplication ( const TQString &  wallet,
const TQCString &  app 
) [static]

Disconnect the application app from wallet.

Parameters:
walletThe name of the wallet to disconnect.
appThe name of the application to disconnect.
Returns:
Returns true on success, false on error.

Definition at line 206 of file kwallet.cc.

TQStringList 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 299 of file kwallet.cc.

Wallet::EntryType Wallet::entryType ( const TQString &  key) [virtual]

Determine the type of the entry key in this folder.

Parameters:
keyThe key to look up.
Returns:
Returns an enumerated type representing the type of the entry.

Definition at line 628 of file kwallet.cc.

bool Wallet::folderDoesNotExist ( const TQString &  wallet,
const TQString &  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:
walletThe wallet to look in.
folderThe 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 689 of file kwallet.cc.

TQStringList 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 283 of file kwallet.cc.

void KWallet::Wallet::folderListUpdated ( ) [signal]

Emitted when the folder list is changed in this wallet.

void KWallet::Wallet::folderRemoved ( const TQString &  folder) [signal]

Emitted when a folder in this wallet is removed.

Parameters:
folderThe folder that was removed.
void KWallet::Wallet::folderUpdated ( const TQString &  folder) [signal]

Emitted when a folder in this wallet is updated.

Parameters:
folderThe folder that was updated.
const TQString 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 69 of file kwallet.cc.

bool Wallet::hasEntry ( const TQString &  key) [virtual]

Determine if the current folder has they entry key.

Parameters:
keyThe key to search for.
Returns:
Returns true if the folder contains key.

Definition at line 596 of file kwallet.cc.

bool Wallet::hasFolder ( const TQString &  f) [virtual]

Determine if the folder f exists in the wallet.

Parameters:
fthe name of the folder to check for
Returns:
Returns true if the folder exists in the wallet.

Definition at line 315 of file kwallet.cc.

bool Wallet::isEnabled ( ) [static]

Determine if the KDE wallet is enabled.

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

Returns:
Returns true if the wallet enabled, else false.

Definition at line 134 of file kwallet.cc.

bool Wallet::isOpen ( const TQString &  name) [static]

Determine if the wallet name is open by any application.

Parameters:
nameThe name of the wallet to check.
Returns:
Returns true if the wallet is open, else false.

Definition at line 144 of file kwallet.cc.

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 259 of file kwallet.cc.

bool Wallet::keyDoesNotExist ( const TQString &  wallet,
const TQString &  folder,
const TQString &  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:
walletThe wallet to look in.
folderThe folder to look in.
keyThe 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 699 of file kwallet.cc.

const TQString Wallet::LocalWallet ( ) [static]

The name of the wallet used to store local passwords.

Definition at line 36 of file kwallet.cc.

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 236 of file kwallet.cc.

const TQString Wallet::NetworkWallet ( ) [static]

The name of the wallet used to store network passwords.

Definition at line 54 of file kwallet.cc.

Wallet * Wallet::openWallet ( const TQString &  name,
WId  w = 0,
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:
nameThe name of the wallet to open.
otIf 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.
wThe window id to associate any dialogs with.
Returns:
Returns a pointer to the wallet if successful, or a null pointer on error or if rejected.

Definition at line 174 of file kwallet.cc.

const TQString 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 65 of file kwallet.cc.

int Wallet::readEntry ( const TQString &  key,
TQByteArray &  value 
) [virtual]

Read the entry key from the current folder.

The entry format is unknown except that it is either a TQByteArray or a TQDataStream, which effectively means that it is anything.

Parameters:
keyThe key of the entry to read.
valueA buffer to fill with the value.
Returns:
Returns 0 on success, non-zero on error.

Definition at line 397 of file kwallet.cc.

int Wallet::readEntryList ( const TQString &  key,
TQMap< TQString, TQByteArray > &  value 
)

Read the entries matching key from the current folder.

The entry format is unknown except that it is either a TQByteArray or a TQDataStream, which effectively means that it is anything.

Parameters:
keyThe key of the entry to read. Wildcards are supported.
valueA buffer to fill with the value. The key in the map is the entry key.
Returns:
Returns 0 on success, non-zero on error.
Since:
3.4

Definition at line 414 of file kwallet.cc.

int Wallet::readMap ( const TQString &  key,
TQMap< TQString, TQString > &  value 
) [virtual]

Read the map entry key from the current folder.

Parameters:
keyThe key of the entry to read.
valueA 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 447 of file kwallet.cc.

int Wallet::readMapList ( const TQString &  key,
TQMap< TQString, TQMap< TQString, TQString > > &  value 
)

Read the map entry key from the current folder.

Parameters:
keyThe key of the entry to read. Wildcards are supported.
valueA 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.
Since:
3.4

Definition at line 469 of file kwallet.cc.

int Wallet::readPassword ( const TQString &  key,
TQString &  value 
) [virtual]

Read the password entry key from the current folder.

Parameters:
keyThe key of the entry to read.
valueA 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 495 of file kwallet.cc.

int Wallet::readPasswordList ( const TQString &  key,
TQMap< TQString, TQString > &  value 
)

Read the password entry key from the current folder.

Parameters:
keyThe key of the entry to read. Wildcards are supported.
valueA 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.
Since:
3.4

Definition at line 512 of file kwallet.cc.

int Wallet::removeEntry ( const TQString &  key) [virtual]

Remove the entry key from the current folder.

Parameters:
keyThe key to remove.
Returns:
Returns 0 on success, non-zero on error.

Definition at line 612 of file kwallet.cc.

bool Wallet::removeFolder ( const TQString &  f) [virtual]

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

Parameters:
fthe name of the folder to remove
Returns:
Returns true if the folder was successfully removed.

Definition at line 372 of file kwallet.cc.

int Wallet::renameEntry ( const TQString &  oldName,
const TQString &  newName 
) [virtual]

Rename the entry oldName to newName.

Parameters:
oldNameThe original key of the entry.
newNameThe new key of the entry.
Returns:
Returns 0 on success, non-zero on error.

Definition at line 431 of file kwallet.cc.

void Wallet::requestChangePassword ( WId  w = 0) [virtual]

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

Parameters:
wThe window id to associate any dialogs with.

Definition at line 264 of file kwallet.cc.

bool Wallet::setFolder ( const TQString &  f) [virtual]

Set the current working folder to f.

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

Parameters:
fthe name of the folder to make the working folder
Returns:
Returns true if the folder was successfully set.

Definition at line 349 of file kwallet.cc.

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 226 of file kwallet.cc.

TQStringList Wallet::users ( const TQString &  wallet) [static]

List the applications that are using the wallet wallet.

Parameters:
walletThe wallet to query.
Returns:
Returns a list of all DCOP application IDs using the wallet.

Definition at line 216 of file kwallet.cc.

void KWallet::Wallet::walletClosed ( ) [signal]

Emitted when this wallet is closed.

TQStringList Wallet::walletList ( ) [static]

List all the wallets available.

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

Definition at line 119 of file kwallet.cc.

const TQString & Wallet::walletName ( ) const [virtual]

The name of the current wallet.

Definition at line 254 of file kwallet.cc.

void KWallet::Wallet::walletOpened ( bool  success) [signal]

Emitted when a wallet is opened in asynchronous mode.

Parameters:
successTrue if the wallet was opened successfully.
int Wallet::writeEntry ( const TQString &  key,
const TQByteArray &  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:
keyThe key of the new entry.
valueThe value of the entry.
entryTypeThe type of the entry.
Returns:
Returns 0 on success, non-zero on error.

Definition at line 529 of file kwallet.cc.

int Wallet::writeEntry ( const TQString &  key,
const TQByteArray &  value 
) [virtual]

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

Parameters:
keyThe key of the new entry.
valueThe value of the entry.
Returns:
Returns 0 on success, non-zero on error.

Definition at line 545 of file kwallet.cc.

int Wallet::writeMap ( const TQString &  key,
const TQMap< TQString, TQString > &  value 
) [virtual]

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

Parameters:
keyThe key of the new entry.
valueThe value of the map.
Returns:
Returns 0 on success, non-zero on error.

Definition at line 561 of file kwallet.cc.

int Wallet::writePassword ( const TQString &  key,
const TQString &  value 
) [virtual]

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

Parameters:
keyThe key of the new entry.
valueThe value of the password.
Returns:
Returns 0 on success, non-zero on error.

Definition at line 580 of file kwallet.cc.


The documentation for this class was generated from the following files:
  • kwallet.h
  • kwallet.cc

kwallet

Skip menu "kwallet"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Class Members

kwallet

Skip menu "kwallet"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for kwallet by doxygen 1.7.6.1
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |