The NamespaceDefAliasImpl Class Reference

Declaration

class NamespaceDefAliasImpl { ... }

Base class

class	DefinitionAliasMixin<Base>

Public Constructors Index

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

Public Destructor Index

	~NamespaceDefAliasImpl () override

Public Member Functions Index

DefType	definitionType () const override
const NamespaceDef *	getNSAlias () 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 QCString &	localName () 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 Definition *	findInnerCompound (const QCString &name) const override
bool	subGrouping () const override
MemberList *	getMemberList (MemberListType lt) const override
const MemberLists &	getMemberLists () const override
const MemberDef *	getMemberByName (const QCString &name) const override
const MemberGroupList &	getMemberGroups () 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

Definition at line 185 of file namespacedef.cpp.

Public Constructors

NamespaceDefAliasImpl()

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

inline

Definition at line 188 of file namespacedef.cpp.

188 NamespaceDefAliasImpl(const Definition *newScope,const NamespaceDef *nd)

189 : DefinitionAliasMixin(newScope,nd) { init(); }

References DefinitionAliasMixin< NamespaceDef >::DefinitionAliasMixin and DefinitionAliasMixin< NamespaceDef >::init.

Public Destructor

~NamespaceDefAliasImpl()

NamespaceDefAliasImpl::~NamespaceDefAliasImpl ()

inline

Definition at line 190 of file namespacedef.cpp.

190 ~NamespaceDefAliasImpl() override { deinit(); }

Reference DefinitionAliasMixin< NamespaceDef >::deinit.

Public Member Functions

anchor()

QCString NamespaceDefAliasImpl::anchor ()

inline virtual

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

Definition at line 202 of file namespacedef.cpp.

202 QCString anchor() const override

203 { return getNSAlias()->anchor(); }

References Definition::anchor and getNSAlias.

codeSymbolType()

CodeSymbolType NamespaceDefAliasImpl::codeSymbolType ()

inline virtual

Used for syntax highlighting symbol class

Definition at line 198 of file namespacedef.cpp.

198 CodeSymbolType codeSymbolType() const override

199 { return getNSAlias()->codeSymbolType(); }

References Definition::codeSymbolType and getNSAlias.

compoundTypeString()

QCString NamespaceDefAliasImpl::compoundTypeString ()

inline virtual

Definition at line 256 of file namespacedef.cpp.

256 QCString compoundTypeString() const override

257 { return getNSAlias()->compoundTypeString(); }

References NamespaceDef::compoundTypeString and getNSAlias.

countVisibleMembers()

int NamespaceDefAliasImpl::countVisibleMembers ()

inline virtual

Definition at line 258 of file namespacedef.cpp.

258 int countVisibleMembers() const override

259 { return getNSAlias()->countVisibleMembers(); }

References NamespaceDef::countVisibleMembers and getNSAlias.

definitionType()

DefType NamespaceDefAliasImpl::definitionType ()

inline virtual

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

Definition at line 193 of file namespacedef.cpp.

193 DefType definitionType() const override { return TypeNamespace; }

References definitionType and Definition::TypeNamespace.

Referenced by definitionType.

displayName()

QCString NamespaceDefAliasImpl::displayName (bool includeScope=TRUE)

inline virtual

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

Definition at line 210 of file namespacedef.cpp.

210 QCString displayName(bool b=TRUE) const override

211 { return makeDisplayName(this,b); }

References makeDisplayName and TRUE.

findInnerCompound()

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

inline virtual

Definition at line 230 of file namespacedef.cpp.

230 const Definition *findInnerCompound(const QCString &name) const override

231 { return getNSAlias()->findInnerCompound(name); }

References Definition::findInnerCompound, getNSAlias and DefinitionAliasMixin< NamespaceDef >::name.

getClasses()

ClassLinkedRefMap NamespaceDefAliasImpl::getClasses ()

inline virtual

Returns the classes contained in this namespace

Definition at line 242 of file namespacedef.cpp.

242 ClassLinkedRefMap getClasses() const override

243 { return getNSAlias()->getClasses(); }

References NamespaceDef::getClasses and getNSAlias.

getConcepts()

ConceptLinkedRefMap NamespaceDefAliasImpl::getConcepts ()

inline virtual

Returns the concepts contained in this namespace

Definition at line 252 of file namespacedef.cpp.

252 ConceptLinkedRefMap getConcepts() const override

253 { return getNSAlias()->getConcepts(); }

References NamespaceDef::getConcepts and getNSAlias.

getExceptions()

ClassLinkedRefMap NamespaceDefAliasImpl::getExceptions ()

inline virtual

Returns the Slice exceptions contained in this namespace

Definition at line 248 of file namespacedef.cpp.

248 ClassLinkedRefMap getExceptions() const override

249 { return getNSAlias()->getExceptions(); }

References NamespaceDef::getExceptions and getNSAlias.

getInterfaces()

ClassLinkedRefMap NamespaceDefAliasImpl::getInterfaces ()

inline virtual

Returns the Slice interfaces contained in this namespace

Definition at line 244 of file namespacedef.cpp.

244 ClassLinkedRefMap getInterfaces() const override

245 { return getNSAlias()->getInterfaces(); }

References NamespaceDef::getInterfaces and getNSAlias.

getMemberByName()

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

inline virtual

Definition at line 238 of file namespacedef.cpp.

238 const MemberDef *getMemberByName(const QCString &name) const override

239 { return getNSAlias()->getMemberByName(name); }

References NamespaceDef::getMemberByName, getNSAlias and DefinitionAliasMixin< NamespaceDef >::name.

getMemberGroups()

const MemberGroupList & NamespaceDefAliasImpl::getMemberGroups ()

inline virtual

Returns the user defined member groups

Definition at line 240 of file namespacedef.cpp.

240 const MemberGroupList &getMemberGroups() const override

241 { return getNSAlias()->getMemberGroups(); }

References NamespaceDef::getMemberGroups and getNSAlias.

getMemberList()

MemberList * NamespaceDefAliasImpl::getMemberList (MemberListType lt)

inline virtual

Definition at line 234 of file namespacedef.cpp.

234 MemberList *getMemberList(MemberListType lt) const override

235 { return getNSAlias()->getMemberList(lt); }

References NamespaceDef::getMemberList and getNSAlias.

getMemberLists()

const MemberLists & NamespaceDefAliasImpl::getMemberLists ()

inline virtual

Definition at line 236 of file namespacedef.cpp.

236 const MemberLists &getMemberLists() const override

237 { return getNSAlias()->getMemberLists(); }

References NamespaceDef::getMemberLists and getNSAlias.

getNamespaces()

NamespaceLinkedRefMap NamespaceDefAliasImpl::getNamespaces ()

inline virtual

Returns the namespaces contained in this namespace

Definition at line 250 of file namespacedef.cpp.

250 NamespaceLinkedRefMap getNamespaces() const override

251 { return getNSAlias()->getNamespaces(); }

References NamespaceDef::getNamespaces and getNSAlias.

getNSAlias()

const NamespaceDef * NamespaceDefAliasImpl::getNSAlias ()

inline

Definition at line 195 of file namespacedef.cpp.

195 const NamespaceDef *getNSAlias() const { return toNamespaceDef(getAlias()); }

References DefinitionAliasMixin< NamespaceDef >::getAlias and toNamespaceDef.

Referenced by anchor, codeSymbolType, compoundTypeString, countVisibleMembers, findInnerCompound, getClasses, getConcepts, getExceptions, getInterfaces, getMemberByName, getMemberGroups, getMemberList, getMemberLists, getNamespaces, getOutputFileBase, getStructs, getUsedDefinitions, getUsedNamespaces, hasDetailedDescription, isConstantGroup, isInline, isLibrary, isLinkable, isLinkableInProject, isModule, isVisibleInHierarchy, localName, numDocMembers, subGrouping and title.

getOutputFileBase()

QCString NamespaceDefAliasImpl::getOutputFileBase ()

inline virtual

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

Definition at line 200 of file namespacedef.cpp.

200 QCString getOutputFileBase() const override

201 { return getNSAlias()->getOutputFileBase(); }

References getNSAlias and Definition::getOutputFileBase.

getStructs()

ClassLinkedRefMap NamespaceDefAliasImpl::getStructs ()

inline virtual

Returns the Slice structs contained in this namespace

Definition at line 246 of file namespacedef.cpp.

246 ClassLinkedRefMap getStructs() const override

247 { return getNSAlias()->getStructs(); }

References getNSAlias and NamespaceDef::getStructs.

getUsedDefinitions()

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

inline virtual

Definition at line 208 of file namespacedef.cpp.

208 const LinkedRefMap<const Definition> &getUsedDefinitions() const override

209 { return getNSAlias()->getUsedDefinitions(); }

References getNSAlias and NamespaceDef::getUsedDefinitions.

getUsedNamespaces()

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

inline virtual

Definition at line 206 of file namespacedef.cpp.

206 const LinkedRefMap<NamespaceDef> &getUsedNamespaces() const override

207 { return getNSAlias()->getUsedNamespaces(); }

References getNSAlias and NamespaceDef::getUsedNamespaces.

hasDetailedDescription()

bool NamespaceDefAliasImpl::hasDetailedDescription ()

inline virtual

Definition at line 228 of file namespacedef.cpp.

228 bool hasDetailedDescription() const override

229 { return getNSAlias()->hasDetailedDescription(); }

References getNSAlias and NamespaceDef::hasDetailedDescription.

isConstantGroup()

bool NamespaceDefAliasImpl::isConstantGroup ()

inline virtual

Definition at line 214 of file namespacedef.cpp.

214 bool isConstantGroup() const override

215 { return getNSAlias()->isConstantGroup(); }

References getNSAlias and NamespaceDef::isConstantGroup.

isInline()

bool NamespaceDefAliasImpl::isInline ()

inline virtual

Definition at line 220 of file namespacedef.cpp.

220 bool isInline() const override

221 { return getNSAlias()->isInline(); }

References getNSAlias and NamespaceDef::isInline.

isLibrary()

bool NamespaceDefAliasImpl::isLibrary ()

inline virtual

Definition at line 218 of file namespacedef.cpp.

218 bool isLibrary() const override

219 { return getNSAlias()->isLibrary(); }

References getNSAlias and NamespaceDef::isLibrary.

isLinkable()

bool NamespaceDefAliasImpl::isLinkable ()

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

Definition at line 224 of file namespacedef.cpp.

224 bool isLinkable() const override

225 { return getNSAlias()->isLinkable(); }

References getNSAlias and Definition::isLinkable.

isLinkableInProject()

bool NamespaceDefAliasImpl::isLinkableInProject ()

inline virtual

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

Definition at line 222 of file namespacedef.cpp.

222 bool isLinkableInProject() const override

223 { return getNSAlias()->isLinkableInProject(); }

References getNSAlias and Definition::isLinkableInProject.

isModule()

bool NamespaceDefAliasImpl::isModule ()

inline virtual

Definition at line 216 of file namespacedef.cpp.

216 bool isModule() const override

217 { return getNSAlias()->isModule(); }

References getNSAlias and NamespaceDef::isModule.

isVisibleInHierarchy()

bool NamespaceDefAliasImpl::isVisibleInHierarchy ()

inline virtual

Definition at line 226 of file namespacedef.cpp.

226 bool isVisibleInHierarchy() const override

227 { return getNSAlias()->isVisibleInHierarchy(); }

References getNSAlias and NamespaceDef::isVisibleInHierarchy.

localName()

const QCString & NamespaceDefAliasImpl::localName ()

inline virtual

Returns the local name without any scope qualifiers.

Definition at line 212 of file namespacedef.cpp.

212 const QCString &localName() const override

213 { return getNSAlias()->localName(); }

References getNSAlias and Definition::localName.

numDocMembers()

int NamespaceDefAliasImpl::numDocMembers ()

inline virtual

Definition at line 204 of file namespacedef.cpp.

204 int numDocMembers() const override

205 { return getNSAlias()->numDocMembers(); }

References getNSAlias and NamespaceDef::numDocMembers.

subGrouping()

bool NamespaceDefAliasImpl::subGrouping ()

inline virtual

Definition at line 232 of file namespacedef.cpp.

232 bool subGrouping() const override

233 { return getNSAlias()->subGrouping(); }

References getNSAlias and NamespaceDef::subGrouping.

title()

QCString NamespaceDefAliasImpl::title ()

inline virtual

Definition at line 254 of file namespacedef.cpp.

254 QCString title() const override

255 { return getNSAlias()->title(); }

References getNSAlias and NamespaceDef::title.

---

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

• namespacedef.cpp

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.