#include <kopetechatsessionmanager.h>

Inheritance diagram for Kopete::ChatSessionManager:

Public Slots
void	slotReadMessage ()

Signals
void	aboutToDisplay (Kopete::Message &message)

void	aboutToReceive (Kopete::Message &message)

void	aboutToSend (Kopete::Message &message)

void	chatSessionCreated (Kopete::ChatSession *)

void	display (Kopete::Message &message, Kopete::ChatSession *)

void	newEvent (Kopete::MessageEvent *)

void	readMessage ()

void	viewActivated (KopeteView *view)

void	viewClosing (KopeteView *view)

void	viewCreated (KopeteView *)

Public Member Functions
	~ChatSessionManager ()

KopeteView *	activeView ()

Kopete::ChatSession *	create (const Kopete::Contact user, Kopete::ContactPtrList chatContacts, Kopete::Protocol protocol, Kopete::ChatSession::Form form=Kopete::ChatSession::Small)

KopeteView *	createView (Kopete::ChatSession *, const QString &requestedPlugin=QString())

Kopete::ChatSession *	findChatSession (const Kopete::Contact user, Kopete::ContactPtrList chatContacts, Kopete::Protocol protocol)

void	postNewEvent (Kopete::MessageEvent *)

void	registerChatSession (Kopete::ChatSession *)

void	removeSession (Kopete::ChatSession *session)

QList< ChatSession * >	sessions ()

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 ChatSessionManager *	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

Author: Duncan Mac-Vicar Prett dunca.nosp@m.n@kd.nosp@m.e.org

Kopete::ChatSessionManager is responsible for creating and tracking Kopete::ChatSession instances for each chat.

Definition at line 47 of file kopetechatsessionmanager.h.

Constructor & Destructor Documentation

Kopete::ChatSessionManager::~ChatSessionManager ( )

Definition at line 53 of file kopetechatsessionmanager.cpp.

Member Function Documentation

void Kopete::ChatSessionManager::aboutToDisplay ( Kopete::Message & message )

signal

This signal is emitted whenever a message is about to be displayed by the KopeteChatWindow.

Please remember that both messages sent and messages received will emit this signal! Plugins may connect to this signal to change the message contents before it's going to be displayed.

void Kopete::ChatSessionManager::aboutToReceive ( Kopete::Message & message )

signal

Plugins may connect to this signal to manipulate the contents of the message that is being received.

This signal is emitted before aboutToDisplay()

void Kopete::ChatSessionManager::aboutToSend ( Kopete::Message & message )

signal

Plugins may connect to this signal to manipulate the contents of the message that is being sent.

KopeteView * Kopete::ChatSessionManager::activeView ( )

Returns the current active Kopete view.

Definition at line 187 of file kopetechatsessionmanager.cpp.

void Kopete::ChatSessionManager::chatSessionCreated ( Kopete::ChatSession * )

signal

a new KMM has been created

ChatSession * Kopete::ChatSessionManager::create	(	const Kopete::Contact *	user,
		Kopete::ContactPtrList	chatContacts,
		Kopete::Protocol *	protocol,
		Kopete::ChatSession::Form	form = `Kopete::ChatSession::Small`
	)

Create a new chat session.

Provided is the initial list of contacts in the session. If a session with exactly these contacts already exists, it will be reused. Otherwise a new session is created.

Parameters

user	The local user in the session.
chatContacts	The list of contacts taking part in the chat.
protocol	The protocol that the chat is using.

Returns: A pointer to a new or reused Kopete::ChatSession.

Definition at line 106 of file kopetechatsessionmanager.cpp.

KopeteView * Kopete::ChatSessionManager::createView	(	Kopete::ChatSession *	kmm,
		const QString &	requestedPlugin = `QString()`
	)

create a new view for the manager.

only the manager should call this function

Definition at line 156 of file kopetechatsessionmanager.cpp.

void Kopete::ChatSessionManager::display	(	Kopete::Message &	message,
		Kopete::ChatSession *
	)

signal

the message is ready to be displayed

ChatSession * Kopete::ChatSessionManager::findChatSession	(	const Kopete::Contact *	user,
		Kopete::ContactPtrList	chatContacts,
		Kopete::Protocol *	protocol
	)