message.h

Go to the documentation of this file.

/*
    Copyright (C) 2012  Lasath Fernando <kde@lasath.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.1 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*/


#ifndef KTP_MESSAGE_H
#define KTP_MESSAGE_H

#include <TelepathyQt/Message>

#include <TelepathyLoggerQt4/Types>
#include <TelepathyLoggerQt4/TextEvent>

#include <KTp/ktp-export.h>
#include <KTp/message-context.h>

#include <QSharedData>
#include <QSharedDataPointer>

namespace KTp
{

class KTP_EXPORT Message
{
  public:
    enum MessageDirection {
        LocalToRemote,
        RemoteToLocal
    };

    Message(const KTp::Message &other);
    KTp::Message& operator=(const KTp::Message &other);
    virtual ~Message();

    QString mainMessagePart() const;

    void setMainMessagePart(const QString &message);

    void appendMessagePart(const QString &part);

    void appendScript(const QString &script);

    QString finalizedMessage() const;

    QString finalizedScript() const;

    QVariant property(const char *name) const;
    void setProperty(const char *name, const QVariant &value);

    QDateTime time() const;
    QString token() const;
    Tp::ChannelTextMessageType type() const;
    QString senderAlias() const;
    QString senderId() const;

    int partsSize() const;

    bool isHistory() const;

    MessageDirection direction() const;

protected:
    Message(const Tp::Message &original, const KTp::MessageContext &context);
    Message(const Tp::ReceivedMessage &original, const KTp::MessageContext &context);
    Message(const Tpl::TextEventPtr &original, const KTp::MessageContext &context);
    explicit Message(const QString &messageText, const KTp::MessageContext &context);


private:
    class Private;
    QSharedDataPointer<Private> d;
    friend class MessageProcessor;
};

}


#endif // MESSAGE_H