LeechCraft Monocle  0.6.70-13729-g7046a9d2a7
Modular document viewer for LeechCraft
LC::Monocle::IHighlightAnnotation Class Referenceabstract

The interface for AnnotationType::Highlight annotations. More...

#include "iannotation.h"

+ Inheritance diagram for LC::Monocle::IHighlightAnnotation:
+ Collaboration diagram for LC::Monocle::IHighlightAnnotation:

Public Member Functions

virtual ~IHighlightAnnotation ()
 
virtual QList< QPolygonF > GetPolygons () const =0
 Returns the shape of the highlight. More...
 
- Public Member Functions inherited from LC::Monocle::IAnnotation
virtual ~IAnnotation ()
 
virtual QString GetAuthor () const =0
 Returns the author of the annotation. More...
 
virtual QDateTime GetDate () const =0
 Returns the date the annotation was created. More...
 
virtual QRectF GetBoundary () const =0
 Returns the bounding rectangle of the annotation. More...
 
virtual AnnotationType GetAnnotationType () const =0
 Returns the type of the annotation. More...
 
virtual QString GetText () const =0
 Returns the text contained in the annotation. More...
 

Detailed Description

The interface for AnnotationType::Highlight annotations.

Definition at line 149 of file iannotation.h.

Constructor & Destructor Documentation

◆ ~IHighlightAnnotation()

virtual LC::Monocle::IHighlightAnnotation::~IHighlightAnnotation ( )
inlinevirtual

Definition at line 152 of file iannotation.h.

Member Function Documentation

◆ GetPolygons()

virtual QList<QPolygonF> LC::Monocle::IHighlightAnnotation::GetPolygons ( ) const
pure virtual

Returns the shape of the highlight.

The shape of a single annotation is comprised of a list of polygons, each expected to be a closed shape. The polygons in the returned list can have both empty and non-empty pairwise intersections.

The points in the polygons should be in page coordinates, where (0; 0) is the top left corner, and (1; 1) is the bottom right corner.

The IAnnotation::GetBoundary() should return the bounding rectangle of the bounding rectangles of the polygons in the returned list.

Returns
The shape of the highlight on the page in page coordinates.

The documentation for this class was generated from the following file: