ibackendplugin.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 <QString>
#include <QMetaType>
#include "idocument.h"
 
namespace LC
{
namespace Monocle
{
    class IRedirectProxy;
    typedef std::shared_ptr<IRedirectProxy> IRedirectProxy_ptr;
 
    class IBackendPlugin
    {
    public:
        virtual ~IBackendPlugin () {}
 
        enum class LoadCheckResult
        {
            Cannot,
 
            Can,
 
            Redirect
        };
 
        virtual LoadCheckResult CanLoadDocument (const QString& filename) = 0;
 
        virtual IDocument_ptr LoadDocument (const QString& filename) = 0;
 
        virtual IRedirectProxy_ptr GetRedirection (const QString& filename)
        {
            Q_UNUSED (filename)
            return {};
        }
 
        virtual QStringList GetSupportedMimes () const = 0;
 
        virtual bool IsThreaded () const
        {
            return false;
        }
    };
}
}
 
Q_DECLARE_INTERFACE (LC::Monocle::IBackendPlugin,
        "org.LeechCraft.Monocle.IBackendPlugin/1.0")