The ClassDef Class Reference

A abstract class representing of a compound symbol. More...

Declaration

class ClassDef { ... }

Included Headers

#include <src/classdef.h>

Base class

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

Derived Classes

class	DefinitionAliasMixin<Base>
class	ClassDefMutable

Enumerations Index

enum	CompoundType { ... }
	The various compound types. More...

Public Member Functions Index

std::unique_ptr< ClassDef >	deepCopy (const QCString &name) const =0
void	moveTo (Definition *)=0
QCString	getInstanceOutputFileBase () const =0
bool	isLocal () const =0
	Returns TRUE if this is a local class definition, see EXTRACT_LOCAL_CLASSES. More...
ClassLinkedRefMap	getClasses () const =0
	returns the classes nested into this class More...
bool	hasDetailedDescription () const =0
	returns TRUE if this class has a non-empty detailed description More...
QCString	collaborationGraphFileName () const =0
	returns the file name to use for the collaboration graph More...
QCString	inheritanceGraphFileName () const =0
	returns the file name to use for the inheritance graph More...
CompoundType	compoundType () const =0
	Returns the type of compound this is, i.e. More...
QCString	compoundTypeString () const =0
	Returns the type of compound as a string. More...
const BaseClassList &	baseClasses () const =0
	Returns the list of base classes from which this class directly inherits. More...
void	updateBaseClasses (const BaseClassList &bcd)=0
	Update the list of base classes to the one passed. More...
const BaseClassList &	subClasses () const =0
	Returns the list of sub classes that directly derive from this class. More...
void	updateSubClasses (const BaseClassList &bcd)=0
	Update the list of sub classes to the one passed. More...
const MemberNameInfoLinkedMap &	memberNameInfoLinkedMap () const =0
	Returns a dictionary of all members. More...
Protection	protection () const =0
	Return the protection level (Public,Protected,Private) in which this compound was found. More...
bool	isVisibleInHierarchy () const =0
	the class is visible in a class diagram, or class hierarchy More...
bool	visibleInParentsDeclList () const =0
	show this class in the declaration section of its parent? More...
const ArgumentList &	templateArguments () const =0
	Returns the template arguments of this class. More...
FileDef *	getFileDef () const =0
	Returns the namespace this compound is in, or 0 if it has a global scope. More...
ModuleDef *	getModuleDef () const =0
	Returns the C++20 module in which this compound's definition can be found. More...
const MemberDef *	getMemberByName (const QCString &) const =0
	Returns the member with the given name. More...
int	isBaseClass (const ClassDef *bcd, bool followInstances, const QCString &templSpec=QCString()) const =0
	Returns TRUE iff bcd is a direct or indirect base class of this class. More...
bool	isSubClass (ClassDef *bcd, int level=0) const =0
	Returns TRUE iff bcd is a direct or indirect sub class of this class. More...
bool	isAccessibleMember (const MemberDef *md) const =0
	returns TRUE iff md is a member of this class or of the the public/protected members of a base class More...
const TemplateInstanceList &	getTemplateInstances () const =0
	Returns a sorted dictionary with all template instances found for this template class. More...
const ClassDef *	templateMaster () const =0
	Returns the template master of which this class is an instance. More...
bool	isTemplate () const =0
	Returns TRUE if this class is a template. More...
const IncludeInfo *	includeInfo () const =0
const UsesClassList &	usedImplementationClasses () const =0
const UsesClassList &	usedByImplementationClasses () const =0
const ConstraintClassList &	templateTypeConstraints () const =0
bool	isTemplateArgument () const =0
ArgumentLists	getTemplateParameterLists () const =0
	Returns the template parameter lists that form the template declaration of this class. More...
QCString	qualifiedNameWithTemplateParameters (const ArgumentLists *actualParams=nullptr, uint32_t *actualParamIndex=nullptr) const =0
bool	isAbstract () const =0
	Returns TRUE if there is at least one pure virtual member in this class. More...
bool	isObjectiveC () const =0
	Returns TRUE if this class is implemented in Objective-C. More...
bool	isFortran () const =0
	Returns TRUE if this class is implemented in Fortran. More...
bool	isCSharp () const =0
	Returns TRUE if this class is implemented in C#. More...
bool	isFinal () const =0
	Returns TRUE if this class is marked as final. More...
bool	isSealed () const =0
	Returns TRUE if this class is marked as sealed. More...
bool	isPublished () const =0
	Returns TRUE if this class is marked as published. More...
bool	isExtension () const =0
	Returns TRUE if this class represents an Objective-C 2.0 extension (nameless category) More...
bool	isForwardDeclared () const =0
	Returns TRUE if this class represents a forward declaration of a template class. More...
bool	isInterface () const =0
	Returns TRUE if this class represents an interface. More...
ClassDef *	categoryOf () const =0
	Returns the class of which this is a category (Objective-C only) More...
QCString	className () const =0
	Returns the name of the class including outer classes, but not including namespaces. More...
MemberList *	getMemberList (MemberListType lt) const =0
	Returns the members in the list identified by lt. More...
const MemberLists &	getMemberLists () const =0
	Returns the list containing the list of members sorted per type. More...
const MemberGroupList &	getMemberGroups () const =0
	Returns the member groups defined for this class. More...
const TemplateNameMap &	getTemplateBaseClassNames () const =0
bool	isUsedOnly () const =0
bool	isEmbeddedInOuterScope () const =0
bool	isSimple () const =0
const ClassDef *	tagLessReference () const =0
const MemberDef *	isSmartPointer () const =0
bool	isJavaEnum () const =0
QCString	title () const =0
QCString	generatedFromFiles () const =0
const FileList &	usedFiles () const =0
const ArgumentList &	typeConstraints () const =0
const ExampleList &	getExamples () const =0
bool	hasExamples () const =0
QCString	getMemberListFileName () const =0
bool	subGrouping () const =0
bool	isSliceLocal () const =0
bool	hasNonReferenceSuperClass () const =0
QCString	requiresClause () const =0
StringVector	getQualifiers () const =0
bool	containsOverload (const MemberDef *md) const =0
bool	isImplicitTemplateInstance () const =0
int	countMembersIncludingGrouped (MemberListType lt, const ClassDef *inheritedFrom, bool additional) const =0
int	countMemberDeclarations (MemberListType lt, const ClassDef *inheritedFrom, MemberListType lt2, bool invert, bool showAlways, ClassDefSet &visitedClasses) const =0
void	writeDeclarationLink (OutputList &ol, bool &found, const QCString &header, bool localNames) const =0
void	writeDocumentation (OutputList &ol) const =0
void	writeDocumentationForInnerClasses (OutputList &ol) const =0
void	writeMemberPages (OutputList &ol) const =0
void	writeMemberList (OutputList &ol) const =0
void	writeDeclaration (OutputList &ol, const MemberDef *md, bool inGroup, int indentLevel, const ClassDef *inheritedFrom, const QCString &inheritId) const =0
void	writeQuickMemberLinks (OutputList &ol, const MemberDef *md) const =0
void	writeSummaryLinks (OutputList &ol) const =0
void	writePageNavigation (OutputList &ol) const =0
void	writeInlineDocumentation (OutputList &ol) const =0
void	writeTagFile (TextStream &) const =0
void	writeMemberDeclarations (OutputList &ol, ClassDefSet &visitedClasses, MemberListType lt, const QCString &title, const QCString &subTitle=QCString(), bool showInline=FALSE, const ClassDef *inheritedFrom=nullptr, MemberListType lt2=MemberListType::Invalid(), bool invert=FALSE, bool showAlways=FALSE) const =0
void	addGroupedInheritedMembers (OutputList &ol, MemberListType lt, const ClassDef *inheritedFrom, const QCString &inheritId) const =0

Description

A abstract class representing of a compound symbol.

A compound can be a class, struct, union, interface, service, singleton, or exception.

Definition at line 103 of file classdef.h.

Enumerations

CompoundType

enum ClassDef::CompoundType

The various compound types.

Enumeration values

Class
Struct
Union
Interface
Protocol
Category
Exception
Service
Singleton

Definition at line 109 of file classdef.h.

109 enum CompoundType { Class, //=Entry::CLASS_SEC,

110 Struct, //=Entry::STRUCT_SEC,

111 Union, //=Entry::UNION_SEC,

112 Interface, //=Entry::INTERFACE_SEC,

113 Protocol, //=Entry::PROTOCOL_SEC,

114 Category, //=Entry::CATEGORY_SEC,

115 Exception, //=Entry::EXCEPTION_SEC

116 Service, //=Entry::CLASS_SEC

117 Singleton, //=Entry::CLASS_SEC

118 };

Public Member Functions

addGroupedInheritedMembers()

virtual void ClassDef::addGroupedInheritedMembers (OutputList & ol, MemberListType lt, const ClassDef * inheritedFrom, const QCString & inheritId)

Definition at line 368 of file classdef.h.

Referenced by ClassDefAliasImpl::addGroupedInheritedMembers and MemberList::writeDeclarations.

baseClasses()

virtual const BaseClassList & ClassDef::baseClasses ()

Returns the list of base classes from which this class directly inherits.

Definition at line 153 of file classdef.h.

Referenced by VhdlDocGen::addBaseClass, DotGfxHierarchyTable::addHierarchy, ClassDefAliasImpl::baseClasses, DotClassGraph::buildGraph, classHasVisibleChildren, classHasVisibleRoot, classInheritedProtectionLevel, computeMemberRelationsForBaseClass, generateDEFForClass, PerlModGenerator::generatePerlModForClass, generateSqlite3ForClass, generateXMLForClass, ClassDefImpl::hideDerivedVariablesInPython, DiagramRow::insertClass, ClassDefImpl::mergeCategory, minClassDistance, trimBaseClassScope, writeClassTreeToOutput and writeObjCMethodCall.

categoryOf()

virtual ClassDef * ClassDef::categoryOf ()

Returns the class of which this is a category (Objective-C only)

Definition at line 286 of file classdef.h.

Referenced by MemberDefImpl::_writeCategoryRelation, ClassDefAliasImpl::categoryOf, classInheritedProtectionLevel, minClassDistance and writeObjCMethodCall.

className()

virtual QCString ClassDef::className ()

Returns the name of the class including outer classes, but not including namespaces.

Definition at line 291 of file classdef.h.

Referenced by ClassDefAliasImpl::className, VhdlDocGen::findAllArchitectures, VhdlDocGen::getClassName, makeDisplayName, makeQualifiedNameWithTemplateParameters, DefinitionImpl::navigationPathAsString, FileDefImpl::sortMemberLists, GroupDefImpl::sortMemberLists, ModuleDefImpl::sortMemberLists, NamespaceDefImpl::sortMemberLists and VhdlDocGen::writeInlineClassLink.

collaborationGraphFileName()

virtual QCString ClassDef::collaborationGraphFileName ()

returns the file name to use for the collaboration graph

Definition at line 139 of file classdef.h.

Referenced by ClassDefAliasImpl::collaborationGraphFileName and DotClassGraph::DotClassGraph.

compoundType()

virtual CompoundType ClassDef::compoundType ()

Returns the type of compound this is, i.e.

class/struct/union/..

Definition at line 145 of file classdef.h.

Referenced by MemberDefImpl::_writeReimplements, DocSets::addIndexItem, buildInterfaceAndServiceList, compoundIcon, ClassDefAliasImpl::compoundType, computeMemberRelationsForBaseClass, createTagLessInstance, generateLink, FileDefImpl::insertClass, NamespaceDefImpl::insertClass, makeDisplayName, ClassDefImpl::mergeMembersFromBaseClasses and writeClassTree.

compoundTypeString()

virtual QCString ClassDef::compoundTypeString ()

Returns the type of compound as a string.

Definition at line 148 of file classdef.h.

Referenced by addClassToContext, ClassDefAliasImpl::compoundTypeString, generateDEFForClass, PerlModGenerator::generatePerlModForClass, generateSqlite3ForClass, generateXMLForClass, SearchIndex::setCurrentDoc, MemberDefImpl::warnIfUndocumented and MemberDefImpl::writeDocumentation.

containsOverload()

virtual bool ClassDef::containsOverload (const MemberDef * md)

Definition at line 333 of file classdef.h.

Referenced by ClassDefAliasImpl::containsOverload and findUsingDeclImports.

countMemberDeclarations()

virtual int ClassDef::countMemberDeclarations (MemberListType lt, const ClassDef * inheritedFrom, MemberListType lt2, bool invert, bool showAlways, ClassDefSet & visitedClasses)

Definition at line 343 of file classdef.h.

Referenced by ClassDefImpl::countInheritedDecMembers and ClassDefAliasImpl::countMemberDeclarations.

countMembersIncludingGrouped()

virtual int ClassDef::countMembersIncludingGrouped (MemberListType lt, const ClassDef * inheritedFrom, bool additional)

Definition at line 341 of file classdef.h.

Referenced by ClassDefAliasImpl::countMembersIncludingGrouped.

deepCopy()

virtual std::unique_ptr< ClassDef > ClassDef::deepCopy (const QCString & name)

Definition at line 120 of file classdef.h.

Reference Definition::name.

Referenced by findUsingDeclImports.

generatedFromFiles()

virtual QCString ClassDef::generatedFromFiles ()

Definition at line 318 of file classdef.h.

Referenced by ClassDefAliasImpl::generatedFromFiles.

getClasses()

virtual ClassLinkedRefMap ClassDef::getClasses ()

returns the classes nested into this class

Definition at line 133 of file classdef.h.

Referenced by addClassAndNestedClasses, ClassDefImpl::addMembersToTemplateInstance, findTagLessClasses, PerlModGenerator::generatePerlModForClass, generateSqlite3ForClass, generateXMLForClass, ClassDefAliasImpl::getClasses, processTagLessClasses and writeClassTree.

getExamples()

virtual const ExampleList & ClassDef::getExamples ()

Definition at line 322 of file classdef.h.

Referenced by ClassDefAliasImpl::getExamples.

getFileDef()

virtual FileDef * ClassDef::getFileDef ()

Returns the namespace this compound is in, or 0 if it has a global scope.

Returns the file in which this compound's definition can be found. Should not return 0 (but it might be a good idea to check anyway).

Definition at line 193 of file classdef.h.

Referenced by addInstance, createTagLessInstance, findClassRelation, findClassWithinClassContext, findModuleDef, findUsedClassesForClass, generateClassOrGlobalLink, generateXMLForClass, getDefsOld, ClassDefAliasImpl::getFileDef, SymbolResolver::Private::isAccessibleFrom, writeTemplateList and writeTemplateList.

getInstanceOutputFileBase()

virtual QCString ClassDef::getInstanceOutputFileBase ()

Definition at line 127 of file classdef.h.

Referenced by ClassDefAliasImpl::getInstanceOutputFileBase.

getMemberByName()

virtual const MemberDef * ClassDef::getMemberByName (const QCString &)

Returns the member with the given name.

Definition at line 200 of file classdef.h.

Referenced by buildFunctionList, SymbolResolver::Private::followPath, generateClassMemberLink, generateClassOrGlobalLink, ClassDefAliasImpl::getMemberByName, setCallContextForVar and writeObjCMethodCall.

getMemberGroups()

virtual const MemberGroupList & ClassDef::getMemberGroups ()

Returns the member groups defined for this class.

Definition at line 300 of file classdef.h.

Referenced by PerlModGenerator::generatePerlModForClass, generateSqlite3ForClass, generateXMLForClass and ClassDefAliasImpl::getMemberGroups.

getMemberList()

virtual MemberList * ClassDef::getMemberList (MemberListType lt)

Returns the members in the list identified by lt.

Definition at line 294 of file classdef.h.

Referenced by createTagLessInstance, VhdlDocGen::findAllPackages, VhdlDocGen::findFunction, VhdlDocGen::findMemberDef, generateDEFForClass, PerlModGenerator::generatePerlModForClass, ClassDefAliasImpl::getMemberList and processTagLessClasses.

getMemberListFileName()

virtual QCString ClassDef::getMemberListFileName ()

Definition at line 324 of file classdef.h.

Referenced by ClassDefAliasImpl::getMemberListFileName.

getMemberLists()

virtual const MemberLists & ClassDef::getMemberLists ()

Returns the list containing the list of members sorted per type.

Definition at line 297 of file classdef.h.

Referenced by generateDEFForClass, generateSqlite3ForClass, generateXMLForClass and ClassDefAliasImpl::getMemberLists.

getModuleDef()

virtual ModuleDef * ClassDef::getModuleDef ()

Returns the C++20 module in which this compound's definition can be found.

Definition at line 197 of file classdef.h.

Referenced by ClassDefAliasImpl::getModuleDef.

getQualifiers()

virtual StringVector ClassDef::getQualifiers ()

Definition at line 331 of file classdef.h.

Referenced by generateXMLForClass and ClassDefAliasImpl::getQualifiers.

getTemplateBaseClassNames()

virtual const TemplateNameMap & ClassDef::getTemplateBaseClassNames ()

Definition at line 302 of file classdef.h.

Referenced by computeTemplateClassRelations and ClassDefAliasImpl::getTemplateBaseClassNames.

getTemplateInstances()

virtual const TemplateInstanceList & ClassDef::getTemplateInstances ()

Returns a sorted dictionary with all template instances found for this template class.

Returns 0 if not a template or no instances.

Definition at line 221 of file classdef.h.

Referenced by DotClassGraph::buildGraph, computeTemplateClassRelations, ClassDefAliasImpl::getTemplateInstances and hasNonReferenceSuperClassRec.

getTemplateParameterLists()

virtual ArgumentLists ClassDef::getTemplateParameterLists ()

Returns the template parameter lists that form the template declaration of this class.

Example: template<class T> class TC {} = 0; will return a list with one ArgumentList containing one argument with type="class" and name="T".

Definition at line 248 of file classdef.h.

Referenced by addMemberFunction, ClassDefAliasImpl::getTemplateParameterLists and MemberDefImpl::writeDocumentation.

hasDetailedDescription()

virtual bool ClassDef::hasDetailedDescription ()

returns TRUE if this class has a non-empty detailed description

Definition at line 136 of file classdef.h.

Referenced by ClassDefAliasImpl::hasDetailedDescription.

hasExamples()

virtual bool ClassDef::hasExamples ()

Definition at line 323 of file classdef.h.

Referenced by ClassDefAliasImpl::hasExamples.

hasNonReferenceSuperClass()

virtual bool ClassDef::hasNonReferenceSuperClass ()

Definition at line 328 of file classdef.h.

Referenced by ClassDefAliasImpl::hasNonReferenceSuperClass.

includeInfo()

virtual const IncludeInfo * ClassDef::includeInfo ()

Definition at line 231 of file classdef.h.

Referenced by DocSets::addIndexItem, PerlModGenerator::generatePerlModForClass, generateSqlite3ForClass, generateXMLForClass and ClassDefAliasImpl::includeInfo.

inheritanceGraphFileName()

virtual QCString ClassDef::inheritanceGraphFileName ()

returns the file name to use for the inheritance graph

Definition at line 142 of file classdef.h.

Referenced by DotClassGraph::DotClassGraph and ClassDefAliasImpl::inheritanceGraphFileName.

isAbstract()

virtual bool ClassDef::isAbstract ()

Returns TRUE if there is at least one pure virtual member in this class.

Definition at line 256 of file classdef.h.

Referenced by generateXMLForClass and ClassDefAliasImpl::isAbstract.

isAccessibleMember()

virtual bool ClassDef::isAccessibleMember (const MemberDef * md)

returns TRUE iff md is a member of this class or of the the public/protected members of a base class

Definition at line 216 of file classdef.h.

Referenced by ClassDefAliasImpl::isAccessibleMember.

isBaseClass()

virtual int ClassDef::isBaseClass (const ClassDef * bcd, bool followInstances, const QCString & templSpec=QCString())

Returns TRUE iff bcd is a direct or indirect base class of this class.

This function will recursively traverse all branches of the inheritance tree.

Definition at line 206 of file classdef.h.

Referenced by addInstance, findClassRelation, findMemberLink, ClassDefAliasImpl::isBaseClass, ClassDefImpl::isBaseClass, MemberDefImpl::isReimplementedBy, VhdlDocGen::isSubClass and ClassDefImpl::mergeMembersFromBaseClasses.

isCSharp()

virtual bool ClassDef::isCSharp ()

Returns TRUE if this class is implemented in C#.

Definition at line 265 of file classdef.h.

Referenced by ClassDefAliasImpl::isCSharp.

isEmbeddedInOuterScope()

virtual bool ClassDef::isEmbeddedInOuterScope ()

Definition at line 306 of file classdef.h.

Referenced by addClassAndNestedClasses and ClassDefAliasImpl::isEmbeddedInOuterScope.

isExtension()

virtual bool ClassDef::isExtension ()

Returns TRUE if this class represents an Objective-C 2.0 extension (nameless category)

Definition at line 277 of file classdef.h.

Referenced by ClassDefAliasImpl::isExtension and ClassDefImpl::mergeCategory.

isFinal()

virtual bool ClassDef::isFinal ()

Returns TRUE if this class is marked as final.

Definition at line 268 of file classdef.h.

Referenced by generateXMLForClass and ClassDefAliasImpl::isFinal.

isFortran()

virtual bool ClassDef::isFortran ()

Returns TRUE if this class is implemented in Fortran.

Definition at line 262 of file classdef.h.

Referenced by ClassDefAliasImpl::isFortran.

isForwardDeclared()

virtual bool ClassDef::isForwardDeclared ()

Returns TRUE if this class represents a forward declaration of a template class.

Definition at line 280 of file classdef.h.

Referenced by addClassToContext and ClassDefAliasImpl::isForwardDeclared.

isImplicitTemplateInstance()

virtual bool ClassDef::isImplicitTemplateInstance ()

Definition at line 335 of file classdef.h.

Referenced by addClassAndNestedClasses, Index::addClassMemberNameToIndex, addMemberToSearchIndex, generateDEFForClass, PerlModGenerator::generatePerlModForClass, generateSqlite3ForClass, generateXMLForClass, ClassDefAliasImpl::isImplicitTemplateInstance and writeClassTree.

isInterface()

virtual bool ClassDef::isInterface ()

Returns TRUE if this class represents an interface.

Definition at line 283 of file classdef.h.

Referenced by ClassDefAliasImpl::isInterface and ClassDefImpl::writeIncludeFilesForSlice.

isJavaEnum()

virtual bool ClassDef::isJavaEnum ()

Definition at line 314 of file classdef.h.

Referenced by ClassDefAliasImpl::isJavaEnum, ClassDefMutable::sortAllMembersList and MemberList::writeSimpleDocumentation.

isLocal()

virtual bool ClassDef::isLocal ()

Returns TRUE if this is a local class definition, see EXTRACT_LOCAL_CLASSES.

Definition at line 130 of file classdef.h.

Referenced by ClassDefAliasImpl::isLocal and ClassDefImpl::mergeCategory.

isObjectiveC()

virtual bool ClassDef::isObjectiveC ()

Returns TRUE if this class is implemented in Objective-C.

Definition at line 259 of file classdef.h.

Referenced by MemberDefImpl::displayDefinition, ClassDefAliasImpl::isObjectiveC, MemberDefImpl::writeDocumentation and ClassDefImpl::writeMemberList.

isPublished()

virtual bool ClassDef::isPublished ()

Returns TRUE if this class is marked as published.

Definition at line 274 of file classdef.h.

Referenced by ClassDefAliasImpl::isPublished.

isSealed()

virtual bool ClassDef::isSealed ()

Returns TRUE if this class is marked as sealed.

Definition at line 271 of file classdef.h.

Referenced by generateXMLForClass and ClassDefAliasImpl::isSealed.

isSimple()

virtual bool ClassDef::isSimple ()

Definition at line 308 of file classdef.h.

Referenced by MemberDefImpl::getOutputFileBase, MemberDefImpl::isDetailedSectionVisible, ClassDefAliasImpl::isSimple and writeClassTree.

isSliceLocal()

virtual bool ClassDef::isSliceLocal ()

Definition at line 327 of file classdef.h.

Referenced by ClassDefAliasImpl::isSliceLocal.

isSmartPointer()

virtual const MemberDef * ClassDef::isSmartPointer ()

Definition at line 312 of file classdef.h.

Referenced by ClassDefAliasImpl::isSmartPointer.

isSubClass()

virtual bool ClassDef::isSubClass (ClassDef * bcd, int level=0)

Returns TRUE iff bcd is a direct or indirect sub class of this class.

Definition at line 211 of file classdef.h.

Referenced by findClassRelation, ClassDefAliasImpl::isSubClass and ClassDefImpl::isSubClass.

isTemplate()

virtual bool ClassDef::isTemplate ()

Returns TRUE if this class is a template.

Definition at line 229 of file classdef.h.

Referenced by DocSets::addIndexItem, flushCachedTemplateRelations, getCanonicalTypeForIdentifier, ClassDefAliasImpl::isTemplate and SymbolResolver::Private::newResolveTypedef.

isTemplateArgument()

virtual bool ClassDef::isTemplateArgument ()

Definition at line 239 of file classdef.h.

Referenced by SymbolResolver::Private::getResolvedSymbol, SymbolResolver::Private::getResolvedType and ClassDefAliasImpl::isTemplateArgument.

isUsedOnly()

virtual bool ClassDef::isUsedOnly ()

Definition at line 304 of file classdef.h.

Referenced by getCanonicalTypeForIdentifier and ClassDefAliasImpl::isUsedOnly.

isVisibleInHierarchy()

virtual bool ClassDef::isVisibleInHierarchy ()

the class is visible in a class diagram, or class hierarchy

Definition at line 176 of file classdef.h.

Referenced by DotGfxHierarchyTable::addHierarchy, classHasVisibleRoot, ClassDefImpl::countInheritedByNodes, ClassDefImpl::countInheritsNodes, DiagramRow::insertClass, ClassDefAliasImpl::isVisibleInHierarchy, writeClassTreeToOutput and ClassDefImpl::writeInheritanceGraph.

memberNameInfoLinkedMap()

virtual const MemberNameInfoLinkedMap & ClassDef::memberNameInfoLinkedMap ()

Returns a dictionary of all members.

This includes any inherited members. Members are sorted alphabetically.

Definition at line 168 of file classdef.h.

Referenced by PerlModGenerator::addListOfAllMembers, ClassDefImpl::addMembersToTemplateInstance, associateAllClassMembers, computeClassRelations, computeMemberRelationsForBaseClass, findUsedClassesForClass, findUsingDeclImports, ClassDefImpl::hideDerivedVariablesInPython, ClassDefAliasImpl::memberNameInfoLinkedMap, ClassDefImpl::mergeCategory, ClassDefImpl::mergeMembersFromBaseClasses and writeListOfAllMembers.

moveTo()

virtual void ClassDef::moveTo (Definition *)

Definition at line 121 of file classdef.h.

Referenced by findUsingDeclImports.

protection()

virtual Protection ClassDef::protection ()

Return the protection level (Public,Protected,Private) in which this compound was found.

Definition at line 173 of file classdef.h.

Referenced by addClassAndNestedClasses, VhdlDocGen::findMember, generateMemLink, generateSqlite3ForClass, generateXMLForClass, VhdlDocGen::getClassName, getSpecifierTypeFromClass, ClassDefImpl::insertSubClass, ClassDefAliasImpl::protection, writeClassTree, writeClassTreeToOutput, VhdlDocGen::writeInlineClassLink and VhdlDocGen::writeVHDLDeclaration.

qualifiedNameWithTemplateParameters()

virtual QCString ClassDef::qualifiedNameWithTemplateParameters (const ArgumentLists * actualParams=nullptr, uint32_t * actualParamIndex=nullptr)

Definition at line 250 of file classdef.h.

Referenced by addMemberFunction, addMethodToClass, addVariableToClass, findMember, getCanonicalTypeForIdentifier, makeDisplayName and makeQualifiedNameWithTemplateParameters.

requiresClause()

virtual QCString ClassDef::requiresClause ()

Definition at line 330 of file classdef.h.

Referenced by addClassToContext, generateXMLForClass and ClassDefAliasImpl::requiresClause.

subClasses()

virtual const BaseClassList & ClassDef::subClasses ()

Returns the list of sub classes that directly derive from this class.

Definition at line 160 of file classdef.h.

Referenced by DotGfxHierarchyTable::addHierarchy, DotClassGraph::buildGraph, classHasVisibleChildren, generateDEFForClass, PerlModGenerator::generatePerlModForClass, generateSqlite3ForClass, generateXMLForClass, hasNonReferenceSuperClassRec, DiagramRow::insertClass, VhdlDocGen::isSubClass, ClassDefAliasImpl::subClasses and writeClassTreeToOutput.

subGrouping()

virtual bool ClassDef::subGrouping ()

Definition at line 325 of file classdef.h.

Referenced by ClassDefAliasImpl::subGrouping.

tagLessReference()

virtual const ClassDef * ClassDef::tagLessReference ()

Definition at line 310 of file classdef.h.

Referenced by ClassDefAliasImpl::tagLessReference.

templateArguments()

virtual const ArgumentList & ClassDef::templateArguments ()

Returns the template arguments of this class.

Definition at line 183 of file classdef.h.

Referenced by addClassToContext, ClassDefImpl::addMembersToTemplateInstance, ClassDefMutable::addMembersToTemplateInstance, ClassDefMutable::addMemberToTemplateInstance, addTemplateList, computeTemplateClassRelations, findBaseClassesForClass, findTemplateInstanceRelation, findUsedClassesForClass, getTemplateArgumentsFromName, insertTemplateSpecifierInScope, makeQualifiedNameWithTemplateParameters, SymbolResolver::Private::newResolveTypedef, resolveTemplateInstanceInType, searchTemplateSpecs, ClassDefAliasImpl::templateArguments, writeTemplateList and writeTemplateList.

templateMaster()

virtual const ClassDef * ClassDef::templateMaster ()

Returns the template master of which this class is an instance.

Returns 0 if not applicable.

Definition at line 226 of file classdef.h.

Referenced by DotClassGraph::buildGraph, ClassDefImpl::isBaseClass, VhdlDocGen::isSubClass, makeTemplateInstanceRelation and ClassDefAliasImpl::templateMaster.

templateTypeConstraints()

virtual const ConstraintClassList & ClassDef::templateTypeConstraints ()

Definition at line 237 of file classdef.h.

Referenced by DotClassGraph::buildGraph and ClassDefAliasImpl::templateTypeConstraints.

title()

virtual QCString ClassDef::title ()

Definition at line 316 of file classdef.h.

Referenced by generateSqlite3ForClass, ClassDefAliasImpl::title and writeMemberDeclarations.

typeConstraints()

virtual const ArgumentList & ClassDef::typeConstraints ()

Definition at line 321 of file classdef.h.

Referenced by ClassDefAliasImpl::typeConstraints.

updateBaseClasses()

virtual void ClassDef::updateBaseClasses (const BaseClassList & bcd)

Update the list of base classes to the one passed.

Definition at line 156 of file classdef.h.

Referenced by VhdlDocGen::addBaseClass.

updateSubClasses()

virtual void ClassDef::updateSubClasses (const BaseClassList & bcd)

Update the list of sub classes to the one passed.

Definition at line 163 of file classdef.h.

usedByImplementationClasses()

virtual const UsesClassList & ClassDef::usedByImplementationClasses ()

Definition at line 235 of file classdef.h.

Referenced by DotClassGraph::buildGraph and ClassDefAliasImpl::usedByImplementationClasses.

usedFiles()

virtual const FileList & ClassDef::usedFiles ()

Definition at line 319 of file classdef.h.

Referenced by ClassDefAliasImpl::usedFiles.

usedImplementationClasses()

virtual const UsesClassList & ClassDef::usedImplementationClasses ()

Definition at line 233 of file classdef.h.

Referenced by DotClassGraph::buildGraph and ClassDefAliasImpl::usedImplementationClasses.

visibleInParentsDeclList()

virtual bool ClassDef::visibleInParentsDeclList ()

show this class in the declaration section of its parent?

Definition at line 179 of file classdef.h.

Referenced by ClassDefAliasImpl::visibleInParentsDeclList.

writeDeclaration()

virtual void ClassDef::writeDeclaration (OutputList & ol, const MemberDef * md, bool inGroup, int indentLevel, const ClassDef * inheritedFrom, const QCString & inheritId)

Definition at line 356 of file classdef.h.

Referenced by ClassDefAliasImpl::writeDeclaration and MemberDefImpl::writeDeclaration.

writeDeclarationLink()

virtual void ClassDef::writeDeclarationLink (OutputList & ol, bool & found, const QCString & header, bool localNames)

Definition at line 350 of file classdef.h.

Referenced by ClassDefAliasImpl::writeDeclarationLink.

writeDocumentation()

virtual void ClassDef::writeDocumentation (OutputList & ol)

Definition at line 352 of file classdef.h.

Referenced by generateNamespaceClassDocs and ClassDefAliasImpl::writeDocumentation.

writeDocumentationForInnerClasses()

virtual void ClassDef::writeDocumentationForInnerClasses (OutputList & ol)

Definition at line 353 of file classdef.h.

Referenced by generateNamespaceClassDocs and ClassDefAliasImpl::writeDocumentationForInnerClasses.

writeInlineDocumentation()

virtual void ClassDef::writeInlineDocumentation (OutputList & ol)

Definition at line 361 of file classdef.h.

Referenced by ClassDefAliasImpl::writeInlineDocumentation.

writeMemberDeclarations()

virtual void ClassDef::writeMemberDeclarations (OutputList & ol, ClassDefSet & visitedClasses, MemberListType lt, const QCString & title, const QCString & subTitle=QCString(), bool showInline=FALSE, const ClassDef * inheritedFrom=nullptr, MemberListType lt2=MemberListType::Invalid(), bool invert=FALSE, bool showAlways=FALSE)

Definition at line 363 of file classdef.h.

References FALSE, MemberListType::Invalid and title.

Referenced by ClassDefImpl::writeInheritedMemberDeclarations and ClassDefAliasImpl::writeMemberDeclarations.

writeMemberList()

virtual void ClassDef::writeMemberList (OutputList & ol)

Definition at line 355 of file classdef.h.

Referenced by generateNamespaceClassDocs and ClassDefAliasImpl::writeMemberList.

writeMemberPages()

virtual void ClassDef::writeMemberPages (OutputList & ol)

Definition at line 354 of file classdef.h.

Referenced by ClassDefAliasImpl::writeMemberPages.

writePageNavigation()

virtual void ClassDef::writePageNavigation (OutputList & ol)

Definition at line 360 of file classdef.h.

Referenced by ClassDefAliasImpl::writePageNavigation.

writeQuickMemberLinks()

virtual void ClassDef::writeQuickMemberLinks (OutputList & ol, const MemberDef * md)

Definition at line 358 of file classdef.h.

Referenced by ClassDefAliasImpl::writeQuickMemberLinks.

writeSummaryLinks()

virtual void ClassDef::writeSummaryLinks (OutputList & ol)

Definition at line 359 of file classdef.h.

Referenced by ClassDefAliasImpl::writeSummaryLinks.

writeTagFile()

virtual void ClassDef::writeTagFile (TextStream &)

Definition at line 362 of file classdef.h.

Referenced by ClassDefAliasImpl::writeTagFile and writeTagFile.

---

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

• classdef.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.