#include <kopeteonlinestatusmanager.h>

Inheritance diagram for Kopete::OnlineStatusManager:

Public Types
enum	Category { Idle =1<<8, ExtendedAway =1<<9, Invisible =1<<10, Busy =1<<5, FreeForChat =1<<6, Away =1<<2, Online =1<<1, Offline =1 }

enum	Option { HasStatusMessage = 0x01, DisabledIfOffline = 0x02, HideFromMenu = 0x04 }

Signals
void	iconsChanged ()

Public Member Functions
	~OnlineStatusManager ()

Kopete::OnlineStatusManager::Category	initialStatus () const

OnlineStatus	onlineStatus (Protocol *protocol, Categories category) const

QList< OnlineStatus >	registeredStatusList (Protocol *protocol) const

void	registerOnlineStatus (const OnlineStatus &status)

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Static Public Member Functions
static KIcon	pixmapForCategory (Categories category)

static OnlineStatusManager *	self ()

Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Additional Inherited Members
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from QObject
	objectName

Detailed Description

OnlineStatusManager is a singleton which manage OnlineStatus.

Author: Olivier Goffart

Definition at line 42 of file kopeteonlinestatusmanager.h.

Member Enumeration Documentation

enum Kopete::OnlineStatusManager::Category

Kopete will uses categories to have a more general system than simply globally away.

Idealy, in each protocol, there should be one status per categories (status may be in several or in none categories

Idle is the status used for auto-away

Status number are organised so that make a tree.

Enumerator
Idle
ExtendedAway
Invisible
Busy
FreeForChat
Away
Online
Offline

Definition at line 59 of file kopeteonlinestatusmanager.h.

enum Kopete::OnlineStatusManager::Option

See also: registerOnlineStatus

Enumerator

HasStatusMessage

The user may set status messages for this online status.

DisabledIfOffline

The action of the status will be disabled if the account is offline.

use it if your protocol doesn't support connecting with the status as initial status. You praticaly shouldn't abuse of that, and automatically set status after connecting if possible

HideFromMenu

The status will not appears in the action menu.

Used if you want to register the status for e.g. autoaway, without letting the user set itself that status

Definition at line 76 of file kopeteonlinestatusmanager.h.

Constructor & Destructor Documentation

Kopete::OnlineStatusManager::~OnlineStatusManager ( )

Definition at line 64 of file kopeteonlinestatusmanager.cpp.

Member Function Documentation

void Kopete::OnlineStatusManager::iconsChanged ( )

signal

OnlineStatusManager::Category Kopete::OnlineStatusManager::initialStatus ( ) const

This returns status from config as Kopete::OnlineStatusManager::Category.

Returns: the desired initial status

Definition at line 130 of file kopeteonlinestatusmanager.cpp.

OnlineStatus Kopete::OnlineStatusManager::onlineStatus	(	Protocol *	protocol,
		Categories	category
	)		const

return the status of the protocol which is in the category category

If no status has been registered in this category, return the one in the category which is the most similair

Definition at line 89 of file kopeteonlinestatusmanager.cpp.

KIcon Kopete::OnlineStatusManager::pixmapForCategory ( Categories category )

static

return KIcon for given category

Definition at line 408 of file kopeteonlinestatusmanager.cpp.

QList< OnlineStatus > Kopete::OnlineStatusManager::registeredStatusList ( Protocol * protocol ) const

return the registered statuses for given protocol

Definition at line 403 of file kopeteonlinestatusmanager.cpp.

void Kopete::OnlineStatusManager::registerOnlineStatus ( const OnlineStatus & status )

You need to register each status an account can be.

Registered statuses will appear in the account menu.

You should use a special OnlineStatus constructor that call this function automatically The Protocol constructor is a good place to construct the OnlineStatuses

You can set the status to be in the predefined categories. Ideally, each category should own one status. A status may be in several categories, or in none. There shouldn't be more than one status per protocol per categories.

Parameters

status The status to register

Definition at line 84 of file kopeteonlinestatusmanager.cpp.

OnlineStatusManager * Kopete::OnlineStatusManager::self ( )

static

Definition at line 49 of file kopeteonlinestatusmanager.cpp.

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

kopete/libkopete

Public Types

Signals

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

kopete/libkopete

kdenetwork API Reference

Search