Skip to main content

The GroupDef Class Reference

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

Declaration​

class GroupDef { ... }

Included Headers​

#include <src/groupdef.h>

Base classes​

classDefinitionMutable
classDefinition

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

Derived Classes​

classDefinitionMixin<Base>

Public Member Functions Index​

QCStringgroupTitle () const =0
voidsetGroupTitle (const QCString &newtitle)=0
boolhasGroupTitle () const =0
voidaddFile (FileDef *def)=0
boolcontainsFile (const FileDef *def) const =0
booladdClass (ClassDef *def)=0
booladdConcept (ConceptDef *def)=0
booladdModule (ModuleDef *def)=0
booladdNamespace (NamespaceDef *def)=0
voidaddGroup (GroupDef *def)=0
voidaddPage (PageDef *def)=0
voidaddExample (PageDef *def)=0
voidaddDir (DirDef *dd)=0
boolinsertMember (MemberDef *def, bool docOnly=FALSE)=0
voidremoveMember (MemberDef *md)=0
boolfindGroup (const GroupDef *def) const =0
voidwriteDocumentation (OutputList &ol)=0
voidwriteMemberPages (OutputList &ol, int hierarchyLevel)=0
voidwriteTagFile (TextStream &)=0
size_tnumDocMembers () const =0
boolisVisibleInHierarchy () const =0
boolisASubGroup () const =0
voidcomputeAnchors ()=0
voidcountMembers ()=0
voidaddMembersToMemberGroup ()=0
voiddistributeMemberGroupDocumentation ()=0
voidfindSectionsInDocumentation ()=0
voidaddListReferences ()=0
voidsortMemberLists ()=0
boolsubGrouping () const =0
voidsetGroupScope (Definition *d)=0
Definition *getGroupScope () const =0
MemberList *getMemberList (MemberListType lt) const =0
const MemberLists &getMemberLists () const =0
const MemberGroupList &getMemberGroups () const =0
const FileList &getFiles () const =0
const ClassLinkedRefMap &getClasses () const =0
const ConceptLinkedRefMap &getConcepts () const =0
const ModuleLinkedRefMap &getModules () const =0
const NamespaceLinkedRefMap &getNamespaces () const =0
const GroupList &getSubGroups () const =0
const PageLinkedRefMap &getPages () const =0
const DirList &getDirs () const =0
const PageLinkedRefMap &getExamples () const =0
boolhasDetailedDescription () const =0
voidsortSubGroups ()=0
boolhasGroupGraph () const =0
voidoverrideGroupGraph (bool e)=0

Description​

A model of a group of symbols.

Definition at line 51 of file groupdef.h.

Public Member Functions​

addClass()​

virtual bool GroupDef::addClass (ClassDef * def)

Definition at line 61 of file groupdef.h.

Reference addClass.

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

addConcept()​

virtual bool GroupDef::addConcept (ConceptDef * def)

Definition at line 62 of file groupdef.h.

Reference addConcept.

Referenced by addConcept and addConceptToGroups.

addDir()​

virtual void GroupDef::addDir (DirDef * dd)

Definition at line 68 of file groupdef.h.

Reference addDir.

Referenced by addDir and addDirToGroups.

addExample()​

virtual void GroupDef::addExample (PageDef * def)

Definition at line 67 of file groupdef.h.

Reference addExample.

Referenced by addExample and addExampleToGroups.

addFile()​

virtual void GroupDef::addFile (FileDef * def)

Definition at line 59 of file groupdef.h.

Reference addFile.

Referenced by addFile and buildFileList.

addGroup()​

virtual void GroupDef::addGroup (GroupDef * def)

Definition at line 65 of file groupdef.h.

Reference addGroup.

Referenced by addGroup and addGroupToGroups.

addListReferences()​

virtual void GroupDef::addListReferences ()

Definition at line 85 of file groupdef.h.

Reference addListReferences.

Referenced by addListReferences.

addMembersToMemberGroup()​

virtual void GroupDef::addMembersToMemberGroup ()

Definition at line 81 of file groupdef.h.

Reference addMembersToMemberGroup.

Referenced by addMembersToMemberGroup.

addModule()​

virtual bool GroupDef::addModule (ModuleDef * def)

Definition at line 63 of file groupdef.h.

Reference addModule.

Referenced by addModule and addModuleToGroups.

addNamespace()​

virtual bool GroupDef::addNamespace (NamespaceDef * def)

Definition at line 64 of file groupdef.h.

Reference addNamespace.

Referenced by addNamespace, addNamespaceToGroups and findUsingDirectives.

addPage()​

virtual void GroupDef::addPage (PageDef * def)

Definition at line 66 of file groupdef.h.

Reference addPage.

Referenced by addPage and addRelatedPage.

computeAnchors()​

virtual void GroupDef::computeAnchors ()

Definition at line 78 of file groupdef.h.

Reference computeAnchors.

Referenced by computeAnchors.

containsFile()​

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

Definition at line 60 of file groupdef.h.

Reference containsFile.

Referenced by buildFileList and containsFile.

countMembers()​

virtual void GroupDef::countMembers ()

Definition at line 79 of file groupdef.h.

Reference countMembers.

Referenced by countMembers.

distributeMemberGroupDocumentation()​

virtual void GroupDef::distributeMemberGroupDocumentation ()

Definition at line 82 of file groupdef.h.

Reference distributeMemberGroupDocumentation.

Referenced by distributeMemberGroupDocumentation.

findGroup()​

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

Definition at line 71 of file groupdef.h.

Reference findGroup.

Referenced by addGroupToGroups and findGroup.

findSectionsInDocumentation()​

virtual void GroupDef::findSectionsInDocumentation ()

Definition at line 83 of file groupdef.h.

Reference findSectionsInDocumentation.

Referenced by findSectionsInDocumentation.

getClasses()​

virtual const ClassLinkedRefMap & GroupDef::getClasses ()

Definition at line 99 of file groupdef.h.

Reference getClasses.

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

getConcepts()​

virtual const ConceptLinkedRefMap & GroupDef::getConcepts ()

Definition at line 100 of file groupdef.h.

Reference getConcepts.

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

getDirs()​

virtual const DirList & GroupDef::getDirs ()

Definition at line 105 of file groupdef.h.

Reference getDirs.

Referenced by DotGroupCollaboration::buildGraph, getDirs and writeGroupTreeNode.

getExamples()​

virtual const PageLinkedRefMap & GroupDef::getExamples ()

Definition at line 106 of file groupdef.h.

Reference getExamples.

Referenced by getExamples.

getFiles()​

virtual const FileList & GroupDef::getFiles ()

Definition at line 98 of file groupdef.h.

Reference getFiles.

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

getGroupScope()​

virtual Definition * GroupDef::getGroupScope ()

Definition at line 90 of file groupdef.h.

Reference getGroupScope.

Referenced by getGroupScope.

getMemberGroups()​

virtual const MemberGroupList & GroupDef::getMemberGroups ()

Definition at line 96 of file groupdef.h.

Reference getMemberGroups.

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

getMemberList()​

virtual MemberList * GroupDef::getMemberList (MemberListType lt)

Definition at line 92 of file groupdef.h.

Reference getMemberList.

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

getMemberLists()​

virtual const MemberLists & GroupDef::getMemberLists ()

Definition at line 93 of file groupdef.h.

Reference getMemberLists.

Referenced by generateSqlite3ForGroup, generateXMLForGroup, getMemberLists and writeGroupTreeNode.

getModules()​

virtual const ModuleLinkedRefMap & GroupDef::getModules ()

Definition at line 101 of file groupdef.h.

Reference getModules.

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

getNamespaces()​

virtual const NamespaceLinkedRefMap & GroupDef::getNamespaces ()

Definition at line 102 of file groupdef.h.

Reference getNamespaces.

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

getPages()​

virtual const PageLinkedRefMap & GroupDef::getPages ()

Definition at line 104 of file groupdef.h.

Reference getPages.

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

getSubGroups()​

virtual const GroupList & GroupDef::getSubGroups ()

Definition at line 103 of file groupdef.h.

Reference getSubGroups.

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

groupTitle()​

virtual QCString GroupDef::groupTitle ()

Definition at line 56 of file groupdef.h.

Reference groupTitle.

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

hasDetailedDescription()​

virtual bool GroupDef::hasDetailedDescription ()

Definition at line 107 of file groupdef.h.

Reference hasDetailedDescription.

Referenced by hasDetailedDescription.

hasGroupGraph()​

virtual bool GroupDef::hasGroupGraph ()

Definition at line 111 of file groupdef.h.

Reference hasGroupGraph.

Referenced by hasGroupGraph.

hasGroupTitle()​

virtual bool GroupDef::hasGroupTitle ()

Definition at line 58 of file groupdef.h.

Reference hasGroupTitle.

Referenced by buildGroupListFiltered and hasGroupTitle.

insertMember()​

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

Definition at line 69 of file groupdef.h.

References FALSE and insertMember.

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

isASubGroup()​

virtual bool GroupDef::isASubGroup ()

Definition at line 77 of file groupdef.h.

Reference isASubGroup.

Referenced by isASubGroup and writeGroupTreeNode.

isVisibleInHierarchy()​

virtual bool GroupDef::isVisibleInHierarchy ()

Definition at line 76 of file groupdef.h.

Reference isVisibleInHierarchy.

Referenced by isVisibleInHierarchy and writeGroupTreeNode.

numDocMembers()​

virtual size_t GroupDef::numDocMembers ()

Definition at line 75 of file groupdef.h.

Reference numDocMembers.

Referenced by numDocMembers.

overrideGroupGraph()​

virtual void GroupDef::overrideGroupGraph (bool e)

Definition at line 112 of file groupdef.h.

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

Referenced by buildGroupListFiltered and overrideGroupGraph.

removeMember()​

virtual void GroupDef::removeMember (MemberDef * md)

Definition at line 70 of file groupdef.h.

Reference removeMember.

Referenced by addMemberToGroups and removeMember.

setGroupScope()​

virtual void GroupDef::setGroupScope (Definition * d)

Definition at line 89 of file groupdef.h.

Reference setGroupScope.

Referenced by findGroupScope and setGroupScope.

setGroupTitle()​

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

Definition at line 57 of file groupdef.h.

Reference setGroupTitle.

Referenced by buildGroupListFiltered and setGroupTitle.

sortMemberLists()​

virtual void GroupDef::sortMemberLists ()

Definition at line 86 of file groupdef.h.

Reference sortMemberLists.

Referenced by sortMemberLists.

sortSubGroups()​

virtual void GroupDef::sortSubGroups ()

Definition at line 108 of file groupdef.h.

Reference sortSubGroups.

Referenced by sortSubGroups.

subGrouping()​

virtual bool GroupDef::subGrouping ()

Definition at line 87 of file groupdef.h.

Reference subGrouping.

Referenced by subGrouping.

writeDocumentation()​

virtual void GroupDef::writeDocumentation (OutputList & ol)

Definition at line 72 of file groupdef.h.

Reference writeDocumentation.

Referenced by writeDocumentation.

writeMemberPages()​

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

Definition at line 73 of file groupdef.h.

Reference writeMemberPages.

Referenced by writeMemberPages.

writeTagFile()​

virtual void GroupDef::writeTagFile (TextStream &)

Definition at line 74 of file groupdef.h.

Reference writeTagFile.

Referenced by writeTagFile.

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

Generated via doxygen2docusaurus by Doxygen 1.14.0.