A model of a directory symbol. More...

#include <src/dirdef.h>

Inheritance diagram for DirDef:

Collaboration diagram for DirDef:

Classes
class	UsedDirLinkedMap

Public Member Functions
virtual const QCString	shortName () const =0

virtual void	addSubDir (DirDef *subdir)=0

virtual const FileList &	getFiles () const =0

virtual void	addFile (const FileDef *fd)=0

virtual const DirList &	subDirs () const =0

virtual bool	hasSubdirs () const =0

virtual int	level () const =0

virtual DirDef *	parent () const =0

virtual int	dirIndex () const =0

virtual const UsedDirLinkedMap &	usedDirs () const =0

virtual bool	isParentOf (const DirDef *dir) const =0

virtual bool	depGraphIsTrivial () const =0

virtual QCString	shortTitle () const =0

virtual bool	hasDetailedDescription () const =0

virtual void	writeDocumentation (OutputList &ol)=0

virtual void	writeTagFile (TextStream &t)=0

virtual void	setDiskName (const QCString &name)=0

virtual void	setDirIndex (int index)=0

virtual void	sort ()=0

virtual void	setParent (DirDef *parent)=0

virtual void	setLevel ()=0

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

virtual void	computeDependencies ()=0

virtual bool	hasDirectoryGraph () const =0

virtual void	overrideDirectoryGraph (bool e)=0

Public Member Functions inherited from DefinitionMutable
virtual void	setName (const QCString &name)=0

virtual void	setId (const QCString &name)=0

virtual void	setDefFile (const QCString &df, int defLine, int defColumn)=0

virtual void	setDocumentation (const QCString &d, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE)=0

virtual void	setBriefDescription (const QCString &b, const QCString &briefFile, int briefLine)=0

virtual void	setInbodyDocumentation (const QCString &d, const QCString &docFile, int docLine)=0

virtual void	setReference (const QCString &r)=0

virtual void	setBodySegment (int defLine, int bls, int ble)=0

virtual void	setBodyDef (const FileDef *fd)=0

virtual void	setRefItems (const RefItemVector &sli)=0

virtual void	setOuterScope (Definition *d)=0

virtual void	setHidden (bool b)=0

virtual void	setArtificial (bool b)=0

virtual void	setExported (bool b)=0

virtual void	setLanguage (SrcLangExt lang)=0

virtual void	setLocalName (const QCString &name)=0

virtual void	makePartOfGroup (GroupDef *gd)=0

virtual void	addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList)=0

virtual void	addSourceReferencedBy (MemberDef *d)=0

virtual void	addSourceReferences (MemberDef *d)=0

virtual void	mergeRefItems (Definition *d)=0

virtual void	addInnerCompound (Definition *d)=0

virtual void	addSectionsToIndex ()=0

virtual void	mergeReferences (const Definition *other)=0

virtual void	mergeReferencedBy (const Definition *other)=0

virtual void	computeTooltip ()=0

virtual void	writeSourceDef (OutputList &ol, const QCString &scopeName) const =0

virtual void	writeInlineCode (OutputList &ol, const QCString &scopeName) const =0

virtual bool	hasSourceRefs () const =0

virtual bool	hasSourceReffedBy () const =0

virtual void	writeSourceRefs (OutputList &ol, const QCString &scopeName) const =0

virtual void	writeSourceReffedBy (OutputList &ol, const QCString &scopeName) const =0

virtual void	writeNavigationPath (OutputList &ol) const =0

virtual void	writeQuickMemberLinks (OutputList &, const MemberDef *) const =0

virtual void	writeSummaryLinks (OutputList &) const =0

virtual void	writeDocAnchorsToTagFile (TextStream &) const =0

virtual void	writeToc (OutputList &ol, const LocalToc &lt) const =0

Public Member Functions inherited from Definition
virtual DefType	definitionType () const =0

virtual CodeSymbolType	codeSymbolType () const =0

virtual bool	isAlias () const =0

virtual const QCString &	name () const =0

virtual bool	isAnonymous () const =0

virtual QCString	displayName (bool includeScope=TRUE) const =0

virtual const QCString &	localName () const =0

virtual QCString	qualifiedName () const =0

virtual QCString	symbolName () const =0

virtual QCString	getOutputFileBase () const =0

virtual QCString	anchor () const =0

virtual QCString	getSourceFileBase () const =0

virtual QCString	getSourceAnchor () const =0

virtual QCString	documentation () const =0

virtual int	docLine () const =0

virtual QCString	docFile () const =0

virtual QCString	briefDescription (bool abbreviate=FALSE) const =0

virtual QCString	briefDescriptionAsTooltip () const =0

virtual int	briefLine () const =0

virtual QCString	inbodyDocumentation () const =0

virtual QCString	inbodyFile () const =0

virtual int	inbodyLine () const =0

virtual QCString	briefFile () const =0

virtual QCString	getDefFileName () const =0

virtual QCString	getDefFileExtension () const =0

virtual int	getDefLine () const =0

virtual int	getDefColumn () const =0

virtual bool	hasDocumentation () const =0

virtual bool	hasUserDocumentation () const =0

virtual bool	isLinkableInProject () const =0

virtual bool	isLinkable () const =0

virtual bool	isVisibleInProject () const =0

virtual bool	isVisible () const =0

virtual bool	isHidden () const =0

virtual bool	isArtificial () const =0

virtual bool	isExported () const =0

virtual QCString	getReference () const =0

virtual bool	isReference () const =0

virtual QCString	externalReference (const QCString &relPath) const =0

virtual int	getStartDefLine () const =0

virtual int	getStartBodyLine () const =0

virtual int	getEndBodyLine () const =0

virtual const FileDef *	getBodyDef () const =0

virtual SrcLangExt	getLanguage () const =0
	Returns the programming language this definition was written in.

virtual const GroupList &	partOfGroups () const =0

virtual bool	isLinkableViaGroup () const =0

virtual const RefItemVector &	xrefListItems () const =0

virtual const Definition *	findInnerCompound (const QCString &name) const =0

virtual Definition *	getOuterScope () const =0

virtual const MemberVector &	getReferencesMembers () const =0

virtual const MemberVector &	getReferencedByMembers () const =0

virtual bool	hasSections () const =0

virtual bool	hasSources () const =0

virtual bool	hasBriefDescription () const =0
	returns TRUE if this class has a brief description

virtual QCString	id () const =0

virtual const SectionRefs &	getSectionRefs () const =0
	returns the section dictionary, only of importance for pagedef

virtual QCString	navigationPathAsString () const =0

virtual QCString	pathFragment () const =0

virtual void	_setSymbolName (const QCString &name)=0

virtual QCString	_symbolName () const =0

Additional Inherited Members
Public Types inherited from Definition
enum	DefType { TypeClass = 0 , TypeFile = 1 , TypeNamespace = 2 , TypeModule = 3 , TypeMember = 4 , TypeGroup = 5 , TypePackage = 6 , TypePage = 7 , TypeDir = 8 , TypeConcept = 9 }

Detailed Description

A model of a directory symbol.

Definition at line 109 of file dirdef.h.

Member Function Documentation

◆ addFile()

virtual void DirDef::addFile ( const FileDef * fd )

pure virtual

Implemented in DirDefImpl.

Referenced by buildDirectories().

◆ addSubDir()

virtual void DirDef::addSubDir ( DirDef * subdir )

pure virtual

Implemented in DirDefImpl.

Referenced by buildDirectories().

◆ addUsesDependency()

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

pure virtual

Implemented in DirDefImpl.

Referenced by DirDefImpl::addUsesDependency().

◆ computeDependencies()

virtual void DirDef::computeDependencies ( )

pure virtual

Implemented in DirDefImpl.

◆ depGraphIsTrivial()

virtual bool DirDef::depGraphIsTrivial ( ) const

pure virtual

Implemented in DirDefImpl.

Referenced by DotDirDeps::isTrivial().

◆ dirIndex()

virtual int DirDef::dirIndex ( ) const

pure virtual

Implemented in DirDefImpl.

Referenced by addDependencies().

◆ getFiles()

virtual const FileList & DirDef::getFiles ( ) const

pure virtual

Implemented in DirDefImpl.

Referenced by dirHasVisibleChildren(), generateSqlite3ForDir(), generateXMLForDir(), and writeDirTreeNode().

◆ hasDetailedDescription()

virtual bool DirDef::hasDetailedDescription ( ) const

pure virtual

Implemented in DirDefImpl.

◆ hasDirectoryGraph()

virtual bool DirDef::hasDirectoryGraph ( ) const

pure virtual

Implemented in DirDefImpl.

◆ hasSubdirs()

virtual bool DirDef::hasSubdirs ( ) const

pure virtual

Implemented in DirDefImpl.

Referenced by drawTree().

◆ isParentOf()

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

pure virtual

Implemented in DirDefImpl.

◆ level()

virtual int DirDef::level ( ) const

pure virtual

Implemented in DirDefImpl.

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

◆ overrideDirectoryGraph()

virtual void DirDef::overrideDirectoryGraph ( bool e )

pure virtual

Implemented in DirDefImpl.

Referenced by findDirDocumentation().

◆ parent()

virtual DirDef * DirDef::parent ( ) const

pure virtual

Implemented in DirDefImpl.

Referenced by DirDefImpl::addUsesDependency(), DirDefImpl::isParentOf(), writeDotDirDepGraph(), and writePartialDirPath().

◆ setDirIndex()

virtual void DirDef::setDirIndex ( int index )

pure virtual

Implemented in DirDefImpl.

◆ setDiskName()

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

pure virtual

Implemented in DirDefImpl.

◆ setLevel()

virtual void DirDef::setLevel ( )

pure virtual

Implemented in DirDefImpl.

Referenced by DirDefImpl::setLevel().

◆ setParent()

virtual void DirDef::setParent ( DirDef * parent )

pure virtual

Implemented in DirDefImpl.

Referenced by DirDefImpl::addSubDir().

◆ shortName()

virtual const QCString DirDef::shortName ( ) const

pure virtual

Implemented in DirDefImpl.

Referenced by DirDefImpl::addUsesDependency(), compareDirDefs(), DirDefImpl::createNewDir(), drawClusterOpening(), drawDirectory(), writeDirTreeNode(), DirRelation::writeDocumentation(), and writePartialDirPath().

◆ shortTitle()

virtual QCString DirDef::shortTitle ( ) const

pure virtual

Implemented in DirDefImpl.

◆ sort()

virtual void DirDef::sort ( )

pure virtual

Implemented in DirDefImpl.

◆ subDirs()

virtual const DirList & DirDef::subDirs ( ) const

pure virtual

Implemented in DirDefImpl.

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

◆ usedDirs()

virtual const UsedDirLinkedMap & DirDef::usedDirs ( ) const

pure virtual

Implemented in DirDefImpl.

Referenced by addDependencies(), and writeDotDirDepGraph().

◆ writeDocumentation()

virtual void DirDef::writeDocumentation ( OutputList & ol )

pure virtual

Implemented in DirDefImpl.

◆ writeTagFile()

virtual void DirDef::writeTagFile ( TextStream & t )

pure virtual

Implemented in DirDefImpl.

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

src/dirdef.h

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addFile()

◆ addSubDir()

◆ addUsesDependency()

◆ computeDependencies()

◆ depGraphIsTrivial()

◆ dirIndex()

◆ getFiles()

◆ hasDetailedDescription()

◆ hasDirectoryGraph()

◆ hasSubdirs()

◆ isParentOf()

◆ level()

◆ overrideDirectoryGraph()

◆ parent()

◆ setDirIndex()

◆ setDiskName()

◆ setLevel()

◆ setParent()

◆ shortName()

◆ shortTitle()

◆ sort()

◆ subDirs()

◆ usedDirs()

◆ writeDocumentation()

◆ writeTagFile()