iproxyobject.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 <optional>
#include <QString>
#include "azothcommon.h"
#include "ihaveavatars.h"

class QObject;

template<typename>
class QFuture;

namespace LC
{
namespace Util
{
    class ResourceLoader;
}

namespace Azoth
{
    struct InjectedMessage;
    class Hooks;

    class IFormatterProxyObject
    {
    public:
        virtual ~IFormatterProxyObject () {}

        virtual QList<QColor> GenerateColors (const QString& scheme, QColor bg) const = 0;

        virtual QString GetNickColor (const QString& nick, const QList<QColor>& colors) const = 0;

        virtual QString FormatNickname (QString nick, QObject *message, const QString& color) const = 0;

        virtual QString EscapeBody (QString body, IMessage::EscapePolicy) const = 0;

        virtual QString FormatBody (QString body, QObject *message, const QList<QColor>& coloring) const = 0;

        virtual void PreprocessMessage (QObject *message) = 0;

        virtual void FormatLinks (QString& body) = 0;

        virtual QStringList FindLinks (const QString&) = 0;
    };

    class IAvatarsManager
    {
    protected:
        virtual ~IAvatarsManager () {}
    public:
        virtual QFuture<QImage> GetAvatar (QObject *entryObj, IHaveAvatars::Size size) = 0;

        virtual QFuture<std::optional<QByteArray>> GetStoredAvatarData (const QString& entryId, IHaveAvatars::Size size) = 0;
    };

    class IProxyObject
    {
    public:
        virtual ~IProxyObject () {}

        enum PublicResourceLoader
        {
            PRLClientIcons,
            PRLStatusIcons,
            PRLSystemIcons
        };

        virtual QObject* GetSettingsManager () = 0;

        virtual void SetPassword (const QString& password, QObject *account) = 0;

        virtual QString GetAccountPassword (QObject *account, bool useStored = true) = 0;

        virtual bool IsAutojoinAllowed () = 0;

        virtual QString StateToString (State state) const = 0;

        virtual QByteArray AuthStatusToString (AuthStatus status) const = 0;

        virtual AuthStatus AuthStatusFromString (const QByteArray& str) const = 0;

        virtual QObject* GetAccount (const QString& accID) const = 0;

        virtual QList<QObject*> GetAllAccounts () const = 0;

        virtual QObject* GetEntry (const QString& entryID, const QString& accID = {}) const = 0;

        virtual void OpenChat (const QString& entryID,
                const QString& accID,
                const QString& message = QString (),
                const QString& variant = QString ()) const = 0;

        virtual QWidget* FindOpenedChat (const QString& entryID, const QByteArray& accID) const = 0;

        virtual Util::ResourceLoader* GetResourceLoader (PublicResourceLoader loader) const = 0;

        virtual QIcon GetIconForState (State state) const = 0;

        virtual void InjectMessage (ICLEntry&, const InjectedMessage&) = 0;

        virtual QString ToPlainBody (QString body) = 0;

        virtual bool IsMessageRead (QObject *msgObj) = 0;

        virtual void MarkMessagesAsRead (QObject *entryObject) = 0;

        virtual std::optional<CustomStatus> FindCustomStatus (const QString& name) const = 0;

        virtual QStringList GetCustomStatusNames () const = 0;

        virtual void RedrawItem (QObject*) const = 0;

        virtual QObject* GetFirstUnreadMessage (QObject *entryObj) const = 0;

        virtual QImage GetDefaultAvatar (int size = -1) const = 0;

        virtual IFormatterProxyObject& GetFormatterProxy () = 0;

        virtual IAvatarsManager* GetAvatarsManager () = 0;

        virtual Hooks& GetHooks () = 0;
    };
}
}

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