LeechCraft Monocle  0.6.70-10870-g558588d6ec
Modular document viewer for LeechCraft
Public Member Functions | List of all members
LeechCraft::Monocle::IPageLink Class Referenceabstract

Additional interface for page links. More...

#include "ilink.h"

Public Member Functions

virtual ~IPageLink ()
 Virtual destructor. More...
 
virtual QString GetDocumentFilename () const =0
 The name of the document to open. More...
 
virtual int GetPageNumber () const =0
 Returns the index of the page this link refers to. More...
 
virtual double NewX () const =0
 Returns the new x coordinate of the viewport. More...
 
virtual double NewY () const =0
 Returns the new x coordinate of the viewport. More...
 
virtual double NewZoom () const =0
 Returns the new zoom value for the page. More...
 

Detailed Description

Additional interface for page links.

Links of type LinkType::PageLink should implement this interface in addition to ILink.

See also
ILink

Definition at line 119 of file ilink.h.

Constructor & Destructor Documentation

◆ ~IPageLink()

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

Virtual destructor.

Definition at line 124 of file ilink.h.

Member Function Documentation

◆ GetDocumentFilename()

virtual QString LeechCraft::Monocle::IPageLink::GetDocumentFilename ( ) const
pure virtual

The name of the document to open.

If the link is relative to the current document, this method returns an empty string.

Returns
The name of the document to open, or empty string for current document.

◆ GetPageNumber()

virtual int LeechCraft::Monocle::IPageLink::GetPageNumber ( ) const
pure virtual

Returns the index of the page this link refers to.

Returns
The index of the page this link refers to.

◆ NewX()

virtual double LeechCraft::Monocle::IPageLink::NewX ( ) const
pure virtual

Returns the new x coordinate of the viewport.

The returned value is in page's coordinates, that is, between 0 and the width of the page it belongs to.

Returns
The new x coordinate of the viewport in page.

◆ NewY()

virtual double LeechCraft::Monocle::IPageLink::NewY ( ) const
pure virtual

Returns the new x coordinate of the viewport.

The returned value is in page's coordinates, that is, between 0 and the width of the page it belongs to.

Returns
The new x coordinate of the viewport in page.

◆ NewZoom()

virtual double LeechCraft::Monocle::IPageLink::NewZoom ( ) const
pure virtual

Returns the new zoom value for the page.

Returns
The new zoom value.
The documentation for this class was generated from the following file: