Doxygen
DefinitionAliasMixin< Base > Class Template Reference

#include <src/definitionimpl.h>

Inheritance diagram for DefinitionAliasMixin< Base >:
Collaboration diagram for DefinitionAliasMixin< Base >:

Public Member Functions

 DefinitionAliasMixin (const Definition *scope, const Definition *alias)
 ~DefinitionAliasMixin () override=default
void init ()
void deinit ()
bool isAlias () const override
const QCString & name () const override
bool isAnonymous () const override
const QCString & localName () const override
QCString qualifiedName () const override
QCString symbolName () const override
QCString getSourceFileBase () const override
QCString getSourceAnchor () const override
QCString documentation () const override
int docLine () const override
QCString docFile () const override
QCString briefDescription (bool abbreviate=FALSE) const override
QCString briefDescriptionAsTooltip () const override
int briefLine () const override
QCString inbodyDocumentation () const override
QCString inbodyFile () const override
int inbodyLine () const override
QCString briefFile () const override
QCString getDefFileName () const override
QCString getDefFileExtension () const override
int getDefLine () const override
int getDefColumn () const override
bool hasDocumentation () const override
bool hasUserDocumentation () const override
bool isVisibleInProject () const override
bool isVisible () const override
bool isHidden () const override
bool isArtificial () const override
bool isExported () const override
QCString getReference () const override
bool isReference () const override
QCString externalReference (const QCString &relPath) const override
int getStartDefLine () const override
int getStartBodyLine () const override
int getEndBodyLine () const override
const FileDef * getBodyDef () const override
SrcLangExt getLanguage () const override
const GroupList & partOfGroups () const override
bool isLinkableViaGroup () const override
const RefItemVector & xrefListItems () const override
const Definition * findInnerCompound (const QCString &name) const override
Definition * getOuterScope () const override
const MemberVector & getReferencesMembers () const override
const MemberVector & getReferencedByMembers () const override
bool hasSections () const override
bool hasSources () const override
bool hasBriefDescription () const override
QCString id () const override
const SectionRefs & getSectionRefs () const override
QCString navigationPathAsString () const override
QCString pathFragment () const override

Protected Member Functions

const Definition * getAlias () const
const Definition * getScope () const

Private Member Functions

virtual Definition * toDefinition_ ()
DefinitionMutable * toDefinitionMutable_ () override
const DefinitionImpl * toDefinitionImpl_ () const override
void _setSymbolName (const QCString &name) override
QCString _symbolName () const override

Private Attributes

DefinitionAliasImpl m_impl
const Definition * m_scope
const Definition * m_alias
QCString m_symbolName

Detailed Description

template<class Base>
class DefinitionAliasMixin< Base >

Definition at line 323 of file definitionimpl.h.

Constructor & Destructor Documentation

◆ DefinitionAliasMixin()

template<class Base>
DefinitionAliasMixin< Base >::DefinitionAliasMixin ( const Definition * scope,
const Definition * alias )
inline

Definition at line 326 of file definitionimpl.h.

327 : m_impl(this,scope,alias), m_scope(scope), m_alias(alias) {}
DefinitionAliasMixin::m_scope
const Definition * m_scope
Definition definitionimpl.h:451
DefinitionAliasMixin::m_alias
const Definition * m_alias
Definition definitionimpl.h:452
DefinitionAliasMixin::m_impl
DefinitionAliasImpl m_impl
Definition definitionimpl.h:450

References m_alias, m_impl, and m_scope.

Referenced by ~DefinitionAliasMixin().

◆ ~DefinitionAliasMixin()

template<class Base>
DefinitionAliasMixin< Base >::~DefinitionAliasMixin ( )
overridedefault

References DefinitionAliasMixin().

Member Function Documentation

◆ _setSymbolName()

template<class Base>
void DefinitionAliasMixin< Base >::_setSymbolName ( const QCString & name)
inlineoverrideprivate

Definition at line 448 of file definitionimpl.h.

448{ m_symbolName = name; }
DefinitionAliasMixin::name
const QCString & name() const override
Definition definitionimpl.h:338

References m_symbolName, and name().

◆ _symbolName()

template<class Base>
QCString DefinitionAliasMixin< Base >::_symbolName ( ) const
inlineoverrideprivate

Definition at line 449 of file definitionimpl.h.

449{ return m_symbolName; }

References m_symbolName.

◆ briefDescription()

template<class Base>
QCString DefinitionAliasMixin< Base >::briefDescription ( bool abbreviate = FALSE) const
inlineoverride

Reimplemented in MemberDefAliasImpl.

Definition at line 358 of file definitionimpl.h.

359 { return m_alias->briefDescription(abbreviate); }

References abbreviate(), FALSE, and m_alias.

◆ briefDescriptionAsTooltip()

template<class Base>
QCString DefinitionAliasMixin< Base >::briefDescriptionAsTooltip ( ) const
inlineoverride

Definition at line 360 of file definitionimpl.h.

361 { return m_alias->briefDescriptionAsTooltip(); }

References m_alias.

◆ briefFile()

template<class Base>
QCString DefinitionAliasMixin< Base >::briefFile ( ) const
inlineoverride

Definition at line 370 of file definitionimpl.h.

371 { return m_alias->briefFile(); }

References m_alias.

◆ briefLine()

template<class Base>
int DefinitionAliasMixin< Base >::briefLine ( ) const
inlineoverride

Definition at line 362 of file definitionimpl.h.

363 { return m_alias->briefLine(); }

References m_alias.

◆ deinit()

template<class Base>
void DefinitionAliasMixin< Base >::deinit ( )
inline

Definition at line 332 of file definitionimpl.h.

332{ m_impl.deinit(); }

References m_impl.

◆ docFile()

template<class Base>
QCString DefinitionAliasMixin< Base >::docFile ( ) const
inlineoverride

Definition at line 356 of file definitionimpl.h.

357 { return m_alias->docFile(); }

References m_alias.

◆ docLine()

template<class Base>
int DefinitionAliasMixin< Base >::docLine ( ) const
inlineoverride

Definition at line 354 of file definitionimpl.h.

355 { return m_alias->docLine(); }

References m_alias.

◆ documentation()

template<class Base>
QCString DefinitionAliasMixin< Base >::documentation ( ) const
inlineoverride

Reimplemented in MemberDefAliasImpl.

Definition at line 352 of file definitionimpl.h.

353 { return m_alias->documentation(); }

References m_alias.

◆ externalReference()

template<class Base>
QCString DefinitionAliasMixin< Base >::externalReference ( const QCString & relPath) const
inlineoverride

Definition at line 398 of file definitionimpl.h.

399 { return m_alias->externalReference(relPath); }

References m_alias.

◆ findInnerCompound()

template<class Base>
const Definition * DefinitionAliasMixin< Base >::findInnerCompound ( const QCString & name) const
inlineoverride

Reimplemented in NamespaceDefAliasImpl.

Definition at line 416 of file definitionimpl.h.

417 { return m_alias->findInnerCompound(name); }

References m_alias, and name().

◆ getAlias()

template<class Base>
const Definition * DefinitionAliasMixin< Base >::getAlias ( ) const
inlineprotected

Definition at line 440 of file definitionimpl.h.

440{ return m_alias; }

References m_alias.

◆ getBodyDef()

template<class Base>
const FileDef * DefinitionAliasMixin< Base >::getBodyDef ( ) const
inlineoverride

Definition at line 406 of file definitionimpl.h.

407 { return m_alias->getBodyDef(); }

References m_alias.

◆ getDefColumn()

template<class Base>
int DefinitionAliasMixin< Base >::getDefColumn ( ) const
inlineoverride

Definition at line 378 of file definitionimpl.h.

379 { return m_alias->getDefColumn(); }

References m_alias.

◆ getDefFileExtension()

template<class Base>
QCString DefinitionAliasMixin< Base >::getDefFileExtension ( ) const
inlineoverride

Definition at line 374 of file definitionimpl.h.

375 { return m_alias->getDefFileExtension(); }

References m_alias.

◆ getDefFileName()

template<class Base>
QCString DefinitionAliasMixin< Base >::getDefFileName ( ) const
inlineoverride

Definition at line 372 of file definitionimpl.h.

373 { return m_alias->getDefFileName(); }

References m_alias.

◆ getDefLine()

template<class Base>
int DefinitionAliasMixin< Base >::getDefLine ( ) const
inlineoverride

Definition at line 376 of file definitionimpl.h.

377 { return m_alias->getDefLine(); }

References m_alias.

◆ getEndBodyLine()

template<class Base>
int DefinitionAliasMixin< Base >::getEndBodyLine ( ) const
inlineoverride

Definition at line 404 of file definitionimpl.h.

405 { return m_alias->getEndBodyLine(); }

References m_alias.

◆ getLanguage()

template<class Base>
SrcLangExt DefinitionAliasMixin< Base >::getLanguage ( ) const
inlineoverride

Definition at line 408 of file definitionimpl.h.

409 { return m_alias->getLanguage(); }

References m_alias.

◆ getOuterScope()

template<class Base>
Definition * DefinitionAliasMixin< Base >::getOuterScope ( ) const
inlineoverride

Definition at line 418 of file definitionimpl.h.

419 { return const_cast<Definition*>(m_scope); }

References m_scope.

◆ getReference()

template<class Base>
QCString DefinitionAliasMixin< Base >::getReference ( ) const
inlineoverride

Reimplemented in MemberDefAliasImpl.

Definition at line 394 of file definitionimpl.h.

395 { return m_alias->getReference(); }

References m_alias.

◆ getReferencedByMembers()

template<class Base>
const MemberVector & DefinitionAliasMixin< Base >::getReferencedByMembers ( ) const
inlineoverride

Definition at line 422 of file definitionimpl.h.

423 { return m_alias->getReferencedByMembers(); }

References m_alias.

◆ getReferencesMembers()

template<class Base>
const MemberVector & DefinitionAliasMixin< Base >::getReferencesMembers ( ) const
inlineoverride

Definition at line 420 of file definitionimpl.h.

421 { return m_alias->getReferencesMembers(); }

References m_alias.

◆ getScope()

template<class Base>
const Definition * DefinitionAliasMixin< Base >::getScope ( ) const
inlineprotected

Definition at line 441 of file definitionimpl.h.

441{ return m_scope; }

References m_scope.

◆ getSectionRefs()

template<class Base>
const SectionRefs & DefinitionAliasMixin< Base >::getSectionRefs ( ) const
inlineoverride

Definition at line 432 of file definitionimpl.h.

433 { return m_alias->getSectionRefs(); }

References m_alias.

◆ getSourceAnchor()

template<class Base>
QCString DefinitionAliasMixin< Base >::getSourceAnchor ( ) const
inlineoverride

Definition at line 350 of file definitionimpl.h.

351 { return m_alias->getSourceAnchor(); }

References m_alias.

◆ getSourceFileBase()

template<class Base>
QCString DefinitionAliasMixin< Base >::getSourceFileBase ( ) const
inlineoverride

Definition at line 348 of file definitionimpl.h.

349 { return m_alias->getSourceFileBase(); }

References m_alias.

◆ getStartBodyLine()

template<class Base>
int DefinitionAliasMixin< Base >::getStartBodyLine ( ) const
inlineoverride

Definition at line 402 of file definitionimpl.h.

403 { return m_alias->getStartBodyLine(); }

References m_alias.

◆ getStartDefLine()

template<class Base>
int DefinitionAliasMixin< Base >::getStartDefLine ( ) const
inlineoverride

Definition at line 400 of file definitionimpl.h.

401 { return m_alias->getStartDefLine(); }

References m_alias.

◆ hasBriefDescription()

template<class Base>
bool DefinitionAliasMixin< Base >::hasBriefDescription ( ) const
inlineoverride

Definition at line 428 of file definitionimpl.h.

429 { return m_alias->hasBriefDescription(); }

References m_alias.

◆ hasDocumentation()

template<class Base>
bool DefinitionAliasMixin< Base >::hasDocumentation ( ) const
inlineoverride

Reimplemented in MemberDefAliasImpl.

Definition at line 380 of file definitionimpl.h.

381 { return m_alias->hasDocumentation(); }

References m_alias.

◆ hasSections()

template<class Base>
bool DefinitionAliasMixin< Base >::hasSections ( ) const
inlineoverride

Definition at line 424 of file definitionimpl.h.

425 { return m_alias->hasSections(); }

References m_alias.

◆ hasSources()

template<class Base>
bool DefinitionAliasMixin< Base >::hasSources ( ) const
inlineoverride

Definition at line 426 of file definitionimpl.h.

427 { return m_alias->hasSources(); }

References m_alias.

◆ hasUserDocumentation()

template<class Base>
bool DefinitionAliasMixin< Base >::hasUserDocumentation ( ) const
inlineoverride

Reimplemented in MemberDefAliasImpl.

Definition at line 382 of file definitionimpl.h.

383 { return m_alias->hasUserDocumentation(); }

References m_alias.

◆ id()

template<class Base>
QCString DefinitionAliasMixin< Base >::id ( ) const
inlineoverride

Definition at line 430 of file definitionimpl.h.

431 { return m_alias->id(); }

References m_alias.

◆ inbodyDocumentation()

template<class Base>
QCString DefinitionAliasMixin< Base >::inbodyDocumentation ( ) const
inlineoverride

Definition at line 364 of file definitionimpl.h.

365 { return m_alias->inbodyDocumentation(); }

References m_alias.

◆ inbodyFile()

template<class Base>
QCString DefinitionAliasMixin< Base >::inbodyFile ( ) const
inlineoverride

Definition at line 366 of file definitionimpl.h.

367 { return m_alias->inbodyFile(); }

References m_alias.

◆ inbodyLine()

template<class Base>
int DefinitionAliasMixin< Base >::inbodyLine ( ) const
inlineoverride

Definition at line 368 of file definitionimpl.h.

369 { return m_alias->inbodyLine(); }

References m_alias.

◆ init()

template<class Base>
void DefinitionAliasMixin< Base >::init ( )
inline

Definition at line 331 of file definitionimpl.h.

331{ m_impl.init(); }

References init(), and m_impl.

Referenced by init().

◆ isAlias()

template<class Base>
bool DefinitionAliasMixin< Base >::isAlias ( ) const
inlineoverride

Definition at line 335 of file definitionimpl.h.

335{ return TRUE; }

References TRUE.

◆ isAnonymous()

template<class Base>
bool DefinitionAliasMixin< Base >::isAnonymous ( ) const
inlineoverride

Definition at line 340 of file definitionimpl.h.

341 { return m_alias->isAnonymous(); }

References m_alias.

◆ isArtificial()

template<class Base>
bool DefinitionAliasMixin< Base >::isArtificial ( ) const
inlineoverride

Definition at line 390 of file definitionimpl.h.

391 { return m_alias->isArtificial(); }

References m_alias.

◆ isExported()

template<class Base>
bool DefinitionAliasMixin< Base >::isExported ( ) const
inlineoverride

Definition at line 392 of file definitionimpl.h.

393 { return m_alias->isExported(); }

References m_alias.

◆ isHidden()

template<class Base>
bool DefinitionAliasMixin< Base >::isHidden ( ) const
inlineoverride

Definition at line 388 of file definitionimpl.h.

389 { return m_alias->isHidden(); }

References m_alias.

◆ isLinkableViaGroup()

template<class Base>
bool DefinitionAliasMixin< Base >::isLinkableViaGroup ( ) const
inlineoverride

Definition at line 412 of file definitionimpl.h.

413 { return m_alias->isLinkableViaGroup(); }

References m_alias.

◆ isReference()

template<class Base>
bool DefinitionAliasMixin< Base >::isReference ( ) const
inlineoverride

Reimplemented in MemberDefAliasImpl.

Definition at line 396 of file definitionimpl.h.

397 { return m_alias->isReference(); }

References m_alias.

◆ isVisible()

template<class Base>
bool DefinitionAliasMixin< Base >::isVisible ( ) const
inlineoverride

Definition at line 386 of file definitionimpl.h.

387 { return m_alias->isVisible(); }

References m_alias.

◆ isVisibleInProject()

template<class Base>
bool DefinitionAliasMixin< Base >::isVisibleInProject ( ) const
inlineoverride

Definition at line 384 of file definitionimpl.h.

385 { return m_alias->isVisibleInProject(); }

References m_alias.

◆ localName()

template<class Base>
const QCString & DefinitionAliasMixin< Base >::localName ( ) const
inlineoverride

Reimplemented in NamespaceDefAliasImpl.

Definition at line 342 of file definitionimpl.h.

343 { return m_alias->localName(); }

References m_alias.

◆ name()

template<class Base>
const QCString & DefinitionAliasMixin< Base >::name ( ) const
inlineoverride

Reimplemented in MemberDefAliasImpl.

Definition at line 338 of file definitionimpl.h.

339 { return m_impl.name(); }

References m_impl.

Referenced by _setSymbolName(), and findInnerCompound().

◆ navigationPathAsString()

template<class Base>
QCString DefinitionAliasMixin< Base >::navigationPathAsString ( ) const
inlineoverride

Definition at line 434 of file definitionimpl.h.

435 { return m_alias->navigationPathAsString(); }

References m_alias.

◆ partOfGroups()

template<class Base>
const GroupList & DefinitionAliasMixin< Base >::partOfGroups ( ) const
inlineoverride

Definition at line 410 of file definitionimpl.h.

411 { return m_alias->partOfGroups(); }

References m_alias.

◆ pathFragment()

template<class Base>
QCString DefinitionAliasMixin< Base >::pathFragment ( ) const
inlineoverride

Definition at line 436 of file definitionimpl.h.

437 { return m_alias->pathFragment(); }

References m_alias.

◆ qualifiedName()

template<class Base>
QCString DefinitionAliasMixin< Base >::qualifiedName ( ) const
inlineoverride

Reimplemented in MemberDefAliasImpl.

Definition at line 344 of file definitionimpl.h.

345 { return m_impl.qualifiedName(); }

References m_impl.

◆ symbolName()

template<class Base>
QCString DefinitionAliasMixin< Base >::symbolName ( ) const
inlineoverride

Definition at line 346 of file definitionimpl.h.

347 { return m_alias->symbolName(); }

References m_alias.

◆ toDefinition_()

template<class Base>
virtual Definition * DefinitionAliasMixin< Base >::toDefinition_ ( )
inlineprivatevirtual

Definition at line 444 of file definitionimpl.h.

444{ return this; }

◆ toDefinitionImpl_()

template<class Base>
const DefinitionImpl * DefinitionAliasMixin< Base >::toDefinitionImpl_ ( ) const
inlineoverrideprivate

Definition at line 446 of file definitionimpl.h.

446{ return nullptr; }

◆ toDefinitionMutable_()

template<class Base>
DefinitionMutable * DefinitionAliasMixin< Base >::toDefinitionMutable_ ( )
inlineoverrideprivate

Definition at line 445 of file definitionimpl.h.

445{ return nullptr; }

◆ xrefListItems()

template<class Base>
const RefItemVector & DefinitionAliasMixin< Base >::xrefListItems ( ) const
inlineoverride

Definition at line 414 of file definitionimpl.h.

415 { return m_alias->xrefListItems(); }

References m_alias.

Member Data Documentation

◆ m_alias

template<class Base>
const Definition* DefinitionAliasMixin< Base >::m_alias
private

Definition at line 452 of file definitionimpl.h.

Referenced by briefDescription(), briefDescriptionAsTooltip(), briefFile(), briefLine(), DefinitionAliasMixin(), docFile(), docLine(), documentation(), externalReference(), findInnerCompound(), getAlias(), getBodyDef(), getDefColumn(), getDefFileExtension(), getDefFileName(), getDefLine(), getEndBodyLine(), getLanguage(), getReference(), getReferencedByMembers(), getReferencesMembers(), getSectionRefs(), getSourceAnchor(), getSourceFileBase(), getStartBodyLine(), getStartDefLine(), hasBriefDescription(), hasDocumentation(), hasSections(), hasSources(), hasUserDocumentation(), id(), inbodyDocumentation(), inbodyFile(), inbodyLine(), isAnonymous(), isArtificial(), isExported(), isHidden(), isLinkableViaGroup(), isReference(), isVisible(), isVisibleInProject(), localName(), navigationPathAsString(), partOfGroups(), pathFragment(), symbolName(), and xrefListItems().

◆ m_impl

template<class Base>
DefinitionAliasImpl DefinitionAliasMixin< Base >::m_impl
private

Definition at line 450 of file definitionimpl.h.

Referenced by DefinitionAliasMixin(), deinit(), init(), name(), and qualifiedName().

◆ m_scope

template<class Base>
const Definition* DefinitionAliasMixin< Base >::m_scope
private

Definition at line 451 of file definitionimpl.h.

Referenced by DefinitionAliasMixin(), getOuterScope(), and getScope().

◆ m_symbolName

template<class Base>
QCString DefinitionAliasMixin< Base >::m_symbolName
private

Definition at line 453 of file definitionimpl.h.

Referenced by _setSymbolName(), and _symbolName().

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