LayoutDocManager Class Reference

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

#include <layout.h>

Classes
class	Private

Public Types
enum	LayoutPart {   Undefined = -1, Class, Concept, Namespace,   File, Group, Directory, NrParts }

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. More...
LayoutNavEntry *	rootNavEntry () const
	returns the (invisible) root of the navigation tree. More...
void	parse (const QCString &fileName, const char *data=nullptr)
	Parses a user provided layout.
void	init ()

Static Public Member Functions
static LayoutDocManager &	instance ()
	Returns a reference to this singleton. More...

Friends
class	LayoutParser

Detailed Description

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

Member Function Documentation

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.

instance()

LayoutDocManager & LayoutDocManager::instance ( )

static

Returns a reference to this singleton.

rootNavEntry()

LayoutNavEntry * LayoutDocManager::rootNavEntry

(

)

const

returns the (invisible) root of the navigation tree.

---

The documentation for this class was generated from the following files:

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