iprotocol.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>
 
class QObject;
class QIcon;
 
namespace LC
{
namespace Azoth
{
    class IAccount;
    class IProtocolPlugin;

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

        enum ProtocolFeature
        {
            PFNone = 0x0,

            PFSupportsMUCs = 0x01,

            PFMUCsJoinable = 0x02,

            PFSupportsInBandRegistration = 0x04,

            PFNoAccountRegistration = 0x08
        };
 
        Q_DECLARE_FLAGS (ProtocolFeatures, ProtocolFeature)
 
        
        enum AccountAddOption
        {
            AAONoOptions = 0,

            AAORegisterNewAccount = 0x01
        };
 
        Q_DECLARE_FLAGS (AccountAddOptions, AccountAddOption)
 
        
        virtual QObject* GetQObject () = 0;

        virtual ProtocolFeatures GetFeatures () const = 0;

        virtual QList<QObject*> GetRegisteredAccounts () = 0;

        virtual QObject* GetParentProtocolPlugin () const = 0;

        virtual QString GetProtocolName () const = 0;

        virtual QIcon GetProtocolIcon () const = 0;

        virtual QByteArray GetProtocolID () const = 0;

        virtual QList<QWidget*> GetAccountRegistrationWidgets (AccountAddOptions options) = 0;

        virtual void RegisterAccount (const QString& name, const QList<QWidget*>& widgets) = 0;

        virtual void RemoveAccount (QObject *account) = 0;

        virtual void accountAdded (QObject *account) = 0;

        virtual void accountRemoved (QObject *account) = 0;
    };
}
}
 
Q_DECLARE_METATYPE (LC::Azoth::IProtocol*)
Q_DECLARE_OPERATORS_FOR_FLAGS (LC::Azoth::IProtocol::ProtocolFeatures)
Q_DECLARE_INTERFACE (LC::Azoth::IProtocol,
        "org.Deviant.LeechCraft.Azoth.IProtocol/1.0")