kopetechatsession.h

Go to the documentation of this file.

/*
    kopetechatsession.h - Manages all chats

    Copyright (c) 2002      by Duncan Mac-Vicar Prett <duncan@kde.org>
    Copyright (c) 2002      by Daniel Stone           <dstone@kde.org>
    Copyright (c) 2002-2003 by Martijn Klingens       <klingens@kde.org>
    Copyright (c) 2002-2004 by Olivier Goffart        <ogoffart@kde.org>
    Copyright (c) 2003      by Jason Keirstead        <jason@keirstead.org>
    Copyright (c) 2005      by Michaël Larouche      <larouche@kde.org>
    Copyright (c) 2009      by Fabian Rami          <fabian.rami@wowcompany.com>

    Kopete    (c) 2002-2003 by the Kopete developers  <kopete-devel@kde.org>

    *************************************************************************
    *                                                                       *
    * This library is free software; you can redistribute it and/or         *
    * modify it under the terms of the GNU Lesser General Public            *
    * License as published by the Free Software Foundation; either          *
    * version 2 of the License, or (at your option) any later version.      *
    *                                                                       *
    *************************************************************************
*/

#ifndef KOPETECHATSESSION_H
#define KOPETECHATSESSION_H

#include <QtCore/QObject>

#include <kxmlguiclient.h>

#include "kopete_export.h"

// FIXME: get rid of these includes
#include "kopetemessage.h"
#include "kopetemessagehandlerchain.h"

class KMMPrivate;

class KopeteView;

namespace Kopete
{

class Contact;
class Message;
class Protocol;
class OnlineStatus;
class Account;
class ChatSessionManager;
class PropertyContainer;
class MessageHandlerChain;
class TemporaryKMMCallbackAppendMessageHandler;

typedef QList<Contact*>   ContactPtrList;
typedef QList<Message> MessageList;


class KOPETE_EXPORT ChatSession : public QObject , public KXMLGUIClient
{
    // friend class so the object factory can access the protected constructor
    friend class ChatSessionManager;

    Q_OBJECT

public:
    enum Form { Small,
        Chatroom };
    ~ChatSession();

    const ContactPtrList& members() const;

    const Contact* myself() const;

    Protocol* protocol() const;

    Account *account() const ;

    const QString displayName();

    void setLastUrl( const QString &verylastUrl );

    const QString lastUrl();

    void setDisplayName( const QString &displayName );

    void setContactOnlineStatus( const Contact *contact, const OnlineStatus &newStatus );

    const OnlineStatus contactOnlineStatus( const Contact *contact ) const;

    // FIXME: canCreate should definitely be an enum and not a bool - Martijn
    KopeteView* view( bool canCreate = false, const QString &requestedPlugin = QString() );

    bool mayInvite() const ;

    virtual void inviteContact(const QString &contactId);

    MessageHandlerChain::Ptr chainForDirection( Message::MessageDirection dir );

    Form form() const;

    bool warnGroupChat() const;

    QString initLastUrl( const Kopete::Contact* c );

    static QString getUrlsFileName(const Kopete::Contact*);

    void urlSearch( const Kopete::Message &msg );

    QStringList findUrls(const Kopete::Message &msg );

signals:
    void closing( Kopete::ChatSession *kmm );

    void messageAppended( Kopete::Message &msg, Kopete::ChatSession *kmm = 0L );

    void messageReceived( Kopete::Message &msg, Kopete::ChatSession *kmm = 0L );

    void messageSent( Kopete::Message &msg, Kopete::ChatSession *kmm = 0L );

    void messageSuccess();

    // FIXME: What's 'suppress'? Shouldn't this be an enum? - Martijn
    void contactAdded( const Kopete::Contact *contact, bool suppress );

    void contactRemoved( const Kopete::Contact *contact, const QString &reason, Qt::TextFormat format = Qt::PlainText, bool suppressNotification = false );

    void onlineStatusChanged( Kopete::Contact *, const Kopete::OnlineStatus &, const Kopete::OnlineStatus & );

    void statusMessageChanged( Kopete::Contact* );

    void nickNameChanged( Kopete::Contact *, const QString & );

    void displayNameChanged();

    void myselfTyping( bool isTyping );

    void remoteTyping( const Kopete::Contact *contact, bool isTyping );

    void eventNotification( const QString& notificationText);

    void viewActivated( KopeteView* view );

    void messageStateChanged( uint messageId, Kopete::Message::MessageState state );

    void photoChanged();

    void toggleGraphicOverride(bool enable);

public slots:
    void receivedTypingMsg( const Kopete::Contact *contact , bool isTyping = true );

    void receivedTypingMsg( const QString &contactId, bool isTyping = true );

    void receivedEventNotification(  const QString& notificationText );

    void receivedMessageState( uint messageId, Kopete::Message::MessageState state );
    
    void appendMessage( Kopete::Message &msg );

    void addContact( const Kopete::Contact *c, bool suppress = false );

    void addContact( const Kopete::Contact *c, const Kopete::OnlineStatus &initialStatus, bool suppress = false );

    void removeContact( const Kopete::Contact *contact, const QString& reason = QString(), Qt::TextFormat format = Qt::PlainText, bool suppressNotification = false );

    void setCanBeDeleted ( bool canBeDeleted );

    void ref();
    void deref();
        

    void sendMessage( Kopete::Message &message );

    void typing( bool t );

    void messageSucceeded();

    void emitNudgeNotification();
    
    void raiseView();

private slots:
    void clearChains();
    void slotUpdateDisplayName();
    void slotViewDestroyed();
    void slotOnlineStatusChanged( Kopete::Contact *c, const Kopete::OnlineStatus &status, const Kopete::OnlineStatus &oldStatus );
    void slotContactDestroyed( Kopete::Contact *contact );
    void slotMyselfDestroyed( Kopete::Contact *contact );
    void slotContactPropertyChanged( Kopete::PropertyContainer * contact, const QString &key, const QVariant &oldValue, const QVariant &newValue );

protected:
    ChatSession( const Contact *user, ContactPtrList others, Protocol *protocol, Form form = Small );

    void setMayInvite(bool);

    void setWarnGroupChat(bool);

private:
    KMMPrivate *d;

    // FIXME: remove
    friend class TemporaryKMMCallbackAppendMessageHandler;
};

}

#endif

// vim: set noet ts=4 sts=4 sw=4: