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

Implemented by documents whose pages can change dynamically. More...

#include "idynamicdocument.h"

Public Member Functions

virtual ~IDynamicDocument ()
 Virtual destructor. More...
 

Protected Member Functions

virtual void pageSizeChanged (int page)=0
 Emitted when the size of the given page is changed. More...
 
virtual void pageContentsChanged (int page)=0
 Emitted when contents of the given page are changed. More...
 

Detailed Description

Implemented by documents whose pages can change dynamically.

This interface should be implemented by documents whose pages can change "themselves", including only page sizes and page contents. Changes in forms, annotations and links (if any) should be propagated via the corresponding classes.

The primary use of this interface is for format backends that load the documents asynchronously. An example of such backend is the DjVuLibre-based Seen plugin.

This class has some signals, and one can use the IDocument::GetQObject() method to get an object of this class as a QObject and connect to those signals:

IDynamicDocument *idd = ...;
connect (dynamic_cast<IDocument*> (idd)->GetQObject (),
SIGNAL (pageSizeChanged (int)),
this,
SLOT (handlePageSizeChanged (int)));

Definition at line 60 of file idynamicdocument.h.

Constructor & Destructor Documentation

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

Virtual destructor.

Definition at line 65 of file idynamicdocument.h.

References pageContentsChanged(), pageSizeChanged(), and Q_DECLARE_INTERFACE().

+ Here is the call graph for this function:

Member Function Documentation

virtual void LeechCraft::Monocle::IDynamicDocument::pageContentsChanged ( int  page)
protectedpure virtual

Emitted when contents of the given page are changed.

The page should typically be re-rendered after this signal.

Parameters
[out]pageThe index of the page that has been changed.

Referenced by ~IDynamicDocument().

+ Here is the caller graph for this function:

virtual void LeechCraft::Monocle::IDynamicDocument::pageSizeChanged ( int  page)
protectedpure virtual

Emitted when the size of the given page is changed.

The signal is emitted after the new size is known, so IDocument::GetPageSize(page) should already return the new value.

Parameters
[out]pageThe index of the page that has been changed.

Referenced by ~IDynamicDocument().

+ Here is the caller graph for this function:


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