• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdenetwork API Reference
  • KDE Home
  • Contact Us
 

kopete/libkopete

  • Kopete
  • ChatSessionManager
Public Slots | Signals | Public Member Functions | Static Public Member Functions | List of all members
Kopete::ChatSessionManager Class Reference

#include <kopetechatsessionmanager.h>

Inheritance diagram for Kopete::ChatSessionManager:
Inheritance graph
[legend]

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 ()
 

Static Public Member Functions

static ChatSessionManager * self ()
 

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
userThe local user in the session.
chatContactsThe list of contacts taking part in the chat.
protocolThe 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 
)

Find a chat session, if one exists, that matches the given list of contacts.

Parameters
userThe local user in the session.
chatContactsThe list of contacts taking part in the chat.
protocolThe protocol that the chat is using.
Returns
A pointer to an existing Kopete::ChatSession, or 0L if none was found.

Definition at line 65 of file kopetechatsessionmanager.cpp.

void Kopete::ChatSessionManager::newEvent ( Kopete::MessageEvent *  )
signal

A new event has been posted.

void Kopete::ChatSessionManager::postNewEvent ( Kopete::MessageEvent *  e)

Post a new event.

this will emit the newEvent signal

Definition at line 182 of file kopetechatsessionmanager.cpp.

void Kopete::ChatSessionManager::readMessage ( )
signal

The global shortcut for sending message has been used.

void Kopete::ChatSessionManager::registerChatSession ( Kopete::ChatSession *  result)

Registers a Kopete::ChatSession (or subclass thereof) with the Kopete::ChatSessionManager.

Definition at line 123 of file kopetechatsessionmanager.cpp.

void Kopete::ChatSessionManager::removeSession ( Kopete::ChatSession *  session)

called by the kmm itself when it gets deleted

Definition at line 145 of file kopetechatsessionmanager.cpp.

ChatSessionManager * Kopete::ChatSessionManager::self ( )
static

Definition at line 39 of file kopetechatsessionmanager.cpp.

QList< ChatSession * > Kopete::ChatSessionManager::sessions ( )

Get a list of all open sessions.

Definition at line 151 of file kopetechatsessionmanager.cpp.

void Kopete::ChatSessionManager::slotReadMessage ( )
slot

Definition at line 118 of file kopetechatsessionmanager.cpp.

void Kopete::ChatSessionManager::viewActivated ( KopeteView *  view)
signal

A view as been activated(manually only?).

void Kopete::ChatSessionManager::viewClosing ( KopeteView *  view)
signal
void Kopete::ChatSessionManager::viewCreated ( KopeteView *  )
signal

A new view has been created.


The documentation for this class was generated from the following files:
  • kopetechatsessionmanager.h
  • kopetechatsessionmanager.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:53:51 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kopete/libkopete

Skip menu "kopete/libkopete"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdenetwork API Reference

Skip menu "kdenetwork API Reference"
  • kget
  • kopete
  •   kopete
  •   libkopete
  • krdc
  • krfb

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal