A model of a group of symbols. More...

#include <src/groupdef.h>

Inheritance diagram for GroupDef:

Collaboration diagram for GroupDef:

Public Member Functions
virtual QCString	groupTitle () const =0

virtual void	setGroupTitle (const QCString &newtitle)=0

virtual bool	hasGroupTitle () const =0

virtual void	addFile (FileDef *def)=0

virtual bool	containsFile (const FileDef *def) const =0

virtual bool	addClass (ClassDef *def)=0

virtual bool	addConcept (ConceptDef *def)=0

virtual bool	addModule (ModuleDef *def)=0

virtual bool	addNamespace (NamespaceDef *def)=0

virtual void	addGroup (GroupDef *def)=0

virtual void	addPage (PageDef *def)=0

virtual void	addExample (PageDef *def)=0

virtual void	addDir (DirDef *dd)=0

virtual bool	insertMember (MemberDef *def, bool docOnly=FALSE)=0

virtual void	removeMember (MemberDef *md)=0

virtual bool	findGroup (const GroupDef *def) const =0

virtual void	writeDocumentation (OutputList &ol)=0

virtual void	writeMemberPages (OutputList &ol, int hierarchyLevel)=0

virtual void	writeTagFile (TextStream &)=0

virtual size_t	numDocMembers () const =0

virtual bool	isVisibleInHierarchy () const =0

virtual bool	isASubGroup () const =0

virtual void	computeAnchors ()=0

virtual void	countMembers ()=0

virtual void	addMembersToMemberGroup ()=0

virtual void	distributeMemberGroupDocumentation ()=0

virtual void	findSectionsInDocumentation ()=0

virtual void	addListReferences ()=0

virtual void	sortMemberLists ()=0

virtual bool	subGrouping () const =0

virtual void	setGroupScope (Definition *d)=0

virtual Definition *	getGroupScope () const =0

virtual MemberList *	getMemberList (MemberListType lt) const =0

virtual const MemberLists &	getMemberLists () const =0

virtual const MemberGroupList &	getMemberGroups () const =0

virtual const FileList &	getFiles () const =0

virtual const ClassLinkedRefMap &	getClasses () const =0

virtual const ConceptLinkedRefMap &	getConcepts () const =0

virtual const ModuleLinkedRefMap &	getModules () const =0

virtual const NamespaceLinkedRefMap &	getNamespaces () const =0

virtual const GroupList &	getSubGroups () const =0

virtual const PageLinkedRefMap &	getPages () const =0

virtual const DirList &	getDirs () const =0

virtual const PageLinkedRefMap &	getExamples () const =0

virtual bool	hasDetailedDescription () const =0

virtual void	sortSubGroups ()=0

virtual bool	hasGroupGraph () const =0

virtual void	overrideGroupGraph (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, const QCString &sourceRefName)=0

virtual void	addSourceReferences (MemberDef *d, const QCString &sourceRefName)=0

virtual void	mergeRefItems (Definition *d)=0

virtual void	addInnerCompound (Definition *d)=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 =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 group of symbols.

Definition at line 51 of file groupdef.h.

Member Function Documentation

◆ addClass()

virtual bool GroupDef::addClass ( ClassDef * def )

pure virtual

Implemented in GroupDefImpl.

References addClass().

Referenced by addClass(), addClassToGroups(), distributeClassGroupRelations(), and ClassDefImpl::setGroupDefForAllMembers().

◆ addConcept()

virtual bool GroupDef::addConcept ( ConceptDef * def )

pure virtual

Implemented in GroupDefImpl.

References addConcept().

Referenced by addConcept(), and addConceptToGroups().

◆ addDir()

virtual void GroupDef::addDir ( DirDef * dd )

pure virtual

Implemented in GroupDefImpl.

References addDir().

Referenced by addDir(), and addDirToGroups().

◆ addExample()

virtual void GroupDef::addExample ( PageDef * def )

pure virtual

Implemented in GroupDefImpl.

References addExample().

Referenced by addExample(), and addExampleToGroups().

◆ addFile()

virtual void GroupDef::addFile ( FileDef * def )

pure virtual

Implemented in GroupDefImpl.

References addFile().

Referenced by addFile(), and buildFileList().

◆ addGroup()

virtual void GroupDef::addGroup ( GroupDef * def )

pure virtual

Implemented in GroupDefImpl.

References addGroup().

Referenced by addGroup(), and addGroupToGroups().

◆ addListReferences()

virtual void GroupDef::addListReferences ( )

pure virtual

Implemented in GroupDefImpl.

References addListReferences().

Referenced by addListReferences().

◆ addMembersToMemberGroup()

virtual void GroupDef::addMembersToMemberGroup ( )

pure virtual

Implemented in GroupDefImpl.

References addMembersToMemberGroup().

Referenced by addMembersToMemberGroup().

◆ addModule()

virtual bool GroupDef::addModule ( ModuleDef * def )

pure virtual

Implemented in GroupDefImpl.

References addModule().

Referenced by addModule(), and addModuleToGroups().

◆ addNamespace()

virtual bool GroupDef::addNamespace ( NamespaceDef * def )

pure virtual

Implemented in GroupDefImpl.

References addNamespace().

Referenced by addNamespace(), addNamespaceToGroups(), and findUsingDirectives().

◆ addPage()

virtual void GroupDef::addPage ( PageDef * def )

pure virtual

Implemented in GroupDefImpl.

References addPage().

Referenced by addPage(), and addRelatedPage().

◆ computeAnchors()

virtual void GroupDef::computeAnchors ( )

pure virtual

Implemented in GroupDefImpl.

References computeAnchors().

Referenced by computeAnchors().

◆ containsFile()

virtual bool GroupDef::containsFile ( const FileDef * def ) const

pure virtual

Implemented in GroupDefImpl.

References containsFile().

Referenced by buildFileList(), and containsFile().

◆ countMembers()

virtual void GroupDef::countMembers ( )

pure virtual

Implemented in GroupDefImpl.

References countMembers().

Referenced by countMembers().

◆ distributeMemberGroupDocumentation()

virtual void GroupDef::distributeMemberGroupDocumentation ( )

pure virtual

Implemented in GroupDefImpl.

References distributeMemberGroupDocumentation().

Referenced by distributeMemberGroupDocumentation().

◆ findGroup()

virtual bool GroupDef::findGroup ( const GroupDef * def ) const

pure virtual

Implemented in GroupDefImpl.

References findGroup().

Referenced by addGroupToGroups(), and findGroup().

◆ findSectionsInDocumentation()

virtual void GroupDef::findSectionsInDocumentation ( )

pure virtual

Implemented in GroupDefImpl.

References findSectionsInDocumentation().

Referenced by findSectionsInDocumentation().

◆ getClasses()

virtual const ClassLinkedRefMap & GroupDef::getClasses ( ) const

pure virtual

Implemented in GroupDefImpl.

References getClasses().

Referenced by DotGroupCollaboration::buildGraph(), PerlModGenerator::generatePerlModForGroup(), generateSqlite3ForGroup(), generateXMLForGroup(), getClasses(), and writeGroupTreeNode().

◆ getConcepts()

virtual const ConceptLinkedRefMap & GroupDef::getConcepts ( ) const

pure virtual

Implemented in GroupDefImpl.

References getConcepts().

Referenced by PerlModGenerator::generatePerlModForGroup(), generateSqlite3ForGroup(), generateXMLForGroup(), getConcepts(), and writeGroupTreeNode().

◆ getDirs()

virtual const DirList & GroupDef::getDirs ( ) const

pure virtual

Implemented in GroupDefImpl.

References getDirs().

Referenced by DotGroupCollaboration::buildGraph(), getDirs(), and writeGroupTreeNode().

◆ getExamples()

virtual const PageLinkedRefMap & GroupDef::getExamples ( ) const

pure virtual

Implemented in GroupDefImpl.

References getExamples().

Referenced by getExamples().

◆ getFiles()

virtual const FileList & GroupDef::getFiles ( ) const

pure virtual

Implemented in GroupDefImpl.

References getFiles().

Referenced by DotGroupCollaboration::buildGraph(), PerlModGenerator::generatePerlModForGroup(), generateSqlite3ForGroup(), generateXMLForGroup(), getFiles(), and writeGroupTreeNode().

◆ getGroupScope()

virtual Definition * GroupDef::getGroupScope ( ) const

pure virtual

Implemented in GroupDefImpl.

References getGroupScope().

Referenced by getGroupScope().

◆ getMemberGroups()

virtual const MemberGroupList & GroupDef::getMemberGroups ( ) const

pure virtual

Implemented in GroupDefImpl.

References getMemberGroups().

Referenced by PerlModGenerator::generatePerlModForGroup(), generateSqlite3ForGroup(), generateXMLForGroup(), and getMemberGroups().

◆ getMemberList()

virtual MemberList * GroupDef::getMemberList ( MemberListType lt ) const

pure virtual

Implemented in GroupDefImpl.

References getMemberList().

Referenced by DotGroupCollaboration::buildGraph(), PerlModGenerator::generatePerlModForGroup(), getMemberList(), tryAddEnumDocsToGroupMember(), and writeGroupTreeNode().

◆ getMemberLists()

virtual const MemberLists & GroupDef::getMemberLists ( ) const

pure virtual

Implemented in GroupDefImpl.

References getMemberLists().

Referenced by generateSqlite3ForGroup(), generateXMLForGroup(), getMemberLists(), and writeGroupTreeNode().

◆ getModules()

virtual const ModuleLinkedRefMap & GroupDef::getModules ( ) const

pure virtual

Implemented in GroupDefImpl.

References getModules().

Referenced by PerlModGenerator::generatePerlModForGroup(), generateSqlite3ForGroup(), generateXMLForGroup(), and getModules().

◆ getNamespaces()

virtual const NamespaceLinkedRefMap & GroupDef::getNamespaces ( ) const

pure virtual

Implemented in GroupDefImpl.

References getNamespaces().

Referenced by DotGroupCollaboration::buildGraph(), PerlModGenerator::generatePerlModForGroup(), generateSqlite3ForGroup(), generateXMLForGroup(), getNamespaces(), and writeGroupTreeNode().

◆ getPages()

virtual const PageLinkedRefMap & GroupDef::getPages ( ) const

pure virtual

Implemented in GroupDefImpl.

References getPages().

Referenced by DotGroupCollaboration::buildGraph(), PerlModGenerator::generatePerlModForGroup(), generateSqlite3ForGroup(), generateXMLForGroup(), getPages(), and writeGroupTreeNode().

◆ getSubGroups()

virtual const GroupList & GroupDef::getSubGroups ( ) const

pure virtual

Implemented in GroupDefImpl.

References getSubGroups().

Referenced by DotGroupCollaboration::buildGraph(), PerlModGenerator::generatePerlModForGroup(), generateSqlite3ForGroup(), generateXMLForGroup(), getSubGroups(), hasNonReferenceNestedGroupRec(), and writeGroupTreeNode().

◆ groupTitle()

virtual QCString GroupDef::groupTitle ( ) const

pure virtual

Implemented in GroupDefImpl.

References groupTitle().

Referenced by buildGroupListFiltered(), DotGroupCollaboration::DotGroupCollaboration(), PerlModGenerator::generatePerlModForGroup(), generateSqlite3ForGroup(), generateXMLForGroup(), groupTitle(), DocParser::handleLinkedWord(), DefinitionImpl::navigationPathAsString(), DefinitionImpl::pathFragment(), SearchIndex::setCurrentDoc(), SearchIndexExternal::setCurrentDoc(), and writeGroupTreeNode().

◆ hasDetailedDescription()

virtual bool GroupDef::hasDetailedDescription ( ) const

pure virtual

Implemented in GroupDefImpl.

References hasDetailedDescription().

Referenced by hasDetailedDescription().

◆ hasGroupGraph()

virtual bool GroupDef::hasGroupGraph ( ) const

pure virtual

Implemented in GroupDefImpl.

References hasGroupGraph().

Referenced by hasGroupGraph().

◆ hasGroupTitle()

virtual bool GroupDef::hasGroupTitle ( ) const

pure virtual

Implemented in GroupDefImpl.

References hasGroupTitle().

Referenced by buildGroupListFiltered(), and hasGroupTitle().

◆ insertMember()

virtual bool GroupDef::insertMember	(	MemberDef *	def,
		bool	docOnly = FALSE )

pure virtual

Implemented in GroupDefImpl.

References FALSE, and insertMember().

Referenced by addMemberToGroups(), insertMember(), MemberGroup::insertMember(), and ClassDefImpl::setGroupDefForAllMembers().

◆ isASubGroup()

virtual bool GroupDef::isASubGroup ( ) const

pure virtual

Implemented in GroupDefImpl.

References isASubGroup().

Referenced by isASubGroup(), and writeGroupTreeNode().

◆ isVisibleInHierarchy()

virtual bool GroupDef::isVisibleInHierarchy ( ) const

pure virtual

Implemented in GroupDefImpl.

References isVisibleInHierarchy().

Referenced by isVisibleInHierarchy(), and writeGroupTreeNode().

◆ numDocMembers()

virtual size_t GroupDef::numDocMembers ( ) const

pure virtual

Implemented in GroupDefImpl.

References numDocMembers().

Referenced by numDocMembers().

◆ overrideGroupGraph()

virtual void GroupDef::overrideGroupGraph ( bool e )

pure virtual

Implemented in GroupDefImpl.

References createGroupDef(), Definition::name(), overrideGroupGraph(), and toGroupDef().

Referenced by buildGroupListFiltered(), and overrideGroupGraph().

◆ removeMember()

virtual void GroupDef::removeMember ( MemberDef * md )

pure virtual

Implemented in GroupDefImpl.

References removeMember().

Referenced by addMemberToGroups(), and removeMember().

◆ setGroupScope()

virtual void GroupDef::setGroupScope ( Definition * d )

pure virtual

Implemented in GroupDefImpl.

References setGroupScope().

Referenced by findGroupScope(), and setGroupScope().

◆ setGroupTitle()

virtual void GroupDef::setGroupTitle ( const QCString & newtitle )

pure virtual

Implemented in GroupDefImpl.

References setGroupTitle().

Referenced by buildGroupListFiltered(), and setGroupTitle().

◆ sortMemberLists()

virtual void GroupDef::sortMemberLists ( )

pure virtual

Implemented in GroupDefImpl.

References sortMemberLists().

Referenced by sortMemberLists().

◆ sortSubGroups()

virtual void GroupDef::sortSubGroups ( )

pure virtual

Implemented in GroupDefImpl.

References sortSubGroups().

Referenced by sortSubGroups().

◆ subGrouping()

virtual bool GroupDef::subGrouping ( ) const

pure virtual

Implemented in GroupDefImpl.

References subGrouping().

Referenced by subGrouping().

◆ writeDocumentation()

virtual void GroupDef::writeDocumentation ( OutputList & ol )

pure virtual

Implemented in GroupDefImpl.

References writeDocumentation().

Referenced by writeDocumentation().

◆ writeMemberPages()

virtual void GroupDef::writeMemberPages	(	OutputList &	ol,
		int	hierarchyLevel )

pure virtual

Implemented in GroupDefImpl.

References writeMemberPages().

Referenced by writeMemberPages().

◆ writeTagFile()

virtual void GroupDef::writeTagFile ( TextStream & )

pure virtual

Implemented in GroupDefImpl.

References writeTagFile().

Referenced by writeTagFile().

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

src/groupdef.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addClass()

◆ addConcept()

◆ addDir()

◆ addExample()

◆ addFile()

◆ addGroup()

◆ addListReferences()

◆ addMembersToMemberGroup()

◆ addModule()

◆ addNamespace()

◆ addPage()

◆ computeAnchors()

◆ containsFile()

◆ countMembers()

◆ distributeMemberGroupDocumentation()

◆ findGroup()

◆ findSectionsInDocumentation()

◆ getClasses()

◆ getConcepts()

◆ getDirs()

◆ getExamples()

◆ getFiles()

◆ getGroupScope()

◆ getMemberGroups()

◆ getMemberList()

◆ getMemberLists()

◆ getModules()

◆ getNamespaces()

◆ getPages()

◆ getSubGroups()

◆ groupTitle()

◆ hasDetailedDescription()

◆ hasGroupGraph()

◆ hasGroupTitle()

◆ insertMember()

◆ isASubGroup()

◆ isVisibleInHierarchy()

◆ numDocMembers()

◆ overrideGroupGraph()

◆ removeMember()

◆ setGroupScope()

◆ setGroupTitle()

◆ sortMemberLists()

◆ sortSubGroups()

◆ subGrouping()

◆ writeDocumentation()

◆ writeMemberPages()

◆ writeTagFile()