KDE 4.0 API Reference kopete/libkopete
Kopete::ChatSessionManager Class Reference
#include <kopetechatsessionmanager.h>
Detailed Description
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 54 of file kopetechatsessionmanager.cpp.
Member Function Documentation
| ChatSessionManager * Kopete::ChatSessionManager::self | ( | ) | [static] |
Definition at line 39 of file kopetechatsessionmanager.cpp.
| 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.
| ChatSession * Kopete::ChatSessionManager::findChatSession | ( | const Kopete::Contact * | user, | |
| Kopete::ContactPtrList | chatContacts, | |||
| Kopete::Protocol * | protocol | |||
| ) |
Find a chat session, if one exists, that matches the given list of contacts.
- 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 an existing Kopete::ChatSession, or 0L if none was found.
Definition at line 66 of file kopetechatsessionmanager.cpp.
| void Kopete::ChatSessionManager::registerChatSession | ( | Kopete::ChatSession * | result | ) |
Registers a Kopete::ChatSession (or subclass thereof) with the Kopete::ChatSessionManager.
Definition at line 124 of file kopetechatsessionmanager.cpp.
| QList< ChatSession * > Kopete::ChatSessionManager::sessions | ( | ) |
| void Kopete::ChatSessionManager::removeSession | ( | Kopete::ChatSession * | session | ) |
Definition at line 146 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::postNewEvent | ( | Kopete::MessageEvent * | e | ) |
Post a new event.
this will emit the newEvent signal
Definition at line 183 of file kopetechatsessionmanager.cpp.
| KopeteView * Kopete::ChatSessionManager::activeView | ( | ) |
Returns the current active Kopete view.
Definition at line 188 of file kopetechatsessionmanager.cpp.
| 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::aboutToSend | ( | Kopete::Message & | message | ) | [signal] |
Plugins may connect to this signal to manipulate the contents of the message that is being sent.
| 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::viewCreated | ( | KopeteView * | ) | [signal] |
A new view has been created.
| void Kopete::ChatSessionManager::viewActivated | ( | KopeteView * | view | ) | [signal] |
A view as been activated(manually only?).
| void Kopete::ChatSessionManager::viewClosing | ( | KopeteView * | view | ) | [signal] |
| void Kopete::ChatSessionManager::chatSessionCreated | ( | Kopete::ChatSession * | ) | [signal] |
a new KMM has been created
| void Kopete::ChatSessionManager::display | ( | Kopete::Message & | message, | |
| Kopete::ChatSession * | ||||
| ) | [signal] |
the message is ready to be displayed
| void Kopete::ChatSessionManager::newEvent | ( | Kopete::MessageEvent * | ) | [signal] |
A new event has been posted.
| void Kopete::ChatSessionManager::readMessage | ( | ) | [signal] |
The global shortcut for sending message has been used.
| void Kopete::ChatSessionManager::slotReadMessage | ( | ) | [slot] |
Definition at line 119 of file kopetechatsessionmanager.cpp.
The documentation for this class was generated from the following files:
