The index.h File Reference

Included Headers

#include <memory> #include <vector> #include <map> #include "qcstring.h" #include "construct.h"

Namespaces Index

namespace	ClassMemberHighlight
namespace	FileMemberHighlight
namespace	NamespaceMemberHighlight
namespace	ModuleMemberHighlight

Classes Index

class	Index

Enumerations Index

enum class	IndexSection { ... }
enum class	HighlightedItem { ... }

Functions Index

void	writeGraphInfo (OutputList &ol)
void	writeIndexHierarchy (OutputList &ol)
void	startTitle (OutputList &ol, const QCString &fileName, const DefinitionMutable *def=nullptr)
void	endTitle (OutputList &ol, const QCString &fileName, const QCString &name)
void	startFile (OutputList &ol, const QCString &name, const QCString &manName, const QCString &title, HighlightedItem hli=HighlightedItem::None, bool additionalIndices=false, const QCString &altSidebarName=QCString(), int hierarchyLevel=0, const QCString &allMembersFile=QCString())
void	endFile (OutputList &ol, bool skipNavIndex=FALSE, bool skipEndContents=FALSE, const QCString &navPath=QCString())
void	endFileWithNavPath (OutputList &ol, const DefinitionMutable *d, bool showPageNavigation=true)

Enumerations

HighlightedItem

enum class HighlightedItem

strong

Enumeration values

None	(=0)
Main
Modules
Namespaces
Topics
ClassHierarchy
InterfaceHierarchy
ExceptionHierarchy
Classes
Concepts
Interfaces
Structs
Exceptions
AnnotatedClasses
AnnotatedInterfaces
AnnotatedStructs
AnnotatedExceptions
Files
NamespaceMembers
ModuleMembers
Functions
Globals
Pages
Examples
Search
UserGroup
ClassVisible
ConceptVisible
InterfaceVisible
StructVisible
ExceptionVisible
NamespaceVisible
FileVisible
ModuleVisible

Definition at line 58 of file index.h.

59{

60 None=0,

61 Main,

62 Modules,

63 Namespaces,

64 Topics,

65 ClassHierarchy,

66 InterfaceHierarchy,

67 ExceptionHierarchy,

68 Classes,

69 Concepts,

70 Interfaces,

71 Structs,

72 Exceptions,

73 AnnotatedClasses,

74 AnnotatedInterfaces,

75 AnnotatedStructs,

76 AnnotatedExceptions,

77 Files,

78 NamespaceMembers,

79 ModuleMembers,

80 Functions,

81 Globals,

82 Pages,

83 Examples,

84 Search,

85 UserGroup,

86

87 ClassVisible,

88 ConceptVisible,

89 InterfaceVisible,

90 StructVisible,

91 ExceptionVisible,

92 NamespaceVisible,

93 FileVisible,

94 ModuleVisible

95};

IndexSection

enum class IndexSection

strong

Enumeration values

isTitlePageStart
isTitlePageAuthor
isMainPage
isModuleIndex
isTopicIndex
isDirIndex
isNamespaceIndex
isConceptIndex
isClassHierarchyIndex
isCompoundIndex
isFileIndex
isPageIndex
isModuleDocumentation
isTopicDocumentation
isDirDocumentation
isNamespaceDocumentation
isClassDocumentation
isConceptDocumentation
isFileDocumentation
isExampleDocumentation
isPageDocumentation
isPageDocumentation2
isEndIndex

Definition at line 31 of file index.h.

32{

33 isTitlePageStart,

34 isTitlePageAuthor,

35 isMainPage,

36 isModuleIndex,

37 isTopicIndex,

38 isDirIndex,

39 isNamespaceIndex,

40 isConceptIndex,

41 isClassHierarchyIndex,

42 isCompoundIndex,

43 isFileIndex,

44 isPageIndex,

45 isModuleDocumentation,

46 isTopicDocumentation,

47 isDirDocumentation,

48 isNamespaceDocumentation,

49 isClassDocumentation,

50 isConceptDocumentation,

51 isFileDocumentation,

52 isExampleDocumentation,

53 isPageDocumentation,

54 isPageDocumentation2,

55 isEndIndex

56};

Functions

endFile()

void endFile (OutputList & ol, bool skipNavIndex=FALSE, bool skipEndContents=FALSE, const QCString & navPath=QCString())

Declaration at line 232 of file index.h, definition at line 427 of file index.cpp.

427void endFile(OutputList &ol,bool skipNavIndex,bool skipEndContents,

428 const QCString &navPath)

429{

430 bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);

431 ol.pushGeneratorState();

432 ol.disableAllBut(OutputType::Html);

433 if (!skipNavIndex)

434 {

435 if (!skipEndContents) ol.endContents();

436 if (generateTreeView)

437 {

438 ol.writeString("</div><!-- doc-content -->\n");

439 ol.writeString("</div><!-- container -->\n");

440 }

441 }

442

443 ol.writeFooter(navPath); // write the footer

444 ol.popGeneratorState();

445 ol.endFile();

446}

References Config_getBool, OutputList::disableAllBut, OutputList::endContents, OutputList::endFile, Html, OutputList::popGeneratorState, OutputList::pushGeneratorState, OutputList::writeFooter and OutputList::writeString.

Referenced by endFileWithNavPath, generateExampleDocs, writeAlphabeticalExceptionIndex, writeAlphabeticalIndex, writeAlphabeticalInterfaceIndex, writeAlphabeticalStructIndex, writeAnnotatedIndexGeneric, writeClassMemberIndexFiltered, writeConceptIndex, GroupDefImpl::writeDocumentation, ModuleDefImpl::writeDocumentation, PageDefImpl::writeDocumentation, MemberList::writeDocumentationPage, writeExampleIndex, writeFileIndex, writeFileMemberIndexFiltered, writeGraphicalClassHierarchy, writeGraphicalExceptionHierarchy, writeGraphicalInterfaceHierarchy, writeGraphInfo, writeHierarchicalExceptionIndex, writeHierarchicalIndex, writeHierarchicalInterfaceIndex, writeIndex, ClassDefImpl::writeMemberList, writeModuleIndex, writeModuleMemberIndexFiltered, writeNamespaceIndex, writeNamespaceMemberIndexFiltered, writePageIndex, writeTopicIndex and writeUserGroupStubPage.

endFileWithNavPath()

void endFileWithNavPath (OutputList & ol, const DefinitionMutable * d, bool showPageNavigation=true)

Declaration at line 234 of file index.h, definition at line 448 of file index.cpp.

448void endFileWithNavPath(OutputList &ol,const DefinitionMutable *d,bool showPageNavigation)

449{

450 bool generateTreeview = Config_getBool(GENERATE_TREEVIEW);

451 bool generateOutlinePanel = Config_getBool(PAGE_OUTLINE_PANEL);

452 QCString navPath;

453 if (generateTreeview)

454 {

455 ol.pushGeneratorState();

456 ol.disableAllBut(OutputType::Html);

457 ol.writeString("</div><!-- doc-content -->\n");

458 if (generateOutlinePanel && showPageNavigation) d->writePageNavigation(ol);

459 ol.writeString("</div><!-- container -->\n");

460 ol.popGeneratorState();

461 navPath = toDefinition(const_cast<DefinitionMutable*>(d))->navigationPathAsString();

462 }

463 endFile(ol,generateTreeview,TRUE,navPath);

464}

References Config_getBool, OutputList::disableAllBut, endFile, Html, Definition::navigationPathAsString, OutputList::popGeneratorState, OutputList::pushGeneratorState, toDefinition, TRUE, DefinitionMutable::writePageNavigation and OutputList::writeString.

Referenced by ClassDefImpl::writeDocumentation, ConceptDefImpl::writeDocumentation, DirDefImpl::writeDocumentation, DirRelation::writeDocumentation, FileDefImpl::writeDocumentation, NamespaceDefImpl::writeDocumentation, PageDefImpl::writeDocumentation, MemberList::writeDocumentationPage and FileDefImpl::writeSourceFooter.

endTitle()

void endTitle (OutputList & ol, const QCString & fileName, const QCString & name)

Declaration at line 227 of file index.h, definition at line 394 of file index.cpp.

394void endTitle(OutputList &ol,const QCString &fileName,const QCString &name)

395{

396 ol.popGeneratorState();

397 ol.endTitleHead(fileName,name);

398 ol.endHeaderSection();

399}

References OutputList::endHeaderSection, OutputList::endTitleHead and OutputList::popGeneratorState.

Referenced by generateExampleDocs, writeAlphabeticalExceptionIndex, writeAlphabeticalIndex, writeAlphabeticalInterfaceIndex, writeAlphabeticalStructIndex, writeAnnotatedIndexGeneric, writeConceptIndex, ClassDefImpl::writeDocumentation, ConceptDefImpl::writeDocumentation, DirDefImpl::writeDocumentation, FileDefImpl::writeDocumentation, NamespaceDefImpl::writeDocumentation, writeExampleIndex, writeFileIndex, writeGraphicalClassHierarchy, writeGraphicalExceptionHierarchy, writeGraphicalInterfaceHierarchy, writeGraphInfo, writeHierarchicalExceptionIndex, writeHierarchicalIndex, writeHierarchicalInterfaceIndex, ClassDefImpl::writeMemberList, writeModuleIndex, writeNamespaceIndex, writePageIndex, FileDefImpl::writeSourceHeader, writeTopicIndex and writeUserGroupStubPage.

startFile()

void startFile (OutputList & ol, const QCString & name, const QCString & manName, const QCString & title, HighlightedItem hli=HighlightedItem::None, bool additionalIndices=false, const QCString & altSidebarName=QCString(), int hierarchyLevel=0, const QCString & allMembersFile=QCString())

Declaration at line 228 of file index.h, definition at line 401 of file index.cpp.

401void startFile(OutputList &ol,const QCString &name,const QCString &manName,

402 const QCString &title,HighlightedItem hli,bool additionalIndices,

403 const QCString &altSidebarName, int hierarchyLevel, const QCString &allMembersFile)

404{

405 bool disableIndex = Config_getBool(DISABLE_INDEX);

406 bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);

407 bool fullSidebar = Config_getBool(FULL_SIDEBAR);

408 bool quickLinksAfterSplitbar = !disableIndex && generateTreeView && fullSidebar;

409 ol.startFile(name,manName,title,hierarchyLevel);

410 ol.startQuickIndices();

411 if (!disableIndex && !quickLinksAfterSplitbar)

412 {

413 ol.writeQuickLinks(hli,name);

414 }

415 if (!additionalIndices)

416 {

417 ol.endQuickIndices();

418 }

419 ol.writeSplitBar(!altSidebarName.isEmpty() ? altSidebarName : name, allMembersFile);

420 if (quickLinksAfterSplitbar)

421 {

422 ol.writeQuickLinks(hli,name);

423 }

424 ol.writeSearchInfo();

425}

References Config_getBool, OutputList::endQuickIndices, QCString::isEmpty, OutputList::startFile, OutputList::startQuickIndices, OutputList::writeQuickLinks, OutputList::writeSearchInfo and OutputList::writeSplitBar.

Referenced by generateExampleDocs, writeAlphabeticalExceptionIndex, writeAlphabeticalIndex, writeAlphabeticalInterfaceIndex, writeAlphabeticalStructIndex, writeAnnotatedIndexGeneric, writeConceptIndex, ClassDefImpl::writeDocumentation, ConceptDefImpl::writeDocumentation, DirDefImpl::writeDocumentation, DirRelation::writeDocumentation, FileDefImpl::writeDocumentation, GroupDefImpl::writeDocumentation, ModuleDefImpl::writeDocumentation, NamespaceDefImpl::writeDocumentation, PageDefImpl::writeDocumentation, MemberList::writeDocumentationPage, writeExampleIndex, writeFileIndex, writeGraphicalClassHierarchy, writeGraphicalExceptionHierarchy, writeGraphicalInterfaceHierarchy, writeGraphInfo, writeHierarchicalExceptionIndex, writeHierarchicalIndex, writeHierarchicalInterfaceIndex, ClassDefImpl::writeMemberList, writeModuleIndex, writeNamespaceIndex, writePageIndex, FileDefImpl::writeSourceHeader, writeTopicIndex and writeUserGroupStubPage.

startTitle()

void startTitle (OutputList & ol, const QCString & fileName, const DefinitionMutable * def=nullptr)

Declaration at line 226 of file index.h, definition at line 384 of file index.cpp.

384void startTitle(OutputList &ol,const QCString &fileName,const DefinitionMutable *def)

385{

386 bool generateOutlinePanel = Config_getBool(GENERATE_TREEVIEW) && Config_getBool(PAGE_OUTLINE_PANEL);

387 ol.startHeaderSection();

388 if (!generateOutlinePanel && def) def->writeSummaryLinks(ol);

389 ol.startTitleHead(fileName);

390 ol.pushGeneratorState();

391 ol.disable(OutputType::Man);

392}

References Config_getBool, OutputList::disable, Man, OutputList::pushGeneratorState, OutputList::startHeaderSection, OutputList::startTitleHead and DefinitionMutable::writeSummaryLinks.

Referenced by generateExampleDocs, writeAlphabeticalExceptionIndex, writeAlphabeticalIndex, writeAlphabeticalInterfaceIndex, writeAlphabeticalStructIndex, writeAnnotatedIndexGeneric, writeConceptIndex, ClassDefImpl::writeDocumentation, ConceptDefImpl::writeDocumentation, DirDefImpl::writeDocumentation, FileDefImpl::writeDocumentation, NamespaceDefImpl::writeDocumentation, writeExampleIndex, writeFileIndex, writeGraphicalClassHierarchy, writeGraphicalExceptionHierarchy, writeGraphicalInterfaceHierarchy, writeGraphInfo, writeHierarchicalExceptionIndex, writeHierarchicalIndex, writeHierarchicalInterfaceIndex, ClassDefImpl::writeMemberList, writeModuleIndex, writeNamespaceIndex, writePageIndex, FileDefImpl::writeSourceHeader, writeTopicIndex and writeUserGroupStubPage.

writeGraphInfo()

void writeGraphInfo (OutputList & ol)

Declaration at line 224 of file index.h, definition at line 4035 of file index.cpp.

4035void writeGraphInfo(OutputList &ol)

4036{

4037 if (!Config_getBool(HAVE_DOT) || !Config_getBool(GENERATE_HTML)) return;

4038 ol.pushGeneratorState();

4039 ol.disableAllBut(OutputType::Html);

4040

4041 DotLegendGraph gd;

4042 gd.writeGraph(Config_getString(HTML_OUTPUT));

4043

4044 bool oldStripCommentsState = Config_getBool(STRIP_CODE_COMMENTS);

4045 bool oldCreateSubdirs = Config_getBool(CREATE_SUBDIRS);

4046 // temporarily disable the stripping of comments for our own code example!

4047 Config_updateBool(STRIP_CODE_COMMENTS,FALSE);

4048 // temporarily disable create subdirs for linking to our example

4049 Config_updateBool(CREATE_SUBDIRS,FALSE);

4050

4051 startFile(ol,"graph_legend",QCString(),theTranslator->trLegendTitle());

4052 startTitle(ol,QCString());

4053 ol.parseText(theTranslator->trLegendTitle());

4054 endTitle(ol,QCString(),QCString());

4055 ol.startContents();

4056 QCString legendDocs = theTranslator->trLegendDocs();

4057 int s = legendDocs.find("<center>");

4058 int e = legendDocs.find("</center>");

4059 QCString imgExt = getDotImageExtension();

4060 if (imgExt=="svg" && s!=-1 && e!=-1)

4061 {

4062 legendDocs = legendDocs.left(s+8) + "[!-- " + "SVG 0 --]" + legendDocs.mid(e);

4063 //printf("legendDocs=%s\n",qPrint(legendDocs));

4064 }

4065

4066 {

4067 auto fd = createFileDef("","graph_legend.dox");

4068 ol.generateDoc("graph_legend",1,fd.get(),nullptr,legendDocs,FALSE,FALSE,

4069 QCString(),FALSE,FALSE,FALSE);

4070 }

4071

4072 // restore config settings

4073 Config_updateBool(STRIP_CODE_COMMENTS,oldStripCommentsState);

4074 Config_updateBool(CREATE_SUBDIRS,oldCreateSubdirs);

4075

4076 endFile(ol);

4077 ol.popGeneratorState();

4078}

References Config_getBool, Config_getString, Config_updateBool, createFileDef, OutputList::disableAllBut, endFile, endTitle, FALSE, QCString::find, OutputList::generateDoc, getDotImageExtension, Html, QCString::left, QCString::mid, OutputList::parseText, OutputList::popGeneratorState, OutputList::pushGeneratorState, OutputList::startContents, startFile, startTitle, theTranslator and DotLegendGraph::writeGraph.

Referenced by generateOutput.

writeIndexHierarchy()

void writeIndexHierarchy (OutputList & ol)

Declaration at line 225 of file index.h, definition at line 5718 of file index.cpp.

5718void writeIndexHierarchy(OutputList &ol)

5719{

5720 writeMenuData();

5721 LayoutNavEntry *lne = LayoutDocManager::instance().rootNavEntry();

5722 if (lne)

5723 {

5724 writeIndexHierarchyEntries(ol,lne->children());

5725 }

5726}

References LayoutNavEntry::children, LayoutDocManager::instance, LayoutDocManager::rootNavEntry, writeIndexHierarchyEntries and writeMenuData.

Referenced by generateOutput.

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.