ientitymanager.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 <QObject>

namespace LeechCraft
{
    struct Entity;
}

class Q_DECL_EXPORT IEntityManager
{
public:
    struct DelegationResult
    {
        QObject *Handler_ = nullptr;

        int ID_ = 0;

        DelegationResult () = default;

        DelegationResult (QObject *handler, int id)
        : Handler_ { handler }
        , ID_ { id }
        {
        }

        operator bool () const
        {
            return Handler_;
        }
    };

    virtual ~IEntityManager () {}

    virtual DelegationResult DelegateEntity (LeechCraft::Entity entity, QObject *desired = 0) = 0;

    virtual bool HandleEntity (LeechCraft::Entity entity, QObject *desired = 0) = 0;

    virtual bool CouldHandle (const LeechCraft::Entity& entity) = 0;

    virtual QList<QObject*> GetPossibleHandlers (const LeechCraft::Entity& entity) = 0;
};

Q_DECLARE_INTERFACE (IEntityManager, "org.Deviant.LeechCraft.IEntityManager/1.0")