LeechCraft Monocle  0.6.70-6645-gcd10d7e
Modular document viewer for LeechCraft
LeechCraft::Monocle::ILink Class Referenceabstract

Base interface for links. More...

#include "ilink.h"

Public Member Functions

virtual ~ILink ()
 Virtual destructor. More...
 
virtual LinkType GetLinkType () const =0
 Returns the link type. More...
 
virtual QRectF GetArea () const =0
 Returns the area on the page of this link. More...
 
virtual void Execute ()=0
 Executes the link. More...
 

Detailed Description

Base interface for links.

Links should implement this interface.

See also
IPageLink

Definition at line 78 of file ilink.h.

Constructor & Destructor Documentation

virtual LeechCraft::Monocle::ILink::~ILink ( )
inlinevirtual

Virtual destructor.

Definition at line 83 of file ilink.h.

Member Function Documentation

virtual void LeechCraft::Monocle::ILink::Execute ( )
pure virtual

Executes the link.

This method is called to indicate that the user has chosen to execute the action related to the link.

virtual QRectF LeechCraft::Monocle::ILink::GetArea ( ) const
pure virtual

Returns the area on the page of this link.

The returned rectangle is in page's coordinates, that is, with width from 0 to page width and height from 0 to page height.

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.
virtual LinkType LeechCraft::Monocle::ILink::GetLinkType ( ) const
pure virtual

Returns the link type.

Returns
The type of this link.

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