Doxygen
|
Singleton providing access to the (user configurable) layout of the documentation. More...
#include <src/layout.h>
Classes | |
class | Private |
Public Types | |
enum | LayoutPart { PART_SPECIFICATIONS } |
Public Member Functions | |
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. | |
LayoutNavEntry * | createChildNavEntry (LayoutNavEntry *root, LayoutNavEntry::Kind k, bool vs, const QCString &bf, const QCString &tl, const QCString &intro) |
append a new node as a child to root. | |
void | parse (const QCString &fileName, const char *data=nullptr) |
Parses a user provided layout. | |
void | init () |
int | majorVersion () const |
int | minorVersion () const |
Static Public Member Functions | |
static LayoutDocManager & | instance () |
Returns a reference to this singleton. | |
static std::string | partToString (int k) |
Private Member Functions | |
void | addEntry (LayoutPart p, LayoutDocEntryPtr &&e) |
void | mergeNavEntries (LayoutDocManager &manager) |
void | mergeDocEntries (const QCString &fileName, LayoutDocManager &manager) |
void | removeInvisibleDocEntries () |
LayoutDocManager () | |
~LayoutDocManager () |
Private Attributes | |
std::unique_ptr< Private > | d |
Friends | |
class | LayoutParser |
Singleton providing access to the (user configurable) layout of the documentation.
|
private |
Definition at line 1409 of file layout.cpp.
References d.
Referenced by instance(), mergeDocEntries(), mergeNavEntries(), and parse().
|
private |
Definition at line 1413 of file layout.cpp.
|
private |
Definition at line 1464 of file layout.cpp.
References d.
LayoutNavEntry * LayoutDocManager::createChildNavEntry | ( | LayoutNavEntry * | root, |
LayoutNavEntry::Kind | k, | ||
bool | vs, | ||
const QCString & | bf, | ||
const QCString & | tl, | ||
const QCString & | intro ) |
append a new node as a child to root.
Definition at line 1453 of file layout.cpp.
const LayoutDocEntryList & LayoutDocManager::docEntries | ( | LayoutDocManager::LayoutPart | part | ) | const |
Returns the list of LayoutDocEntry's in representation order for a given page identified by part.
Definition at line 1443 of file layout.cpp.
References d.
void LayoutDocManager::init | ( | ) |
Definition at line 1417 of file layout.cpp.
References d, QCString::data(), LayoutParser::endElement(), XMLHandlers::endElement, LayoutParser::error(), XMLHandlers::error, ResourceMgr::getAsString(), instance(), ResourceMgr::instance(), Debug::isFlagSet(), LayoutParser, Debug::Lex_xml, LayoutParser::majorVersion(), LayoutParser::minorVersion(), msg, XMLParser::parse(), removeInvisibleDocEntries(), LayoutParser::setDocumentLocator(), LayoutParser::startElement(), and XMLHandlers::startElement.
Referenced by parseInput().
|
static |
Returns a reference to this singleton.
Definition at line 1437 of file layout.cpp.
References LayoutDocManager().
Referenced by addMembersToIndex(), ClassDefImpl::countAdditionalInheritedMembers(), ModuleDefImpl::countVisibleMembers(), NamespaceDefImpl::countVisibleMembers(), generateJSNavTree(), ClassDefImpl::getTitleForMemberListType(), init(), parseInput(), printLayout(), renderQuickLinksAsTabs(), ClassDefImpl::setAnonymousEnumType(), ClassDefImpl::writeAdditionalInheritedMembers(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedIndexGeneric(), writeClassMemberIndex(), writeClassMemberIndexFiltered(), writeConceptIndex(), ClassDefImpl::writeDeclaration(), writeDefaultQuickLinks(), ClassDefImpl::writeDocumentation(), ConceptDefImpl::writeDocumentation(), DirDefImpl::writeDocumentation(), FileDefImpl::writeDocumentation(), GroupDefImpl::writeDocumentation(), ModuleDefImpl::writeDocumentation(), NamespaceDefImpl::writeDocumentation(), ClassDefImpl::writeDocumentationContents(), writeExampleIndex(), writeFileIndex(), writeFileMemberIndex(), writeFileMemberIndexFiltered(), writeGraphicalClassHierarchy(), writeGraphicalExceptionHierarchy(), writeGraphicalInterfaceHierarchy(), writeGroupTreeNode(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), writeIndex(), writeIndexHierarchy(), writeIndexHierarchyEntries(), ClassDefImpl::writeInlineDocumentation(), writeMenuData(), writeModuleIndex(), writeModuleMemberIndex(), writeModuleMemberIndexFiltered(), writeModuleMembers(), writeNamespaceIndex(), writeNamespaceMemberIndex(), writeNamespaceMemberIndexFiltered(), writeNamespaceMembers(), writePageIndex(), writePages(), ClassDefImpl::writeSummaryLinks(), FileDefImpl::writeSummaryLinks(), GroupDefImpl::writeSummaryLinks(), ModuleDefImpl::writeSummaryLinks(), NamespaceDefImpl::writeSummaryLinks(), ClassDefImpl::writeTagFile(), DirDefImpl::writeTagFile(), FileDefImpl::writeTagFile(), GroupDefImpl::writeTagFile(), ModuleDefImpl::writeTagFile(), NamespaceDefImpl::writeTagFile(), and writeTopicIndex().
int LayoutDocManager::majorVersion | ( | ) | const |
|
private |
Definition at line 1723 of file layout.cpp.
References d, LayoutDocManager(), and mergeDocEntryLists().
Referenced by parse().
|
private |
Definition at line 1635 of file layout.cpp.
References LayoutDocManager(), mergeNavTreeNodesRec(), and rootNavEntry().
int LayoutDocManager::minorVersion | ( | ) | const |
void LayoutDocManager::parse | ( | const QCString & | fileName, |
const char * | data = nullptr ) |
Parses a user provided layout.
Definition at line 1470 of file layout.cpp.
References d, QCString::data(), LayoutParser::endElement(), XMLHandlers::endElement, LayoutParser::error(), XMLHandlers::error, fileToString(), Debug::isFlagSet(), LayoutDocManager(), LayoutParser, Debug::Lex_xml, LayoutParser::majorVersion(), mergeDocEntries(), LayoutParser::minorVersion(), msg, XMLParser::parse(), DebugLex::print(), qPrint(), removeInvisibleDocEntries(), LayoutParser::setDocumentLocator(), LayoutParser::startElement(), XMLHandlers::startElement, and transcodeCharacterStringToUTF8().
Referenced by parseInput().
|
inlinestatic |
Definition at line 273 of file layout.h.
References PART_SPECIFICATIONS.
Referenced by printLayout().
|
private |
Definition at line 1511 of file layout.cpp.
References d.
LayoutNavEntry * LayoutDocManager::rootNavEntry | ( | ) | const |
returns the (invisible) root of the navigation tree.
Definition at line 1448 of file layout.cpp.
References d.
Referenced by generateJSNavTree(), mergeNavEntries(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedIndexGeneric(), writeClassMemberIndex(), writeClassMemberIndexFiltered(), writeConceptIndex(), writeDefaultQuickLinks(), writeExampleIndex(), writeFileIndex(), writeFileMemberIndex(), writeFileMemberIndexFiltered(), writeGraphicalClassHierarchy(), writeGraphicalExceptionHierarchy(), writeGraphicalInterfaceHierarchy(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), writeIndex(), writeIndexHierarchy(), writeMenuData(), writeModuleIndex(), writeModuleMemberIndex(), writeModuleMemberIndexFiltered(), writeNamespaceIndex(), writeNamespaceMemberIndex(), writeNamespaceMemberIndexFiltered(), writePageIndex(), writePages(), and writeTopicIndex().
|
friend |
Definition at line 306 of file layout.h.
References LayoutParser, printLayout(), and writeDefaultLayoutFile().
Referenced by init(), LayoutParser, and parse().
|
private |
Definition at line 305 of file layout.h.
Referenced by addEntry(), createChildNavEntry(), docEntries(), init(), LayoutDocManager(), majorVersion(), mergeDocEntries(), minorVersion(), parse(), removeInvisibleDocEntries(), and rootNavEntry().