doxygen  1.8.18
About: Doxygen is a source code documentation generator tool for C++, C, Objective-C, C#, PHP, Java, Python, IDL (diverse flavors), Fortran, VHDL, Tcl, and to some extent D. Different output formats are supported.
  Fossies Dox: doxygen-1.8.18.src.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

GroupDef Class Referenceabstract

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

#include <groupdef.h>

+ Inheritance diagram for GroupDef:
+ Collaboration diagram for GroupDef:

Public Member Functions

 ~GroupDef ()
 
virtual DefType definitionType () const =0
 
virtual QCString getOutputFileBase () const =0
 
virtual QCString anchor () const =0
 
virtual QCString displayName (bool=TRUE) const =0
 
virtual const char * groupTitle () const =0
 
virtual void setGroupTitle (const char *newtitle)=0
 
virtual bool hasGroupTitle () const =0
 
virtual void addFile (const FileDef *def)=0
 
virtual bool addClass (const ClassDef *def)=0
 
virtual bool addNamespace (const NamespaceDef *def)=0
 
virtual void addGroup (const GroupDef *def)=0
 
virtual void addPage (PageDef *def)=0
 
virtual void addExample (const PageDef *def)=0
 
virtual void addDir (const 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)=0
 
virtual void writeQuickMemberLinks (OutputList &ol, const MemberDef *currentMd) const =0
 
virtual void writeTagFile (FTextStream &)=0
 
virtual int numDocMembers () const =0
 
virtual bool isLinkableInProject () const =0
 
virtual bool isLinkable () 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 DefinitiongetGroupScope () const =0
 
virtual MemberListgetMemberList (MemberListType lt) const =0
 
virtual const QList< MemberList > & getMemberLists () const =0
 
virtual MemberGroupSDictgetMemberGroupSDict () const =0
 
virtual FileListgetFiles () const =0
 
virtual ClassSDictgetClasses () const =0
 
virtual NamespaceSDictgetNamespaces () const =0
 
virtual GroupListgetSubGroups () const =0
 
virtual PageSDictgetPages () const =0
 
virtual DirListgetDirs () const =0
 
virtual PageSDictgetExamples () const =0
 
virtual bool hasDetailedDescription () const =0
 
virtual void sortSubGroups ()=0
 
- Public Member Functions inherited from Definition
virtual bool isAlias () const =0
 
virtual QCString name () const =0
 
virtual bool isAnonymous () const =0
 
virtual QCString localName () const =0
 
virtual QCString qualifiedName () const =0
 
virtual QCString symbolName () 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 isVisibleInProject () const =0
 
virtual bool isVisible () const =0
 
virtual bool isHidden () const =0
 
virtual bool isArtificial () 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 FileDefgetBodyDef () const =0
 
virtual SrcLangExt getLanguage () const =0
 Returns the programming language this definition was written in. More...
 
virtual GroupListpartOfGroups () const =0
 
virtual bool isLinkableViaGroup () const =0
 
virtual const std::vector< RefItem * > & xrefListItems () const =0
 
virtual DefinitionfindInnerCompound (const char *name) const =0
 
virtual DefinitiongetOuterScope () const =0
 
virtual MemberSDictgetReferencesMembers () const =0
 
virtual MemberSDictgetReferencedByMembers () 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 More...
 
virtual QCString id () const =0
 
virtual const SectionRefsgetSectionRefs () const =0
 returns the section dictionary, only of importance for pagedef More...
 
virtual QCString navigationPathAsString () const =0
 
virtual QCString pathFragment () const =0
 
virtual void setName (const char *name)=0
 
virtual void setId (const char *name)=0
 
virtual void setDefFile (const QCString &df, int defLine, int defColumn)=0
 
virtual void setDocumentation (const char *d, const char *docFile, int docLine, bool stripWhiteSpace=TRUE)=0
 
virtual void setBriefDescription (const char *b, const char *briefFile, int briefLine)=0
 
virtual void setInbodyDocumentation (const char *d, const char *docFile, int docLine)=0
 
virtual void setReference (const char *r)=0
 
virtual void setBodySegment (int defLine, int bls, int ble)=0
 
virtual void setBodyDef (FileDef *fd)=0
 
virtual void setRefItems (const std::vector< RefItem * > &sli)=0
 
virtual void setOuterScope (Definition *d)=0
 
virtual void setHidden (bool b)=0
 
virtual void setArtificial (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 (const MemberDef *d)=0
 
virtual void addSourceReferences (const MemberDef *d)=0
 
virtual void mergeRefItems (Definition *d)=0
 
virtual void addInnerCompound (const Definition *d)=0
 
virtual void addSectionsToIndex ()=0
 
virtual void writeSourceDef (OutputList &ol, const char *scopeName) const =0
 
virtual void writeInlineCode (OutputList &ol, const char *scopeName) const =0
 
virtual void writeSourceRefs (OutputList &ol, const char *scopeName) const =0
 
virtual void writeSourceReffedBy (OutputList &ol, const char *scopeName) const =0
 
virtual void writeNavigationPath (OutputList &ol) const =0
 
virtual void writeSummaryLinks (OutputList &) const =0
 
virtual void writeDocAnchorsToTagFile (FTextStream &) const =0
 
virtual void writeToc (OutputList &ol, const LocalToc &lt) const =0
 
virtual void setCookie (Cookie *cookie) const =0
 
virtual Cookiecookie () const =0
 
virtual void _setSymbolName (const QCString &name)=0
 
virtual QCString _symbolName () const =0
 
- Public Member Functions inherited from DefinitionIntf
 DefinitionIntf ()
 
virtual ~DefinitionIntf ()
 

Additional Inherited Members

- Public Types inherited from DefinitionIntf
enum  DefType {
  TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeMember = 3,
  TypeGroup = 4, TypePackage = 5, TypePage = 6, TypeDir = 7,
  TypeSymbolList = 8
}
 

Detailed Description

A model of a group of symbols.

Definition at line 47 of file groupdef.h.

Constructor & Destructor Documentation

◆ ~GroupDef()

GroupDef::~GroupDef ( )
inline

Definition at line 50 of file groupdef.h.

Member Function Documentation

◆ addClass()

virtual bool GroupDef::addClass ( const ClassDef def)
pure virtual

◆ addDir()

virtual void GroupDef::addDir ( const DirDef dd)
pure virtual

Implemented in GroupDefImpl.

Referenced by addDirToGroups().

◆ addExample()

virtual void GroupDef::addExample ( const PageDef def)
pure virtual

Implemented in GroupDefImpl.

Referenced by addExampleToGroups().

◆ addFile()

virtual void GroupDef::addFile ( const FileDef def)
pure virtual

Implemented in GroupDefImpl.

Referenced by buildFileList().

◆ addGroup()

virtual void GroupDef::addGroup ( const GroupDef def)
pure virtual

Implemented in GroupDefImpl.

Referenced by addDirsAsGroups(), and 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().

◆ addNamespace()

virtual bool GroupDef::addNamespace ( const 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().

◆ anchor()

virtual QCString GroupDef::anchor ( ) const
pure virtual

Returns the anchor within a page where this item can be found

Implements Definition.

Implemented in GroupDefImpl.

◆ computeAnchors()

virtual void GroupDef::computeAnchors ( )
pure virtual

Implemented in GroupDefImpl.

Referenced by computeMemberReferences().

◆ countMembers()

virtual void GroupDef::countMembers ( )
pure virtual

Implemented in GroupDefImpl.

Referenced by countMembers().

◆ definitionType()

virtual DefType GroupDef::definitionType ( ) const
pure virtual

Use this for dynamic inspection of the type of the derived class

Implements DefinitionIntf.

Implemented in GroupDefImpl.

◆ displayName()

virtual QCString GroupDef::displayName ( bool  includeScope = TRUE) const
pure virtual

Returns the name of the definition as it appears in the output

Implements Definition.

Implemented in GroupDefImpl.

◆ 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(), and GroupDefImpl::findGroup().

◆ findSectionsInDocumentation()

virtual void GroupDef::findSectionsInDocumentation ( )
pure virtual

Implemented in GroupDefImpl.

Referenced by findSectionsInDocumentation().

◆ getClasses()

◆ getDirs()

virtual DirList* GroupDef::getDirs ( ) const
pure virtual

◆ getExamples()

virtual PageSDict* GroupDef::getExamples ( ) const
pure virtual

◆ getFiles()

◆ getGroupScope()

virtual Definition* GroupDef::getGroupScope ( ) const
pure virtual

Implemented in GroupDefImpl.

◆ getMemberGroupSDict()

virtual MemberGroupSDict* GroupDef::getMemberGroupSDict ( ) const
pure virtual

◆ getMemberList()

◆ getMemberLists()

virtual const QList<MemberList>& GroupDef::getMemberLists ( ) const
pure virtual

Implemented in GroupDefImpl.

Referenced by generateXMLForGroup(), and writeGroupTreeNode().

◆ getNamespaces()

◆ getOutputFileBase()

◆ getPages()

◆ getSubGroups()

◆ groupTitle()

◆ hasDetailedDescription()

virtual bool GroupDef::hasDetailedDescription ( ) const
pure virtual

Implemented in GroupDefImpl.

Referenced by ModuleContext::Private::hasDetails().

◆ 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

◆ isASubGroup()

virtual bool GroupDef::isASubGroup ( ) const
pure virtual

◆ isLinkable()

virtual bool GroupDef::isLinkable ( ) const
pure virtual

Returns TRUE iff it is possible to link to this item. This can be a link to another project imported via a tag file.

Implements Definition.

Implemented in GroupDefImpl.

Referenced by addMemberToSearchIndex(), createJavaScriptSearchIndex(), findMembersWithSpecificName(), getDefs(), and DefinitionImpl::isLinkableViaGroup().

◆ isLinkableInProject()

virtual bool GroupDef::isLinkableInProject ( ) const
pure virtual

Returns TRUE iff it is possible to link to this item within this project.

Implements Definition.

Implemented in GroupDefImpl.

Referenced by MemberDefImpl::_computeLinkableInProject(), and writeTagFile().

◆ numDocMembers()

virtual int GroupDef::numDocMembers ( ) const
pure virtual

Implemented in GroupDefImpl.

◆ 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 char *  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 generateOutput().

◆ subGrouping()

virtual bool GroupDef::subGrouping ( ) const
pure virtual

Implemented in GroupDefImpl.

Referenced by ModuleContext::Private::memberGroups().

◆ writeDocumentation()

virtual void GroupDef::writeDocumentation ( OutputList ol)
pure virtual

Implemented in GroupDefImpl.

Referenced by generateGroupDocs().

◆ writeMemberPages()

virtual void GroupDef::writeMemberPages ( OutputList ol)
pure virtual

Implemented in GroupDefImpl.

◆ writeQuickMemberLinks()

virtual void GroupDef::writeQuickMemberLinks ( OutputList ol,
const MemberDef currentMd 
) const
pure virtual

Implements Definition.

Implemented in GroupDefImpl.

◆ writeTagFile()

virtual void GroupDef::writeTagFile ( FTextStream )
pure virtual

Implemented in GroupDefImpl.

Referenced by writeTagFile().


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