kopetemessage.h

Go to the documentation of this file.

/*
    kopetemessage.h  -  Base class for Kopete messages

    Copyright (c) 2002-2003 by Martijn Klingens      <klingens@kde.org>
    Copyright (c) 2002-2004 by Olivier Goffart       <ogoffart@kde.org>
    Copyright (c) 2006-2007 by Charles Connell       <charles@connells.org>
    Copyright (c) 2007      by Michaël Larouche      <larouche@kde.org>
    Copyright (c) 2008      by Roman Jarosz          <kedgedev@centrum.cz>

    Kopete    (c) 2002-2008 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 KOPETEMESSAGE_H
#define KOPETEMESSAGE_H

#include <QtCore/QSharedData>
#include <QtCore/QList>
#include <QtCore/Qt>

#include "kopete_export.h"

class QByteArray;
class QColor;
class QDateTime;
class QFont;
class QTextCodec;
class QTextDocument;
class QStringList;
class QPixmap;

namespace Kopete {


class ChatSession;
class Contact;


class KOPETE_EXPORT Message
{
public:
    enum MessageDirection
    {
        Inbound = 0, 
        Outbound = 1, 
        Internal= 2 
    };

    enum MessageType
    {
        TypeNormal, 
        TypeAction, 
        TypeFileTransferRequest, 
        TypeVoiceClipRequest 
    };

    enum MessageImportance
    {
        Low = 0, 
        Normal = 1, 
        Highlight = 2 
    };

    enum MessageState
    {
        StateUnknown = 0, 
        StateSending = 1, 
        StateSent = 2, 
        StateError = 3 
    };

    explicit Message();

    ~Message();

    explicit Message( const Contact *fromKC, const Contact *toKC );
    explicit Message( const Contact *fromKC, const QList<Contact*> &contacts);

    Message( const Message &other );

    Message & operator=( const Message &other );

    uint id() const;

    static uint nextId();

    QDateTime timestamp() const;

    void setTimestamp(const QDateTime &timestamp);

    bool delayed() const;

    void setDelayed(bool delay);

    const Contact * from() const;

    QList<Contact*> to() const;

    MessageType type() const;

    void setType(MessageType type);

    QString requestedPlugin() const;

    void setRequestedPlugin(const QString &requestedPlugin);

    QColor foregroundColor() const;

    QColor backgroundColor() const;

    bool isRightToLeft() const;

    const QStringList regexpPatterns();

    QFont font() const;

    QString subject() const;

    void setSubject(const QString &subject);

    const QTextDocument *body() const;

    Qt::TextFormat format() const;

    MessageDirection direction() const;

    void setDirection(MessageDirection direction);

    MessageImportance importance() const;

    void setImportance(MessageImportance importance);

    MessageState state() const;

    void setState(MessageState state);

    void setForegroundColor( const QColor &color );

    void setBackgroundColor( const QColor &color );

    void setFont( const QFont &font );

    void setPlainBody( const QString &body);

    void setHtmlBody( const QString &body);
    
    void setForcedHtmlBody( const QString &body);

    void setBody( const QTextDocument *body);

    QString plainBody() const;

    QString escapedBody() const;

    QString parsedBody() const;

     ChatSession *manager() const ;

     void setManager(ChatSession * manager);

    void KDE_DEPRECATED setBackgroundOverride( bool enable );

    void KDE_DEPRECATED setForegroundOverride( bool enable );

    void KDE_DEPRECATED setRichTextOverride( bool enable );
    
    void setFormattingOverride( bool enable );

    QString getHtmlStyleAttribute() const;

    void setFileTransferDisabled( bool disabled );

    bool fileTransferDisabled() const;

    void setFileName( const QString &fileName );

    QString fileName() const;

    void setFileSize( unsigned long size );

    unsigned long fileSize() const;

    void setFilePreview( const QPixmap &preview );

    QPixmap filePreview() const;

    QStringList classes() const;

    void addClass(const QString& classe);

    void setClasses(const QStringList &classes);

public:  /* static helpers */

    static QString unescape( const QString &xml );

    static QString escape( const QString & );

#if 0
    //candidate for removal!
    static QString decodeString( const QByteArray &message,
        const QTextCodec *providedCodec = 0L, bool *success = 0L );
#endif

private:
    class Private;
    QSharedDataPointer<Private> d;

    void doSetBody( QString body, Qt::TextFormat format = Qt::PlainText );

    void doSetBody (const QTextDocument *body, Qt::TextFormat format = Qt::PlainText);

    static QString parseLinks( const QString &message, Qt::TextFormat format );
};

}

#endif

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