GroupDef Class Reference

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)=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 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.

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

addConcept()

virtual bool GroupDef::addConcept ( ConceptDef * def )

pure virtual

Implemented in GroupDefImpl.

Referenced by addConceptToGroups().

addDir()

virtual void GroupDef::addDir ( DirDef * dd )

pure virtual

Implemented in GroupDefImpl.

Referenced by addDirToGroups().

addExample()

virtual void GroupDef::addExample ( PageDef * def )

pure virtual

Implemented in GroupDefImpl.

Referenced by addExampleToGroups().

addFile()

virtual void GroupDef::addFile ( FileDef * def )

pure virtual

Implemented in GroupDefImpl.

Referenced by buildFileList().

addGroup()

virtual void GroupDef::addGroup ( GroupDef * def )

pure virtual

Implemented in GroupDefImpl.

Referenced by addGroupToGroups().

addListReferences()

virtual void GroupDef::addListReferences ( )

pure virtual

Implemented in GroupDefImpl.

Referenced by addListReferences().

addMembersToMemberGroup()

virtual void GroupDef::addMembersToMemberGroup ( )

pure virtual

Implemented in GroupDefImpl.

Referenced by addMembersToMemberGroup().

addModule()

virtual bool GroupDef::addModule ( ModuleDef * def )

pure virtual

Implemented in GroupDefImpl.

Referenced by addModuleToGroups().

addNamespace()

virtual bool GroupDef::addNamespace ( NamespaceDef * def )

pure virtual

Implemented in GroupDefImpl.

Referenced by addNamespaceToGroups(), and findUsingDirectives().

addPage()

virtual void GroupDef::addPage ( PageDef * def )

pure virtual

Implemented in GroupDefImpl.

Referenced by addRelatedPage().

computeAnchors()

virtual void GroupDef::computeAnchors ( )

pure virtual

Implemented in GroupDefImpl.

Referenced by computeMemberReferences().

containsFile()

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

pure virtual

Implemented in GroupDefImpl.

Referenced by buildFileList().

countMembers()

virtual void GroupDef::countMembers ( )

pure virtual

Implemented in GroupDefImpl.

Referenced by countMembers().

distributeMemberGroupDocumentation()

virtual void GroupDef::distributeMemberGroupDocumentation ( )

pure virtual

Implemented in GroupDefImpl.

Referenced by distributeMemberGroupDocumentation().

findGroup()

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

pure virtual

Implemented in GroupDefImpl.

Referenced by addGroupToGroups().

findSectionsInDocumentation()

virtual void GroupDef::findSectionsInDocumentation ( )

pure virtual

Implemented in GroupDefImpl.

Referenced by findSectionsInDocumentation().

getClasses()

virtual const ClassLinkedRefMap & GroupDef::getClasses ( ) const

pure virtual

Implemented in GroupDefImpl.

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

getConcepts()

virtual const ConceptLinkedRefMap & GroupDef::getConcepts ( ) const

pure virtual

Implemented in GroupDefImpl.

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

getDirs()

virtual const DirList & GroupDef::getDirs ( ) const

pure virtual

Implemented in GroupDefImpl.

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

getExamples()

virtual const PageLinkedRefMap & GroupDef::getExamples ( ) const

pure virtual

Implemented in GroupDefImpl.

getFiles()

virtual const FileList & GroupDef::getFiles ( ) const

pure virtual

Implemented in GroupDefImpl.

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

getGroupScope()

virtual Definition * GroupDef::getGroupScope ( ) const

pure virtual

Implemented in GroupDefImpl.

getMemberGroups()

virtual const MemberGroupList & GroupDef::getMemberGroups ( ) const

pure virtual

Implemented in GroupDefImpl.

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

getMemberList()

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

pure virtual

Implemented in GroupDefImpl.

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

getMemberLists()

virtual const MemberLists & GroupDef::getMemberLists ( ) const

pure virtual

Implemented in GroupDefImpl.

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

getModules()

virtual const ModuleLinkedRefMap & GroupDef::getModules ( ) const

pure virtual

Implemented in GroupDefImpl.

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

getNamespaces()

virtual const NamespaceLinkedRefMap & GroupDef::getNamespaces ( ) const

pure virtual

Implemented in GroupDefImpl.

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

getPages()

virtual const PageLinkedRefMap & GroupDef::getPages ( ) const

pure virtual

Implemented in GroupDefImpl.

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

getSubGroups()

virtual const GroupList & GroupDef::getSubGroups ( ) const

pure virtual

Implemented in GroupDefImpl.

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

groupTitle()

virtual QCString GroupDef::groupTitle ( ) const

pure virtual

Implemented in GroupDefImpl.

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

hasDetailedDescription()

virtual bool GroupDef::hasDetailedDescription ( ) const

pure virtual

Implemented in GroupDefImpl.

hasGroupGraph()

virtual bool GroupDef::hasGroupGraph ( ) const

pure virtual

Implemented in GroupDefImpl.

hasGroupTitle()

virtual bool GroupDef::hasGroupTitle ( ) const

pure virtual

Implemented in GroupDefImpl.

Referenced by buildGroupListFiltered().

insertMember()

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

pure virtual

Implemented in GroupDefImpl.

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

isASubGroup()

virtual bool GroupDef::isASubGroup ( ) const

pure virtual

Implemented in GroupDefImpl.

Referenced by writeGroupTreeNode().

isVisibleInHierarchy()

virtual bool GroupDef::isVisibleInHierarchy ( ) const

pure virtual

Implemented in GroupDefImpl.

Referenced by writeGroupTreeNode().

numDocMembers()

virtual size_t GroupDef::numDocMembers ( ) const

pure virtual

Implemented in GroupDefImpl.

overrideGroupGraph()

virtual void GroupDef::overrideGroupGraph ( bool e )

pure virtual

Implemented in GroupDefImpl.

Referenced by buildGroupListFiltered().

removeMember()

virtual void GroupDef::removeMember ( MemberDef * md )

pure virtual

Implemented in GroupDefImpl.

Referenced by addMemberToGroups().

setGroupScope()

virtual void GroupDef::setGroupScope ( Definition * d )

pure virtual

Implemented in GroupDefImpl.

Referenced by findGroupScope().

setGroupTitle()

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

pure virtual

Implemented in GroupDefImpl.

Referenced by buildGroupListFiltered().

sortMemberLists()

virtual void GroupDef::sortMemberLists ( )

pure virtual

Implemented in GroupDefImpl.

Referenced by sortMemberLists().

sortSubGroups()

virtual void GroupDef::sortSubGroups ( )

pure virtual

Implemented in GroupDefImpl.

Referenced by parseInput().

subGrouping()

virtual bool GroupDef::subGrouping ( ) const

pure virtual

Implemented in GroupDefImpl.

writeDocumentation()

virtual void GroupDef::writeDocumentation ( OutputList & ol )

pure virtual

Implemented in GroupDefImpl.

Referenced by generateGroupDocs().

writeMemberPages()

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

pure virtual

Implemented in GroupDefImpl.

writeTagFile()

virtual void GroupDef::writeTagFile ( TextStream & )

pure virtual

Implemented in GroupDefImpl.

Referenced by writeTagFile().

---

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

• src/groupdef.h