Kopete::IdentityManager Class Reference

#include <kopeteidentitymanager.h>

Inheritance diagram for Kopete::IdentityManager:

Public Slots
void	load ()
void	save ()
void	setOnlineStatus (uint category, const Kopete::StatusMessage &statusMessage=Kopete::StatusMessage(), uint flags=0)

Signals
void	defaultIdentityChanged (Kopete::Identity *identity)
void	identityOnlineStatusChanged (Kopete::Identity *identity)
void	identityRegistered (Kopete::Identity *identity)
void	identityUnregistered (const Kopete::Identity *identity)

Public Member Functions
	~IdentityManager ()
Identity *	defaultIdentity ()
Identity *	findIdentity (const QString &identityId)
const Identity::List &	identities () const
Identity *	registerIdentity (Identity *identity)
void	removeIdentity (Identity *identity)
void	setDefaultIdentity (Identity *ident)

Static Public Member Functions
static IdentityManager *	self ()

Detailed Description

IdentityManager manages all defined identities in Kopete.

You can query them and globally set them all online or offline from here.

IdentityManager is a singleton, you may uses it with IdentityManager::self()

Author

Gustavo Pichorim Boiko <gustavo.boiko@kdemail.net>

Definition at line 39 of file kopeteidentitymanager.h.

Constructor & Destructor Documentation

Kopete::IdentityManager::~IdentityManager

(

)

Definition at line 62 of file kopeteidentitymanager.cpp.

Member Function Documentation

Identity * Kopete::IdentityManager::defaultIdentity

(

)

Returs the default identity to be used.

This is the default identity configured in kopete. If no identity was created yet, this function will create a new identity, set it as the default identity and return it. If there are identities already created, but none of them was set as the default, it will return the first identity of the list.

Returns

the default identity

Definition at line 130 of file kopeteidentitymanager.cpp.

void Kopete::IdentityManager::defaultIdentityChanged ( Kopete::Identity *  identity )

signal

Signals when the default identity has changed.

Identity * Kopete::IdentityManager::findIdentity

(

const QString &

identityId

)

Return the identity asked.

Parameters

identityId

is the ID for the identity

Returns

the Identity object found or NULL if no identity was found

Definition at line 120 of file kopeteidentitymanager.cpp.

const Identity::List & Kopete::IdentityManager::identities

(

)

const

Retrieve the list of identities.

Returns

a list of all the identities

Definition at line 115 of file kopeteidentitymanager.cpp.

void Kopete::IdentityManager::identityOnlineStatusChanged ( Kopete::Identity *  identity )

signal

void Kopete::IdentityManager::identityRegistered ( Kopete::Identity *  identity )

signal

Signals when an identity is ready for use.

void Kopete::IdentityManager::identityUnregistered ( const Kopete::Identity *  identity )

signal

Signals when an identity has been unregistered.

At this state, we are already in the Identity destructor.

void Kopete::IdentityManager::load ( )

slot

Load the identity data from KConfig

Definition at line 214 of file kopeteidentitymanager.cpp.

Identity * Kopete::IdentityManager::registerIdentity

(

Identity *

identity

)

Register the identity.

This adds the identity in the manager's identity list. It will check no identities already exist with the same ID, if any, the identity is deleted. and not added

Returns

identity, or 0L if the identity was deleted because id collision

Definition at line 79 of file kopeteidentitymanager.cpp.

void Kopete::IdentityManager::removeIdentity

(

Identity *

identity

)

Delete the identity and clean the config data.

This will mostly be called when no account is assigned to an identity

Definition at line 179 of file kopeteidentitymanager.cpp.

void Kopete::IdentityManager::save ( )

slot

Save the identity data to KConfig

Definition at line 195 of file kopeteidentitymanager.cpp.

IdentityManager * Kopete::IdentityManager::self ( )

static

Retrieve the instance of IdentityManager.

The identity manager is a singleton class of which only a single instance will exist. If no manager exists yet this function will create one for you.

Returns

the instance of the IdentityManager

Definition at line 46 of file kopeteidentitymanager.cpp.

void Kopete::IdentityManager::setDefaultIdentity

(

Identity *

ident

)

Sets a new default identity.

By changing the default identity, you do NOT change the accounts' identity association. They are kept as if nothing has changed

Definition at line 162 of file kopeteidentitymanager.cpp.

void Kopete::IdentityManager::setOnlineStatus ( uint  category, const Kopete::StatusMessage &  statusMessage = Kopete::StatusMessage(), uint  flags = 0  )

slot

Set all identities a status in the specified category.

Parameters

category	is one of the Kopete::OnlineStatusManager::Categories
statusMessage	is the new status message
flags	is a bitmask of SetOnlineStatusFlag

Definition at line 69 of file kopeteidentitymanager.cpp.

---

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

• kopeteidentitymanager.h
• kopeteidentitymanager.cpp