Kopete::PasswordedAccount Class Reference

#include <kopetepasswordedaccount.h>

Inheritance diagram for Kopete::PasswordedAccount:

Public Slots
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
	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	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 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

An account requiring a password to connect.

Instead of reimplementing connect() in your subclass, reimplement connectWithPassword.

Author

Richard Smith kde@m.nosp@m.etaf.nosp@m.oo.co.nosp@m..uk

Definition at line 36 of file kopetepasswordedaccount.h.

Constructor & Destructor Documentation

Kopete::PasswordedAccount::PasswordedAccount	(	Kopete::Protocol *	parent,
		const QString &	acctId,
		bool	allowBlankPassword = false
	)

KopetePasswordedAccount 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
allowBlankPassword	If this protocol allows blank passwords. Note that this will mean that
name	The name for this QObject

Definition at line 34 of file kopetepasswordedaccount.cpp.

Kopete::PasswordedAccount::~PasswordedAccount ( )

virtual

Definition at line 39 of file kopetepasswordedaccount.cpp.

Member Function Documentation

void Kopete::PasswordedAccount::connect

(

)

Definition at line 49 of file kopetepasswordedaccount.cpp.

void Kopete::PasswordedAccount::connect ( const OnlineStatus &  initialStatus )

virtual

Go online for this service.

Parameters

initialStatus

is the status to connect with. If it is an invalid status for this account, the default online for the account should be used.

Implements Kopete::Account.

Definition at line 55 of file kopetepasswordedaccount.cpp.

virtual void Kopete::PasswordedAccount::connectWithPassword ( const QString &  password )

pure virtualslot

Called when your account should attempt to connect.

Parameters

password

The password to connect with, or QString() if the user wished to cancel the connection attempt.

void Kopete::PasswordedAccount::disconnected ( Kopete::Account::DisconnectReason  reason )

protectedvirtualslot

Reimplemented to set the password wrong if the reason is BadPassword

Definition at line 91 of file kopetepasswordedaccount.cpp.

Kopete::OnlineStatus Kopete::PasswordedAccount::initialStatus

(

)

Get the initial status.

Definition at line 80 of file kopetepasswordedaccount.cpp.

Kopete::Password & Kopete::PasswordedAccount::password

(

)

Returns a reference to the password object stored in this account.

Definition at line 44 of file kopetepasswordedaccount.cpp.

QString Kopete::PasswordedAccount::passwordPrompt ( )

protectedvirtual

Returns the prompt shown to the user when requesting their password.

The default implementation should be adequate in most cases; override if you have a custom message to show the user.

Definition at line 72 of file kopetepasswordedaccount.cpp.

bool Kopete::PasswordedAccount::removeAccount ( )

virtual

Remove the account from the server.

Reimplementation of Account::removeAccount() to remove the password from the wallet. if your protocol reimplements this function, this function should still be called.

Returns

Always true

Reimplemented from Kopete::Account.

Definition at line 85 of file kopetepasswordedaccount.cpp.

---

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

• kopetepasswordedaccount.h
• kopetepasswordedaccount.cpp