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

Base interface for annotations. More...

#include "iannotation.h"

+ Inheritance diagram for LC::Monocle::IAnnotation:

Public Member Functions

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

Base interface for annotations.

This interface should be implemented by all annotation objects. In fact, exact annotation interfaces all derive from this one, so there is no need in deriving from this one explicitly.

See also
ITextAnnotation, IHighlightAnnotation, ILinkAnnotation

Definition at line 86 of file iannotation.h.

Constructor & Destructor Documentation

◆ ~IAnnotation()

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

Definition at line 89 of file iannotation.h.

Member Function Documentation

◆ GetAnnotationType()

virtual AnnotationType LC::Monocle::IAnnotation::GetAnnotationType ( ) const
pure virtual

Returns the type of the annotation.

Returns
The type of the annotation.

◆ GetAuthor()

virtual QString LC::Monocle::IAnnotation::GetAuthor ( ) const
pure virtual

Returns the author of the annotation.

Returns
The name of the author of the annotation.

◆ GetBoundary()

virtual QRectF LC::Monocle::IAnnotation::GetBoundary ( ) const
pure virtual

Returns the bounding rectangle of the annotation.

This method should return the bounding rectangle in page coordinates, where (0; 0) is the top left corner, and (1; 1) is the bottom right corner.

Returns
The annotation rect in page coordinates.

◆ GetDate()

virtual QDateTime LC::Monocle::IAnnotation::GetDate ( ) const
pure virtual

Returns the date the annotation was created.

If the date is unknown or not applicable, an invalid QDateTime object should be returned.

Returns
The timestamp of the annotation.

◆ GetText()

virtual QString LC::Monocle::IAnnotation::GetText ( ) const
pure virtual

Returns the text contained in the annotation.

Returns
The text of the annotation (or an empty string if not applicable).

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