kpimidentities
KPIMIdentities::IdentityManager Class Reference
#include <identitymanager.h>
Inherits QObject.
Detailed Description
Manages the list of identities.
Definition at line 39 of file identitymanager.h.
Public Types | |
typedef QList< Identity >::Iterator | Iterator |
typedef QList< Identity > ::ConstIterator | ConstIterator |
typedef Iterator | iterator |
typedef ConstIterator | const_iterator |
Signals | |
void | changed () |
void | changed (uint uoid) |
void | changed (const KPIMIdentities::Identity &ident) |
void | deleted (uint uoid) |
void | added (const KPIMIdentities::Identity &ident) |
void | identitiesChanged (const QString &id) |
Public Member Functions | |
IdentityManager (bool readonly=false, QObject *parent=0, const char *name=0) | |
void | commit () |
void | rollback () |
bool | hasPendingChanges () const |
QStringList | identities () const |
QStringList | shadowIdentities () const |
void | sort () |
const Identity & | identityForAddress (const QString &addresses) const |
bool | thatIsMe (const QString &addressList) const |
const Identity & | identityForUoid (uint uoid) const |
const Identity & | identityForUoidOrDefault (uint uoid) const |
const Identity & | defaultIdentity () const |
bool | setAsDefault (uint uoid) |
Identity & | modifyIdentityForName (const QString &identityName) |
Identity & | modifyIdentityForUoid (uint uoid) |
bool | removeIdentity (const QString &identityName) |
ConstIterator | begin () const |
ConstIterator | end () const |
Iterator | modifyBegin () |
Iterator | modifyEnd () |
Identity & | newFromScratch (const QString &name) |
Identity & | newFromControlCenter (const QString &name) |
Identity & | newFromExisting (const Identity &other, const QString &name=QString()) |
QStringList | allEmails () const |
Protected Slots | |
void | slotRollback () |
Protected Member Functions | |
virtual void | createDefaultIdentity (QString &, QString &) |
Protected Attributes | |
QList< Identity > | mIdentities |
QList< Identity > | mShadowIdentities |
Member Typedef Documentation
typedef Iterator KPIMIdentities::IdentityManager::iterator |
typedef ConstIterator KPIMIdentities::IdentityManager::const_iterator |
Constructor & Destructor Documentation
IdentityManager::IdentityManager | ( | bool | readonly = false , |
|
QObject * | parent = 0 , |
|||
const char * | name = 0 | |||
) | [explicit] |
Create an identity manager, which loads the emailidentities file to create identities.
- Parameters:
-
readonly if true, no changes can be made to the identity manager This means in particular that if there is no identity configured, the default identity created here will not be saved. It is assumed that a minimum of one identity is always present.
Definition at line 57 of file identitymanager.cpp.
Member Function Documentation
void IdentityManager::commit | ( | ) |
Commit changes to disk and emit changed() if necessary.
Definition at line 100 of file identitymanager.cpp.
void IdentityManager::rollback | ( | ) |
Re-read the config from disk and forget changes.
Definition at line 158 of file identitymanager.cpp.
bool IdentityManager::hasPendingChanges | ( | ) | const |
QStringList IdentityManager::identities | ( | ) | const |
QStringList IdentityManager::shadowIdentities | ( | ) | const |
Convenience method.
- Returns:
- the list of (shadow) identities, ie. the ones currently under configuration.
Definition at line 177 of file identitymanager.cpp.
void IdentityManager::sort | ( | ) |
Sort the identities by name (the default is always first).
This operates on the shadow list, so you need to commit for the changes to take effect.
Definition at line 186 of file identitymanager.cpp.
const Identity & IdentityManager::identityForAddress | ( | const QString & | addresses | ) | const |
- Returns:
- an identity whose address matches any in
addresses
or Identity::null if no such identity exists.
Definition at line 297 of file identitymanager.cpp.
bool IdentityManager::thatIsMe | ( | const QString & | addressList | ) | const |
- Returns:
- true if
addressList
contains any of our addresses, false otherwise.
- See also:
- identityForAddress
Definition at line 312 of file identitymanager.cpp.
const Identity & IdentityManager::identityForUoid | ( | uint | uoid | ) | const |
- Returns:
- the identity with Unique Object Identifier (UOID)
uoid
or Identity::null if not found.
Definition at line 277 of file identitymanager.cpp.
const Identity & IdentityManager::identityForUoidOrDefault | ( | uint | uoid | ) | const |
Convenience menthod.
- Returns:
- the identity with Unique Object Identifier (UOID)
uoid
or the default identity if not found.
Definition at line 287 of file identitymanager.cpp.
const Identity & IdentityManager::defaultIdentity | ( | ) | const |
bool IdentityManager::setAsDefault | ( | uint | uoid | ) |
Sets the identity with Unique Object Identifier (UOID) uoid
to be new the default identity.
As usual, use commit to make this permanent.
- Returns:
- false if an identity with UOID
uoid
was not found
Definition at line 360 of file identitymanager.cpp.
Identity & IdentityManager::modifyIdentityForName | ( | const QString & | identityName | ) |
- Returns:
- the identity named
identityName
. This method returns a reference to the identity that can be modified. To let others see this change, use commit.
Definition at line 317 of file identitymanager.cpp.
Identity & IdentityManager::modifyIdentityForUoid | ( | uint | uoid | ) |
- Returns:
- the identity with Unique Object Identifier (UOID)
uoid
. This method returns a reference to the identity that can be modified. To let others see this change, use commit.
Definition at line 331 of file identitymanager.cpp.
bool IdentityManager::removeIdentity | ( | const QString & | identityName | ) |
Removes the identity with name identityName
Will return false if the identity is not found, or when one tries to remove the last identity.
Definition at line 385 of file identitymanager.cpp.
IdentityManager::Iterator IdentityManager::modifyBegin | ( | ) |
Iterator used by the configuration dialog, which works on a separate list of identities, for modification.
Changes are made effective by commit().
Definition at line 267 of file identitymanager.cpp.
QStringList KPIMIdentities::IdentityManager::allEmails | ( | ) | const |
Returns the list of all email addresses (only name) from all identities.
Definition at line 512 of file identitymanager.cpp.
void KPIMIdentities::IdentityManager::changed | ( | ) | [signal] |
Emitted whenever a commit changes any configure option.
void KPIMIdentities::IdentityManager::changed | ( | uint | uoid | ) | [signal] |
Emitted whenever the identity with Unique Object Identifier (UOID) uoid
changed.
Useful for more fine-grained change notifications than what is possible with the standard changed() signal.
void KPIMIdentities::IdentityManager::changed | ( | const KPIMIdentities::Identity & | ident | ) | [signal] |
Emitted whenever the identity ident
changed.
Useful for more fine-grained change notifications than what is possible with the standard changed() signal.
void KPIMIdentities::IdentityManager::deleted | ( | uint | uoid | ) | [signal] |
Emitted on commit() for each deleted identity.
At the time this signal is emitted, the identity does still exist and can be retrieved by identityForUoid() if needed
void KPIMIdentities::IdentityManager::added | ( | const KPIMIdentities::Identity & | ident | ) | [signal] |
Emitted on commit() for each new identity.
virtual void KPIMIdentities::IdentityManager::createDefaultIdentity | ( | QString & | , | |
QString & | ||||
) | [inline, protected, virtual] |
This is called when no identity has been defined, so we need to create a default one.
The parameters are filled with some default values from KUser, but reimplementations of this method can give them another value.
Definition at line 187 of file identitymanager.h.
Member Data Documentation
QList<Identity> KPIMIdentities::IdentityManager::mIdentities [protected] |
QList<Identity> KPIMIdentities::IdentityManager::mShadowIdentities [protected] |
The documentation for this class was generated from the following files: