LeechCraft Monocle 0.6.70-17609-g3dde4097dd
Modular document viewer for LeechCraft
Loading...
Searching...
No Matches
LC::Monocle::ILink Class Referenceabstract

Base interface for links. More...

#include "ilink.h"

Public Member Functions

virtual ~ILink ()=default
 Virtual destructor.
 
virtual LinkType GetLinkType () const =0
 Returns the link type.
 
virtual PageRelativeRectBase GetArea () const =0
 Returns the area on the page of this link.
 
virtual LinkAction GetLinkAction () const =0
 Returns the link action.
 
virtual QString GetToolTip () const
 Returns the tooltip for the link.
 

Detailed Description

Base interface for links.

Links should implement this interface.

Definition at line 113 of file ilink.h.

Constructor & Destructor Documentation

◆ ~ILink()

virtual LC::Monocle::ILink::~ILink ( )
virtualdefault

Virtual destructor.

Member Function Documentation

◆ GetArea()

virtual PageRelativeRectBase LC::Monocle::ILink::GetArea ( ) const
pure virtual

Returns the area on the page of this link.

If the link doesn't belong to a page (i. e. is a TOC link) the return value isn't used and may be arbitrary.

Returns
The area of this link on its page.

◆ GetLinkAction()

virtual LinkAction LC::Monocle::ILink::GetLinkAction ( ) const
pure virtual

Returns the link action.

◆ GetLinkType()

virtual LinkType LC::Monocle::ILink::GetLinkType ( ) const
pure virtual

Returns the link type.

Returns
The type of this link.

◆ GetToolTip()

virtual QString LC::Monocle::ILink::GetToolTip ( ) const
inlinevirtual

Returns the tooltip for the link.

Definition at line 141 of file ilink.h.


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