doxygen
Classes | Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
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 {
  Class, Namespace, File, Group,
  Directory, NrParts
}
 

Public Member Functions

const QList< LayoutDocEntry > & docEntries (LayoutPart part) const
 Returns the list of LayoutDocEntry's in representation order for a given page identified by part. More...
 
LayoutNavEntryrootNavEntry () const
 returns the (invisible) root of the navigation tree. More...
 
void parse (const char *fileName)
 Parses a user provided layout.
 
void init ()
 
void writeDefault (const char *fileName) const
 

Static Public Member Functions

static LayoutDocManagerinstance ()
 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 QList< LayoutDocEntry > & 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: