imessage.h

Go to the documentation of this file.

/**********************************************************************
 * LeechCraft - modular cross-platform feature rich internet client.
 * Copyright (C) 2006-2014  Georg Rudoy
 *
 * Distributed under the Boost Software License, Version 1.0.
 * (See accompanying file LICENSE or copy at https://www.boost.org/LICENSE_1_0.txt)
 **********************************************************************/

#pragma once

#include <QString>
#include <QDateTime>
#include <QtPlugin>
#include "messagebase.h"

class QObject;

namespace LC
{
namespace Azoth
{
    class ICLEntry;

    class IMessage : public MessageBase
    {
    public:
        virtual ~IMessage () {};

        enum class Direction : uint8_t
        {
            In,

            Out
        };

        enum class Type : uint8_t
        {
            ChatMessage,

            MUCMessage,

            StatusMessage,

            EventMessage,

            ServiceMessage
        };

        enum class SubType : uint8_t
        {
            Other,

            KickNotification,

            BanNotification,

            ParticipantStatusChange,

            ParticipantRoleAffiliationChange,

            ParticipantJoin,

            ParticipantLeave,

            ParticipantNickChange,

            RoomSubjectChange
        };

        enum class EscapePolicy : uint8_t
        {
            Escape,
            NoEscape
        };

        virtual QObject* GetQObject () = 0;

        virtual void Store () = 0;

        virtual Direction GetDirection () const = 0;

        virtual Type GetMessageType () const = 0;

        virtual SubType GetMessageSubType () const = 0;

        virtual QObject* OtherPart () const = 0;

        virtual QObject* ParentCLEntry () const
        {
            return OtherPart ();
        }

        virtual QString GetOtherVariant () const = 0;

        virtual QString GetBody () const = 0;

        virtual void SetBody (const QString& body) = 0;

        virtual EscapePolicy GetEscapePolicy () const
        {
            return EscapePolicy::Escape;
        }

        virtual QDateTime GetDateTime () const = 0;

        virtual void SetDateTime (const QDateTime& timestamp) = 0;
    };
}
}

Q_DECLARE_INTERFACE (LC::Azoth::IMessage,
        "org.LeechCraft.Azoth.IMessage/1.0")