Kopete::ManagedConnectionAccount Class Reference

#include <managedconnectionaccount.h>

Inheritance diagram for Kopete::ManagedConnectionAccount:

Public Slots
void	connectWithPassword (const QString &password)
Public Slots inherited from Kopete::PasswordedAccount
virtual void	connectWithPassword (const QString &password)=0
Public Slots inherited from Kopete::Account
virtual void	block (const QString &contactId)
virtual void	disconnect ()=0
void	editAccount (QWidget *parent=0L)
bool	resume ()
virtual void	setOnlineStatus (const Kopete::OnlineStatus &status, const Kopete::StatusMessage &reason=Kopete::StatusMessage(), const OnlineStatusOptions &options=None)=0
virtual void	setStatusMessage (const Kopete::StatusMessage &statusMessage)=0
bool	suspend (const Kopete::StatusMessage &reason=Kopete::StatusMessage())
virtual void	unblock (const QString &contactId)

Public Member Functions
	ManagedConnectionAccount (Protocol *parent, const QString &acctId)
Public Member Functions inherited from Kopete::PasswordedAccount
	PasswordedAccount (Protocol *parent, const QString &acctId, bool allowBlankPassword=false)
virtual	~PasswordedAccount ()
void	connect ()
void	connect (const OnlineStatus &initialStatus)
OnlineStatus	initialStatus ()
Password &	password ()
virtual bool	removeAccount ()
Public Member Functions inherited from Kopete::Account
	Account (Protocol *parent, const QString &accountID)
	~Account ()
QPixmap	accountIcon (const int size=0) const
QString	accountIconPath (const KIconLoader::Group size) const
QString	accountId () const
QString	accountLabel () const
MetaContact *	addContact (const QString &contactId, const QString &displayName=QString(), Group *group=0, AddMode mode=DontChangeKABC)
bool	addContact (const QString &contactId, MetaContact *parent, AddMode mode=DontChangeKABC)
BlackLister *	blackLister ()
const QColor	color () const
KConfigGroup *	configGroup () const
const QHash< QString, Contact * > &	contacts ()
QString	customIcon () const
bool	excludeConnect () const
virtual void	fillActionMenu (KActionMenu *actionMenu)
virtual bool	hasCustomStatusMenu () const
Identity *	identity () const
bool	isAway () const
virtual bool	isBlocked (const QString &contactId)
bool	isBusy () const
bool	isConnected () const
Contact *	myself () const
uint	priority () const
Protocol *	protocol () const
bool	registerContact (Contact *c)
void	setColor (const QColor &color)
void	setCustomIcon (const QString &)
void	setExcludeConnect (bool)
virtual bool	setIdentity (Kopete::Identity *ident)
void	setPriority (uint priority)
bool	suppressStatusNotification () const

Protected Slots
virtual void	slotConnectionStatusChanged (const QString &host, NetworkStatus::EnumStatus status)
Protected Slots inherited from Kopete::PasswordedAccount
virtual void	disconnected (Kopete::Account::DisconnectReason reason)
Protected Slots inherited from Kopete::Account
virtual void	disconnected (Kopete::Account::DisconnectReason reason)
void	networkingStatusChanged (const Solid::Networking::Status status)
void	setAllContactsStatus (const Kopete::OnlineStatus &status)

Protected Member Functions
virtual void	performConnectWithPassword (const QString &password)=0
Protected Member Functions inherited from Kopete::PasswordedAccount
virtual QString	passwordPrompt ()
Protected Member Functions inherited from Kopete::Account
virtual bool	createContact (const QString &contactId, MetaContact *parentContact)=0
void	setAccountLabel (const QString &label)
void	setMyself (Contact *myself)

Additional Inherited Members
Public Types inherited from Kopete::Account
enum	AddMode { ChangeKABC = 0, DontChangeKABC = 1, Temporary = 2 }
enum	DisconnectReason {   OtherClient = -4, BadPassword = -3, BadUserName = -2, InvalidHost = -1,   Manual = 0, ConnectionReset = 1, Unknown = 99 }
enum	OnlineStatusOption { None = 0x00, KeepSpecialFlags = 0x01 }
Signals inherited from Kopete::Account
void	accountDestroyed (const Kopete::Account *account)
void	colorChanged (const QColor &)
void	isConnectedChanged ()
Properties inherited from Kopete::Account
QPixmap	accountIcon
QString	accountId
QColor	color
bool	excludeConnect
bool	isAway
bool	isConnected
uint	priority
bool	suppressStatusNotification

Detailed Description

A ManagedConnectionAccount queries the NetworkStatus KDED Module before trying to connect using connectwithPassword, starting a network connection if needed.

If the network is not available, it delays calling performConnectWithPassword until it receives notification from the daemon that the network is up. The account receiveds notifications from the daemon of network failures and calls disconnect to set the account offline in a timely manner.

Definition at line 36 of file managedconnectionaccount.h.

Constructor & Destructor Documentation

Kopete::ManagedConnectionAccount::ManagedConnectionAccount	(	Protocol *	parent,
		const QString &	acctId
	)

ManagedConnectionAccount constructor.

Parameters

parent	The protocol this account connects via
acctId	The ID of this account - should be unique within this protocol
maxPasswordLength	The maximum length for passwords for this account, or 0 for no limit

Definition at line 27 of file managedconnectionaccount.cpp.

Member Function Documentation

void Kopete::ManagedConnectionAccount::connectWithPassword ( const QString &  password )

slot

Begin the connection process, by checking if the connection is available with the ConnectionManager.

This method is called by PasswordedAccount::connect()

Parameters

password

the password to connect with.

Definition at line 34 of file managedconnectionaccount.cpp.

virtual void Kopete::ManagedConnectionAccount::performConnectWithPassword ( const QString &  password )

protectedpure virtual

Connect to the server, once the network is available.

This method is called by the ManagedConnectionAccount once the network is available. In this method you should set up your network connection and connect to the server.

void Kopete::ManagedConnectionAccount::slotConnectionStatusChanged ( const QString &  host, NetworkStatus::EnumStatus  status  )

protectedvirtualslot

Handle a change in the network connection Called by the ConnectionManager when the network comes up or fails.

The default implementation calls performConnectWithPassword when the network goes online and connectWithPassword() was previously called, and calls disconnect() when the connection goes down.

Parameters

host	For future expansion.
status	the new status of the network

Definition at line 56 of file managedconnectionaccount.cpp.

---

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

• managedconnectionaccount.h
• managedconnectionaccount.cpp