doxygen
|
A abstract class representing of a compound symbol. More...
#include <classdef.h>
Public Types | |
enum | CompoundType { Class, Struct, Union, Interface, Protocol, Category, Exception, Service, Singleton } |
The various compound types. | |
![]() | |
enum | DefType { TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeModule = 3, TypeMember = 4, TypeGroup = 5, TypePackage = 6, TypePage = 7, TypeDir = 8, TypeConcept = 9 } |
Public Member Functions | |
virtual DefType | definitionType () const =0 |
Used for RTTI, this is a class. | |
virtual QCString | getOutputFileBase () const =0 |
Returns the unique base name (without extension) of the class's file on disk. | |
virtual QCString | getInstanceOutputFileBase () const =0 |
virtual QCString | getSourceFileBase () const =0 |
Returns the base name for the source code file. | |
virtual QCString | getReference () const =0 |
If this class originated from a tagfile, this will return the tag file reference. | |
virtual bool | isReference () const =0 |
Returns TRUE if this class is imported via a tag file. | |
virtual bool | isLocal () const =0 |
Returns TRUE if this is a local class definition, see EXTRACT_LOCAL_CLASSES. | |
virtual ClassLinkedRefMap | getClasses () const =0 |
returns the classes nested into this class | |
virtual bool | hasDocumentation () const =0 |
returns TRUE if this class has documentation | |
virtual bool | hasDetailedDescription () const =0 |
returns TRUE if this class has a non-empty detailed description | |
virtual QCString | collaborationGraphFileName () const =0 |
returns the file name to use for the collaboration graph | |
virtual QCString | inheritanceGraphFileName () const =0 |
returns the file name to use for the inheritance graph | |
virtual QCString | displayName (bool includeScope=TRUE) const =0 |
Returns the name as it is appears in the documentation. | |
virtual CompoundType | compoundType () const =0 |
Returns the type of compound this is, i.e. More... | |
virtual QCString | compoundTypeString () const =0 |
Returns the type of compound as a string. | |
virtual const BaseClassList & | baseClasses () const =0 |
Returns the list of base classes from which this class directly inherits. | |
virtual void | updateBaseClasses (const BaseClassList &bcd)=0 |
Update the list of base classes to the one passed. | |
virtual const BaseClassList & | subClasses () const =0 |
Returns the list of sub classes that directly derive from this class. | |
virtual void | updateSubClasses (const BaseClassList &bcd)=0 |
Update the list of sub classes to the one passed. | |
virtual const MemberNameInfoLinkedMap & | memberNameInfoLinkedMap () const =0 |
Returns a dictionary of all members. More... | |
virtual Protection | protection () const =0 |
Return the protection level (Public,Protected,Private) in which this compound was found. | |
virtual bool | isLinkableInProject () const =0 |
returns TRUE iff a link is possible to this item within this project. | |
virtual bool | isLinkable () const =0 |
return TRUE iff a link to this class is possible (either within this project, or as a cross-reference to another project). | |
virtual bool | isVisibleInHierarchy () const =0 |
the class is visible in a class diagram, or class hierarchy | |
virtual bool | visibleInParentsDeclList () const =0 |
show this class in the declaration section of its parent? | |
virtual const ArgumentList & | templateArguments () const =0 |
Returns the template arguments of this class. | |
virtual FileDef * | getFileDef () const =0 |
Returns the namespace this compound is in, or 0 if it has a global scope. More... | |
virtual ModuleDef * | getModuleDef () const =0 |
Returns the C++20 module in which this compound's definition can be found. | |
virtual const MemberDef * | getMemberByName (const QCString &) const =0 |
Returns the member with the given name. | |
virtual 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... | |
virtual bool | isSubClass (ClassDef *bcd, int level=0) const =0 |
Returns TRUE iff bcd is a direct or indirect sub class of this class. | |
virtual 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 | |
virtual const TemplateInstanceList & | getTemplateInstances () const =0 |
Returns a sorted dictionary with all template instances found for this template class. More... | |
virtual const ClassDef * | templateMaster () const =0 |
Returns the template master of which this class is an instance. More... | |
virtual bool | isTemplate () const =0 |
Returns TRUE if this class is a template. | |
virtual const IncludeInfo * | includeInfo () const =0 |
virtual const UsesClassList & | usedImplementationClasses () const =0 |
virtual const UsesClassList & | usedByImplementationClasses () const =0 |
virtual const ConstraintClassList & | templateTypeConstraints () const =0 |
virtual bool | isTemplateArgument () const =0 |
virtual const Definition * | findInnerCompound (const QCString &name) const =0 |
Returns the definition of a nested compound if available, or 0 otherwise. More... | |
virtual ArgumentLists | getTemplateParameterLists () const =0 |
Returns the template parameter lists that form the template declaration of this class. More... | |
virtual QCString | qualifiedNameWithTemplateParameters (const ArgumentLists *actualParams=0, uint32_t *actualParamIndex=0) const =0 |
virtual bool | isAbstract () const =0 |
Returns TRUE if there is at least one pure virtual member in this class. | |
virtual bool | isObjectiveC () const =0 |
Returns TRUE if this class is implemented in Objective-C. | |
virtual bool | isFortran () const =0 |
Returns TRUE if this class is implemented in Fortran. | |
virtual bool | isCSharp () const =0 |
Returns TRUE if this class is implemented in C#. | |
virtual bool | isFinal () const =0 |
Returns TRUE if this class is marked as final. | |
virtual bool | isSealed () const =0 |
Returns TRUE if this class is marked as sealed. | |
virtual bool | isPublished () const =0 |
Returns TRUE if this class is marked as published. | |
virtual bool | isExtension () const =0 |
Returns TRUE if this class represents an Objective-C 2.0 extension (nameless category) | |
virtual bool | isForwardDeclared () const =0 |
Returns TRUE if this class represents a forward declaration of a template class. | |
virtual bool | isInterface () const =0 |
Returns TRUE if this class represents an interface. | |
virtual ClassDef * | categoryOf () const =0 |
Returns the class of which this is a category (Objective-C only) | |
virtual QCString | className () const =0 |
Returns the name of the class including outer classes, but not including namespaces. | |
virtual MemberList * | getMemberList (MemberListType lt) const =0 |
Returns the members in the list identified by lt. | |
virtual const MemberLists & | getMemberLists () const =0 |
Returns the list containing the list of members sorted per type. | |
virtual const MemberGroupList & | getMemberGroups () const =0 |
Returns the member groups defined for this class. | |
virtual const TemplateNameMap & | getTemplateBaseClassNames () const =0 |
virtual bool | isUsedOnly () const =0 |
virtual QCString | anchor () const =0 |
virtual bool | isEmbeddedInOuterScope () const =0 |
virtual bool | isSimple () const =0 |
virtual const ClassDef * | tagLessReference () const =0 |
virtual const MemberDef * | isSmartPointer () const =0 |
virtual bool | isJavaEnum () const =0 |
virtual QCString | title () const =0 |
virtual QCString | generatedFromFiles () const =0 |
virtual const FileList & | usedFiles () const =0 |
virtual const ArgumentList & | typeConstraints () const =0 |
virtual const ExampleList & | getExamples () const =0 |
virtual bool | hasExamples () const =0 |
virtual QCString | getMemberListFileName () const =0 |
virtual bool | subGrouping () const =0 |
virtual bool | isSliceLocal () const =0 |
virtual bool | hasNonReferenceSuperClass () const =0 |
virtual QCString | requiresClause () const =0 |
virtual StringVector | getQualifiers () const =0 |
virtual int | countMembersIncludingGrouped (MemberListType lt, const ClassDef *inheritedFrom, bool additional) const =0 |
virtual int | countInheritanceNodes () const =0 |
virtual int | countMemberDeclarations (MemberListType lt, const ClassDef *inheritedFrom, int lt2, bool invert, bool showAlways, ClassDefSet &visitedClasses) const =0 |
virtual ClassDef * | insertTemplateInstance (const QCString &fileName, int startLine, int startColumn, const QCString &templSpec, bool &freshInstance) const =0 |
virtual void | writeDeclarationLink (OutputList &ol, bool &found, const QCString &header, bool localNames) const =0 |
virtual void | writeDocumentation (OutputList &ol) const =0 |
virtual void | writeDocumentationForInnerClasses (OutputList &ol) const =0 |
virtual void | writeMemberPages (OutputList &ol) const =0 |
virtual void | writeMemberList (OutputList &ol) const =0 |
virtual void | writeDeclaration (OutputList &ol, const MemberDef *md, bool inGroup, int indentLevel, const ClassDef *inheritedFrom, const QCString &inheritId) const =0 |
virtual void | writeQuickMemberLinks (OutputList &ol, const MemberDef *md) const =0 |
virtual void | writeSummaryLinks (OutputList &ol) const =0 |
virtual void | writeInlineDocumentation (OutputList &ol) const =0 |
virtual void | writeTagFile (TextStream &) const =0 |
virtual void | writeMemberDeclarations (OutputList &ol, ClassDefSet &visitedClasses, MemberListType lt, const QCString &title, const QCString &subTitle=QCString(), bool showInline=FALSE, const ClassDef *inheritedFrom=0, int lt2=-1, bool invert=FALSE, bool showAlways=FALSE) const =0 |
virtual void | addGroupedInheritedMembers (OutputList &ol, MemberListType lt, const ClassDef *inheritedFrom, const QCString &inheritId) const =0 |
![]() | |
virtual CodeSymbolType | codeSymbolType () const =0 |
virtual bool | isAlias () const =0 |
virtual const QCString & | name () const =0 |
virtual bool | isAnonymous () const =0 |
virtual const QCString & | localName () const =0 |
virtual QCString | qualifiedName () const =0 |
virtual QCString | symbolName () 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 | hasUserDocumentation () const =0 |
virtual bool | isVisibleInProject () const =0 |
virtual bool | isVisible () const =0 |
virtual bool | isHidden () const =0 |
virtual bool | isArtificial () const =0 |
virtual bool | isExported () const =0 |
virtual QCString | externalReference (const QCString &relPath) const =0 |
virtual int | getStartDefLine () const =0 |
virtual int | getStartBodyLine () const =0 |
virtual int | getEndBodyLine () const =0 |
virtual const FileDef * | getBodyDef () const =0 |
virtual SrcLangExt | getLanguage () const =0 |
Returns the programming language this definition was written in. More... | |
virtual const GroupList & | partOfGroups () const =0 |
virtual bool | isLinkableViaGroup () const =0 |
virtual const RefItemVector & | xrefListItems () const =0 |
virtual Definition * | getOuterScope () const =0 |
virtual const MemberVector & | getReferencesMembers () const =0 |
virtual const MemberVector & | getReferencedByMembers () const =0 |
virtual bool | hasSections () const =0 |
virtual bool | hasSources () const =0 |
virtual bool | hasBriefDescription () const =0 |
returns TRUE if this class has a brief description | |
virtual QCString | id () const =0 |
virtual const SectionRefs & | getSectionRefs () const =0 |
returns the section dictionary, only of importance for pagedef | |
virtual QCString | navigationPathAsString () const =0 |
virtual QCString | pathFragment () const =0 |
virtual void | _setSymbolName (const QCString &name)=0 |
virtual QCString | _symbolName () const =0 |
A abstract class representing of a compound symbol.
A compound can be a class, struct, union, interface, service, singleton, or exception.
|
pure virtual |
Returns the anchor within a page where this item can be found
Implements Definition.
Implemented in ClassDefAliasImpl, and ClassDefImpl.
|
pure virtual |
Returns the type of compound this is, i.e.
class/struct/union/..
Implemented in ClassDefAliasImpl, and ClassDefImpl.
|
pure virtual |
Returns the definition of a nested compound if available, or 0 otherwise.
name | The name of the nested compound |
Implements Definition.
Implemented in ClassDefAliasImpl, and ClassDefImpl.
|
pure 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).
Implemented in ClassDefAliasImpl, and ClassDefImpl.
|
pure virtual |
Returns a sorted dictionary with all template instances found for this template class.
Returns 0 if not a template or no instances.
Implemented in ClassDefAliasImpl, and ClassDefImpl.
|
pure 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".
Implemented in ClassDefAliasImpl, and ClassDefImpl.
|
pure 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.
Implemented in ClassDefAliasImpl, and ClassDefImpl.
|
pure virtual |
Returns a dictionary of all members.
This includes any inherited members. Members are sorted alphabetically.
Implemented in ClassDefAliasImpl, and ClassDefImpl.
|
pure virtual |
Returns the template master of which this class is an instance.
Returns 0 if not applicable.
Implemented in ClassDefAliasImpl, and ClassDefImpl.