iannotation.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 <QtPlugin>
#include <QMetaType>
#include "ilink.h"
 
class QRectF;
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 QRectF 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_INTERFACE (LC::Monocle::IAnnotation,
        "org.LeechCraft.Monocle.IAnnotation/1.0")
Q_DECLARE_INTERFACE (LC::Monocle::ITextAnnotation,
        "org.LeechCraft.Monocle.ITextAnnotation/1.0")
Q_DECLARE_INTERFACE (LC::Monocle::IHighlightAnnotation,
        "org.LeechCraft.Monocle.IHighlightAnnotation/1.0")
Q_DECLARE_INTERFACE (LC::Monocle::ILinkAnnotation,
        "org.LeechCraft.Monocle.ILinkAnnotation/1.0")
Q_DECLARE_INTERFACE (LC::Monocle::ICaretAnnotation,
        "org.LeechCraft.Monocle.ICaretAnnotation/1.0")
 
Q_DECLARE_METATYPE (LC::Monocle::IAnnotation_ptr)