iannotation.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 <QtPlugin>
#include <QMetaType>
#include "ilink.h"

class QDateTime;
class QPolygonF;

namespace LC
{
namespace Monocle
{
    enum class AnnotationType
    {
        Text,

        Highlight,

        Link,

        Caret,

        Other
    };

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

        virtual QString GetAuthor () const = 0;

        virtual QDateTime GetDate () const = 0;

        virtual PageRelativeRectBase GetBoundary () const = 0;

        virtual AnnotationType GetAnnotationType () const = 0;

        virtual QString GetText () const = 0;
    };

    class ITextAnnotation : public IAnnotation
    {
    public:
        virtual ~ITextAnnotation () {}

        virtual bool IsInline () const = 0;
    };

    class IHighlightAnnotation : public IAnnotation
    {
    public:
        virtual ~IHighlightAnnotation () {}

        virtual QList<QPolygonF> GetPolygons () const = 0;
    };

    class ILinkAnnotation : public IAnnotation
    {
    public:
        virtual ~ILinkAnnotation () {}

        virtual ILink_ptr GetLink () const = 0;
    };

    class ICaretAnnotation : public IAnnotation
    {
    public:
        virtual ~ICaretAnnotation () {}
    };

    typedef std::shared_ptr<IAnnotation> IAnnotation_ptr;
    typedef std::shared_ptr<ITextAnnotation> ITextAnnotation_ptr;
    typedef std::shared_ptr<IHighlightAnnotation> IHighlightAnnotation_ptr;
    typedef std::shared_ptr<ILinkAnnotation> ILinkAnnotation_ptr;
    typedef std::shared_ptr<ICaretAnnotation> ICaretAnnotation_ptr;
}
}

Q_DECLARE_METATYPE (LC::Monocle::IAnnotation_ptr)