LeechCraft Azoth  %{LEECHCRAFT_VERSION}
Modular multiprotocol IM plugin for LeechCraft
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator
LeechCraft::Azoth::IExtSelfInfoAccount Class Referenceabstract

Interface for accounts with extended self information. More...

#include "iextselfinfoaccount.h"

Public Member Functions

virtual ~IExtSelfInfoAccount ()
 
virtual QObject * GetSelfContact () const =0
 Returns the self-contact of this account. More...
 
virtual QImage GetSelfAvatar () const =0
 Returns the avatar of this account. More...
 
virtual QIcon GetAccountIcon () const =0
 Returns the icon of this account. More...
 

Detailed Description

Interface for accounts with extended self information.

Implementing this interface allows other parts of Azoth to know such information as the avatar of this account, or which contact represents self-contact, if any.

See Also
IAccount

Definition at line 46 of file iextselfinfoaccount.h.

Constructor & Destructor Documentation

virtual LeechCraft::Azoth::IExtSelfInfoAccount::~IExtSelfInfoAccount ( )
inlinevirtual

Definition at line 49 of file iextselfinfoaccount.h.

Member Function Documentation

virtual QIcon LeechCraft::Azoth::IExtSelfInfoAccount::GetAccountIcon ( ) const
pure virtual

Returns the icon of this account.

The returned icon is used to distinguish this account from other accounts of the same protocol. For example, an XMPP account on GMail may choose to return a GMail-y icon.

Returning a null icon means that general protocol icon will be used.

Returns
The icon of this account.
virtual QImage LeechCraft::Azoth::IExtSelfInfoAccount::GetSelfAvatar ( ) const
pure virtual

Returns the avatar of this account.

The returned avatar is typically used to represent the user of the account in contact list or in chat windows.

Returns
The avatar of this account.
virtual QObject* LeechCraft::Azoth::IExtSelfInfoAccount::GetSelfContact ( ) const
pure virtual

Returns the self-contact of this account.

Self-contact represents the user of this account in the contact list. If there is no concept of self-contact in the given protocol, this function may return 0.

Self-contact should also be returned from all the "standard" functions like IAccount::GetCLEntries() and such. Generally, it should be a normal ICLEntry-derived object.

Returns
ICLEntry-derived object representing self contact.

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