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

class QUrl;

template<typename>
class QFuture;

namespace LeechCraft
{
namespace Monocle
{
    struct DocumentInfo
    {
        QString Title_;
        QString Subject_;
        QString Description_;
        QString Author_;

        QStringList Genres_;
        QStringList Keywords_;

        QDateTime Date_;
    };

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

        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;
    protected:
        virtual void navigateRequested (const QString& filename, int pageNum, double x, double y) = 0;

        virtual void printRequested (const QList<int>& pages) = 0;
    };

    typedef std::shared_ptr<IDocument> IDocument_ptr;
}
}

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