IndexList类 参考

A list of index interfaces. 更多...

#include <index.h>

类 IndexList 继承关系图:

IndexList 的协作图:

Public 成员函数
	IndexList ()
	Creates a list of indexes 更多...
template<class T , class... As>
void	addIndex (As &&... args)
	Add an index generator to the list, using a syntax similar to std::make_unique<T>() 更多...
void	disable ()
void	enable ()
bool	isEnabled () const
void	initialize ()
void	finalize ()
void	incContentsDepth ()
void	decContentsDepth ()
void	addContentsItem (bool isDir, const QCString &name, const QCString &ref, const QCString &file, const QCString &anchor, bool separateIndex=FALSE, bool addToNavIndex=FALSE, const Definition *def=0)
void	addIndexItem (const Definition *context, const MemberDef *md, const QCString &sectionAnchor=QCString(), const QCString &title=QCString())
void	addIndexFile (const QCString &name)
void	addImageFile (const QCString &name)
void	addStyleSheetFile (const QCString &name)
Public 成员函数 继承自 IndexIntf
virtual	~IndexIntf ()

Private 成员函数
template<class... Ts, class... As>
void	foreach (void(IndexIntf::*methodPtr)(Ts...), As &&... args)

Private 属性
std::vector< std::unique_ptr< IndexIntf > >	m_intfs
bool	m_enabled

详细描述

A list of index interfaces.

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

在文件 index.h 第 55 行定义.

构造及析构函数说明

IndexList()

IndexList::IndexList ( )

inline

Creates a list of indexes

在文件 index.h 第 74 行定义.

{ m_enabled=TRUE; }

引用了 m_enabled , 以及 TRUE.

成员函数说明

addContentsItem()

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

inlinevirtual

实现了 IndexIntf.

在文件 index.h 第 97 行定义.

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

引用了 IndexIntf::addContentsItem() , 以及 m_enabled.

被这些函数引用 addMembersToIndex(), DefinitionImpl::addSectionsToIndex(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedIndexGeneric(), writeClassMemberIndex(), writeClassMemberIndexFiltered(), writeClassTreeForList(), writeClassTreeInsideNamespaceElement(), writeClassTreeToOutput(), writeConceptIndex(), writeConceptList(), writeConceptRootList(), writeConceptTreeInsideNamespaceElement(), writeDirHierarchy(), writeDirTreeNode(), writeExampleIndex(), writeFileIndex(), writeFileMemberIndex(), writeFileMemberIndexFiltered(), writeGroupIndex(), writeGroupTreeNode(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), writeIndex(), writeIndexHierarchyEntries(), writeMemberToIndex(), writeNamespaceIndex(), writeNamespaceMemberIndex(), writeNamespaceMemberIndexFiltered(), writeNamespaceTreeElement() , 以及 writePages().

addImageFile()

void IndexList::addImageFile ( const QCString &  name )

inlinevirtual

实现了 IndexIntf.

在文件 index.h 第 105 行定义.

    { if (m_enabled) foreach(&IndexIntf::addImageFile,name); }

引用了 IndexIntf::addImageFile() , 以及 m_enabled.

被这些函数引用 copyExtraFiles(), copyLogo(), DocParser::findAndCopyImage(), FormulaManager::generateImages(), PlantumlManager::generatePlantUMLOutput(), writeColoredImgData(), writeDotGraphFromFile(), DotGraph::writeGraph(), ClassDiagram::writeImage(), writeMscGraphFromFile(), HtmlGenerator::writeSearchData() , 以及 HtmlGenerator::writeTabData().

addIndex()

template<class T , class... As>

void IndexList::addIndex ( As &&...  args )

inline

Add an index generator to the list, using a syntax similar to std::make_unique<T>()

在文件 index.h 第 78 行定义.

    { m_intfs.push_back(std::make_unique<T>(std::forward<As>(args)...)); }

引用了 m_intfs.

被这些函数引用 parseInput().

addIndexFile()

void IndexList::addIndexFile ( const QCString &  name )

inlinevirtual

实现了 IndexIntf.

在文件 index.h 第 103 行定义.

    { if (m_enabled) foreach(&IndexIntf::addIndexFile,name); }

引用了 IndexIntf::addIndexFile() , 以及 m_enabled.

被这些函数引用 HtmlGenerator::startFile().

addIndexItem()

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

inlinevirtual

实现了 IndexIntf.

在文件 index.h 第 101 行定义.

    { if (m_enabled) foreach(&IndexIntf::addIndexItem,context,md,sectionAnchor,title); }

引用了 IndexIntf::addIndexItem() , 以及 m_enabled.

被这些函数引用 addToIndices() , 以及 HtmlDocVisitor::visit().

addStyleSheetFile()

void IndexList::addStyleSheetFile ( const QCString &  name )

inlinevirtual

实现了 IndexIntf.

在文件 index.h 第 107 行定义.

    { if (m_enabled) foreach(&IndexIntf::addStyleSheetFile,name); }

引用了 IndexIntf::addStyleSheetFile() , 以及 m_enabled.

被这些函数引用 writeJavaScriptSearchIndex(), HtmlGenerator::writeSearchData(), HtmlGenerator::writeStyleInfo() , 以及 HtmlGenerator::writeTabData().

decContentsDepth()

void IndexList::decContentsDepth ( )

inlinevirtual

实现了 IndexIntf.

在文件 index.h 第 95 行定义.

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

引用了 IndexIntf::decContentsDepth() , 以及 m_enabled.

被这些函数引用 addMembersToIndex(), DefinitionImpl::addSectionsToIndex(), writeAnnotatedIndexGeneric(), writeClassHierarchy(), writeClassMemberIndex(), writeClassMemberIndexFiltered(), writeClassTreeInsideNamespaceElement(), writeClassTreeToOutput(), writeConceptIndex(), writeConceptTreeInsideNamespaceElement(), writeDirTreeNode(), writeExampleIndex(), writeFileIndex(), writeFileMemberIndex(), writeFileMemberIndexFiltered(), writeGroupIndex(), writeGroupTreeNode(), writeIndexHierarchyEntries(), writeMemberToIndex(), writeNamespaceIndex(), writeNamespaceMemberIndex(), writeNamespaceMemberIndexFiltered(), writeNamespaceTreeElement() , 以及 writePages().

disable()

void IndexList::disable ( )

inline

在文件 index.h 第 81 行定义.

    { m_enabled = FALSE; }

引用了 FALSE , 以及 m_enabled.

被这些函数引用 writeAnnotatedIndexGeneric(), writeGroupIndex(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex() , 以及 writeHierarchicalInterfaceIndex().

enable()

void IndexList::enable ( )

inline

在文件 index.h 第 83 行定义.

    { m_enabled = TRUE; }

引用了 m_enabled , 以及 TRUE.

被这些函数引用 writeAnnotatedIndexGeneric(), writeGroupIndex(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex() , 以及 writeHierarchicalInterfaceIndex().

finalize()

void IndexList::finalize ( )

inlinevirtual

实现了 IndexIntf.

在文件 index.h 第 91 行定义.

    { foreach(&IndexIntf::finalize); }

引用了 IndexIntf::finalize().

被这些函数引用 generateOutput().

foreach()

template<class... Ts, class... As>

void IndexList::foreach ( void(IndexIntf::*)(Ts...)  methodPtr, As &&...  args  )

inlineprivate

在文件 index.h 第 64 行定义.

    {
      for (const auto &intf : m_intfs)
      {
        (intf.get()->*methodPtr)(std::forward<As>(args)...);
      }
    }

引用了 m_intfs.

incContentsDepth()

void IndexList::incContentsDepth ( )

inlinevirtual

实现了 IndexIntf.

在文件 index.h 第 93 行定义.

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

引用了 IndexIntf::incContentsDepth() , 以及 m_enabled.

被这些函数引用 addMembersToIndex(), DefinitionImpl::addSectionsToIndex(), writeAnnotatedIndexGeneric(), writeClassMemberIndex(), writeClassMemberIndexFiltered(), writeClassTreeForList(), writeClassTreeInsideNamespaceElement(), writeClassTreeToOutput(), writeConceptIndex(), writeConceptTreeInsideNamespaceElement(), writeDirTreeNode(), writeExampleIndex(), writeFileIndex(), writeFileMemberIndex(), writeFileMemberIndexFiltered(), writeGroupIndex(), writeGroupTreeNode(), writeIndexHierarchyEntries(), writeMemberToIndex(), writeNamespaceIndex(), writeNamespaceMemberIndex(), writeNamespaceMemberIndexFiltered(), writeNamespaceTreeElement() , 以及 writePages().

initialize()

void IndexList::initialize ( )

inlinevirtual

实现了 IndexIntf.

在文件 index.h 第 89 行定义.

    { foreach(&IndexIntf::initialize); }

引用了 IndexIntf::initialize().

被这些函数引用 parseInput().

isEnabled()

bool IndexList::isEnabled ( ) const

inline

在文件 index.h 第 85 行定义.

    { return m_enabled; }

引用了 m_enabled.

类成员变量说明

m_enabled

bool IndexList::m_enabled

private

在文件 index.h 第 111 行定义.

被这些函数引用 addContentsItem(), addImageFile(), addIndexFile(), addIndexItem(), addStyleSheetFile(), decContentsDepth(), disable(), enable(), incContentsDepth(), IndexList() , 以及 isEnabled().

m_intfs

std::vector< std::unique_ptr<IndexIntf> > IndexList::m_intfs

private

在文件 index.h 第 58 行定义.

被这些函数引用 addIndex() , 以及 foreach().

---

该类的文档由以下文件生成:

• src/index.h