doxygen  1.8.18
About: Doxygen is a source code documentation generator tool for C++, C, Objective-C, C#, PHP, Java, Python, IDL (diverse flavors), Fortran, VHDL, Tcl, and to some extent D. Different output formats are supported.
  Fossies Dox: doxygen-1.8.18.src.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

IndexIntf Class Referenceabstract

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, const Definition *def)=0
 
virtual void addIndexItem (const Definition *context, const 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 31 of file index.h.

Constructor & Destructor Documentation

◆ ~IndexIntf()

virtual IndexIntf::~IndexIntf ( )
inlinevirtual

Definition at line 34 of file index.h.

Member Function Documentation

◆ addContentsItem()

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

◆ addImageFile()

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

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

Referenced by IndexList::addImageFile().

◆ addIndexFile()

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

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

Referenced by IndexList::addIndexFile().

◆ addIndexItem()

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

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

Referenced by IndexList::addIndexItem().

◆ addStyleSheetFile()

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

◆ decContentsDepth()

virtual void IndexIntf::decContentsDepth ( )
pure virtual

◆ finalize()

virtual void IndexIntf::finalize ( )
pure virtual

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

Referenced by IndexList::finalize().

◆ incContentsDepth()

virtual void IndexIntf::incContentsDepth ( )
pure virtual

◆ initialize()

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: