doxygen
Public Member Functions | List of all members
MemberDefAliasImpl Class Reference
Inheritance diagram for MemberDefAliasImpl:
Inheritance graph
[legend]
Collaboration diagram for MemberDefAliasImpl:
Collaboration graph
[legend]

Public Member Functions

 MemberDefAliasImpl (const Definition *newScope, const MemberDef *md)
 
virtual DefType definitionType () const
 
const MemberDefgetMdAlias () const
 
virtual MemberDefresolveAlias ()
 
virtual const MemberDefresolveAlias () const
 
virtual MemberDefdeepCopy () const
 
virtual void moveTo (Definition *)
 
virtual QCString name () const
 
virtual CodeSymbolType codeSymbolType () const
 
virtual QCString getOutputFileBase () const
 
virtual QCString getReference () const
 
virtual QCString anchor () const
 
virtual QCString declaration () const
 
virtual QCString definition () const
 
virtual QCString typeString () const
 
virtual QCString argsString () const
 
virtual QCString excpString () const
 
virtual QCString bitfieldString () const
 
virtual QCString extraTypeChars () const
 
virtual const QCStringinitializer () const
 
virtual int initializerLines () const
 
virtual uint64 getMemberSpecifiers () const
 
virtual const MemberListgetSectionList (const Definition *container) const
 
virtual QCString displayDefinition () const
 
virtual const ClassDefgetClassDef () const
 
virtual const FileDefgetFileDef () const
 
virtual const NamespaceDefgetNamespaceDef () const
 
virtual const ClassDefaccessorClass () const
 
virtual QCString getReadAccessor () const
 
virtual QCString getWriteAccessor () const
 
virtual const GroupDefgetGroupDef () const
 
virtual Grouping::GroupPri_t getGroupPri () const
 
virtual QCString getGroupFileName () const
 
virtual int getGroupStartLine () const
 
virtual bool getGroupHasDocs () const
 
virtual QCString qualifiedName () const
 
virtual QCString objCMethodName (bool localLink, bool showStatic) const
 
virtual Protection protection () const
 
virtual Specifier virtualness (int count) const
 
virtual MemberType memberType () const
 
virtual QCString memberTypeName () const
 
virtual bool isSignal () const
 
virtual bool isSlot () const
 
virtual bool isVariable () const
 
virtual bool isEnumerate () const
 
virtual bool isEnumValue () const
 
virtual bool isTypedef () const
 
virtual bool isSequence () const
 
virtual bool isDictionary () const
 
virtual bool isFunction () const
 
virtual bool isFunctionPtr () const
 
virtual bool isDefine () const
 
virtual bool isFriend () const
 
virtual bool isDCOP () const
 
virtual bool isProperty () const
 
virtual bool isEvent () const
 
virtual bool isRelated () const
 
virtual bool isForeign () const
 
virtual bool isStatic () const
 
virtual bool isInline () const
 
virtual bool isExplicit () const
 
virtual bool isMutable () const
 
virtual bool isGettable () const
 
virtual bool isPrivateGettable () const
 
virtual bool isProtectedGettable () const
 
virtual bool isSettable () const
 
virtual bool isPrivateSettable () const
 
virtual bool isProtectedSettable () const
 
virtual bool isReadable () const
 
virtual bool isWritable () const
 
virtual bool isAddable () const
 
virtual bool isRemovable () const
 
virtual bool isRaisable () const
 
virtual bool isFinal () const
 
virtual bool isAbstract () const
 
virtual bool isOverride () const
 
virtual bool isInitonly () const
 
virtual bool isOptional () const
 
virtual bool isRequired () const
 
virtual bool isNonAtomic () const
 
virtual bool isCopy () const
 
virtual bool isAssign () const
 
virtual bool isRetain () const
 
virtual bool isWeak () const
 
virtual bool isStrong () const
 
virtual bool isEnumStruct () const
 
virtual bool isUnretained () const
 
virtual bool isNew () const
 
virtual bool isSealed () const
 
virtual bool isImplementation () const
 
virtual bool isExternal () const
 
virtual bool isTypeAlias () const
 
virtual bool isDefault () const
 
virtual bool isDelete () const
 
virtual bool isNoExcept () const
 
virtual bool isAttribute () const
 
virtual bool isUNOProperty () const
 
virtual bool isReadonly () const
 
virtual bool isBound () const
 
virtual bool isConstrained () const
 
virtual bool isTransient () const
 
virtual bool isMaybeVoid () const
 
virtual bool isMaybeDefault () const
 
virtual bool isMaybeAmbiguous () const
 
virtual bool isPublished () const
 
virtual bool isTemplateSpecialization () const
 
virtual bool isObjCMethod () const
 
virtual bool isObjCProperty () const
 
virtual bool isCSharpProperty () const
 
virtual bool isConstructor () const
 
virtual bool isDestructor () const
 
virtual bool hasOneLineInitializer () const
 
virtual bool hasMultiLineInitializer () const
 
virtual bool showInCallGraph () const
 
virtual bool isStrongEnumValue () const
 
virtual bool livesInsideEnum () const
 
virtual bool isSliceLocal () const
 
virtual bool isConstExpr () const
 
virtual int numberOfFlowKeyWords () const
 
virtual bool isFriendToHide () const
 
virtual bool isNotFriend () const
 
virtual bool isFunctionOrSignalSlot () const
 
virtual bool isRelatedOrFriend () const
 
virtual bool isLinkableInProject () const
 
virtual bool isLinkable () const
 
virtual bool hasDocumentation () const
 
virtual bool isDeleted () const
 
virtual bool isBriefSectionVisible () const
 
virtual bool isDetailedSectionVisible (MemberListContainer container) const
 
virtual bool hasDetailedDescription () const
 
virtual bool isFriendClass () const
 
virtual bool isDocumentedFriendClass () const
 
virtual const MemberDefreimplements () const
 
virtual const MemberVectorreimplementedBy () const
 
virtual bool isReimplementedBy (const ClassDef *cd) const
 
virtual ClassDefrelatedAlso () const
 
virtual bool hasDocumentedEnumValues () const
 
virtual const MemberDefgetAnonymousEnumType () const
 
virtual bool isDocsForDefinition () const
 
virtual const MemberDefgetEnumScope () const
 
virtual const MemberVectorenumFieldList () const
 
virtual QCString enumBaseType () const
 
virtual bool hasExamples () const
 
virtual const ExampleListgetExamples () const
 
virtual bool isPrototype () const
 
virtual const ArgumentListargumentList () const
 
virtual const ArgumentListdeclArgumentList () const
 
virtual const ArgumentListtemplateArguments () const
 
virtual const ArgumentLists & definitionTemplateParameterLists () const
 
virtual int getMemberGroupId () const
 
virtual MemberGroupgetMemberGroup () const
 
virtual bool fromAnonymousScope () const
 
virtual bool anonymousDeclShown () const
 
virtual MemberDeffromAnonymousMember () const
 
virtual bool hasCallGraph () const
 
virtual bool hasCallerGraph () const
 
virtual bool hasReferencesRelation () const
 
virtual bool hasReferencedByRelation () const
 
virtual const MemberDeftemplateMaster () const
 
virtual QCString getScopeString () const
 
virtual ClassDefgetClassDefOfAnonymousType () const
 
virtual bool isTypedefValCached () const
 
virtual const ClassDefgetCachedTypedefVal () const
 
virtual QCString getCachedTypedefTemplSpec () const
 
virtual QCString getCachedResolvedTypedef () const
 
virtual MemberDefmemberDefinition () const
 
virtual MemberDefmemberDeclaration () const
 
virtual const MemberDefinheritsDocsFrom () const
 
virtual const MemberDefgetGroupAlias () const
 
virtual ClassDefcategory () const
 
virtual const MemberDefcategoryRelation () const
 
virtual QCString displayName (bool b=TRUE) const
 
virtual QCString getDeclType () const
 
virtual StringVector getLabels (const Definition *container) const
 
virtual const ArgumentListtypeConstraints () const
 
virtual QCString documentation () const
 
virtual QCString briefDescription (bool abbr=FALSE) const
 
virtual QCString fieldType () const
 
virtual bool isReference () const
 
virtual QCString getDeclFileName () const
 
virtual int getDeclLine () const
 
virtual int getDeclColumn () const
 
virtual QCString requiresClause () const
 
virtual bool visibleInIndex () const
 
virtual void warnIfUndocumented () const
 
virtual void warnIfUndocumentedParams () const
 
virtual void detectUndocumentedParams (bool hasParamCommand, bool hasReturnCommand) const
 
virtual void setMemberGroup (MemberGroup *grp)
 
virtual MemberDefMutablecreateTemplateInstanceMember (const ArgumentList &formalArgs, const std::unique_ptr< ArgumentList > &actualArgs) const
 
virtual void writeDeclaration (OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, bool inGroup, int indentLevel, const ClassDef *inheritFrom=0, const QCString &inheritId=QCString()) const
 
virtual void writeEnumDeclaration (OutputList &typeDecl, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd) const
 
- Public Member Functions inherited from DefinitionAliasMixin< MemberDef >
 DefinitionAliasMixin (const Definition *scope, const Definition *alias)
 
void init ()
 
void deinit ()
 
virtual bool isAlias () const
 
virtual bool isAnonymous () const
 
virtual QCString localName () const
 
virtual QCString symbolName () const
 
virtual QCString getSourceFileBase () const
 
virtual QCString getSourceAnchor () const
 
virtual int docLine () const
 
virtual QCString docFile () const
 
virtual QCString briefDescriptionAsTooltip () const
 
virtual int briefLine () const
 
virtual QCString inbodyDocumentation () const
 
virtual QCString inbodyFile () const
 
virtual int inbodyLine () const
 
virtual QCString briefFile () const
 
virtual QCString getDefFileName () const
 
virtual QCString getDefFileExtension () const
 
virtual int getDefLine () const
 
virtual int getDefColumn () const
 
virtual bool hasUserDocumentation () const
 
virtual bool isVisibleInProject () const
 
virtual bool isVisible () const
 
virtual bool isHidden () const
 
virtual bool isArtificial () const
 
virtual QCString externalReference (const QCString &relPath) const
 
virtual int getStartDefLine () const
 
virtual int getStartBodyLine () const
 
virtual int getEndBodyLine () const
 
virtual const FileDefgetBodyDef () const
 
virtual SrcLangExt getLanguage () const
 
virtual const GroupListpartOfGroups () const
 
virtual bool isLinkableViaGroup () const
 
virtual const RefItemVector & xrefListItems () const
 
virtual const DefinitionfindInnerCompound (const QCString &name) const
 
virtual DefinitiongetOuterScope () const
 
virtual const MemberVectorgetReferencesMembers () const
 
virtual const MemberVectorgetReferencedByMembers () const
 
virtual bool hasSections () const
 
virtual bool hasSources () const
 
virtual bool hasBriefDescription () const
 
virtual QCString id () const
 
virtual const SectionRefsgetSectionRefs () const
 
virtual QCString navigationPathAsString () const
 
virtual QCString pathFragment () const
 
- Public Member Functions inherited from MemberDef
ClassDefMutablegetClassDefMutable () const
 

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
}
 
- Protected Member Functions inherited from DefinitionAliasMixin< MemberDef >
const DefinitiongetAlias () const
 
const DefinitiongetScope () const
 

Member Function Documentation

◆ anchor()

virtual QCString MemberDefAliasImpl::anchor ( ) const
inlinevirtual

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

Implements MemberDef.

◆ briefDescription()

virtual QCString MemberDefAliasImpl::briefDescription ( bool  abbreviate = FALSE) const
inlinevirtual

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

Reimplemented from DefinitionAliasMixin< MemberDef >.

◆ codeSymbolType()

virtual CodeSymbolType MemberDefAliasImpl::codeSymbolType ( ) const
inlinevirtual

Used for syntax highlighting symbol class

Implements Definition.

◆ definitionType()

virtual DefType MemberDefAliasImpl::definitionType ( ) const
inlinevirtual

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

Implements MemberDef.

◆ displayName()

virtual QCString MemberDefAliasImpl::displayName ( bool  includeScope = TRUE) const
inlinevirtual

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

Implements MemberDef.

◆ documentation()

virtual QCString MemberDefAliasImpl::documentation ( ) const
inlinevirtual

Returns the detailed description of this definition

Reimplemented from DefinitionAliasMixin< MemberDef >.

◆ getOutputFileBase()

virtual QCString MemberDefAliasImpl::getOutputFileBase ( ) const
inlinevirtual

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

Implements MemberDef.

◆ getReference()

virtual QCString MemberDefAliasImpl::getReference ( ) const
inlinevirtual

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

Reimplemented from DefinitionAliasMixin< MemberDef >.

◆ hasDocumentation()

virtual bool MemberDefAliasImpl::hasDocumentation ( ) const
inlinevirtual

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

See also
hasUserDocumentation()

Reimplemented from DefinitionAliasMixin< MemberDef >.

◆ isLinkable()

virtual bool MemberDefAliasImpl::isLinkable ( ) const
inlinevirtual

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

◆ isLinkableInProject()

virtual bool MemberDefAliasImpl::isLinkableInProject ( ) const
inlinevirtual

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

Implements MemberDef.

◆ isReference()

virtual bool MemberDefAliasImpl::isReference ( ) const
inlinevirtual

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

Reimplemented from DefinitionAliasMixin< MemberDef >.

◆ name()

virtual QCString MemberDefAliasImpl::name ( ) const
inlinevirtual

Returns the name of the definition

Reimplemented from DefinitionAliasMixin< MemberDef >.

◆ qualifiedName()

virtual QCString MemberDefAliasImpl::qualifiedName ( ) const
inlinevirtual

Returns the fully qualified name of this definition

Reimplemented from DefinitionAliasMixin< MemberDef >.


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