The ClassDefAliasImpl Class Reference

Declaration

class ClassDefAliasImpl { ... }

Base class

class	DefinitionAliasMixin<Base>

Public Constructors Index

	ClassDefAliasImpl (const Definition *newScope, const ClassDef *cd)

Public Destructor Index

	~ClassDefAliasImpl () override

Public Member Functions Index

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

Definition at line 569 of file classdef.cpp.

Public Constructors

ClassDefAliasImpl()

ClassDefAliasImpl::ClassDefAliasImpl (const Definition * newScope, const ClassDef * cd)

inline

Definition at line 572 of file classdef.cpp.

572 ClassDefAliasImpl(const Definition *newScope,const ClassDef *cd)

573 : DefinitionAliasMixin(newScope,cd) { init(); }

References DefinitionAliasMixin< ClassDef >::DefinitionAliasMixin and DefinitionAliasMixin< ClassDef >::init.

Public Destructor

~ClassDefAliasImpl()

ClassDefAliasImpl::~ClassDefAliasImpl ()

inline

Definition at line 574 of file classdef.cpp.

574 ~ClassDefAliasImpl() override { deinit(); }

Reference DefinitionAliasMixin< ClassDef >::deinit.

Public Member Functions

addGroupedInheritedMembers()

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

inline virtual

Definition at line 780 of file classdef.cpp.

780 void addGroupedInheritedMembers(OutputList &ol,MemberListType lt,

781 const ClassDef *inheritedFrom,const QCString &inheritId) const override

782 { getCdAlias()->addGroupedInheritedMembers(ol,lt,inheritedFrom,inheritId); }

References ClassDef::addGroupedInheritedMembers and getCdAlias.

anchor()

QCString ClassDefAliasImpl::anchor ()

inline virtual

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

Definition at line 702 of file classdef.cpp.

702 QCString anchor() const override

703 { return getCdAlias()->anchor(); }

References Definition::anchor and getCdAlias.

baseClasses()

const BaseClassList & ClassDefAliasImpl::baseClasses ()

inline virtual

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

Definition at line 615 of file classdef.cpp.

615 const BaseClassList &baseClasses() const override

616 { return getCdAlias()->baseClasses(); }

References ClassDef::baseClasses and getCdAlias.

categoryOf()

ClassDef * ClassDefAliasImpl::categoryOf ()

inline virtual

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

Definition at line 688 of file classdef.cpp.

688 ClassDef *categoryOf() const override

689 { return getCdAlias()->categoryOf(); }

References ClassDef::categoryOf and getCdAlias.

className()

QCString ClassDefAliasImpl::className ()

inline virtual

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

Definition at line 690 of file classdef.cpp.

690 QCString className() const override

691 { return getCdAlias()->className(); }

References ClassDef::className and getCdAlias.

codeSymbolType()

CodeSymbolType ClassDefAliasImpl::codeSymbolType ()

inline virtual

Used for syntax highlighting symbol class

Definition at line 585 of file classdef.cpp.

585 CodeSymbolType codeSymbolType() const override

586 { return getCdAlias()->codeSymbolType(); }

References Definition::codeSymbolType and getCdAlias.

collaborationGraphFileName()

QCString ClassDefAliasImpl::collaborationGraphFileName ()

inline virtual

returns the file name to use for the collaboration graph

Definition at line 605 of file classdef.cpp.

605 QCString collaborationGraphFileName() const override

606 { return getCdAlias()->collaborationGraphFileName(); }

References ClassDef::collaborationGraphFileName and getCdAlias.

compoundType()

CompoundType ClassDefAliasImpl::compoundType ()

inline virtual

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

class/struct/union/..

Definition at line 611 of file classdef.cpp.

611 CompoundType compoundType() const override

612 { return getCdAlias()->compoundType(); }

References ClassDef::compoundType and getCdAlias.

compoundTypeString()

QCString ClassDefAliasImpl::compoundTypeString ()

inline virtual

Returns the type of compound as a string.

Definition at line 613 of file classdef.cpp.

613 QCString compoundTypeString() const override

614 { return getCdAlias()->compoundTypeString(); }

References ClassDef::compoundTypeString and getCdAlias.

containsOverload()

bool ClassDefAliasImpl::containsOverload (const MemberDef * md)

inline virtual

Definition at line 738 of file classdef.cpp.

738 bool containsOverload(const MemberDef *md) const override

739 { return getCdAlias()->containsOverload(md); }

References ClassDef::containsOverload and getCdAlias.

countMemberDeclarations()

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

inline virtual

Definition at line 743 of file classdef.cpp.

743 int countMemberDeclarations(MemberListType lt,const ClassDef *inheritedFrom,

744 MemberListType lt2,bool invert,bool showAlways,ClassDefSet &visitedClasses) const override

745 { return getCdAlias()->countMemberDeclarations(lt,inheritedFrom,lt2,invert,showAlways,visitedClasses); }

References ClassDef::countMemberDeclarations and getCdAlias.

countMembersIncludingGrouped()

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

inline virtual

Definition at line 741 of file classdef.cpp.

741 int countMembersIncludingGrouped(MemberListType lt,const ClassDef *inheritedFrom,bool additional) const override

742 { return getCdAlias()->countMembersIncludingGrouped(lt,inheritedFrom,additional); }

References ClassDef::countMembersIncludingGrouped and getCdAlias.

deepCopy()

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

inline virtual

Definition at line 580 of file classdef.cpp.

580 std::unique_ptr<ClassDef> deepCopy(const QCString &name) const override {

581 return createClassDefAlias(getScope(),getCdAlias());

582 }

References createClassDefAlias, getCdAlias, DefinitionAliasMixin< ClassDef >::getScope and DefinitionAliasMixin< ClassDef >::name.

definitionType()

DefType ClassDefAliasImpl::definitionType ()

inline virtual

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

Definition at line 577 of file classdef.cpp.

577 DefType definitionType() const override { return TypeClass; }

References definitionType and Definition::TypeClass.

Referenced by definitionType.

displayName()

QCString ClassDefAliasImpl::displayName (bool includeScope=TRUE)

inline virtual

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

Definition at line 609 of file classdef.cpp.

609 QCString displayName(bool includeScope=TRUE) const override

610 { return makeDisplayName(this,includeScope); }

References makeDisplayName and TRUE.

findInnerCompound()

const Definition * ClassDefAliasImpl::findInnerCompound (const QCString & name)

inline virtual

Definition at line 661 of file classdef.cpp.

661 const Definition *findInnerCompound(const QCString &name) const override

662 { return getCdAlias()->findInnerCompound(name); }

References Definition::findInnerCompound, getCdAlias and DefinitionAliasMixin< ClassDef >::name.

generatedFromFiles()

QCString ClassDefAliasImpl::generatedFromFiles ()

inline virtual

Definition at line 716 of file classdef.cpp.

716 QCString generatedFromFiles() const override

717 { return getCdAlias()->generatedFromFiles(); }

References ClassDef::generatedFromFiles and getCdAlias.

getCdAlias()

const ClassDef * ClassDefAliasImpl::getCdAlias ()

inline

Definition at line 579 of file classdef.cpp.

579 const ClassDef *getCdAlias() const { return toClassDef(getAlias()); }

References DefinitionAliasMixin< ClassDef >::getAlias and toClassDef.

Referenced by addGroupedInheritedMembers, anchor, baseClasses, categoryOf, className, codeSymbolType, collaborationGraphFileName, compoundType, compoundTypeString, containsOverload, countMemberDeclarations, countMembersIncludingGrouped, deepCopy, findInnerCompound, generatedFromFiles, getClasses, getExamples, getFileDef, getInstanceOutputFileBase, getMemberByName, getMemberGroups, getMemberList, getMemberListFileName, getMemberLists, getModuleDef, getOutputFileBase, getQualifiers, getReference, getSourceFileBase, getTemplateBaseClassNames, getTemplateInstances, getTemplateParameterLists, hasDetailedDescription, hasDocumentation, hasExamples, hasNonReferenceSuperClass, includeInfo, inheritanceGraphFileName, isAbstract, isAccessibleMember, isBaseClass, isCSharp, isEmbeddedInOuterScope, isExtension, isFinal, isFortran, isForwardDeclared, isImplicitTemplateInstance, isInterface, isJavaEnum, isLinkable, isLinkableInProject, isLocal, isObjectiveC, isPublished, isReference, isSealed, isSimple, isSliceLocal, isSmartPointer, isSubClass, isTemplate, isTemplateArgument, isUsedOnly, isVisibleInHierarchy, memberNameInfoLinkedMap, protection, requiresClause, subClasses, subGrouping, tagLessReference, templateArguments, templateMaster, templateTypeConstraints, title, typeConstraints, usedByImplementationClasses, usedFiles, usedImplementationClasses, visibleInParentsDeclList, writeDeclaration, writeDeclarationLink, writeDocumentation, writeDocumentationForInnerClasses, writeInlineDocumentation, writeMemberDeclarations, writeMemberList, writeMemberPages, writePageNavigation, writeQuickMemberLinks, writeSummaryLinks and writeTagFile.

getClasses()

ClassLinkedRefMap ClassDefAliasImpl::getClasses ()

inline virtual

returns the classes nested into this class

Definition at line 599 of file classdef.cpp.

599 ClassLinkedRefMap getClasses() const override

600 { return getCdAlias()->getClasses(); }

References getCdAlias and ClassDef::getClasses.

getExamples()

const ExampleList & ClassDefAliasImpl::getExamples ()

inline virtual

Definition at line 722 of file classdef.cpp.

722 const ExampleList &getExamples() const override

723 { return getCdAlias()->getExamples(); }

References getCdAlias and ClassDef::getExamples.

getFileDef()

FileDef * ClassDefAliasImpl::getFileDef ()

inline virtual

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 633 of file classdef.cpp.

633 FileDef *getFileDef() const override

634 { return getCdAlias()->getFileDef(); }

References getCdAlias and ClassDef::getFileDef.

getInstanceOutputFileBase()

QCString ClassDefAliasImpl::getInstanceOutputFileBase ()

inline virtual

Definition at line 589 of file classdef.cpp.

589 QCString getInstanceOutputFileBase() const override

590 { return getCdAlias()->getInstanceOutputFileBase(); }

References getCdAlias and ClassDef::getInstanceOutputFileBase.

getMemberByName()

const MemberDef * ClassDefAliasImpl::getMemberByName (const QCString &)

inline virtual

Returns the member with the given name.

Definition at line 637 of file classdef.cpp.

637 const MemberDef *getMemberByName(const QCString &s) const override

638 { return getCdAlias()->getMemberByName(s); }

References getCdAlias and ClassDef::getMemberByName.

getMemberGroups()

const MemberGroupList & ClassDefAliasImpl::getMemberGroups ()

inline virtual

Returns the member groups defined for this class.

Definition at line 696 of file classdef.cpp.

696 const MemberGroupList &getMemberGroups() const override

697 { return getCdAlias()->getMemberGroups(); }

References getCdAlias and ClassDef::getMemberGroups.

getMemberList()

MemberList * ClassDefAliasImpl::getMemberList (MemberListType lt)

inline virtual

Returns the members in the list identified by lt.

Definition at line 692 of file classdef.cpp.

692 MemberList *getMemberList(MemberListType lt) const override

693 { return getCdAlias()->getMemberList(lt); }

References getCdAlias and ClassDef::getMemberList.

getMemberListFileName()

QCString ClassDefAliasImpl::getMemberListFileName ()

inline virtual

Definition at line 726 of file classdef.cpp.

726 QCString getMemberListFileName() const override

727 { return getCdAlias()->getMemberListFileName(); }

References getCdAlias and ClassDef::getMemberListFileName.

getMemberLists()

const MemberLists & ClassDefAliasImpl::getMemberLists ()

inline virtual

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

Definition at line 694 of file classdef.cpp.

694 const MemberLists &getMemberLists() const override

695 { return getCdAlias()->getMemberLists(); }

References getCdAlias and ClassDef::getMemberLists.

getModuleDef()

ModuleDef * ClassDefAliasImpl::getModuleDef ()

inline virtual

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

Definition at line 635 of file classdef.cpp.

635 ModuleDef *getModuleDef() const override

636 { return getCdAlias()->getModuleDef(); }

References getCdAlias and ClassDef::getModuleDef.

getOutputFileBase()

QCString ClassDefAliasImpl::getOutputFileBase ()

inline virtual

Returns the base file name (without extension) of this definition. as it is referenced to/written to disk.

Definition at line 587 of file classdef.cpp.

587 QCString getOutputFileBase() const override

588 { return getCdAlias()->getOutputFileBase(); }

References getCdAlias and Definition::getOutputFileBase.

getQualifiers()

StringVector ClassDefAliasImpl::getQualifiers ()

inline virtual

Definition at line 736 of file classdef.cpp.

736 StringVector getQualifiers() const override

737 { return getCdAlias()->getQualifiers(); }

References getCdAlias and ClassDef::getQualifiers.

getReference()

QCString ClassDefAliasImpl::getReference ()

inline virtual

If this definition was imported via a tag file, this function returns the tagfile for the external project. This can be translated into an external link target via Doxygen::tagDestinationDict

Definition at line 593 of file classdef.cpp.

593 QCString getReference() const override

594 { return getCdAlias()->getReference(); }

References getCdAlias and Definition::getReference.

getSourceFileBase()

QCString ClassDefAliasImpl::getSourceFileBase ()

inline virtual

Returns the name of the source listing of this definition.

Definition at line 591 of file classdef.cpp.

591 QCString getSourceFileBase() const override

592 { return getCdAlias()->getSourceFileBase(); }

References getCdAlias and Definition::getSourceFileBase.

getTemplateBaseClassNames()

const TemplateNameMap & ClassDefAliasImpl::getTemplateBaseClassNames ()

inline virtual

Definition at line 698 of file classdef.cpp.

698 const TemplateNameMap &getTemplateBaseClassNames() const override

699 { return getCdAlias()->getTemplateBaseClassNames(); }

References getCdAlias and ClassDef::getTemplateBaseClassNames.

getTemplateInstances()

const TemplateInstanceList & ClassDefAliasImpl::getTemplateInstances ()

inline virtual

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 645 of file classdef.cpp.

645 const TemplateInstanceList &getTemplateInstances() const override

646 { return getCdAlias()->getTemplateInstances(); }

References getCdAlias and ClassDef::getTemplateInstances.

getTemplateParameterLists()

ArgumentLists ClassDefAliasImpl::getTemplateParameterLists ()

inline virtual

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 663 of file classdef.cpp.

663 ArgumentLists getTemplateParameterLists() const override

664 { return getCdAlias()->getTemplateParameterLists(); }

References getCdAlias and ClassDef::getTemplateParameterLists.

hasDetailedDescription()

bool ClassDefAliasImpl::hasDetailedDescription ()

inline virtual

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

Definition at line 603 of file classdef.cpp.

603 bool hasDetailedDescription() const override

604 { return getCdAlias()->hasDetailedDescription(); }

References getCdAlias and ClassDef::hasDetailedDescription.

hasDocumentation()

bool ClassDefAliasImpl::hasDocumentation ()

inline virtual

Returns TRUE iff the definition is documented (which could be generated documentation)

See Also

hasUserDocumentation()

Definition at line 601 of file classdef.cpp.

601 bool hasDocumentation() const override

602 { return getCdAlias()->hasDocumentation(); }

References getCdAlias and Definition::hasDocumentation.

hasExamples()

bool ClassDefAliasImpl::hasExamples ()

inline virtual

Definition at line 724 of file classdef.cpp.

724 bool hasExamples() const override

725 { return getCdAlias()->hasExamples(); }

References getCdAlias and ClassDef::hasExamples.

hasNonReferenceSuperClass()

bool ClassDefAliasImpl::hasNonReferenceSuperClass ()

inline virtual

Definition at line 732 of file classdef.cpp.

732 bool hasNonReferenceSuperClass() const override

733 { return getCdAlias()->hasNonReferenceSuperClass(); }

References getCdAlias and ClassDef::hasNonReferenceSuperClass.

includeInfo()

const IncludeInfo * ClassDefAliasImpl::includeInfo ()

inline virtual

Definition at line 651 of file classdef.cpp.

651 const IncludeInfo *includeInfo() const override

652 { return getCdAlias()->includeInfo(); }

References getCdAlias and ClassDef::includeInfo.

inheritanceGraphFileName()

QCString ClassDefAliasImpl::inheritanceGraphFileName ()

inline virtual

returns the file name to use for the inheritance graph

Definition at line 607 of file classdef.cpp.

607 QCString inheritanceGraphFileName() const override

608 { return getCdAlias()->inheritanceGraphFileName(); }

References getCdAlias and ClassDef::inheritanceGraphFileName.

isAbstract()

bool ClassDefAliasImpl::isAbstract ()

inline virtual

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

Definition at line 668 of file classdef.cpp.

668 bool isAbstract() const override

669 { return getCdAlias()->isAbstract(); }

References getCdAlias and ClassDef::isAbstract.

isAccessibleMember()

bool ClassDefAliasImpl::isAccessibleMember (const MemberDef * md)

inline virtual

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

Definition at line 643 of file classdef.cpp.

643 bool isAccessibleMember(const MemberDef *md) const override

644 { return getCdAlias()->isAccessibleMember(md); }

References getCdAlias and ClassDef::isAccessibleMember.

isBaseClass()

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

inline virtual

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 639 of file classdef.cpp.

639 int isBaseClass(const ClassDef *bcd,bool followInstances,const QCString &templSpec) const override

640 { return getCdAlias()->isBaseClass(bcd,followInstances,templSpec); }

References getCdAlias and ClassDef::isBaseClass.

isCSharp()

bool ClassDefAliasImpl::isCSharp ()

inline virtual

Returns TRUE if this class is implemented in C#.

Definition at line 674 of file classdef.cpp.

674 bool isCSharp() const override

675 { return getCdAlias()->isCSharp(); }

References getCdAlias and ClassDef::isCSharp.

isEmbeddedInOuterScope()

bool ClassDefAliasImpl::isEmbeddedInOuterScope ()

inline virtual

Definition at line 704 of file classdef.cpp.

704 bool isEmbeddedInOuterScope() const override

705 { return getCdAlias()->isEmbeddedInOuterScope(); }

References getCdAlias and ClassDef::isEmbeddedInOuterScope.

isExtension()

bool ClassDefAliasImpl::isExtension ()

inline virtual

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

Definition at line 682 of file classdef.cpp.

682 bool isExtension() const override

683 { return getCdAlias()->isExtension(); }

References getCdAlias and ClassDef::isExtension.

isFinal()

bool ClassDefAliasImpl::isFinal ()

inline virtual

Returns TRUE if this class is marked as final.

Definition at line 676 of file classdef.cpp.

676 bool isFinal() const override

677 { return getCdAlias()->isFinal(); }

References getCdAlias and ClassDef::isFinal.

isFortran()

bool ClassDefAliasImpl::isFortran ()

inline virtual

Returns TRUE if this class is implemented in Fortran.

Definition at line 672 of file classdef.cpp.

672 bool isFortran() const override

673 { return getCdAlias()->isFortran(); }

References getCdAlias and ClassDef::isFortran.

isForwardDeclared()

bool ClassDefAliasImpl::isForwardDeclared ()

inline virtual

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

Definition at line 684 of file classdef.cpp.

684 bool isForwardDeclared() const override

685 { return getCdAlias()->isForwardDeclared(); }

References getCdAlias and ClassDef::isForwardDeclared.

isImplicitTemplateInstance()

bool ClassDefAliasImpl::isImplicitTemplateInstance ()

inline virtual

Definition at line 750 of file classdef.cpp.

750 bool isImplicitTemplateInstance() const override

751 { return getCdAlias()->isImplicitTemplateInstance(); }

References getCdAlias and ClassDef::isImplicitTemplateInstance.

isInterface()

bool ClassDefAliasImpl::isInterface ()

inline virtual

Returns TRUE if this class represents an interface.

Definition at line 686 of file classdef.cpp.

686 bool isInterface() const override

687 { return getCdAlias()->isInterface(); }

References getCdAlias and ClassDef::isInterface.

isJavaEnum()

bool ClassDefAliasImpl::isJavaEnum ()

inline virtual

Definition at line 712 of file classdef.cpp.

712 bool isJavaEnum() const override

713 { return getCdAlias()->isJavaEnum(); }

References getCdAlias and ClassDef::isJavaEnum.

isLinkable()

bool ClassDefAliasImpl::isLinkable ()

inline 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.

Definition at line 625 of file classdef.cpp.

625 bool isLinkable() const override

626 { return getCdAlias()->isLinkable(); }

References getCdAlias and Definition::isLinkable.

isLinkableInProject()

bool ClassDefAliasImpl::isLinkableInProject ()

inline virtual

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

Definition at line 623 of file classdef.cpp.

623 bool isLinkableInProject() const override

624 { return getCdAlias()->isLinkableInProject(); }

References getCdAlias and Definition::isLinkableInProject.

isLocal()

bool ClassDefAliasImpl::isLocal ()

inline virtual

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

Definition at line 597 of file classdef.cpp.

597 bool isLocal() const override

598 { return getCdAlias()->isLocal(); }

References getCdAlias and ClassDef::isLocal.

isObjectiveC()

bool ClassDefAliasImpl::isObjectiveC ()

inline virtual

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

Definition at line 670 of file classdef.cpp.

670 bool isObjectiveC() const override

671 { return getCdAlias()->isObjectiveC(); }

References getCdAlias and ClassDef::isObjectiveC.

isPublished()

bool ClassDefAliasImpl::isPublished ()

inline virtual

Returns TRUE if this class is marked as published.

Definition at line 680 of file classdef.cpp.

680 bool isPublished() const override

681 { return getCdAlias()->isPublished(); }

References getCdAlias and ClassDef::isPublished.

isReference()

bool ClassDefAliasImpl::isReference ()

inline virtual

Returns TRUE if this definition is imported via a tag file.

Definition at line 595 of file classdef.cpp.

595 bool isReference() const override

596 { return getCdAlias()->isReference(); }

References getCdAlias and Definition::isReference.

isSealed()

bool ClassDefAliasImpl::isSealed ()

inline virtual

Returns TRUE if this class is marked as sealed.

Definition at line 678 of file classdef.cpp.

678 bool isSealed() const override

679 { return getCdAlias()->isSealed(); }

References getCdAlias and ClassDef::isSealed.

isSimple()

bool ClassDefAliasImpl::isSimple ()

inline virtual

Definition at line 706 of file classdef.cpp.

706 bool isSimple() const override

707 { return getCdAlias()->isSimple(); }

References getCdAlias and ClassDef::isSimple.

isSliceLocal()

bool ClassDefAliasImpl::isSliceLocal ()

inline virtual

Definition at line 730 of file classdef.cpp.

730 bool isSliceLocal() const override

731 { return getCdAlias()->isSliceLocal(); }

References getCdAlias and ClassDef::isSliceLocal.

isSmartPointer()

const MemberDef * ClassDefAliasImpl::isSmartPointer ()

inline virtual

Definition at line 710 of file classdef.cpp.

710 const MemberDef *isSmartPointer() const override

711 { return getCdAlias()->isSmartPointer(); }

References getCdAlias and ClassDef::isSmartPointer.

isSubClass()

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

inline virtual

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

Definition at line 641 of file classdef.cpp.

641 bool isSubClass(ClassDef *bcd,int level=0) const override

642 { return getCdAlias()->isSubClass(bcd,level); }

References getCdAlias and ClassDef::isSubClass.

isTemplate()

bool ClassDefAliasImpl::isTemplate ()

inline virtual

Returns TRUE if this class is a template.

Definition at line 649 of file classdef.cpp.

649 bool isTemplate() const override

650 { return getCdAlias()->isTemplate(); }

References getCdAlias and ClassDef::isTemplate.

isTemplateArgument()

bool ClassDefAliasImpl::isTemplateArgument ()

inline virtual

Definition at line 659 of file classdef.cpp.

659 bool isTemplateArgument() const override

660 { return getCdAlias()->isTemplateArgument(); }

References getCdAlias and ClassDef::isTemplateArgument.

isUsedOnly()

bool ClassDefAliasImpl::isUsedOnly ()

inline virtual

Definition at line 700 of file classdef.cpp.

700 bool isUsedOnly() const override

701 { return getCdAlias()->isUsedOnly(); }

References getCdAlias and ClassDef::isUsedOnly.

isVisibleInHierarchy()

bool ClassDefAliasImpl::isVisibleInHierarchy ()

inline virtual

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

Definition at line 627 of file classdef.cpp.

627 bool isVisibleInHierarchy() const override

628 { return getCdAlias()->isVisibleInHierarchy(); }

References getCdAlias and ClassDef::isVisibleInHierarchy.

memberNameInfoLinkedMap()

const MemberNameInfoLinkedMap & ClassDefAliasImpl::memberNameInfoLinkedMap ()

inline virtual

Returns a dictionary of all members.

This includes any inherited members. Members are sorted alphabetically.

Definition at line 619 of file classdef.cpp.

619 const MemberNameInfoLinkedMap &memberNameInfoLinkedMap() const override

620 { return getCdAlias()->memberNameInfoLinkedMap(); }

References getCdAlias and ClassDef::memberNameInfoLinkedMap.

moveTo()

void ClassDefAliasImpl::moveTo (Definition *)

inline virtual

Definition at line 583 of file classdef.cpp.

583 void moveTo(Definition *) override {}

protection()

Protection ClassDefAliasImpl::protection ()

inline virtual

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

Definition at line 621 of file classdef.cpp.

621 Protection protection() const override

622 { return getCdAlias()->protection(); }

References getCdAlias and ClassDef::protection.

qualifiedNameWithTemplateParameters()

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

inline virtual

Definition at line 665 of file classdef.cpp.

665 QCString qualifiedNameWithTemplateParameters(

666 const ArgumentLists *actualParams=nullptr,uint32_t *actualParamIndex=nullptr) const override

667 { return makeQualifiedNameWithTemplateParameters(this,actualParams,actualParamIndex); }

Reference makeQualifiedNameWithTemplateParameters.

requiresClause()

QCString ClassDefAliasImpl::requiresClause ()

inline virtual

Definition at line 734 of file classdef.cpp.

734 QCString requiresClause() const override

735 { return getCdAlias()->requiresClause(); }

References getCdAlias and ClassDef::requiresClause.

subClasses()

const BaseClassList & ClassDefAliasImpl::subClasses ()

inline virtual

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

Definition at line 617 of file classdef.cpp.

617 const BaseClassList &subClasses() const override

618 { return getCdAlias()->subClasses(); }

References getCdAlias and ClassDef::subClasses.

subGrouping()

bool ClassDefAliasImpl::subGrouping ()

inline virtual

Definition at line 728 of file classdef.cpp.

728 bool subGrouping() const override

729 { return getCdAlias()->subGrouping(); }

References getCdAlias and ClassDef::subGrouping.

tagLessReference()

const ClassDef * ClassDefAliasImpl::tagLessReference ()

inline virtual

Definition at line 708 of file classdef.cpp.

708 const ClassDef *tagLessReference() const override

709 { return getCdAlias()->tagLessReference(); }

References getCdAlias and ClassDef::tagLessReference.

templateArguments()

const ArgumentList & ClassDefAliasImpl::templateArguments ()

inline virtual

Returns the template arguments of this class.

Definition at line 631 of file classdef.cpp.

631 const ArgumentList &templateArguments() const override

632 { return getCdAlias()->templateArguments(); }

References getCdAlias and ClassDef::templateArguments.

templateMaster()

const ClassDef * ClassDefAliasImpl::templateMaster ()

inline virtual

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

Returns 0 if not applicable.

Definition at line 647 of file classdef.cpp.

647 const ClassDef *templateMaster() const override

648 { return getCdAlias()->templateMaster(); }

References getCdAlias and ClassDef::templateMaster.

templateTypeConstraints()

const ConstraintClassList & ClassDefAliasImpl::templateTypeConstraints ()

inline virtual

Definition at line 657 of file classdef.cpp.

657 const ConstraintClassList &templateTypeConstraints() const override

658 { return getCdAlias()->templateTypeConstraints(); }

References getCdAlias and ClassDef::templateTypeConstraints.

title()

QCString ClassDefAliasImpl::title ()

inline virtual

Definition at line 714 of file classdef.cpp.

714 QCString title() const override

715 { return getCdAlias()->title(); }

References getCdAlias and ClassDef::title.

Referenced by writeMemberDeclarations.

typeConstraints()

const ArgumentList & ClassDefAliasImpl::typeConstraints ()

inline virtual

Definition at line 720 of file classdef.cpp.

720 const ArgumentList &typeConstraints() const override

721 { return getCdAlias()->typeConstraints(); }

References getCdAlias and ClassDef::typeConstraints.

updateBaseClasses()

void ClassDefAliasImpl::updateBaseClasses (const BaseClassList & bcd)

inline virtual

Update the list of base classes to the one passed.

Definition at line 784 of file classdef.cpp.

784 void updateBaseClasses(const BaseClassList &) override {}

updateSubClasses()

void ClassDefAliasImpl::updateSubClasses (const BaseClassList & bcd)

inline virtual

Update the list of sub classes to the one passed.

Definition at line 785 of file classdef.cpp.

785 void updateSubClasses(const BaseClassList &) override {}

usedByImplementationClasses()

const UsesClassList & ClassDefAliasImpl::usedByImplementationClasses ()

inline virtual

Definition at line 655 of file classdef.cpp.

655 const UsesClassList &usedByImplementationClasses() const override

656 { return getCdAlias()->usedByImplementationClasses(); }

References getCdAlias and ClassDef::usedByImplementationClasses.

usedFiles()

const FileList & ClassDefAliasImpl::usedFiles ()

inline virtual

Definition at line 718 of file classdef.cpp.

718 const FileList &usedFiles() const override

719 { return getCdAlias()->usedFiles(); }

References getCdAlias and ClassDef::usedFiles.

usedImplementationClasses()

const UsesClassList & ClassDefAliasImpl::usedImplementationClasses ()

inline virtual

Definition at line 653 of file classdef.cpp.

653 const UsesClassList &usedImplementationClasses() const override

654 { return getCdAlias()->usedImplementationClasses(); }

References getCdAlias and ClassDef::usedImplementationClasses.

visibleInParentsDeclList()

bool ClassDefAliasImpl::visibleInParentsDeclList ()

inline virtual

show this class in the declaration section of its parent?

Definition at line 629 of file classdef.cpp.

629 bool visibleInParentsDeclList() const override

630 { return getCdAlias()->visibleInParentsDeclList(); }

References getCdAlias and ClassDef::visibleInParentsDeclList.

writeDeclaration()

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

inline virtual

Definition at line 761 of file classdef.cpp.

761 void writeDeclaration(OutputList &ol,const MemberDef *md,bool inGroup,

762 int indentLevel, const ClassDef *inheritedFrom,const QCString &inheritId) const override

763 { getCdAlias()->writeDeclaration(ol,md,inGroup,indentLevel,inheritedFrom,inheritId); }

References getCdAlias and ClassDef::writeDeclaration.

writeDeclarationLink()

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

inline virtual

Definition at line 747 of file classdef.cpp.

747 void writeDeclarationLink(OutputList &ol,bool &found,

748 const QCString &header,bool localNames) const override

749 { getCdAlias()->writeDeclarationLink(ol,found,header,localNames); }

References getCdAlias and ClassDef::writeDeclarationLink.

writeDocumentation()

void ClassDefAliasImpl::writeDocumentation (OutputList & ol)

inline virtual

Definition at line 753 of file classdef.cpp.

753 void writeDocumentation(OutputList &ol) const override

754 { getCdAlias()->writeDocumentation(ol); }

References getCdAlias and ClassDef::writeDocumentation.

writeDocumentationForInnerClasses()

void ClassDefAliasImpl::writeDocumentationForInnerClasses (OutputList & ol)

inline virtual

Definition at line 755 of file classdef.cpp.

755 void writeDocumentationForInnerClasses(OutputList &ol) const override

756 { getCdAlias()->writeDocumentationForInnerClasses(ol); }

References getCdAlias and ClassDef::writeDocumentationForInnerClasses.

writeInlineDocumentation()

void ClassDefAliasImpl::writeInlineDocumentation (OutputList & ol)

inline virtual

Definition at line 770 of file classdef.cpp.

770 void writeInlineDocumentation(OutputList &ol) const override

771 { getCdAlias()->writeInlineDocumentation(ol); }

References getCdAlias and ClassDef::writeInlineDocumentation.

writeMemberDeclarations()

void ClassDefAliasImpl::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)

inline virtual

Definition at line 774 of file classdef.cpp.

774 void writeMemberDeclarations(OutputList &ol,ClassDefSet &visitedClasses,

775 MemberListType lt,const QCString &title,

776 const QCString &subTitle=QCString(),

777 bool showInline=FALSE,const ClassDef *inheritedFrom=nullptr,

778 MemberListType lt2=MemberListType::Invalid(),bool invert=FALSE,bool showAlways=FALSE) const override

779 { getCdAlias()->writeMemberDeclarations(ol,visitedClasses,lt,title,subTitle,showInline,inheritedFrom,lt2,invert,showAlways); }

References FALSE, getCdAlias, MemberListType::Invalid, title and ClassDef::writeMemberDeclarations.

writeMemberList()

void ClassDefAliasImpl::writeMemberList (OutputList & ol)

inline virtual

Definition at line 759 of file classdef.cpp.

759 void writeMemberList(OutputList &ol) const override

760 { getCdAlias()->writeMemberList(ol); }

References getCdAlias and ClassDef::writeMemberList.

writeMemberPages()

void ClassDefAliasImpl::writeMemberPages (OutputList & ol)

inline virtual

Definition at line 757 of file classdef.cpp.

757 void writeMemberPages(OutputList &ol) const override

758 { getCdAlias()->writeMemberPages(ol); }

References getCdAlias and ClassDef::writeMemberPages.

writePageNavigation()

void ClassDefAliasImpl::writePageNavigation (OutputList & ol)

inline virtual

Definition at line 768 of file classdef.cpp.

768 void writePageNavigation(OutputList &ol) const override

769 { getCdAlias()->writePageNavigation(ol); }

References getCdAlias and ClassDef::writePageNavigation.

writeQuickMemberLinks()

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

inline virtual

Definition at line 764 of file classdef.cpp.

764 void writeQuickMemberLinks(OutputList &ol,const MemberDef *md) const override

765 { getCdAlias()->writeQuickMemberLinks(ol,md); }

References getCdAlias and ClassDef::writeQuickMemberLinks.

writeSummaryLinks()

void ClassDefAliasImpl::writeSummaryLinks (OutputList & ol)

inline virtual

Definition at line 766 of file classdef.cpp.

766 void writeSummaryLinks(OutputList &ol) const override

767 { getCdAlias()->writeSummaryLinks(ol); }

References getCdAlias and ClassDef::writeSummaryLinks.

writeTagFile()

void ClassDefAliasImpl::writeTagFile (TextStream & ol)

inline virtual

Definition at line 772 of file classdef.cpp.

772 void writeTagFile(TextStream &ol) const override

773 { getCdAlias()->writeTagFile(ol); }

References getCdAlias and ClassDef::writeTagFile.

---

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

• classdef.cpp

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.