LayoutDocManager类 参考

Singleton providing access to the (user configurable) layout of the documentation 更多...

#include <layout.h>

类
class	Private

Public 类型
enum	LayoutPart {   Class, Concept, Namespace, File,   Group, Directory, NrParts }

Public 成员函数
const LayoutDocEntryList &	docEntries (LayoutPart part) const
	Returns the list of LayoutDocEntry's in representation order for a given page identified by part. 更多...
LayoutNavEntry *	rootNavEntry () const
	returns the (invisible) root of the navigation tree. 更多...
void	parse (const QCString &fileName)
	Parses a user provided layout 更多...
void	init ()

静态 Public 成员函数
static LayoutDocManager &	instance ()
	Returns a reference to this singleton. 更多...

Private 成员函数
void	addEntry (LayoutPart p, LayoutDocEntry *e)
void	clear (LayoutPart p)
	LayoutDocManager ()
	~LayoutDocManager ()

Private 属性
std::unique_ptr< Private >	d

友元
class	LayoutParser

详细描述

Singleton providing access to the (user configurable) layout of the documentation

在文件 layout.h 第 197 行定义.

成员枚举类型说明

LayoutPart

enum LayoutDocManager::LayoutPart

枚举值
Class
Concept
Namespace
File
Group
Directory
NrParts

在文件 layout.h 第 201 行定义.

    {
      Class, Concept, Namespace, File, Group, Directory,
      NrParts
    };

构造及析构函数说明

LayoutDocManager()

LayoutDocManager::LayoutDocManager ( )

private

在文件 layout.cpp 第 1550 行定义.

                                   : d(std::make_unique<Private>())
{
  d->rootNav = new LayoutNavEntry;
}

引用了 d.

被这些函数引用 instance().

~LayoutDocManager()

LayoutDocManager::~LayoutDocManager ( )

private

在文件 layout.cpp 第 1569 行定义.

{
  delete d->rootNav;
}

引用了 d.

成员函数说明

addEntry()

void LayoutDocManager::addEntry ( LayoutDocManager::LayoutPart  p, LayoutDocEntry *  e  )

private

在文件 layout.cpp 第 1590 行定义.

{
  d->docEntries[(int)p].push_back(std::unique_ptr<LayoutDocEntry>(e));
}

引用了 d.

被这些函数引用 LayoutParser::endMemberDecl(), LayoutParser::endMemberDef(), LayoutParser::startMemberDecl(), LayoutParser::startMemberDeclEntry(), LayoutParser::startMemberDef(), LayoutParser::startMemberDefEntry(), LayoutParser::startSectionEntry() , 以及 LayoutParser::startSimpleEntry().

clear()

void LayoutDocManager::clear ( LayoutDocManager::LayoutPart  p )

private

在文件 layout.cpp 第 1595 行定义.

{
  d->docEntries[(int)p].clear();
}

引用了 d.

被这些函数引用 LayoutParser::startClass(), LayoutParser::startConcept(), LayoutParser::startDirectory(), LayoutParser::startFile(), LayoutParser::startGroup() , 以及 LayoutParser::startNamespace().

docEntries()

const LayoutDocEntryList & LayoutDocManager::docEntries

(

LayoutDocManager::LayoutPart

part

)

const

Returns the list of LayoutDocEntry's in representation order for a given page identified by part.

在文件 layout.cpp 第 1580 行定义.

{
  return d->docEntries[(int)part];
}

引用了 d.

init()

void LayoutDocManager::init

(

)

在文件 layout.cpp 第 1556 行定义.

{
  LayoutParser &layoutParser = LayoutParser::instance();
  XMLHandlers handlers;
  handlers.startElement = [&layoutParser](const std::string &name,const XMLHandlers::Attributes &attrs) { layoutParser.startElement(name,attrs); };
  handlers.endElement   = [&layoutParser](const std::string &name) { layoutParser.endElement(name); };
  handlers.error        = [&layoutParser](const std::string &fileName,int lineNr,const std::string &msg) { layoutParser.error(fileName,lineNr,msg); };
  XMLParser parser(handlers);
  layoutParser.setDocumentLocator(&parser);
  QCString layout_default = ResourceMgr::instance().getAsString("layout_default.xml");
  parser.parse("layout_default.xml",layout_default.data(),Debug::isFlagSet(Debug::Lex));
}

引用了 QCString::data(), XMLHandlers::endElement, LayoutParser::endElement(), XMLHandlers::error, LayoutParser::error(), ResourceMgr::getAsString(), ResourceMgr::instance(), LayoutParser::instance(), Debug::isFlagSet(), Debug::Lex, msg(), XMLParser::parse(), LayoutParser::setDocumentLocator(), XMLHandlers::startElement , 以及 LayoutParser::startElement().

被这些函数引用 parseInput().

instance()

LayoutDocManager & LayoutDocManager::instance ( )

static

Returns a reference to this singleton.

在文件 layout.cpp 第 1574 行定义.

{
  static LayoutDocManager *theInstance = new LayoutDocManager;
  return *theInstance;
}

引用了 LayoutDocManager().

被这些函数引用 NestingNodeContext::Private::addMembers(), addMembersToIndex(), ClassDefImpl::countAdditionalInheritedMembers(), countVisibleMembers(), LayoutParser::endMemberDecl(), LayoutParser::endMemberDef(), generateJSNavTree(), ClassDefImpl::getTitleForMemberListType(), parseInput(), renderQuickLinksAsTabs(), ClassDefImpl::setAnonymousEnumType(), LayoutParser::startClass(), LayoutParser::startConcept(), LayoutParser::startDirectory(), LayoutParser::startFile(), LayoutParser::startGroup(), LayoutParser::startMemberDecl(), LayoutParser::startMemberDeclEntry(), LayoutParser::startMemberDef(), LayoutParser::startMemberDefEntry(), LayoutParser::startNamespace(), LayoutParser::startNavEntry(), LayoutParser::startNavIndex(), LayoutParser::startSectionEntry(), LayoutParser::startSimpleEntry(), ClassDefImpl::writeAdditionalInheritedMembers(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedIndexGeneric(), writeClassMemberIndex(), writeClassMemberIndexFiltered(), writeConceptIndex(), ClassDefImpl::writeDeclaration(), writeDefaultQuickLinks(), NamespaceDefImpl::writeDocumentation(), ConceptDefImpl::writeDocumentation(), DirDefImpl::writeDocumentation(), GroupDefImpl::writeDocumentation(), FileDefImpl::writeDocumentation(), ClassDefImpl::writeDocumentationContents(), writeExampleIndex(), writeFileIndex(), writeFileMemberIndex(), writeFileMemberIndexFiltered(), writeGraphicalClassHierarchy(), writeGraphicalExceptionHierarchy(), writeGraphicalInterfaceHierarchy(), writeGroupIndex(), writeGroupTreeNode(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), writeIndexHierarchy(), writeIndexHierarchyEntries(), ClassDefImpl::writeInlineDocumentation(), writeMenuData(), writeNamespaceIndex(), writeNamespaceMemberIndex(), writeNamespaceMemberIndexFiltered(), writeNamespaceMembers(), writePageIndex(), writePages(), FileDefImpl::writeSummaryLinks(), NamespaceDefImpl::writeSummaryLinks(), GroupDefImpl::writeSummaryLinks(), ClassDefImpl::writeSummaryLinks(), NamespaceDefImpl::writeTagFile(), DirDefImpl::writeTagFile(), GroupDefImpl::writeTagFile(), FileDefImpl::writeTagFile() , 以及 ClassDefImpl::writeTagFile().

parse()

void LayoutDocManager::parse

(

const QCString &

fileName

)

Parses a user provided layout

在文件 layout.cpp 第 1600 行定义.

{
  LayoutParser &layoutParser = LayoutParser::instance();
  XMLHandlers handlers;
  handlers.startElement = [&layoutParser](const std::string &name,const XMLHandlers::Attributes &attrs) { layoutParser.startElement(name,attrs); };
  handlers.endElement   = [&layoutParser](const std::string &name) { layoutParser.endElement(name); };
  handlers.error        = [&layoutParser](const std::string &fn,int lineNr,const std::string &msg) { layoutParser.error(fn,lineNr,msg); };
  XMLParser parser(handlers);
  layoutParser.setDocumentLocator(&parser);
  parser.parse(fileName.data(),fileToString(fileName).data(),Debug::isFlagSet(Debug::Lex));
}

引用了 QCString::data(), XMLHandlers::endElement, LayoutParser::endElement(), XMLHandlers::error, LayoutParser::error(), fileToString(), LayoutParser::instance(), Debug::isFlagSet(), Debug::Lex, msg(), XMLParser::parse(), LayoutParser::setDocumentLocator(), XMLHandlers::startElement , 以及 LayoutParser::startElement().

被这些函数引用 parseInput().

rootNavEntry()

LayoutNavEntry * LayoutDocManager::rootNavEntry

(

)

const

returns the (invisible) root of the navigation tree.

在文件 layout.cpp 第 1585 行定义.

{
  return d->rootNav;
}

引用了 d.

被这些函数引用 generateJSNavTree(), renderQuickLinksAsTabs(), LayoutParser::startNavIndex(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedIndexGeneric(), writeClassMemberIndex(), writeClassMemberIndexFiltered(), writeConceptIndex(), writeDefaultQuickLinks(), writeExampleIndex(), writeFileIndex(), writeFileMemberIndex(), writeFileMemberIndexFiltered(), writeGraphicalClassHierarchy(), writeGraphicalExceptionHierarchy(), writeGraphicalInterfaceHierarchy(), writeGroupIndex(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), writeIndexHierarchy(), writeMenuData(), writeNamespaceIndex(), writeNamespaceMemberIndex(), writeNamespaceMemberIndexFiltered(), writePageIndex() , 以及 writePages().

友元及相关函数文档

LayoutParser

friend class LayoutParser

friend

在文件 layout.h 第 224 行定义.

类成员变量说明

d

std::unique_ptr<Private> LayoutDocManager::d

private

在文件 layout.h 第 223 行定义.

被这些函数引用 addEntry(), clear(), docEntries(), LayoutDocManager(), rootNavEntry() , 以及 ~LayoutDocManager().

---

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

• src/layout.h
• src/layout.cpp