iprotocol.h

Go to the documentation of this file.

/**********************************************************************
 * LeechCraft - modular cross-platform feature rich internet client.
 * Copyright (C) 2006-2014  Georg Rudoy
 *
 * Boost Software License - Version 1.0 - August 17th, 2003
 *
 * Permission is hereby granted, free of charge, to any person or organization
 * obtaining a copy of the software and accompanying documentation covered by
 * this license (the "Software") to use, reproduce, display, distribute,
 * execute, and transmit the Software, and to prepare derivative works of the
 * Software, and to permit third-parties to whom the Software is furnished to
 * do so, all subject to the following:
 *
 * The copyright notices in the Software and this entire statement, including
 * the above license grant, this restriction and the following disclaimer,
 * must be included in all copies of the Software, in whole or in part, and
 * all derivative works of the Software, unless such copies or derivative
 * works are solely in the form of machine-executable object code generated by
 * a source language processor.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
 * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
 * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 **********************************************************************/
 
#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")