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 "imessage.h"
#include "azothcommon.h"
 
class QAction;
class QImage;
 
namespace LC
{
namespace Azoth
{
    class IAccount;
    class IMessage;
 
    struct EntryStatus
    {
        State State_;
 
        QString StatusString_;
 
        EntryStatus ()
        : State_ (SOffline)
        {
        }
 
        EntryStatus (State state, const QString& string)
        : State_ (state)
        , StatusString_ (string)
        {
        }
    };
 
    inline bool operator== (const EntryStatus& es1, const EntryStatus& es2)
    {
        return es1.State_ == es2.State_ &&
                es1.StatusString_ == es2.StatusString_;
    }
 
    inline bool operator!= (const EntryStatus& es1, const EntryStatus& es2)
    {
        return !(es1 == es2);
    }
 
    class ICLEntry
    {
    public:
        virtual ~ICLEntry () {}
 
        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 IMessage* CreateMessage (IMessage::Type type,
                const QString& variant,
                const QString& body) = 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;
 
        virtual void gotMessage (QObject *msg) = 0;
 
        virtual void statusChanged (const EntryStatus& st,
                const QString& variant) = 0;
 
        virtual void availableVariantsChanged (const QStringList& newVars) = 0;
 
        virtual void nameChanged (const QString& name) = 0;
 
        virtual void groupsChanged (const QStringList& groups) = 0;
 
        virtual void chatPartStateChanged (const ChatPartState& state,
                const QString& variant) = 0;
 
        virtual void permsChanged () = 0;
 
        virtual void entryGenerallyChanged () = 0;
    };
}
}
 
Q_DECLARE_METATYPE (LC::Azoth::EntryStatus)
Q_DECLARE_OPERATORS_FOR_FLAGS (LC::Azoth::ICLEntry::Features)
Q_DECLARE_INTERFACE (LC::Azoth::ICLEntry,
        "org.Deviant.LeechCraft.Azoth.ICLEntry/1.0")