Doxygen
Loading...
Searching...
No Matches
NamespaceDefAliasImpl Class Reference
+ Inheritance diagram for NamespaceDefAliasImpl:
+ Collaboration diagram for NamespaceDefAliasImpl:

Public Member Functions

 NamespaceDefAliasImpl (const Definition *newScope, const NamespaceDef *nd)
 
 ~NamespaceDefAliasImpl () override
 
DefType definitionType () const override
 
const NamespaceDefgetNSAlias () const
 
CodeSymbolType codeSymbolType () const override
 
QCString getOutputFileBase () const override
 
QCString anchor () const override
 
int numDocMembers () const override
 
const LinkedRefMap< NamespaceDef > & getUsedNamespaces () const override
 
const LinkedRefMap< const Definition > & getUsedDefinitions () const override
 
QCString displayName (bool b=TRUE) const override
 
const QCStringlocalName () const override
 
bool isConstantGroup () const override
 
bool isModule () const override
 
bool isLibrary () const override
 
bool isInline () const override
 
bool isLinkableInProject () const override
 
bool isLinkable () const override
 
bool isVisibleInHierarchy () const override
 
bool hasDetailedDescription () const override
 
const DefinitionfindInnerCompound (const QCString &name) const override
 
bool subGrouping () const override
 
MemberListgetMemberList (MemberListType lt) const override
 
const MemberListsgetMemberLists () const override
 
const MemberDefgetMemberByName (const QCString &name) const override
 
const MemberGroupListgetMemberGroups () const override
 
ClassLinkedRefMap getClasses () const override
 
ClassLinkedRefMap getInterfaces () const override
 
ClassLinkedRefMap getStructs () const override
 
ClassLinkedRefMap getExceptions () const override
 
NamespaceLinkedRefMap getNamespaces () const override
 
ConceptLinkedRefMap getConcepts () const override
 
QCString title () const override
 
QCString compoundTypeString () const override
 
int countVisibleMembers () const override
 
- Public Member Functions inherited from DefinitionAliasMixin< NamespaceDef >
 DefinitionAliasMixin (const Definition *scope, const Definition *alias)
 
 ~DefinitionAliasMixin () override=default
 
void init ()
 
void deinit ()
 
bool isAlias () const override
 
const QCStringname () const override
 
bool isAnonymous () 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 FileDefgetBodyDef () const override
 
SrcLangExt getLanguage () const override
 
const GroupListpartOfGroups () const override
 
bool isLinkableViaGroup () const override
 
const RefItemVectorxrefListItems () const override
 
DefinitiongetOuterScope () const override
 
const MemberVectorgetReferencesMembers () const override
 
const MemberVectorgetReferencedByMembers () const override
 
bool hasSections () const override
 
bool hasSources () const override
 
bool hasBriefDescription () const override
 
QCString id () const override
 
const SectionRefsgetSectionRefs () const override
 
QCString navigationPathAsString () const override
 
QCString pathFragment () const override
 
- Public Member Functions inherited from NamespaceDef
- Public Member Functions inherited from Definition

Additional Inherited Members

- Public Types inherited from Definition
enum  DefType {
  TypeClass = 0 , TypeFile = 1 , TypeNamespace = 2 , TypeModule = 3 ,
  TypeMember = 4 , TypeGroup = 5 , TypePackage = 6 , TypePage = 7 ,
  TypeDir = 8 , TypeConcept = 9
}
 
- Protected Member Functions inherited from DefinitionAliasMixin< NamespaceDef >
const DefinitiongetAlias () const
 
const DefinitiongetScope () const
 

Detailed Description

Definition at line 184 of file namespacedef.cpp.

Constructor & Destructor Documentation

◆ NamespaceDefAliasImpl()

NamespaceDefAliasImpl::NamespaceDefAliasImpl ( const Definition * newScope,
const NamespaceDef * nd )
inline

◆ ~NamespaceDefAliasImpl()

NamespaceDefAliasImpl::~NamespaceDefAliasImpl ( )
inlineoverride

Member Function Documentation

◆ anchor()

QCString NamespaceDefAliasImpl::anchor ( ) const
inlineoverridevirtual

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

Implements Definition.

Definition at line 201 of file namespacedef.cpp.

202 { return getNSAlias()->anchor(); }
virtual QCString anchor() const =0
const NamespaceDef * getNSAlias() const

References Definition::anchor(), and getNSAlias().

◆ codeSymbolType()

CodeSymbolType NamespaceDefAliasImpl::codeSymbolType ( ) const
inlineoverridevirtual

Used for syntax highlighting symbol class

Implements Definition.

Definition at line 197 of file namespacedef.cpp.

198 { return getNSAlias()->codeSymbolType(); }
virtual CodeSymbolType codeSymbolType() const =0

References Definition::codeSymbolType(), and getNSAlias().

◆ compoundTypeString()

QCString NamespaceDefAliasImpl::compoundTypeString ( ) const
inlineoverridevirtual

Implements NamespaceDef.

Definition at line 255 of file namespacedef.cpp.

256 { return getNSAlias()->compoundTypeString(); }
virtual QCString compoundTypeString() const =0

References NamespaceDef::compoundTypeString(), and getNSAlias().

◆ countVisibleMembers()

int NamespaceDefAliasImpl::countVisibleMembers ( ) const
inlineoverridevirtual

Implements NamespaceDef.

Definition at line 257 of file namespacedef.cpp.

258 { return getNSAlias()->countVisibleMembers(); }
virtual int countVisibleMembers() const =0

References NamespaceDef::countVisibleMembers(), and getNSAlias().

◆ definitionType()

DefType NamespaceDefAliasImpl::definitionType ( ) const
inlineoverridevirtual

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

Implements Definition.

Definition at line 192 of file namespacedef.cpp.

192{ return TypeNamespace; }

References definitionType(), and Definition::TypeNamespace.

Referenced by definitionType().

◆ displayName()

QCString NamespaceDefAliasImpl::displayName ( bool includeScope = TRUE) const
inlineoverridevirtual

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

Implements Definition.

Definition at line 209 of file namespacedef.cpp.

210 { return makeDisplayName(this,b); }
static QCString makeDisplayName(const NamespaceDef *nd, bool includeScope)

References makeDisplayName().

◆ findInnerCompound()

const Definition * NamespaceDefAliasImpl::findInnerCompound ( const QCString & name) const
inlineoverridevirtual

Reimplemented from DefinitionAliasMixin< NamespaceDef >.

Definition at line 229 of file namespacedef.cpp.

230 { return getNSAlias()->findInnerCompound(name); }
virtual const Definition * findInnerCompound(const QCString &name) const =0
virtual const QCString & name() const =0

References Definition::findInnerCompound(), getNSAlias(), and Definition::name().

◆ getClasses()

ClassLinkedRefMap NamespaceDefAliasImpl::getClasses ( ) const
inlineoverridevirtual

Returns the classes contained in this namespace

Implements NamespaceDef.

Definition at line 241 of file namespacedef.cpp.

242 { return getNSAlias()->getClasses(); }
virtual ClassLinkedRefMap getClasses() const =0

References NamespaceDef::getClasses(), and getNSAlias().

◆ getConcepts()

ConceptLinkedRefMap NamespaceDefAliasImpl::getConcepts ( ) const
inlineoverridevirtual

Returns the concepts contained in this namespace

Implements NamespaceDef.

Definition at line 251 of file namespacedef.cpp.

252 { return getNSAlias()->getConcepts(); }
virtual ConceptLinkedRefMap getConcepts() const =0

References NamespaceDef::getConcepts(), and getNSAlias().

◆ getExceptions()

ClassLinkedRefMap NamespaceDefAliasImpl::getExceptions ( ) const
inlineoverridevirtual

Returns the Slice exceptions contained in this namespace

Implements NamespaceDef.

Definition at line 247 of file namespacedef.cpp.

248 { return getNSAlias()->getExceptions(); }
virtual ClassLinkedRefMap getExceptions() const =0

References NamespaceDef::getExceptions(), and getNSAlias().

◆ getInterfaces()

ClassLinkedRefMap NamespaceDefAliasImpl::getInterfaces ( ) const
inlineoverridevirtual

Returns the Slice interfaces contained in this namespace

Implements NamespaceDef.

Definition at line 243 of file namespacedef.cpp.

244 { return getNSAlias()->getInterfaces(); }
virtual ClassLinkedRefMap getInterfaces() const =0

References NamespaceDef::getInterfaces(), and getNSAlias().

◆ getMemberByName()

const MemberDef * NamespaceDefAliasImpl::getMemberByName ( const QCString & name) const
inlineoverridevirtual

Implements NamespaceDef.

Definition at line 237 of file namespacedef.cpp.

238 { return getNSAlias()->getMemberByName(name); }
virtual const MemberDef * getMemberByName(const QCString &) const =0

References NamespaceDef::getMemberByName(), getNSAlias(), and Definition::name().

◆ getMemberGroups()

const MemberGroupList & NamespaceDefAliasImpl::getMemberGroups ( ) const
inlineoverridevirtual

Returns the user defined member groups

Implements NamespaceDef.

Definition at line 239 of file namespacedef.cpp.

240 { return getNSAlias()->getMemberGroups(); }
virtual const MemberGroupList & getMemberGroups() const =0

References NamespaceDef::getMemberGroups(), and getNSAlias().

◆ getMemberList()

MemberList * NamespaceDefAliasImpl::getMemberList ( MemberListType lt) const
inlineoverridevirtual

Implements NamespaceDef.

Definition at line 233 of file namespacedef.cpp.

234 { return getNSAlias()->getMemberList(lt); }
virtual MemberList * getMemberList(MemberListType lt) const =0

References NamespaceDef::getMemberList(), and getNSAlias().

◆ getMemberLists()

const MemberLists & NamespaceDefAliasImpl::getMemberLists ( ) const
inlineoverridevirtual

Implements NamespaceDef.

Definition at line 235 of file namespacedef.cpp.

236 { return getNSAlias()->getMemberLists(); }
virtual const MemberLists & getMemberLists() const =0

References NamespaceDef::getMemberLists(), and getNSAlias().

◆ getNamespaces()

NamespaceLinkedRefMap NamespaceDefAliasImpl::getNamespaces ( ) const
inlineoverridevirtual

Returns the namespaces contained in this namespace

Implements NamespaceDef.

Definition at line 249 of file namespacedef.cpp.

250 { return getNSAlias()->getNamespaces(); }
virtual NamespaceLinkedRefMap getNamespaces() const =0

References NamespaceDef::getNamespaces(), and getNSAlias().

◆ getNSAlias()

◆ getOutputFileBase()

QCString NamespaceDefAliasImpl::getOutputFileBase ( ) const
inlineoverridevirtual

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

Implements Definition.

Definition at line 199 of file namespacedef.cpp.

200 { return getNSAlias()->getOutputFileBase(); }
virtual QCString getOutputFileBase() const =0

References getNSAlias(), and Definition::getOutputFileBase().

◆ getStructs()

ClassLinkedRefMap NamespaceDefAliasImpl::getStructs ( ) const
inlineoverridevirtual

Returns the Slice structs contained in this namespace

Implements NamespaceDef.

Definition at line 245 of file namespacedef.cpp.

246 { return getNSAlias()->getStructs(); }
virtual ClassLinkedRefMap getStructs() const =0

References getNSAlias(), and NamespaceDef::getStructs().

◆ getUsedDefinitions()

const LinkedRefMap< const Definition > & NamespaceDefAliasImpl::getUsedDefinitions ( ) const
inlineoverridevirtual

Implements NamespaceDef.

Definition at line 207 of file namespacedef.cpp.

208 { return getNSAlias()->getUsedDefinitions(); }
virtual const LinkedRefMap< const Definition > & getUsedDefinitions() const =0

References getNSAlias(), and NamespaceDef::getUsedDefinitions().

◆ getUsedNamespaces()

const LinkedRefMap< NamespaceDef > & NamespaceDefAliasImpl::getUsedNamespaces ( ) const
inlineoverridevirtual

Implements NamespaceDef.

Definition at line 205 of file namespacedef.cpp.

206 { return getNSAlias()->getUsedNamespaces(); }
virtual const LinkedRefMap< NamespaceDef > & getUsedNamespaces() const =0

References getNSAlias(), and NamespaceDef::getUsedNamespaces().

◆ hasDetailedDescription()

bool NamespaceDefAliasImpl::hasDetailedDescription ( ) const
inlineoverridevirtual

Implements NamespaceDef.

Definition at line 227 of file namespacedef.cpp.

228 { return getNSAlias()->hasDetailedDescription(); }
virtual bool hasDetailedDescription() const =0

References getNSAlias(), and NamespaceDef::hasDetailedDescription().

◆ isConstantGroup()

bool NamespaceDefAliasImpl::isConstantGroup ( ) const
inlineoverridevirtual

Implements NamespaceDef.

Definition at line 213 of file namespacedef.cpp.

214 { return getNSAlias()->isConstantGroup(); }
virtual bool isConstantGroup() const =0

References getNSAlias(), and NamespaceDef::isConstantGroup().

◆ isInline()

bool NamespaceDefAliasImpl::isInline ( ) const
inlineoverridevirtual

Implements NamespaceDef.

Definition at line 219 of file namespacedef.cpp.

220 { return getNSAlias()->isInline(); }
virtual bool isInline() const =0

References getNSAlias(), and NamespaceDef::isInline().

◆ isLibrary()

bool NamespaceDefAliasImpl::isLibrary ( ) const
inlineoverridevirtual

Implements NamespaceDef.

Definition at line 217 of file namespacedef.cpp.

218 { return getNSAlias()->isLibrary(); }
virtual bool isLibrary() const =0

References getNSAlias(), and NamespaceDef::isLibrary().

◆ isLinkable()

bool NamespaceDefAliasImpl::isLinkable ( ) const
inlineoverridevirtual

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.

Definition at line 223 of file namespacedef.cpp.

224 { return getNSAlias()->isLinkable(); }
virtual bool isLinkable() const =0

References getNSAlias(), and Definition::isLinkable().

◆ isLinkableInProject()

bool NamespaceDefAliasImpl::isLinkableInProject ( ) const
inlineoverridevirtual

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

Implements Definition.

Definition at line 221 of file namespacedef.cpp.

222 { return getNSAlias()->isLinkableInProject(); }
virtual bool isLinkableInProject() const =0

References getNSAlias(), and Definition::isLinkableInProject().

◆ isModule()

bool NamespaceDefAliasImpl::isModule ( ) const
inlineoverridevirtual

Implements NamespaceDef.

Definition at line 215 of file namespacedef.cpp.

216 { return getNSAlias()->isModule(); }
virtual bool isModule() const =0

References getNSAlias(), and NamespaceDef::isModule().

◆ isVisibleInHierarchy()

bool NamespaceDefAliasImpl::isVisibleInHierarchy ( ) const
inlineoverridevirtual

Implements NamespaceDef.

Definition at line 225 of file namespacedef.cpp.

226 { return getNSAlias()->isVisibleInHierarchy(); }
virtual bool isVisibleInHierarchy() const =0

References getNSAlias(), and NamespaceDef::isVisibleInHierarchy().

◆ localName()

const QCString & NamespaceDefAliasImpl::localName ( ) const
inlineoverridevirtual

Returns the local name without any scope qualifiers.

Reimplemented from DefinitionAliasMixin< NamespaceDef >.

Definition at line 211 of file namespacedef.cpp.

212 { return getNSAlias()->localName(); }
virtual const QCString & localName() const =0

References getNSAlias(), and Definition::localName().

◆ numDocMembers()

int NamespaceDefAliasImpl::numDocMembers ( ) const
inlineoverridevirtual

Implements NamespaceDef.

Definition at line 203 of file namespacedef.cpp.

204 { return getNSAlias()->numDocMembers(); }
virtual int numDocMembers() const =0

References getNSAlias(), and NamespaceDef::numDocMembers().

◆ subGrouping()

bool NamespaceDefAliasImpl::subGrouping ( ) const
inlineoverridevirtual

Implements NamespaceDef.

Definition at line 231 of file namespacedef.cpp.

232 { return getNSAlias()->subGrouping(); }
virtual bool subGrouping() const =0

References getNSAlias(), and NamespaceDef::subGrouping().

◆ title()

QCString NamespaceDefAliasImpl::title ( ) const
inlineoverridevirtual

Implements NamespaceDef.

Definition at line 253 of file namespacedef.cpp.

254 { return getNSAlias()->title(); }
virtual QCString title() const =0

References getNSAlias(), and NamespaceDef::title().


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