kopete/libkopete

Kopete::Protocol

Kopete::Protocol Class Reference

#include <kopeteprotocol.h>

Inheritance diagram for Kopete::Protocol:

[legend]

List of all members.

Detailed Description

base class of every protocol.

A protocol is just a particular case of Plugin

Protocol is an abstract class, you need to reimplement createNewAccount, createAddContactPage, createEditAccountWidget

Author:

Duncan Mac-Vicar Prett <duncan@kde.org>

Martijn Klingens <klingens@kde.org>

Olivier Goffart <ogoffart@kde.org>

Definition at line 62 of file kopeteprotocol.h.


Public Types
enum	Capability { BaseFgColor = 0x1, BaseBgColor = 0x2, RichFgColor = 0x4, RichBgColor = 0x8, BaseFont = 0x10, RichFont = 0x20, BaseUFormatting = 0x40, BaseIFormatting = 0x80, BaseBFormatting = 0x100, RichUFormatting = 0x200, RichIFormatting = 0x400, RichBFormatting = 0x800, Alignment = 0x1000, BaseFormatting = BaseIFormatting \| BaseUFormatting \| BaseBFormatting, RichFormatting = RichIFormatting \| RichUFormatting \| RichBFormatting, RichColor = RichBgColor \| RichFgColor, BaseColor = BaseBgColor \| BaseFgColor, FullRTF = RichFormatting \| Alignment \| RichFont \| RichFgColor \| RichBgColor, CanSendOffline = 0x10000 }
Public Slots
void	slotMetaContactAboutToSave (Kopete::MetaContact *metaContact)
Public Member Functions
virtual void	aboutToUnload ()
Kopete::OnlineStatus	accountOfflineStatus () const
Capabilities	capabilities () const
virtual AddContactPage *	createAddContactWidget (QWidget parent, Account account)=0
virtual KopeteEditAccountWidget *	createEditAccountWidget (Account account, QWidget parent)=0
virtual Account *	createNewAccount (const QString &accountId)=0
virtual KJob *	createProtocolTask (const QString &taskType)
virtual void	deserialize (MetaContact *metaContact, const QMap< QString, QString > &serializedData)
virtual Contact *	deserializeContact (MetaContact *metaContact, const QMap< QString, QString > &serializedData, const QMap< QString, QString > &addressBookData)
virtual bool	validatePassword (const QString &password) const
virtual	~Protocol ()
Protected Member Functions
	Protocol (const KComponentData &instance, QObject *parent)
void	setCapabilities (Capabilities)

Member Enumeration Documentation

enum Kopete::Protocol::Capability

Available capabilities.

capabilities() returns an ORed list of these, which the edit widget interperts to determine what buttons to show

Enumerator:

BaseFgColor	Setting the bg color of the whole edit widget / message.
BaseBgColor	Setting the fg color of the whole edit widget / message.
RichFgColor	Setting the fg/bg color of text portions individually.
RichBgColor	Setting the fg/bg color of text portions individually.
BaseFont	Setting the font of the whole edit widget / message.
RichFont	Setting the font of text portions individually.
BaseUFormatting	Setting the formatting of the whole edit widget / message.
BaseIFormatting
BaseBFormatting
RichUFormatting	Setting the formatting of text portions individually.
RichIFormatting
RichBFormatting
Alignment	Setting the alignment of text portions.
BaseFormatting	Setting the formatting of the whole edit widget / message.
RichFormatting	Setting the formatting of text portions individually.
RichColor
BaseColor
FullRTF
CanSendOffline	If it's possible to send offline messages.

Definition at line 110 of file kopeteprotocol.h.

Constructor & Destructor Documentation

Kopete::Protocol::~Protocol ( ) [virtual]

Todo:: Ideally, the destructor should be protected. but we need it public to allow QPtrList<Protocol>

Definition at line 62 of file kopeteprotocol.cpp.

Kopete::Protocol::Protocol	(	const KComponentData &	instance,
		QObject *	parent
	)			`[protected]`

Constructor for Protocol.

Parameters:

	instance	The protocol's instance, every plugin needs to have a KComponentData of its own
	parent	The protocol's parent object
	name	The protocol's name

Definition at line 52 of file kopeteprotocol.cpp.

Member Function Documentation

void Kopete::Protocol::aboutToUnload ( ) [virtual]

Reimplemented from Kopete::Plugin.

This method disconnects all accounts and deletes them, after which it will emit readyForUnload.

Note that this is an asynchronous operation that may take some time with active chats. It's no longer immediate as it used to be in Kopete 0.7.x and before. This also means that you can do a clean shutdown.

Note:

The method is not private to allow subclasses to reimplement it even more, but if you need to do this please explain why on the list first. It might make more sense to add another virtual for protocols that's called instead, but for now I actually think protocols don't need their own implementation at all, so I left out the necessary hooks on purpose.

Martijn

Reimplemented from Kopete::Plugin.

Definition at line 125 of file kopeteprotocol.cpp.

Kopete::OnlineStatus Kopete::Protocol::accountOfflineStatus ( ) const

Returns the status used for contacts when accounts of this protocol are offline.

Definition at line 89 of file kopeteprotocol.cpp.

Protocol::Capabilities Kopete::Protocol::capabilities ( ) const

a bitmask of the capabilities of this protocol

See also:: setCapabilities

Definition at line 78 of file kopeteprotocol.cpp.

virtual AddContactPage* Kopete::Protocol::createAddContactWidget	(	QWidget *	parent,
		Account *	account
	)			`[pure virtual]`

Create a new AddContactPage widget to be shown in the Add Contact Wizard.

Returns:: A new AddContactPage to be shown in the Add Contact Wizard

virtual KopeteEditAccountWidget* Kopete::Protocol::createEditAccountWidget	(	Account *	account,
		QWidget *	parent
	)			`[pure virtual]`

Create a new KopeteEditAccountWidget.

Returns:: A new KopeteEditAccountWidget to be shown in the account part of the configurations.

Parameters:

	account	is the KopeteAccount to edit. If it's 0L, then we create a new account
	parent	The parent of the 'to be returned' widget

virtual Account* Kopete::Protocol::createNewAccount ( const QString & accountId ) [pure virtual]

Create an empty Account.

This method is called during the loading of the config file.

Parameters:

accountId

- the account ID to create the account with. This is usually the login name of the account

you don't need to register the account to the AccountManager in this function. But if you want to use this function don't forget to call AccountManager::registerAccount

Returns:: The new Account object created by this function

KJob * Kopete::Protocol::createProtocolTask ( const QString & taskType ) [virtual]

Factory method to create a protocol Task.

Protocols Task are tasks needed for executing specific commands for the given protocol. This method create the required task for the given task type.

If a task type is not available in the protocol, just return a null pointer, like the default implementation.

Example of a implementation of createProtocolTask()

KJob* JabberProtocol::createProtocolTask(const QString &taskType)
{
    if( taskType == QLatin1String("DeleteContactTask") )
    {
        return new JabberDeleteContactTask();
    }
    if( taskType == QLatin1String("AddContactTask") )
    {
        return new JabberAddContactTask();
    }

    return 0;
}

Parameters:

taskType

a task type as a string. Check each task for name.

Definition at line 372 of file kopeteprotocol.cpp.

void Kopete::Protocol::deserialize	(	MetaContact *	metaContact,
		const QMap< QString, QString > &	serializedData
	)			`[virtual]`

Deserialize the plugin data for a meta contact.

This method splits up the data into the independent Kopete::Contact objects and calls deserializeContact() for each contact.

Note that you can still reimplement this method if you prefer, but you are strongly recommended to use this version of the method instead, unless you want to do _VERY_ special things with the data...

Todo:: we probably should think to another way to save the contacltist.

Reimplemented from Kopete::Plugin.

Definition at line 252 of file kopeteprotocol.cpp.

Contact * Kopete::Protocol::deserializeContact	(	MetaContact *	metaContact,
		const QMap< QString, QString > &	serializedData,
		const QMap< QString, QString > &	addressBookData
	)			`[virtual]`

Deserialize a single contact.

This method is called by deserialize() for each separate contact, so you don't need to add your own hooks for multiple contacts in a single meta contact yourself. serializedData and addressBookData will be the data the contact provided in Kopete::Contact::serialize.

The default implementation does nothing.

Returns:: The contact created from the data

See also:: Contact::serialize

Todo:: we probably should think to another way to save the contacltist.

Definition at line 360 of file kopeteprotocol.cpp.

void Kopete::Protocol::setCapabilities ( Capabilities ) [protected]

Sets the capabilities of this protcol.

The subclass contructor is a good place for calling it.

See also:: capabilities()

void Kopete::Protocol::slotMetaContactAboutToSave ( Kopete::MetaContact * metaContact ) [slot]

A meta contact is about to save.

Call serialize() for all contained contacts for this protocol.

Definition at line 170 of file kopeteprotocol.cpp.

bool Kopete::Protocol::validatePassword ( const QString & password ) const [virtual]

Check whether a password is valid for this protocol.

The default implementation validates every password

Parameters:

password

The password to check

Definition at line 379 of file kopeteprotocol.cpp.

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

kopete/libkopete

Kopete::Protocol Class Reference

Detailed Description

Public Types

Public Slots

Public Member Functions

Protected Member Functions

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

kopete/libkopete

kdenetwork