IndexIntf Class Reference

Abstract interface for index generators. More...

#include <index.h>

Inheritance diagram for IndexIntf:

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.

{}

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.

Referenced by IndexList::addContentsItem().

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

pure virtual

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

Referenced by IndexList::addImageFile().

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

pure virtual

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

Referenced by IndexList::addIndexFile().

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.

Referenced by IndexList::addIndexItem().

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

pure virtual

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

Referenced by IndexList::addStyleSheetFile().

virtual void IndexIntf::decContentsDepth ( )

pure virtual

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

Referenced by IndexList::decContentsDepth().

virtual void IndexIntf::finalize ( )

pure virtual

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

Referenced by IndexList::finalize().

virtual void IndexIntf::incContentsDepth ( )

pure virtual

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

Referenced by IndexList::incContentsDepth().

virtual void IndexIntf::initialize ( )

pure virtual

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

Referenced by IndexList::initialize().

---

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

• index.h