doxygen
Public Member Functions | List of all members
MemberDef Class Referenceabstract

A model of a class/file/namespace member symbol. More...

#include <memberdef.h>

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

Public Member Functions

virtual DefType definitionType () const =0
 
virtual MemberDefdeepCopy () const =0
 
virtual void moveTo (Definition *)=0
 
virtual MemberDefresolveAlias ()=0
 
virtual const MemberDefresolveAlias () const =0
 
ClassDefMutablegetClassDefMutable () const
 
virtual QCString getOutputFileBase () const =0
 
virtual QCString getReference () const =0
 
virtual QCString anchor () const =0
 
virtual QCString declaration () const =0
 
virtual QCString definition () const =0
 
virtual QCString typeString () const =0
 
virtual QCString argsString () const =0
 
virtual QCString excpString () const =0
 
virtual QCString bitfieldString () const =0
 
virtual QCString extraTypeChars () const =0
 
virtual const QCStringinitializer () const =0
 
virtual int initializerLines () const =0
 
virtual uint64 getMemberSpecifiers () const =0
 
virtual const MemberListgetSectionList (const Definition *container) const =0
 
virtual QCString displayDefinition () const =0
 
virtual const FileDefgetFileDef () const =0
 
virtual const ClassDefgetClassDef () const =0
 
virtual const NamespaceDefgetNamespaceDef () const =0
 
virtual const ClassDefaccessorClass () const =0
 
virtual QCString getReadAccessor () const =0
 
virtual QCString getWriteAccessor () const =0
 
virtual const GroupDefgetGroupDef () const =0
 
virtual Grouping::GroupPri_t getGroupPri () const =0
 
virtual QCString getGroupFileName () const =0
 
virtual int getGroupStartLine () const =0
 
virtual bool getGroupHasDocs () const =0
 
virtual QCString qualifiedName () const =0
 
virtual QCString objCMethodName (bool localLink, bool showStatic) const =0
 
virtual Protection protection () const =0
 
virtual Specifier virtualness (int count=0) const =0
 
virtual MemberType memberType () const =0
 
virtual QCString memberTypeName () const =0
 
virtual bool isSignal () const =0
 
virtual bool isSlot () const =0
 
virtual bool isVariable () const =0
 
virtual bool isEnumerate () const =0
 
virtual bool isEnumValue () const =0
 
virtual bool isTypedef () const =0
 
virtual bool isSequence () const =0
 
virtual bool isDictionary () const =0
 
virtual bool isFunction () const =0
 
virtual bool isFunctionPtr () const =0
 
virtual bool isDefine () const =0
 
virtual bool isFriend () const =0
 
virtual bool isDCOP () const =0
 
virtual bool isProperty () const =0
 
virtual bool isEvent () const =0
 
virtual bool isRelated () const =0
 
virtual bool isForeign () const =0
 
virtual bool isStatic () const =0
 
virtual bool isInline () const =0
 
virtual bool isExplicit () const =0
 
virtual bool isMutable () const =0
 
virtual bool isGettable () const =0
 
virtual bool isPrivateGettable () const =0
 
virtual bool isProtectedGettable () const =0
 
virtual bool isSettable () const =0
 
virtual bool isPrivateSettable () const =0
 
virtual bool isProtectedSettable () const =0
 
virtual bool isReadable () const =0
 
virtual bool isWritable () const =0
 
virtual bool isAddable () const =0
 
virtual bool isRemovable () const =0
 
virtual bool isRaisable () const =0
 
virtual bool isFinal () const =0
 
virtual bool isAbstract () const =0
 
virtual bool isOverride () const =0
 
virtual bool isInitonly () const =0
 
virtual bool isOptional () const =0
 
virtual bool isRequired () const =0
 
virtual bool isNonAtomic () const =0
 
virtual bool isCopy () const =0
 
virtual bool isAssign () const =0
 
virtual bool isRetain () const =0
 
virtual bool isWeak () const =0
 
virtual bool isStrong () const =0
 
virtual bool isEnumStruct () const =0
 
virtual bool isUnretained () const =0
 
virtual bool isNew () const =0
 
virtual bool isSealed () const =0
 
virtual bool isImplementation () const =0
 
virtual bool isExternal () const =0
 
virtual bool isTypeAlias () const =0
 
virtual bool isDefault () const =0
 
virtual bool isDelete () const =0
 
virtual bool isNoExcept () const =0
 
virtual bool isAttribute () const =0
 
virtual bool isUNOProperty () const =0
 
virtual bool isReadonly () const =0
 
virtual bool isBound () const =0
 
virtual bool isConstrained () const =0
 
virtual bool isTransient () const =0
 
virtual bool isMaybeVoid () const =0
 
virtual bool isMaybeDefault () const =0
 
virtual bool isMaybeAmbiguous () const =0
 
virtual bool isPublished () const =0
 
virtual bool isTemplateSpecialization () const =0
 
virtual bool isObjCMethod () const =0
 
virtual bool isObjCProperty () const =0
 
virtual bool isConstructor () const =0
 
virtual bool isDestructor () const =0
 
virtual bool hasOneLineInitializer () const =0
 
virtual bool hasMultiLineInitializer () const =0
 
virtual bool showInCallGraph () const =0
 
virtual bool isStrongEnumValue () const =0
 
virtual bool livesInsideEnum () const =0
 
virtual bool isSliceLocal () const =0
 
virtual bool isConstExpr () const =0
 
virtual int numberOfFlowKeyWords () const =0
 
virtual bool isFriendToHide () const =0
 
virtual bool isNotFriend () const =0
 
virtual bool isFunctionOrSignalSlot () const =0
 
virtual bool isRelatedOrFriend () const =0
 
virtual bool isLinkableInProject () const =0
 
virtual bool isLinkable () const =0
 
virtual bool hasDocumentation () const =0
 
virtual bool isDeleted () const =0
 
virtual bool isBriefSectionVisible () const =0
 
virtual bool isDetailedSectionVisible (bool inGroup, bool inFile) const =0
 
virtual bool isDetailedSectionLinkable () const =0
 
virtual bool isFriendClass () const =0
 
virtual bool isDocumentedFriendClass () const =0
 
virtual const MemberDefreimplements () const =0
 
virtual const MemberListreimplementedBy () const =0
 
virtual bool isReimplementedBy (const ClassDef *cd) const =0
 
virtual ClassDefrelatedAlso () const =0
 
virtual bool hasDocumentedEnumValues () const =0
 
virtual const MemberDefgetAnonymousEnumType () const =0
 
virtual bool isDocsForDefinition () const =0
 
virtual const MemberDefgetEnumScope () const =0
 
virtual const MemberListenumFieldList () const =0
 
virtual QCString enumBaseType () const =0
 
virtual bool hasExamples () const =0
 
virtual const ExampleListgetExamples () const =0
 
virtual bool isPrototype () const =0
 
virtual const ArgumentListargumentList () const =0
 
virtual const ArgumentListdeclArgumentList () const =0
 
virtual const ArgumentListtemplateArguments () const =0
 
virtual const ArgumentLists & definitionTemplateParameterLists () const =0
 
virtual int getMemberGroupId () const =0
 
virtual MemberGroupgetMemberGroup () const =0
 
virtual bool fromAnonymousScope () const =0
 
virtual bool anonymousDeclShown () const =0
 
virtual MemberDeffromAnonymousMember () const =0
 
virtual bool hasCallGraph () const =0
 
virtual bool hasCallerGraph () const =0
 
virtual bool visibleMemberGroup (bool hideNoHeader) const =0
 
virtual bool hasReferencesRelation () const =0
 
virtual bool hasReferencedByRelation () const =0
 
virtual bool hasMemberSourceRefs () const =0
 
virtual bool hasMemberSourceReffedBy () const =0
 
virtual const MemberDeftemplateMaster () const =0
 
virtual QCString getScopeString () const =0
 
virtual ClassDefgetClassDefOfAnonymousType () const =0
 
virtual bool isTypedefValCached () const =0
 
virtual const ClassDefgetCachedTypedefVal () const =0
 
virtual QCString getCachedTypedefTemplSpec () const =0
 
virtual QCString getCachedResolvedTypedef () const =0
 
virtual MemberDefmemberDefinition () const =0
 
virtual MemberDefmemberDeclaration () const =0
 
virtual const MemberDefinheritsDocsFrom () const =0
 
virtual const MemberDefgetGroupAlias () const =0
 
virtual ClassDefcategory () const =0
 
virtual const MemberDefcategoryRelation () const =0
 
virtual QCString displayName (bool=TRUE) const =0
 
virtual QCString getDeclType () const =0
 
virtual StringVector getLabels (const Definition *container) const =0
 
virtual const ArgumentListtypeConstraints () const =0
 
virtual QCString requiresClause () const =0
 
virtual QCString documentation () const =0
 
virtual QCString briefDescription (bool abbr=FALSE) const =0
 
virtual QCString fieldType () const =0
 
virtual bool isReference () const =0
 
virtual QCString getDeclFileName () const =0
 
virtual int getDeclLine () const =0
 
virtual int getDeclColumn () const =0
 
virtual MemberDefMutablecreateTemplateInstanceMember (const ArgumentList &formalArgs, const std::unique_ptr< ArgumentList > &actualArgs) const =0
 
virtual void writeDeclaration (OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, bool inGroup, const ClassDef *inheritFrom=0, const QCString &inheritId=QCString()) const =0
 
virtual void writeEnumDeclaration (OutputList &typeDecl, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd) const =0
 
virtual void detectUndocumentedParams (bool hasParamCommand, bool hasReturnCommand) const =0
 
virtual void warnIfUndocumented () const =0
 
virtual void warnIfUndocumentedParams () const =0
 
virtual bool visibleInIndex () const =0
 
virtual void setMemberGroup (MemberGroup *grp)=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 symbolName () const =0
 
virtual QCString getSourceFileBase () const =0
 
virtual QCString getSourceAnchor () const =0
 
virtual int docLine () const =0
 
virtual QCString docFile () 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 const DefinitionfindInnerCompound (const QCString &name) 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
 

Additional Inherited Members

- Public Types inherited from Definition
enum  DefType {
  TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeMember = 3,
  TypeGroup = 4, TypePackage = 5, TypePage = 6, TypeDir = 7,
  TypeConcept = 8
}
 

Detailed Description

A model of a class/file/namespace member symbol.

Member Function Documentation

◆ anchor()

virtual QCString MemberDef::anchor ( ) const
pure virtual

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

Implements Definition.

Implemented in MemberDefAliasImpl, and MemberDefImpl.

◆ briefDescription()

virtual QCString MemberDef::briefDescription ( bool  abbreviate = FALSE) const
pure virtual

Returns the brief description of this definition. This can include commands.

Implements Definition.

Implemented in MemberDefAliasImpl, and MemberDefImpl.

◆ definitionType()

virtual DefType MemberDef::definitionType ( ) const
pure virtual

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

Implements Definition.

Implemented in MemberDefAliasImpl, and MemberDefImpl.

◆ displayName()

virtual QCString MemberDef::displayName ( bool  includeScope = TRUE) const
pure virtual

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

Implements Definition.

Implemented in MemberDefAliasImpl, and MemberDefImpl.

◆ documentation()

virtual QCString MemberDef::documentation ( ) const
pure virtual

Returns the detailed description of this definition

Implements Definition.

Implemented in MemberDefAliasImpl, and MemberDefImpl.

◆ getOutputFileBase()

virtual QCString MemberDef::getOutputFileBase ( ) const
pure virtual

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

Implements Definition.

Implemented in MemberDefAliasImpl, and MemberDefImpl.

◆ getReference()

virtual QCString MemberDef::getReference ( ) const
pure 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

Implements Definition.

Implemented in MemberDefAliasImpl, and MemberDefImpl.

◆ hasDocumentation()

virtual bool MemberDef::hasDocumentation ( ) const
pure virtual

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

See also
hasUserDocumentation()

Implements Definition.

Implemented in MemberDefAliasImpl, and MemberDefImpl.

◆ isLinkable()

virtual bool MemberDef::isLinkable ( ) const
pure 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.

Implements Definition.

Implemented in MemberDefAliasImpl, and MemberDefImpl.

◆ isLinkableInProject()

virtual bool MemberDef::isLinkableInProject ( ) const
pure virtual

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

Implements Definition.

Implemented in MemberDefAliasImpl, and MemberDefImpl.

◆ isReference()

virtual bool MemberDef::isReference ( ) const
pure virtual

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

Implements Definition.

Implemented in MemberDefAliasImpl, and MemberDefImpl.

◆ qualifiedName()

virtual QCString MemberDef::qualifiedName ( ) const
pure virtual

Returns the fully qualified name of this definition

Implements Definition.

Implemented in MemberDefAliasImpl, and MemberDefImpl.


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