The DirDef Class Reference

A model of a directory symbol. More...

Declaration

class DirDef { ... }

Included Headers

#include <src/dirdef.h>

Base classes

class	DefinitionMutable
class	Definition
	The common base class of all entity definitions found in the sources. More...

Derived Classes

class	DefinitionMixin<Base>

Public Member Functions Index

const QCString	shortName () const =0
void	addSubDir (DirDef *subdir)=0
const FileList &	getFiles () const =0
void	addFile (FileDef *fd)=0
const DirList &	subDirs () const =0
bool	hasSubdirs () const =0
int	level () const =0
DirDef *	parent () const =0
int	dirIndex () const =0
const UsedDirLinkedMap &	usedDirs () const =0
bool	isParentOf (const DirDef *dir) const =0
bool	depGraphIsTrivial () const =0
QCString	shortTitle () const =0
bool	hasDetailedDescription () const =0
void	writeDocumentation (OutputList &ol)=0
void	writeTagFile (TextStream &t)=0
void	setDiskName (const QCString &name)=0
void	setDirIndex (int index)=0
void	sort ()=0
void	setParent (DirDef *parent)=0
void	setLevel ()=0
void	addUsesDependency (const DirDef *usedDir, const FileDef *srcFd, const FileDef *dstFd, bool srcDirect, bool dstDirect)=0
void	computeDependencies ()=0
bool	hasDirectoryGraph () const =0
void	overrideDirectoryGraph (bool e)=0

Description

A model of a directory symbol.

Definition at line 109 of file dirdef.h.

Public Member Functions

addFile()

virtual void DirDef::addFile (FileDef * fd)

Definition at line 118 of file dirdef.h.

Referenced by buildDirectories.

addSubDir()

virtual void DirDef::addSubDir (DirDef * subdir)

Definition at line 116 of file dirdef.h.

addUsesDependency()

virtual void DirDef::addUsesDependency (const DirDef * usedDir, const FileDef * srcFd, const FileDef * dstFd, bool srcDirect, bool dstDirect)

Definition at line 139 of file dirdef.h.

Referenced by DirDefImpl::addUsesDependency.

computeDependencies()

virtual void DirDef::computeDependencies ()

Definition at line 141 of file dirdef.h.

depGraphIsTrivial()

virtual bool DirDef::depGraphIsTrivial ()

Definition at line 126 of file dirdef.h.

dirIndex()

virtual int DirDef::dirIndex ()

Definition at line 123 of file dirdef.h.

Referenced by addDependencies.

getFiles()

virtual const FileList & DirDef::getFiles ()

Definition at line 117 of file dirdef.h.

Referenced by dirHasVisibleChildren, generateSqlite3ForDir, generateXMLForDir and writeDirTreeNode.

hasDetailedDescription()

virtual bool DirDef::hasDetailedDescription ()

Definition at line 128 of file dirdef.h.

hasDirectoryGraph()

virtual bool DirDef::hasDirectoryGraph ()

Definition at line 144 of file dirdef.h.

hasSubdirs()

virtual bool DirDef::hasSubdirs ()

Definition at line 120 of file dirdef.h.

Referenced by drawTree.

isParentOf()

virtual bool DirDef::isParentOf (const DirDef * dir)

Definition at line 125 of file dirdef.h.

level()

virtual int DirDef::level ()

Definition at line 121 of file dirdef.h.

Referenced by drawClusterOpening, drawDirectory, isAtMaxDepth and DirDefImpl::setLevel.

overrideDirectoryGraph()

virtual void DirDef::overrideDirectoryGraph (bool e)

Definition at line 145 of file dirdef.h.

Referenced by findDirDocumentation.

parent()

virtual DirDef * DirDef::parent ()

Definition at line 122 of file dirdef.h.

Referenced by DirDefImpl::addUsesDependency, DirDefImpl::isParentOf, setParent, writeDotDirDepGraph and writePartialDirPath.

setDirIndex()

virtual void DirDef::setDirIndex (int index)

Definition at line 135 of file dirdef.h.

setDiskName()

virtual void DirDef::setDiskName (const QCString & name)

Definition at line 134 of file dirdef.h.

Reference Definition::name.

setLevel()

virtual void DirDef::setLevel ()

Definition at line 138 of file dirdef.h.

Referenced by DirDefImpl::setLevel.

setParent()

virtual void DirDef::setParent (DirDef * parent)

Definition at line 137 of file dirdef.h.

Reference parent.

Referenced by DirDefImpl::addSubDir.

shortName()

virtual const QCString DirDef::shortName ()

Definition at line 115 of file dirdef.h.

Referenced by DirDefImpl::addUsesDependency, compareDirDefs, DirDefImpl::createNewDir, drawClusterOpening, drawDirectory, writeDirTreeNode and writePartialDirPath.

shortTitle()

virtual QCString DirDef::shortTitle ()

Definition at line 127 of file dirdef.h.

sort()

virtual void DirDef::sort ()

Definition at line 136 of file dirdef.h.

subDirs()

virtual const DirList & DirDef::subDirs ()

Definition at line 119 of file dirdef.h.

Referenced by dirHasVisibleChildren, drawTree, generateSqlite3ForDir, generateXMLForDir and writeDirTreeNode.

usedDirs()

virtual const UsedDirLinkedMap & DirDef::usedDirs ()

Definition at line 124 of file dirdef.h.

Referenced by addDependencies and writeDotDirDepGraph.

writeDocumentation()

virtual void DirDef::writeDocumentation (OutputList & ol)

Definition at line 131 of file dirdef.h.

writeTagFile()

virtual void DirDef::writeTagFile (TextStream & t)

Definition at line 132 of file dirdef.h.

---

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

• dirdef.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.