Public Member Functions | List of all members
IndexIntf Class Referenceabstract

Abstract interface for index generators. More...

#include <index.h>

Inheritance diagram for IndexIntf:
DocSets EclipseHelp FTVHelp HtmlHelp IndexList Qhp

Public Member Functions

virtual ~IndexIntf ()
 
virtual void initialize ()=0
 
virtual void finalize ()=0
 
virtual void incContentsDepth ()=0
 
virtual void decContentsDepth ()=0
 
virtual void addContentsItem (bool isDir, const char *name, const char *ref, const char *file, const char *anchor, bool separateIndex, bool addToNavIndex, Definition *def)=0
 
virtual void addIndexItem (Definition *context, MemberDef *md, const char *sectionAnchor, const char *title)=0
 
virtual void addIndexFile (const char *name)=0
 
virtual void addImageFile (const char *name)=0
 
virtual void addStyleSheetFile (const char *name)=0
 

Detailed Description

Abstract interface for index generators.

Definition at line 30 of file index.h.

Constructor & Destructor Documentation

virtual IndexIntf::~IndexIntf ( )
inlinevirtual

Definition at line 33 of file index.h.

33 {}

Member Function Documentation

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

Implemented in IndexList, HtmlHelp, EclipseHelp, FTVHelp, DocSets, and Qhp.

virtual void IndexIntf::addImageFile ( const char *  name)
pure virtual

Implemented in IndexList, HtmlHelp, EclipseHelp, FTVHelp, DocSets, and Qhp.

virtual void IndexIntf::addIndexFile ( const char *  name)
pure virtual

Implemented in IndexList, HtmlHelp, EclipseHelp, FTVHelp, DocSets, and Qhp.

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

Implemented in IndexList, HtmlHelp, EclipseHelp, FTVHelp, DocSets, and Qhp.

virtual void IndexIntf::addStyleSheetFile ( const char *  name)
pure virtual

Implemented in IndexList, HtmlHelp, EclipseHelp, FTVHelp, DocSets, and Qhp.

virtual void IndexIntf::decContentsDepth ( )
pure virtual

Implemented in IndexList, HtmlHelp, EclipseHelp, FTVHelp, DocSets, and Qhp.

virtual void IndexIntf::finalize ( )
pure virtual

Implemented in IndexList, HtmlHelp, EclipseHelp, FTVHelp, DocSets, and Qhp.

virtual void IndexIntf::incContentsDepth ( )
pure virtual

Implemented in IndexList, HtmlHelp, EclipseHelp, FTVHelp, DocSets, and Qhp.

virtual void IndexIntf::initialize ( )
pure virtual

Implemented in IndexList, HtmlHelp, EclipseHelp, FTVHelp, DocSets, and Qhp.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.11