doxygen
Public Types | Public Member Functions | List of all members
ClassDef Class Referenceabstract

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

#include <classdef.h>

Inheritance diagram for ClassDef:
Inheritance graph
[legend]
Collaboration diagram for ClassDef:
Collaboration graph
[legend]

Public Types

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

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 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 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 MemberNameInfoLinkedMapmemberNameInfoLinkedMap () 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 ArgumentListtemplateArguments () const =0
 Returns the template arguments of this class.
 
virtual NamespaceDefgetNamespaceDef () const =0
 Returns the namespace this compound is in, or 0 if it has a global scope.
 
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.
 
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.
 
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 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.
 
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 const DefinitionfindInnerCompound (const char *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, uint *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 ClassDefcategoryOf () 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 MemberListgetMemberList (MemberListType lt) const =0
 Returns the members in the list identified by lt.
 
virtual const MemberListsgetMemberLists () 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 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 ClassDeftagLessReference () const =0
 
virtual MemberDefisSmartPointer () const =0
 
virtual bool isJavaEnum () const =0
 
virtual QCString title () const =0
 
virtual QCString generatedFromFiles () const =0
 
virtual const FileListusedFiles () const =0
 
virtual const ArgumentListtypeConstraints () const =0
 
virtual const ExampleListgetExamples () 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 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 ClassDefinsertTemplateInstance (const QCString &fileName, int startLine, int startColumn, const QCString &templSpec, bool &freshInstance) const =0
 
virtual void writeDeclarationLink (OutputList &ol, bool &found, const char *header, bool localNames) 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 const GroupListpartOfGroups () const =0
 
virtual bool isLinkableViaGroup () const =0
 
virtual const RefItemVector & xrefListItems () const =0
 
virtual DefinitiongetOuterScope () const =0
 
virtual std::vector< const MemberDef * > getReferencesMembers () const =0
 
virtual std::vector< const MemberDef * > 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 SectionRefsgetSectionRefs () const =0
 returns the section dictionary, only of importance for pagedef
 
virtual QCString navigationPathAsString () const =0
 
virtual QCString pathFragment () 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
 

Detailed Description

A abstract class representing of a compound symbol.

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

Member Function Documentation

◆ anchor()

virtual QCString ClassDef::anchor ( ) const
pure virtual

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

Implements Definition.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

◆ compoundType()

virtual CompoundType ClassDef::compoundType ( ) const
pure virtual

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

class/struct/union/..

Implemented in ClassDefAliasImpl, and ClassDefImpl.

◆ findInnerCompound()

virtual const 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.

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

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

◆ getTemplateParameterLists()

virtual ArgumentLists 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.

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

◆ memberNameInfoLinkedMap()

virtual const MemberNameInfoLinkedMap& ClassDef::memberNameInfoLinkedMap ( ) const
pure virtual

Returns a dictionary of all members.

This includes any inherited members. Members are sorted alphabetically.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

◆ templateMaster()

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

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

Returns 0 if not applicable.

Implemented in ClassDefAliasImpl, and ClassDefImpl.


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