qutim_sdk_0_3::Protocol Class Reference

#include <protocol.h>

List of all members.

Classes
struct	CreateAccountArgument
Public Types
enum	DataType { ProtocolIdName, ProtocolContainsContacts }
enum	ProtocolHook { SupportedAccountParametersHook, CreateAccountHook }
enum	RemoveFlag { DeleteAccount = 0x01 }
Signals
void	accountCreated (qutim_sdk_0_3::Account *)
void	accountRemoved (qutim_sdk_0_3::Account *)
Public Member Functions
	Protocol ()
	Protocol (ProtocolPrivate &p)
virtual	~Protocol ()
virtual Q_INVOKABLE qutim_sdk_0_3::Account *	account (const QString &id) const =0
virtual Q_INVOKABLE QList < qutim_sdk_0_3::Account * >	accounts () const =0
Config	config ()
ConfigGroup	config (const QString &group)
Q_INVOKABLE Account *	createAccount (const QString &id, const QVariantMap &parameters)
virtual QVariant	data (DataType type)
QString	id () const
virtual void	removeAccount (qutim_sdk_0_3::Account *account, RemoveFlag flags=DeleteAccount)
QStringList	supportedAccountParameters () const
Static Public Member Functions
static ProtocolHash	all ()
Protected Member Functions
virtual void	virtual_hook (int id, void *data)
Properties
QString	id
QStringList	supportedAccountParameters
Friends
class	ModuleManager

---

Member Enumeration Documentation

enum qutim_sdk_0_3::Protocol::DataType

Enumerator:

ProtocolIdName
ProtocolContainsContacts

enum qutim_sdk_0_3::Protocol::ProtocolHook

Enumerator:

SupportedAccountParametersHook
CreateAccountHook

enum qutim_sdk_0_3::Protocol::RemoveFlag

Enumerator:

DeleteAccount

---

Constructor & Destructor Documentation

qutim_sdk_0_3::Protocol::Protocol

(

)

qutim_sdk_0_3::Protocol::Protocol

(

ProtocolPrivate &

p

)

virtual qutim_sdk_0_3::Protocol::~Protocol

(

)

[virtual]

---

Member Function Documentation

virtual Q_INVOKABLE qutim_sdk_0_3::Account* qutim_sdk_0_3::Protocol::account

(

const QString &

id

)

const [pure virtual]

void qutim_sdk_0_3::Protocol::accountCreated

(

qutim_sdk_0_3::Account *

)

[signal]

void qutim_sdk_0_3::Protocol::accountRemoved

(

qutim_sdk_0_3::Account *

)

[signal]

virtual Q_INVOKABLE QList<qutim_sdk_0_3::Account*> qutim_sdk_0_3::Protocol::accounts

(

)

const [pure virtual]

static ProtocolHash qutim_sdk_0_3::Protocol::all

(

)

[static]

ConfigGroup qutim_sdk_0_3::Protocol::config

(

const QString &

group

)

Config qutim_sdk_0_3::Protocol::config

(

)

Q_INVOKABLE Account* qutim_sdk_0_3::Protocol::createAccount	(	const QString &	id,
		const QVariantMap &	parameters
	)

virtual QVariant qutim_sdk_0_3::Protocol::data

(

DataType

type

)

[virtual]

QString qutim_sdk_0_3::Protocol::id

(

)

const

virtual void qutim_sdk_0_3::Protocol::removeAccount	(	qutim_sdk_0_3::Account *	account,
		RemoveFlag	flags = DeleteAccount
	)		[virtual]

Remove account from qutIM, protocols can reimplement this method.

Be careful, this method actually delete your account. It is recommended to display a confirmation dialog box.

QStringList qutim_sdk_0_3::Protocol::supportedAccountParameters

(

)

const

virtual void qutim_sdk_0_3::Protocol::virtual_hook	(	int	id,
		void *	data
	)		[protected, virtual]

---

Friends And Related Function Documentation

friend class ModuleManager [friend]

---

Property Documentation

QString qutim_sdk_0_3::Protocol::id [read]

QStringList qutim_sdk_0_3::Protocol::supportedAccountParameters [read]

---

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

• protocol.h