Skip to main content

The IndexIntf Class Reference

Abstract interface for index generators. More...

Declaration

class IndexIntf { ... }

Included Headers

#include <src/indexlist.h>

Derived Classes

classCrawlmap
classDocSets

A class that generates docset files. More...

classEclipseHelp

Generator for Eclipse help files. More...

classFTVHelp

A class that generates a dynamic tree view side panel. More...

classHtmlHelp

A class that generated the HTML Help specific files. More...

classQhp
classSitemap

Public Member Functions Index

voidinitialize ()=0
voidfinalize ()=0
voidincContentsDepth ()=0
voiddecContentsDepth ()=0
voidaddContentsItem (bool isDir, const QCString &name, const QCString &ref, const QCString &file, const QCString &anchor, bool separateIndex, bool addToNavIndex, const Definition *def, const QCString &nameAsHtml)=0
voidaddIndexItem (const Definition *context, const MemberDef *md, const QCString &sectionAnchor, const QCString &title)=0
voidaddIndexFile (const QCString &name)=0
voidaddImageFile (const QCString &)=0
voidaddStyleSheetFile (const QCString &)=0

Description

Abstract interface for index generators.

Definition at line 32 of file indexlist.h.

Public Member Functions

addContentsItem()

virtual void IndexIntf::addContentsItem (bool isDir, const QCString & name, const QCString & ref, const QCString & file, const QCString & anchor, bool separateIndex, bool addToNavIndex, const Definition * def, const QCString & nameAsHtml)

Definition at line 41 of file indexlist.h.

Reference addContentsItem.

Referenced by addContentsItem and IndexList::addContentsItem.

addImageFile()

virtual void IndexIntf::addImageFile (const QCString &)

Definition at line 54 of file indexlist.h.

Reference addImageFile.

Referenced by addImageFile and IndexList::addImageFile.

addIndexFile()

virtual void IndexIntf::addIndexFile (const QCString & name)

Definition at line 53 of file indexlist.h.

Reference addIndexFile.

Referenced by addIndexFile and IndexList::addIndexFile.

addIndexItem()

virtual void IndexIntf::addIndexItem (const Definition * context, const MemberDef * md, const QCString & sectionAnchor, const QCString & title)

Definition at line 51 of file indexlist.h.

Reference addIndexItem.

Referenced by addIndexItem and IndexList::addIndexItem.

addStyleSheetFile()

virtual void IndexIntf::addStyleSheetFile (const QCString &)

Definition at line 55 of file indexlist.h.

Reference addStyleSheetFile.

Referenced by addStyleSheetFile and IndexList::addStyleSheetFile.

decContentsDepth()

virtual void IndexIntf::decContentsDepth ()

Definition at line 40 of file indexlist.h.

Reference decContentsDepth.

Referenced by decContentsDepth and IndexList::decContentsDepth.

finalize()

virtual void IndexIntf::finalize ()

Definition at line 38 of file indexlist.h.

Reference finalize.

Referenced by finalize and IndexList::finalize.

incContentsDepth()

virtual void IndexIntf::incContentsDepth ()

Definition at line 39 of file indexlist.h.

Reference incContentsDepth.

Referenced by incContentsDepth and IndexList::incContentsDepth.

initialize()

virtual void IndexIntf::initialize ()

Definition at line 37 of file indexlist.h.

Reference initialize.

Referenced by initialize and IndexList::initialize.


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


Generated via doxygen2docusaurus by Doxygen 1.14.0.