idocument.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 <memory>
#include <QImage>
#include <QMetaType>
#include <QStringList>
#include <QDateTime>
#include "ilink.h"

class QUrl;

template<typename>
class QFuture;

namespace LC::Monocle
{
    struct DocumentInfo
    {
        QString Title_;
        QString Subject_;
        QString Description_;
        QString Author_;

        QStringList Genres_;
        QStringList Keywords_;

        QDateTime Date_;
    };

    class DocumentSignals;

    class IDocument
    {
    public:
        virtual ~IDocument () = default;

        virtual QObject* GetBackendPlugin () const = 0;

        virtual QObject* GetQObject () = 0;

        virtual bool IsValid () const = 0;

        virtual DocumentInfo GetDocumentInfo () const = 0;

        virtual int GetNumPages () const = 0;

        virtual QSize GetPageSize (int page) const = 0;

        virtual QFuture<QImage> RenderPage (int page, double xScale, double yScale) = 0;

        virtual QList<ILink_ptr> GetPageLinks (int page) = 0;

        virtual QUrl GetDocURL () const = 0;

        virtual const DocumentSignals* GetDocumentSignals () const = 0;
    };

    typedef std::shared_ptr<IDocument> IDocument_ptr;
}


Q_DECLARE_INTERFACE (LC::Monocle::IDocument,
        "org.LeechCraft.Monocle.IDocument/1.0")