A list of index interfaces. More...

#include <index.h>

Inheritance diagram for IndexList:

Public Member Functions
	IndexList ()

void	addIndex (IndexIntf *intf)

void	disable ()

void	enable ()

bool	isEnabled () const

void	initialize ()

void	finalize ()

void	incContentsDepth ()

void	decContentsDepth ()

void	addContentsItem (bool isDir, const char name, const char ref, const char file, const char anchor, bool separateIndex=FALSE, bool addToNavIndex=FALSE, Definition *def=0)

void	addIndexItem (Definition context, MemberDef md, const char sectionAnchor=0, const char title=0)

void	addIndexFile (const char *name)

void	addImageFile (const char *name)

void	addStyleSheetFile (const char *name)

Public Member Functions inherited from IndexIntf
virtual	~IndexIntf ()

Private Member Functions
void	foreach (void(IndexIntf::*methodPtr)())

template<typename A1 >
void	foreach (void(IndexIntf::*methodPtr)(A1), A1 a1)

template<typename A1 , typename A2 , typename A3 >
void	foreach (void(IndexIntf::*methodPtr)(A1, A2, A3), A1 a1, A2 a2, A3 a3)

template<typename A1 , typename A2 , typename A3 , typename A4 >
void	foreach (void(IndexIntf::*methodPtr)(A1, A2, A3, A4), A1 a1, A2 a2, A3 a3, A4 a4)

template<typename A1 , typename A2 , typename A3 , typename A4 , typename A5 >
void	foreach (void(IndexIntf::*methodPtr)(A1, A2, A3, A4, A5), A1 a1, A2 a2, A3 a3, A4 a4, A5 a5)

template<typename A1 , typename A2 , typename A3 , typename A4 , typename A5 , typename A6 >
void	foreach (void(IndexIntf::*methodPtr)(A1, A2, A3, A4, A5, A6), A1 a1, A2 a2, A3 a3, A4 a4, A5 a5, A6 a6)

template<typename A1 , typename A2 , typename A3 , typename A4 , typename A5 , typename A6 , typename A7 , typename A8 >
void	foreach (void(IndexIntf::*methodPtr)(A1, A2, A3, A4, A5, A6, A7, A8), A1 a1, A2 a2, A3 a3, A4 a4, A5 a5, A6 a6, A7 a7, A8 a8)

template<typename A1 , typename A2 , typename A3 , typename A4 , typename A5 , typename A6 , typename A7 , typename A8 , typename A9 >
void	foreach (void(IndexIntf::*methodPtr)(A1, A2, A3, A4, A5, A6, A7, A8, A9), A1 a1, A2 a2, A3 a3, A4 a4, A5 a5, A6 a6, A7 a7, A8 a8, A9 a9)

Private Attributes
QList< IndexIntf >	m_intfs

bool	m_enabled

Detailed Description

A list of index interfaces.

This class itself implements all methods of IndexIntf and just forwards the calls to all items in the list.

Definition at line 53 of file index.h.

Constructor & Destructor Documentation

IndexList::IndexList ( )

inline

Creates a list of indexes

Definition at line 117 of file index.h.

References m_enabled, and m_intfs.

{ m_intfs.setAutoDelete(TRUE); m_enabled=TRUE; }

Member Function Documentation

void IndexList::addContentsItem	(	bool	isDir,
		const char *	name,
		const char *	ref,
		const char *	file,
		const char *	anchor,
		bool	separateIndex = `FALSE`,
		bool	addToNavIndex = `FALSE`,
		Definition *	def = `0`
	)

inlinevirtual

Implements IndexIntf.

Definition at line 137 of file index.h.

References IndexIntf::addContentsItem(), and m_enabled.

Referenced by addMembersToIndex(), Definition::addSectionsToIndex(), writeAlphabeticalIndex(), writeAnnotatedIndex(), writeClassMemberIndex(), writeClassMemberIndexFiltered(), writeClassTree(), writeClassTreeForList(), writeDirHierarchy(), writeDirTreeNode(), writeExampleIndex(), writeFileIndex(), writeFileMemberIndex(), writeFileMemberIndexFiltered(), writeGroupIndex(), writeGroupTreeNode(), writeHierarchicalIndex(), writeIndex(), writeIndexHierarchyEntries(), writeNamespaceIndex(), writeNamespaceMemberIndex(), writeNamespaceMemberIndexFiltered(), writeNamespaceTree(), and writePages().

{ if (m_enabled) foreach<bool,const char *,const char *,const char *,const char*,bool,bool,Definition *>

(&IndexIntf::addContentsItem,isDir,name,ref,file,anchor,separateIndex,addToNavIndex,def); }

void IndexList::addImageFile ( const char * name )

inlinevirtual

Implements IndexIntf.

Definition at line 147 of file index.h.

References IndexIntf::addImageFile(), and m_enabled.

Referenced by copyExtraFiles(), copyLogo(), DotGfxHierarchyTable::createGraph(), findAndCopyImage(), FormulaList::generateBitmaps(), generateGraphLegend(), writeColoredImgData(), writeDotGraphFromFile(), DotClassGraph::writeGraph(), DotInclDepGraph::writeGraph(), DotCallGraph::writeGraph(), DotDirDeps::writeGraph(), ClassDiagram::writeImage(), and HtmlGenerator::writeSearchData().

{ if (m_enabled) foreach<const char *>(&IndexIntf::addImageFile,name); }

void IndexList::addIndex ( IndexIntf * intf )

inline

Add an index generator to the list

Definition at line 119 of file index.h.

References m_intfs.

Referenced by generateOutput().

{ m_intfs.append(intf); }

void IndexList::addIndexFile ( const char * name )

inlinevirtual

Implements IndexIntf.

Definition at line 145 of file index.h.

References IndexIntf::addIndexFile(), and m_enabled.

Referenced by HtmlGenerator::startFile().

{ if (m_enabled) foreach<const char *>(&IndexIntf::addIndexFile,name); }

void IndexList::addIndexItem	(	Definition *	context,
		MemberDef *	md,
		const char *	sectionAnchor = `0`,
		const char *	title = `0`
	)

inlinevirtual

Implements IndexIntf.

Definition at line 142 of file index.h.

References IndexIntf::addIndexItem(), and m_enabled.

Referenced by MemberDef::_writeEnumValues(), HtmlDocVisitor::visit(), MemberDef::writeDeclaration(), NamespaceDef::writeDocumentation(), PageDef::writeDocumentation(), GroupDef::writeDocumentation(), and ClassDef::writeDocumentationContents().

{ if (m_enabled) foreach<Definition *,MemberDef *,const char *,const char *>

(&IndexIntf::addIndexItem,context,md,sectionAnchor,title); }

void IndexList::addStyleSheetFile ( const char * name )

inlinevirtual

Implements IndexIntf.

Definition at line 149 of file index.h.

References IndexIntf::addStyleSheetFile(), and m_enabled.

Referenced by writeJavascriptSearchIndex(), HtmlGenerator::writeSearchData(), HtmlGenerator::writeStyleInfo(), and HtmlGenerator::writeTabData().

{ if (m_enabled) foreach<const char *>(&IndexIntf::addStyleSheetFile,name); }

void IndexList::decContentsDepth ( )

inlinevirtual

Implements IndexIntf.

Definition at line 135 of file index.h.

References IndexIntf::decContentsDepth(), and m_enabled.

Referenced by addMembersToIndex(), Definition::addSectionsToIndex(), writeAnnotatedIndex(), writeClassHierarchy(), writeClassMemberIndex(), writeClassMemberIndexFiltered(), writeClassTree(), writeDirTreeNode(), writeExampleIndex(), writeFileIndex(), writeFileMemberIndex(), writeFileMemberIndexFiltered(), writeGroupIndex(), writeGroupTreeNode(), writeIndexHierarchyEntries(), writeNamespaceIndex(), writeNamespaceMemberIndex(), writeNamespaceMemberIndexFiltered(), writeNamespaceTree(), and writePages().

{ if (m_enabled) foreach(&IndexIntf::decContentsDepth); }

void IndexList::disable ( )

inline

Definition at line 121 of file index.h.

References m_enabled.

Referenced by writeAnnotatedIndex(), writeGroupIndex(), and writeHierarchicalIndex().

{ m_enabled = FALSE; }

void IndexList::enable ( )

inline

Definition at line 123 of file index.h.

References m_enabled.

Referenced by writeAnnotatedIndex(), writeGroupIndex(), and writeHierarchicalIndex().

{ m_enabled = TRUE; }

void IndexList::finalize ( )

inlinevirtual

Implements IndexIntf.

Definition at line 131 of file index.h.

References IndexIntf::finalize().

Referenced by generateOutput().

{ foreach(&IndexIntf::finalize); }

void IndexList::foreach ( void(IndexIntf::*)() methodPtr )

inlineprivate

Definition at line 60 of file index.h.

References m_intfs.

    {
      QListIterator<IndexIntf> li(m_intfs);
      for (li.toFirst();li.current();++li) (li.current()->*methodPtr)();
    }

template<typename A1 >

void IndexList::foreach	(	void(IndexIntf::*)(A1)	methodPtr,
		A1	a1
	)

inlineprivate

Definition at line 67 of file index.h.

References m_intfs.

    {
      QListIterator<IndexIntf> li(m_intfs);
      for (li.toFirst();li.current();++li) (li.current()->*methodPtr)(a1);
    }

template<typename A1 , typename A2 , typename A3 >

void IndexList::foreach	(	void(IndexIntf::*)(A1, A2, A3)	methodPtr,
		A1	a1,
		A2	a2,
		A3	a3
	)

inlineprivate

Definition at line 74 of file index.h.

References m_intfs.

    {
      QListIterator<IndexIntf> li(m_intfs);
      for (li.toFirst();li.current();++li) (li.current()->*methodPtr)(a1,a2,a3);
    }

template<typename A1 , typename A2 , typename A3 , typename A4 >

void IndexList::foreach	(	void(IndexIntf::*)(A1, A2, A3, A4)	methodPtr,
		A1	a1,
		A2	a2,
		A3	a3,
		A4	a4
	)

inlineprivate

Definition at line 81 of file index.h.

References m_intfs.

    {
      QListIterator<IndexIntf> li(m_intfs);
      for (li.toFirst();li.current();++li) (li.current()->*methodPtr)(a1,a2,a3,a4);
    }

template<typename A1 , typename A2 , typename A3 , typename A4 , typename A5 >

void IndexList::foreach	(	void(IndexIntf::*)(A1, A2, A3, A4, A5)	methodPtr,
		A1	a1,
		A2	a2,
		A3	a3,
		A4	a4,
		A5	a5
	)

inlineprivate

Definition at line 88 of file index.h.

References m_intfs.

    {
      QListIterator<IndexIntf> li(m_intfs);
      for (li.toFirst();li.current();++li) (li.current()->*methodPtr)(a1,a2,a3,a4,a5);
    }

template<typename A1 , typename A2 , typename A3 , typename A4 , typename A5 , typename A6 >

void IndexList::foreach	(	void(IndexIntf::*)(A1, A2, A3, A4, A5, A6)	methodPtr,
		A1	a1,
		A2	a2,
		A3	a3,
		A4	a4,
		A5	a5,
		A6	a6
	)

inlineprivate

Definition at line 95 of file index.h.

References m_intfs.

    {
      QListIterator<IndexIntf> li(m_intfs);
      for (li.toFirst();li.current();++li) (li.current()->*methodPtr)(a1,a2,a3,a4,a5,a6);
    }

template<typename A1 , typename A2 , typename A3 , typename A4 , typename A5 , typename A6 , typename A7 , typename A8 >

void IndexList::foreach	(	void(IndexIntf::*)(A1, A2, A3, A4, A5, A6, A7, A8)	methodPtr,
		A1	a1,
		A2	a2,
		A3	a3,
		A4	a4,
		A5	a5,
		A6	a6,
		A7	a7,
		A8	a8
	)

inlineprivate

Definition at line 102 of file index.h.

References m_intfs.

    {
      QListIterator<IndexIntf> li(m_intfs);
      for (li.toFirst();li.current();++li) (li.current()->*methodPtr)(a1,a2,a3,a4,a5,a6,a7,a8);
    }

template<typename A1 , typename A2 , typename A3 , typename A4 , typename A5 , typename A6 , typename A7 , typename A8 , typename A9 >

void IndexList::foreach	(	void(IndexIntf::*)(A1, A2, A3, A4, A5, A6, A7, A8, A9)	methodPtr,
		A1	a1,
		A2	a2,
		A3	a3,
		A4	a4,
		A5	a5,
		A6	a6,
		A7	a7,
		A8	a8,
		A9	a9
	)

inlineprivate

Definition at line 109 of file index.h.

References m_intfs.

    {
      QListIterator<IndexIntf> li(m_intfs);
      for (li.toFirst();li.current();++li) (li.current()->*methodPtr)(a1,a2,a3,a4,a5,a6,a7,a8,a9);
    }