kopete/libkopete

Kopete::ChatSessionManager

Kopete::ChatSessionManager Class Reference

#include <kopetechatsessionmanager.h>

Inheritance diagram for Kopete::ChatSessionManager:

[legend]

List of all members.

Detailed Description

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

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

Definition at line 47 of file kopetechatsessionmanager.h.


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
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 ()
	~ChatSessionManager ()
Static Public Member Functions
static ChatSessionManager *	self ()

Constructor & Destructor Documentation

Kopete::ChatSessionManager::~ChatSessionManager ( )

Definition at line 54 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 188 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 107 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 157 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
	)