LeechCraft Monocle  %{LEECHCRAFT_VERSION}
Modular document viewer for LeechCraft
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator
LeechCraft::Monocle::IHaveTOC Class Referenceabstract

Interface for documents supporting table of contents. More...

#include "ihavetoc.h"

Public Member Functions

virtual ~IHaveTOC ()
 Virtual destructor. More...
 
virtual TOCEntryLevel_t GetTOC ()=0
 Returns the root level of the TOC. More...
 

Detailed Description

Interface for documents supporting table of contents.

This interface should be implemented by the documents of formats supporting having table of contents.

Definition at line 70 of file ihavetoc.h.

Constructor & Destructor Documentation

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

Virtual destructor.

Definition at line 75 of file ihavetoc.h.

Member Function Documentation

virtual TOCEntryLevel_t LeechCraft::Monocle::IHaveTOC::GetTOC ( )
pure virtual

Returns the root level of the TOC.

If the root level is empty, there is no table of contents for this document.

Returns
Returns the root level of the TOC.

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