iclentry.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 <QFlags>
#include <QMetaType>
#include <util/azoth/emitters/clentry.h>
#include "azothcommon.h"
#include "message.h"

class QAction;
class QImage;

namespace LC::Azoth
{
    class IAccount;
    class IMessage;

    class ICLEntry
    {
    protected:
        Emitters::CLEntry Emitter_;

        virtual ~ICLEntry () = default;
    public:
        Emitters::CLEntry& GetCLEntryEmitter () { return Emitter_; }

        enum Feature
        {
            FPermanentEntry = 0x0000,

            FSessionEntry = 0x0001,

            FMaskLongetivity = 0x0003,

            FSupportsRenames = 0x0020,

            FHasCustomChatWidget = 0x0040,

            FSupportsAuth = 0x0080,

            FSupportsGrouping = 0x0100,

            FSelfContact = 0x0200
        };

        Q_DECLARE_FLAGS (Features, Feature)

        enum class EntryType
        {
            Chat,

            MUC,

            PrivateChat,

            UnauthEntry
        };

        virtual QObject* GetQObject () = 0;

        virtual IAccount* GetParentAccount () const = 0;

        virtual ICLEntry* GetParentCLEntry () const
        {
            return nullptr;
        }

        QObject* GetParentCLEntryObject () const
        {
            if (const auto entry = GetParentCLEntry ())
                return entry->GetQObject ();
            return nullptr;
        }

        virtual Features GetEntryFeatures () const = 0;

        virtual EntryType GetEntryType () const = 0;

        virtual QString GetEntryName () const = 0;

        virtual void SetEntryName (const QString& name) = 0;

        virtual QString GetEntryID () const = 0;

        virtual QString GetHumanReadableID () const
        {
            return GetEntryID ();
        }

        virtual QStringList Groups () const = 0;

        virtual void SetGroups (const QStringList& groups) = 0;

        virtual QStringList Variants () const = 0;

        virtual void SendMessage (const OutgoingMessage& message) = 0;

        virtual QList<IMessage*> GetAllMessages () const = 0;

        virtual void PurgeMessages (const QDateTime& before) = 0;

        virtual void SetChatPartState (ChatPartState state,
                const QString& variant) = 0;

        virtual EntryStatus GetStatus (const QString& variant = QString ()) const = 0;

        virtual void ShowInfo () = 0;

        virtual QList<QAction*> GetActions () const = 0;

        virtual QMap<QString, QVariant> GetClientInfo (const QString& variant) const = 0;

        virtual void MarkMsgsRead () = 0;

        virtual void ChatTabClosed () = 0;
    };
}

Q_DECLARE_OPERATORS_FOR_FLAGS (LC::Azoth::ICLEntry::Features)
Q_DECLARE_INTERFACE (LC::Azoth::ICLEntry, "org.Deviant.LeechCraft.Azoth.ICLEntry/1.0")