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

ClassDef Class Referenceabstract

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

#include <classdef.h>

+ Inheritance diagram for ClassDef:
+ Collaboration diagram for ClassDef:

Public Types

enum  CompoundType {
  Class, Struct, Union, Interface,
  Protocol, Category, Exception, Service,
  Singleton
}
 The various compound types. More...
 
- Public Types inherited from DefinitionIntf
enum  DefType {
  TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeMember = 3,
  TypeGroup = 4, TypePackage = 5, TypePage = 6, TypeDir = 7,
  TypeSymbolList = 8
}
 

Public Member Functions

virtual ~ClassDef ()
 
virtual DefType definitionType () const =0
 Used for RTTI, this is a class. More...
 
virtual QCString getOutputFileBase () const =0
 Returns the unique base name (without extension) of the class's file on disk. More...
 
virtual QCString getInstanceOutputFileBase () const =0
 
virtual QCString getSourceFileBase () const =0
 Returns the base name for the source code file. More...
 
virtual QCString getReference () const =0
 If this class originated from a tagfile, this will return the tag file reference. More...
 
virtual bool isReference () const =0
 Returns TRUE if this class is imported via a tag file. More...
 
virtual bool isLocal () const =0
 Returns TRUE if this is a local class definition, see EXTRACT_LOCAL_CLASSES. More...
 
virtual ClassSDictgetClassSDict () const =0
 returns the classes nested into this class More...
 
virtual bool hasDocumentation () const =0
 returns TRUE if this class has documentation More...
 
virtual bool hasDetailedDescription () const =0
 returns TRUE if this class has a non-empty detailed description More...
 
virtual QCString collaborationGraphFileName () const =0
 returns the file name to use for the collaboration graph More...
 
virtual QCString inheritanceGraphFileName () const =0
 returns the file name to use for the inheritance graph More...
 
virtual QCString displayName (bool includeScope=TRUE) const =0
 Returns the name as it is appears in the documentation. More...
 
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. More...
 
virtual BaseClassListbaseClasses () const =0
 Returns the list of base classes from which this class directly inherits. More...
 
virtual BaseClassListsubClasses () const =0
 Returns the list of sub classes that directly derive from this class. More...
 
virtual MemberNameInfoSDictmemberNameInfoSDict () 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. More...
 
virtual bool isLinkableInProject () const =0
 returns TRUE iff a link is possible to this item within this project. More...
 
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). More...
 
virtual bool isVisibleInHierarchy () const =0
 the class is visible in a class diagram, or class hierarchy More...
 
virtual bool visibleInParentsDeclList () const =0
 show this class in the declaration section of its parent? More...
 
virtual const ArgumentListtemplateArguments () const =0
 Returns the template arguments of this class. More...
 
virtual NamespaceDefgetNamespaceDef () const =0
 Returns the namespace this compound is in, or 0 if it has a global scope. More...
 
virtual FileDefgetFileDef () const =0
 Returns the file in which this compound's definition can be found. More...
 
virtual MemberDefgetMemberByName (const QCString &) const =0
 Returns the Java package this class is in or 0 if not applicable. More...
 
virtual bool isBaseClass (const ClassDef *bcd, bool followInstances, int level=0) 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. More...
 
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 More...
 
virtual QDict< ClassDef > * getTemplateInstances () const =0
 Returns a sorted dictionary with all template instances found for this template class. More...
 
virtual const ClassDeftemplateMaster () 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. More...
 
virtual IncludeInfoincludeInfo () const =0
 
virtual UsesClassDictusedImplementationClasses () const =0
 
virtual UsesClassDictusedByImplementationClasses () const =0
 
virtual UsesClassDictusedInterfaceClasses () const =0
 
virtual ConstraintClassDicttemplateTypeConstraints () const =0
 
virtual bool isTemplateArgument () const =0
 
virtual DefinitionfindInnerCompound (const char *name) const =0
 Returns the definition of a nested compound if available, or 0 otherwise. More...
 
virtual std::vector< ArgumentListgetTemplateParameterLists () const =0
 Returns the template parameter lists that form the template declaration of this class. More...
 
virtual QCString qualifiedNameWithTemplateParameters (const std::vector< ArgumentList > *actualParams=0, uint *actualParamIndex=0) const =0
 
virtual bool isAbstract () const =0
 Returns TRUE if there is at least one pure virtual member in this class. More...
 
virtual bool isObjectiveC () const =0
 Returns TRUE if this class is implemented in Objective-C. More...
 
virtual bool isFortran () const =0
 Returns TRUE if this class is implemented in Fortran. More...
 
virtual bool isCSharp () const =0
 Returns TRUE if this class is implemented in C#. More...
 
virtual bool isFinal () const =0
 Returns TRUE if this class is marked as final. More...
 
virtual bool isSealed () const =0
 Returns TRUE if this class is marked as sealed. More...
 
virtual bool isPublished () const =0
 Returns TRUE if this class is marked as published. More...
 
virtual bool isExtension () const =0
 Returns TRUE if this class represents an Objective-C 2.0 extension (nameless category) More...
 
virtual bool isForwardDeclared () const =0
 Returns TRUE if this class represents a forward declaration of a template class. More...
 
virtual bool isInterface () const =0
 Returns TRUE if this class represents an interface. More...
 
virtual ClassDefcategoryOf () const =0
 Returns the class of which this is a category (Objective-C only) More...
 
virtual QCString className () const =0
 Returns the name of the class including outer classes, but not including namespaces. More...
 
virtual MemberListgetMemberList (MemberListType lt) const =0
 Returns the members in the list identified by lt. More...
 
virtual const QList< MemberList > & getMemberLists () const =0
 Returns the list containing the list of members sorted per type. More...
 
virtual MemberGroupSDictgetMemberGroupSDict () const =0
 Returns the member groups defined for this class. More...
 
virtual QDict< int > * getTemplateBaseClassNames () const =0
 
virtual ClassDefgetVariableInstance (const char *templSpec) const =0
 
virtual bool isUsedOnly () const =0
 
virtual QCString anchor () const =0
 
virtual bool isEmbeddedInOuterScope () const =0
 
virtual bool isSimple () const =0
 
virtual const ClassListtaggedInnerClasses () const =0
 
virtual ClassDeftagLessReference () const =0
 
virtual MemberDefisSmartPointer () const =0
 
virtual bool isJavaEnum () const =0
 
virtual bool isGeneric () const =0
 
virtual const ClassSDictinnerClasses () const =0
 
virtual QCString title () const =0
 
virtual QCString generatedFromFiles () const =0
 
virtual const FileListusedFiles () const =0
 
virtual const ArgumentListtypeConstraints () const =0
 
virtual const ExampleSDictexampleList () 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 void setIncludeFile (FileDef *fd, const char *incName, bool local, bool force)=0
 
virtual void setNamespace (NamespaceDef *nd)=0
 
virtual void setFileDef (FileDef *fd)=0
 
virtual void setSubGrouping (bool enabled)=0
 
virtual void setProtection (Protection p)=0
 
virtual void setGroupDefForAllMembers (GroupDef *g, Grouping::GroupPri_t pri, const QCString &fileName, int startLine, bool hasDocs)=0
 
virtual void setIsStatic (bool b)=0
 
virtual void setCompoundType (CompoundType t)=0
 
virtual void setClassName (const char *name)=0
 
virtual void setClassSpecifier (uint64 spec)=0
 
virtual void setTemplateArguments (const ArgumentList &al)=0
 
virtual void setTemplateBaseClassNames (QDict< int > *templateNames)=0
 
virtual void setTemplateMaster (const ClassDef *tm)=0
 
virtual void setTypeConstraints (const ArgumentList &al)=0
 
virtual void setCategoryOf (ClassDef *cd)=0
 
virtual void setUsedOnly (bool b)=0
 
virtual void setTagLessReference (ClassDef *cd)=0
 
virtual void setName (const char *name)=0
 
virtual void setMetaData (const char *md)=0
 
virtual void insertBaseClass (ClassDef *, const char *name, Protection p, Specifier s, const char *t=0)=0
 
virtual void insertSubClass (ClassDef *, Protection p, Specifier s, const char *t=0)=0
 
virtual void insertMember (MemberDef *)=0
 
virtual void insertUsedFile (FileDef *)=0
 
virtual void addMembersToTemplateInstance (const ClassDef *cd, const char *templSpec)=0
 
virtual void addTaggedInnerClass (ClassDef *cd)=0
 
virtual void addInnerCompound (const Definition *d)=0
 
virtual bool addExample (const char *anchor, const char *name, const char *file)=0
 
virtual ClassDefinsertTemplateInstance (const QCString &fileName, int startLine, int startColumn, const QCString &templSpec, bool &freshInstance) const =0
 
virtual void addUsedClass (ClassDef *cd, const char *accessName, Protection prot)=0
 
virtual void addUsedByClass (ClassDef *cd, const char *accessName, Protection prot)=0
 
virtual void makeTemplateArgument (bool b=TRUE)=0
 
virtual void mergeCategory (ClassDef *category)=0
 
virtual void findSectionsInDocumentation ()=0
 
virtual void addMembersToMemberGroup ()=0
 
virtual void addListReferences ()=0
 
virtual void addTypeConstraints ()=0
 
virtual void computeAnchors ()=0
 
virtual void mergeMembers ()=0
 
virtual void sortMemberLists ()=0
 
virtual void distributeMemberGroupDocumentation ()=0
 
virtual void reclassifyMember (MemberDef *md, MemberType t)=0
 
virtual void removeMemberFromLists (MemberDef *md)=0
 
virtual void setAnonymousEnumType ()=0
 
virtual void countMembers ()=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, const ClassDef *inheritedFrom, const char *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 writeDeclarationLink (OutputList &ol, bool &found, const char *header, bool localNames) const =0
 
virtual void writeTagFile (FTextStream &)=0
 
virtual void writeMemberDeclarations (OutputList &ol, MemberListType lt, const QCString &title, const char *subTitle=0, bool showInline=FALSE, const ClassDef *inheritedFrom=0, int lt2=-1, bool invert=FALSE, bool showAlways=FALSE, QPtrDict< void > *visitedClasses=0) const =0
 
virtual void addGroupedInheritedMembers (OutputList &ol, MemberListType lt, const ClassDef *inheritedFrom, const QCString &inheritId) 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, QPtrDict< void > *visitedClasses) const =0
 
virtual void setVisited (bool visited) const =0
 
virtual bool isVisited () const =0
 
- Public Member Functions inherited from Definition
virtual bool isAlias () const =0
 
virtual QCString name () const =0
 
virtual bool isAnonymous () const =0
 
virtual QCString localName () const =0
 
virtual QCString qualifiedName () const =0
 
virtual QCString symbolName () const =0
 
virtual QCString 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 QCString externalReference (const QCString &relPath) const =0
 
virtual int getStartDefLine () const =0
 
virtual int getStartBodyLine () const =0
 
virtual int getEndBodyLine () const =0
 
virtual FileDefgetBodyDef () const =0
 
virtual SrcLangExt getLanguage () const =0
 Returns the programming language this definition was written in. More...
 
virtual GroupListpartOfGroups () const =0
 
virtual bool isLinkableViaGroup () const =0
 
virtual const std::vector< RefItem * > & xrefListItems () const =0
 
virtual DefinitiongetOuterScope () const =0
 
virtual MemberSDictgetReferencesMembers () const =0
 
virtual MemberSDictgetReferencedByMembers () const =0
 
virtual bool hasSections () const =0
 
virtual bool hasSources () const =0
 
virtual bool hasBriefDescription () const =0
 returns TRUE if this class has a brief description More...
 
virtual QCString id () const =0
 
virtual const SectionRefsgetSectionRefs () const =0
 returns the section dictionary, only of importance for pagedef More...
 
virtual QCString navigationPathAsString () const =0
 
virtual QCString pathFragment () const =0
 
virtual void setId (const char *name)=0
 
virtual void setDefFile (const QCString &df, int defLine, int defColumn)=0
 
virtual void setDocumentation (const char *d, const char *docFile, int docLine, bool stripWhiteSpace=TRUE)=0
 
virtual void setBriefDescription (const char *b, const char *briefFile, int briefLine)=0
 
virtual void setInbodyDocumentation (const char *d, const char *docFile, int docLine)=0
 
virtual void setReference (const char *r)=0
 
virtual void setBodySegment (int defLine, int bls, int ble)=0
 
virtual void setBodyDef (FileDef *fd)=0
 
virtual void setRefItems (const std::vector< RefItem * > &sli)=0
 
virtual void setOuterScope (Definition *d)=0
 
virtual void setHidden (bool b)=0
 
virtual void setArtificial (bool b)=0
 
virtual void setLanguage (SrcLangExt lang)=0
 
virtual void setLocalName (const QCString name)=0
 
virtual void makePartOfGroup (GroupDef *gd)=0
 
virtual void addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList)=0
 
virtual void addSourceReferencedBy (const MemberDef *d)=0
 
virtual void addSourceReferences (const MemberDef *d)=0
 
virtual void mergeRefItems (Definition *d)=0
 
virtual void addSectionsToIndex ()=0
 
virtual void writeSourceDef (OutputList &ol, const char *scopeName) const =0
 
virtual void writeInlineCode (OutputList &ol, const char *scopeName) const =0
 
virtual void writeSourceRefs (OutputList &ol, const char *scopeName) const =0
 
virtual void writeSourceReffedBy (OutputList &ol, const char *scopeName) const =0
 
virtual void writeNavigationPath (OutputList &ol) const =0
 
virtual void writeDocAnchorsToTagFile (FTextStream &) const =0
 
virtual void writeToc (OutputList &ol, const LocalToc &lt) const =0
 
virtual void setCookie (Cookie *cookie) const =0
 
virtual Cookiecookie () const =0
 
virtual void _setSymbolName (const QCString &name)=0
 
virtual QCString _symbolName () const =0
 
- Public Member Functions inherited from DefinitionIntf
 DefinitionIntf ()
 
virtual ~DefinitionIntf ()
 

Detailed 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 60 of file classdef.h.

Member Enumeration Documentation

◆ CompoundType

The various compound types.

Enumerator
Class 
Struct 
Union 
Interface 
Protocol 
Category 
Exception 
Service 
Singleton 

Definition at line 64 of file classdef.h.

Constructor & Destructor Documentation

◆ ~ClassDef()

virtual ClassDef::~ClassDef ( )
inlinevirtual

Definition at line 75 of file classdef.h.

Member Function Documentation

◆ addExample()

virtual bool ClassDef::addExample ( const char *  anchor,
const char *  name,
const char *  file 
)
pure virtual

Implemented in ClassDefImpl, and ClassDefAliasImpl.

◆ addGroupedInheritedMembers()

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

Implemented in ClassDefImpl, and ClassDefAliasImpl.

Referenced by MemberList::writeDeclarations().

◆ addInnerCompound()

virtual void ClassDef::addInnerCompound ( const Definition d)
pure virtual

Implements Definition.

Implemented in ClassDefImpl, and ClassDefAliasImpl.

◆ addListReferences()

virtual void ClassDef::addListReferences ( )
pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by addListReferences().

◆ addMembersToMemberGroup()

virtual void ClassDef::addMembersToMemberGroup ( )
pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by addMembersToMemberGroup().

◆ addMembersToTemplateInstance()

virtual void ClassDef::addMembersToTemplateInstance ( const ClassDef cd,
const char *  templSpec 
)
pure virtual

◆ addTaggedInnerClass()

virtual void ClassDef::addTaggedInnerClass ( ClassDef cd)
pure virtual

Implemented in ClassDefImpl, and ClassDefAliasImpl.

Referenced by processTagLessClasses().

◆ addTypeConstraints()

virtual void ClassDef::addTypeConstraints ( )
pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by findUsedTemplateInstances().

◆ addUsedByClass()

virtual void ClassDef::addUsedByClass ( ClassDef cd,
const char *  accessName,
Protection  prot 
)
pure virtual

Implemented in ClassDefImpl, and ClassDefAliasImpl.

Referenced by findUsedClassesForClass().

◆ addUsedClass()

virtual void ClassDef::addUsedClass ( ClassDef cd,
const char *  accessName,
Protection  prot 
)
pure virtual

Implemented in ClassDefImpl, and ClassDefAliasImpl.

Referenced by findUsedClassesForClass().

◆ anchor()

◆ baseClasses()

◆ categoryOf()

virtual ClassDef* ClassDef::categoryOf ( ) const
pure virtual

◆ className()

virtual QCString ClassDef::className ( ) const
pure virtual

◆ collaborationGraphFileName()

virtual QCString ClassDef::collaborationGraphFileName ( ) const
pure virtual

returns the file name to use for the collaboration graph

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::collaborationGraphFileName(), and DotClassGraph::DotClassGraph().

◆ compoundType()

◆ compoundTypeString()

◆ computeAnchors()

virtual void ClassDef::computeAnchors ( )
pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by computeMemberReferences().

◆ countInheritanceNodes()

virtual int ClassDef::countInheritanceNodes ( ) const
pure virtual

◆ countMemberDeclarations()

virtual int ClassDef::countMemberDeclarations ( MemberListType  lt,
const ClassDef inheritedFrom,
int  lt2,
bool  invert,
bool  showAlways,
QPtrDict< void > *  visitedClasses 
) const
pure virtual

◆ countMembers()

virtual void ClassDef::countMembers ( )
pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by countMembers().

◆ countMembersIncludingGrouped()

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

◆ definitionType()

virtual DefType ClassDef::definitionType ( ) const
pure virtual

Used for RTTI, this is a class.

Implements DefinitionIntf.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

◆ displayName()

◆ distributeMemberGroupDocumentation()

virtual void ClassDef::distributeMemberGroupDocumentation ( )
pure virtual

◆ exampleList()

virtual const ExampleSDict* ClassDef::exampleList ( ) const
pure virtual

◆ findInnerCompound()

virtual Definition* ClassDef::findInnerCompound ( const char *  name) const
pure virtual

Returns the definition of a nested compound if available, or 0 otherwise.

Parameters
nameThe name of the nested compound

Implements Definition.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::findInnerCompound().

◆ findSectionsInDocumentation()

virtual void ClassDef::findSectionsInDocumentation ( )
pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by findSectionsInDocumentation().

◆ generatedFromFiles()

virtual QCString ClassDef::generatedFromFiles ( ) const
pure virtual

◆ getClassSDict()

◆ getFileDef()

virtual FileDef* ClassDef::getFileDef ( ) const
pure virtual

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.

Referenced by addInstance(), cModule(), createTagLessInstance(), findClassRelation(), findClassWithinClassContext(), findUsedClassesForClass(), getDefs(), ClassDefAliasImpl::getFileDef(), referenceTo(), and resolveClassNestingRelations().

◆ getInstanceOutputFileBase()

virtual QCString ClassDef::getInstanceOutputFileBase ( ) const
pure virtual

◆ getMemberByName()

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

Returns the Java package this class is in or 0 if not applicable.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::getMemberByName().

◆ getMemberGroupSDict()

◆ getMemberList()

◆ getMemberListFileName()

virtual QCString ClassDef::getMemberListFileName ( ) const
pure virtual

◆ getMemberLists()

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

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

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by generateDEFForClass(), generateXMLForClass(), and ClassDefAliasImpl::getMemberLists().

◆ getNamespaceDef()

virtual NamespaceDef* ClassDef::getNamespaceDef ( ) const
pure virtual

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

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::getNamespaceDef().

◆ getOutputFileBase()

◆ getReference()

◆ getSourceFileBase()

virtual QCString ClassDef::getSourceFileBase ( ) const
pure virtual

Returns the base name for the source code file.

Implements Definition.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefImpl::getSourceFileBase(), and ClassDefAliasImpl::getSourceFileBase().

◆ getTemplateBaseClassNames()

virtual QDict<int>* ClassDef::getTemplateBaseClassNames ( ) const
pure virtual

◆ getTemplateInstances()

virtual QDict<ClassDef>* ClassDef::getTemplateInstances ( ) const
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.

Referenced by DotClassGraph::buildGraph(), computeTemplateClassRelations(), createTemplateInstanceMembers(), ClassDefAliasImpl::getTemplateInstances(), and ClassDefImpl::hasNonReferenceSuperClass().

◆ getTemplateParameterLists()

virtual std::vector<ArgumentList> ClassDef::getTemplateParameterLists ( ) const
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.

Referenced by addMemberFunction(), MemberContext::Private::addTemplateDecls(), ClassDefAliasImpl::getTemplateParameterLists(), and MemberDefImpl::writeDocumentation().

◆ getVariableInstance()

virtual ClassDef* ClassDef::getVariableInstance ( const char *  templSpec) const
pure virtual

◆ hasDetailedDescription()

virtual bool ClassDef::hasDetailedDescription ( ) const
pure virtual

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

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::hasDetailedDescription(), and ClassContext::Private::hasDetails().

◆ hasDocumentation()

virtual bool ClassDef::hasDocumentation ( ) const
pure virtual

returns TRUE if this class has documentation

Implements Definition.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by addClassToContext(), computeClassRelations(), ClassDefAliasImpl::hasDocumentation(), and ClassDefImpl::isVisibleInHierarchy().

◆ hasExamples()

virtual bool ClassDef::hasExamples ( ) const
pure virtual

◆ hasNonReferenceSuperClass()

virtual bool ClassDef::hasNonReferenceSuperClass ( ) const
pure virtual

◆ includeInfo()

◆ inheritanceGraphFileName()

virtual QCString ClassDef::inheritanceGraphFileName ( ) const
pure virtual

returns the file name to use for the inheritance graph

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by DotClassGraph::DotClassGraph(), and ClassDefAliasImpl::inheritanceGraphFileName().

◆ innerClasses()

virtual const ClassSDict* ClassDef::innerClasses ( ) const
pure virtual

◆ insertBaseClass()

virtual void ClassDef::insertBaseClass ( ClassDef ,
const char *  name,
Protection  p,
Specifier  s,
const char *  t = 0 
)
pure virtual

Implemented in ClassDefImpl, and ClassDefAliasImpl.

Referenced by addInstance(), and findClassRelation().

◆ insertMember()

◆ insertSubClass()

virtual void ClassDef::insertSubClass ( ClassDef ,
Protection  p,
Specifier  s,
const char *  t = 0 
)
pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by addInstance(), and findClassRelation().

◆ insertTemplateInstance()

virtual ClassDef* ClassDef::insertTemplateInstance ( const QCString fileName,
int  startLine,
int  startColumn,
const QCString templSpec,
bool freshInstance 
) const
pure virtual

◆ insertUsedFile()

◆ isAbstract()

virtual bool ClassDef::isAbstract ( ) const
pure virtual

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

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by classInformation(), generateXMLForClass(), and ClassDefAliasImpl::isAbstract().

◆ isAccessibleMember()

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

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

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::isAccessibleMember().

◆ isBaseClass()

virtual bool ClassDef::isBaseClass ( const ClassDef bcd,
bool  followInstances,
int  level = 0 
) const
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.

Referenced by addInstance(), computeMemberRelations(), ClassDefImpl::isBaseClass(), ClassDefAliasImpl::isBaseClass(), MemberDefImpl::isReimplementedBy(), VhdlDocGen::isSubClass(), and ClassDefImpl::mergeMembers().

◆ isCSharp()

virtual bool ClassDef::isCSharp ( ) const
pure virtual

Returns TRUE if this class is implemented in C#.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by findClassRelation(), and ClassDefAliasImpl::isCSharp().

◆ isEmbeddedInOuterScope()

◆ isExtension()

virtual bool ClassDef::isExtension ( ) const
pure virtual

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

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::isExtension(), ClassDefImpl::mergeCategory(), and ClassSDict::writeDeclaration().

◆ isFinal()

virtual bool ClassDef::isFinal ( ) const
pure virtual

Returns TRUE if this class is marked as final.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by generateXMLForClass(), and ClassDefAliasImpl::isFinal().

◆ isFortran()

virtual bool ClassDef::isFortran ( ) const
pure virtual

Returns TRUE if this class is implemented in Fortran.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::isFortran().

◆ isForwardDeclared()

virtual bool ClassDef::isForwardDeclared ( ) const
pure virtual

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

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by addClassToContext(), and ClassDefAliasImpl::isForwardDeclared().

◆ isGeneric()

virtual bool ClassDef::isGeneric ( ) const
pure virtual

◆ isInterface()

virtual bool ClassDef::isInterface ( ) const
pure virtual

Returns TRUE if this class represents an interface.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::isInterface(), and ClassDefImpl::writeIncludeFilesForSlice().

◆ isJavaEnum()

virtual bool ClassDef::isJavaEnum ( ) const
pure virtual

◆ isLinkable()

◆ isLinkableInProject()

◆ isLocal()

virtual bool ClassDef::isLocal ( ) const
pure virtual

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

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassSDict::declVisible(), ClassDefAliasImpl::isLocal(), and ClassDefImpl::mergeCategory().

◆ isObjectiveC()

virtual bool ClassDef::isObjectiveC ( ) const
pure virtual

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

Implemented in ClassDefAliasImpl, and ClassDefImpl.

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

◆ isPublished()

virtual bool ClassDef::isPublished ( ) const
pure virtual

Returns TRUE if this class is marked as published.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::isPublished().

◆ isReference()

virtual bool ClassDef::isReference ( ) const
pure virtual

◆ isSealed()

virtual bool ClassDef::isSealed ( ) const
pure virtual

Returns TRUE if this class is marked as sealed.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by generateXMLForClass(), and ClassDefAliasImpl::isSealed().

◆ isSimple()

◆ isSliceLocal()

virtual bool ClassDef::isSliceLocal ( ) const
pure virtual

◆ isSmartPointer()

virtual MemberDef* ClassDef::isSmartPointer ( ) const
pure virtual

◆ isSubClass()

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

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

Implemented in ClassDefAliasImpl, and ClassDefImpl.

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

◆ isTemplate()

virtual bool ClassDef::isTemplate ( ) const
pure virtual

◆ isTemplateArgument()

virtual bool ClassDef::isTemplateArgument ( ) const
pure virtual

◆ isUsedOnly()

virtual bool ClassDef::isUsedOnly ( ) const
pure virtual

◆ isVisibleInHierarchy()

◆ isVisited()

◆ makeTemplateArgument()

virtual void ClassDef::makeTemplateArgument ( bool  b = TRUE)
pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by findUsedClassesForClass().

◆ memberNameInfoSDict()

◆ mergeCategory()

virtual void ClassDef::mergeCategory ( ClassDef category)
pure virtual

Implemented in ClassDefImpl, and ClassDefAliasImpl.

Referenced by mergeCategories().

◆ mergeMembers()

virtual void ClassDef::mergeMembers ( )
pure virtual

◆ protection()

◆ qualifiedNameWithTemplateParameters()

virtual QCString ClassDef::qualifiedNameWithTemplateParameters ( const std::vector< ArgumentList > *  actualParams = 0,
uint actualParamIndex = 0 
) const
pure virtual

◆ reclassifyMember()

virtual void ClassDef::reclassifyMember ( MemberDef md,
MemberType  t 
)
pure virtual

Implemented in ClassDefImpl, and ClassDefAliasImpl.

Referenced by addVariableToClass().

◆ removeMemberFromLists()

virtual void ClassDef::removeMemberFromLists ( MemberDef md)
pure virtual

Implemented in ClassDefImpl, and ClassDefAliasImpl.

◆ setAnonymousEnumType()

virtual void ClassDef::setAnonymousEnumType ( )
pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by setAnonymousEnumType().

◆ setCategoryOf()

virtual void ClassDef::setCategoryOf ( ClassDef cd)
pure virtual

Implemented in ClassDefImpl, and ClassDefAliasImpl.

Referenced by ClassDefImpl::mergeCategory().

◆ setClassName()

virtual void ClassDef::setClassName ( const char *  name)
pure virtual

Implemented in ClassDefImpl, and ClassDefAliasImpl.

Referenced by addVariableToFile(), and writeClassTree().

◆ setClassSpecifier()

virtual void ClassDef::setClassSpecifier ( uint64  spec)
pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by addClassToContext().

◆ setCompoundType()

virtual void ClassDef::setCompoundType ( CompoundType  t)
pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by addClassToContext(), and findClassRelation().

◆ setFileDef()

virtual void ClassDef::setFileDef ( FileDef fd)
pure virtual

◆ setGroupDefForAllMembers()

virtual void ClassDef::setGroupDefForAllMembers ( GroupDef g,
Grouping::GroupPri_t  pri,
const QCString fileName,
int  startLine,
bool  hasDocs 
)
pure virtual

◆ setIncludeFile()

virtual void ClassDef::setIncludeFile ( FileDef fd,
const char *  incName,
bool  local,
bool  force 
)
pure virtual

Implemented in ClassDefImpl, and ClassDefAliasImpl.

Referenced by addIncludeFile().

◆ setIsStatic()

virtual void ClassDef::setIsStatic ( bool  b)
pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by addClassToContext().

◆ setMetaData()

virtual void ClassDef::setMetaData ( const char *  md)
pure virtual

Implemented in ClassDefImpl, and ClassDefAliasImpl.

Referenced by addClassToContext().

◆ setName()

virtual void ClassDef::setName ( const char *  name)
pure virtual

Sets a new name for the definition

Implements Definition.

Implemented in ClassDefImpl, and ClassDefAliasImpl.

◆ setNamespace()

virtual void ClassDef::setNamespace ( NamespaceDef nd)
pure virtual

Implemented in ClassDefImpl, and ClassDefAliasImpl.

◆ setProtection()

virtual void ClassDef::setProtection ( Protection  p)
pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by addClassToContext().

◆ setSubGrouping()

virtual void ClassDef::setSubGrouping ( bool  enabled)
pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by addClassToContext().

◆ setTagLessReference()

virtual void ClassDef::setTagLessReference ( ClassDef cd)
pure virtual

Implemented in ClassDefImpl, and ClassDefAliasImpl.

Referenced by processTagLessClasses().

◆ setTemplateArguments()

virtual void ClassDef::setTemplateArguments ( const ArgumentList al)
pure virtual

Implemented in ClassDefImpl, and ClassDefAliasImpl.

Referenced by addClassToContext().

◆ setTemplateBaseClassNames()

virtual void ClassDef::setTemplateBaseClassNames ( QDict< int > *  templateNames)
pure virtual

Implemented in ClassDefImpl, and ClassDefAliasImpl.

Referenced by findTemplateInstanceRelation().

◆ setTemplateMaster()

virtual void ClassDef::setTemplateMaster ( const ClassDef tm)
pure virtual

◆ setTypeConstraints()

virtual void ClassDef::setTypeConstraints ( const ArgumentList al)
pure virtual

Implemented in ClassDefImpl, and ClassDefAliasImpl.

Referenced by addClassToContext().

◆ setUsedOnly()

virtual void ClassDef::setUsedOnly ( bool  b)
pure virtual

◆ setVisited()

◆ sortMemberLists()

virtual void ClassDef::sortMemberLists ( )
pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by sortMemberLists().

◆ subClasses()

◆ subGrouping()

◆ taggedInnerClasses()

virtual const ClassList* ClassDef::taggedInnerClasses ( ) const
pure virtual

◆ tagLessReference()

virtual ClassDef* ClassDef::tagLessReference ( ) const
pure virtual

◆ templateArguments()

◆ templateMaster()

◆ templateTypeConstraints()

virtual ConstraintClassDict* ClassDef::templateTypeConstraints ( ) const
pure virtual

◆ title()

virtual QCString ClassDef::title ( ) const
pure virtual

◆ typeConstraints()

virtual const ArgumentList& ClassDef::typeConstraints ( ) const
pure virtual

◆ usedByImplementationClasses()

virtual UsesClassDict* ClassDef::usedByImplementationClasses ( ) const
pure virtual

◆ usedFiles()

virtual const FileList& ClassDef::usedFiles ( ) const
pure virtual

◆ usedImplementationClasses()

virtual UsesClassDict* ClassDef::usedImplementationClasses ( ) const
pure virtual

◆ usedInterfaceClasses()

virtual UsesClassDict* ClassDef::usedInterfaceClasses ( ) const
pure virtual

◆ visibleInParentsDeclList()

virtual bool ClassDef::visibleInParentsDeclList ( ) const
pure virtual

◆ writeDeclaration()

virtual void ClassDef::writeDeclaration ( OutputList ol,
const MemberDef md,
bool  inGroup,
const ClassDef inheritedFrom,
const char *  inheritId 
) const
pure virtual

◆ writeDeclarationLink()

virtual void ClassDef::writeDeclarationLink ( OutputList ol,
bool found,
const char *  header,
bool  localNames 
) const
pure virtual

◆ writeDocumentation()

virtual void ClassDef::writeDocumentation ( OutputList ol) const
pure virtual

◆ writeDocumentationForInnerClasses()

virtual void ClassDef::writeDocumentationForInnerClasses ( OutputList ol) const
pure virtual

◆ writeInlineDocumentation()

virtual void ClassDef::writeInlineDocumentation ( OutputList ol) const
pure virtual

◆ writeMemberDeclarations()

virtual void ClassDef::writeMemberDeclarations ( OutputList ol,
MemberListType  lt,
const QCString title,
const char *  subTitle = 0,
bool  showInline = FALSE,
const ClassDef inheritedFrom = 0,
int  lt2 = -1,
bool  invert = FALSE,
bool  showAlways = FALSE,
QPtrDict< void > *  visitedClasses = 0 
) const
pure virtual

◆ writeMemberList()

virtual void ClassDef::writeMemberList ( OutputList ol) const
pure virtual

◆ writeMemberPages()

virtual void ClassDef::writeMemberPages ( OutputList ol) const
pure virtual

Implemented in ClassDefImpl, and ClassDefAliasImpl.

◆ writeQuickMemberLinks()

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

Implements Definition.

Implemented in ClassDefImpl, and ClassDefAliasImpl.

◆ writeSummaryLinks()

virtual void ClassDef::writeSummaryLinks ( OutputList ol) const
pure virtual

Implements Definition.

Implemented in ClassDefImpl, and ClassDefAliasImpl.

◆ writeTagFile()

virtual void ClassDef::writeTagFile ( FTextStream )
pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by writeTagFile().


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