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

An abstract interface of a namespace symbol. More...

#include <namespacedef.h>

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

Public Member Functions

virtual DefType definitionType () const =0
 
virtual QCString getOutputFileBase () const =0
 
virtual QCString anchor () const =0
 
virtual int numDocMembers () const =0
 
virtual const LinkedRefMap< NamespaceDef > & getUsedNamespaces () const =0
 
virtual const LinkedRefMap< ClassDef > & getUsedClasses () const =0
 
virtual QCString displayName (bool=TRUE) const =0
 
virtual bool isConstantGroup () const =0
 
virtual bool isModule () const =0
 
virtual bool isLibrary () const =0
 
virtual bool isInline () const =0
 
virtual bool isLinkableInProject () const =0
 
virtual bool isLinkable () const =0
 
virtual bool isVisibleInHierarchy () const =0
 
virtual bool hasDetailedDescription () const =0
 
virtual const Definition * findInnerCompound (const QCString &name) const =0
 
virtual bool subGrouping () const =0
 
virtual MemberList * getMemberList (MemberListType lt) const =0
 
virtual const MemberLists & getMemberLists () const =0
 
virtual const MemberDef * getMemberByName (const QCString &) const =0
 
virtual int countVisibleMembers () const =0
 
virtual const MemberGroupList & getMemberGroups () const =0
 
virtual ClassLinkedRefMap getClasses () const =0
 
virtual ClassLinkedRefMap getInterfaces () const =0
 
virtual ClassLinkedRefMap getStructs () const =0
 
virtual ClassLinkedRefMap getExceptions () const =0
 
virtual NamespaceLinkedRefMap getNamespaces () const =0
 
virtual ConceptLinkedRefMap getConcepts () const =0
 
virtual QCString title () const =0
 
virtual QCString compoundTypeString () const =0
 
- Public Member Functions inherited from Definition
virtual CodeSymbolType codeSymbolType () const =0
 
virtual bool isAlias () const =0
 
virtual const QCString & name () const =0
 
virtual bool isAnonymous () const =0
 
virtual const QCString & localName () const =0
 
virtual QCString qualifiedName () const =0
 
virtual QCString symbolName () const =0
 
virtual QCString getSourceFileBase () const =0
 
virtual QCString getSourceAnchor () const =0
 
virtual QCString documentation () const =0
 
virtual int docLine () const =0
 
virtual QCString docFile () const =0
 
virtual QCString briefDescription (bool abbreviate=FALSE) 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 hasDocumentation () 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 bool isExported () const =0
 
virtual QCString getReference () const =0
 
virtual bool isReference () 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 const FileDef * getBodyDef () const =0
 
virtual SrcLangExt getLanguage () const =0
 Returns the programming language this definition was written in. More...
 
virtual const GroupList & partOfGroups () const =0
 
virtual bool isLinkableViaGroup () const =0
 
virtual const RefItemVector & xrefListItems () const =0
 
virtual Definition * getOuterScope () const =0
 
virtual const MemberVector & getReferencesMembers () const =0
 
virtual const MemberVector & 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 SectionRefs & getSectionRefs () const =0
 returns the section dictionary, only of importance for pagedef
 
virtual QCString navigationPathAsString () const =0
 
virtual QCString pathFragment () 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, TypeModule = 3,
  TypeMember = 4, TypeGroup = 5, TypePackage = 6, TypePage = 7,
  TypeDir = 8, TypeConcept = 9
}
 

Detailed Description

An abstract interface of a namespace symbol.

Member Function Documentation

◆ anchor()

virtual QCString NamespaceDef::anchor ( ) const
pure virtual

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

Implements Definition.

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

◆ definitionType()

virtual DefType NamespaceDef::definitionType ( ) const
pure virtual

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

Implements Definition.

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

◆ displayName()

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

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

Implements Definition.

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

◆ getClasses()

virtual ClassLinkedRefMap NamespaceDef::getClasses ( ) const
pure virtual

Returns the classes contained in this namespace

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

◆ getConcepts()

virtual ConceptLinkedRefMap NamespaceDef::getConcepts ( ) const
pure virtual

Returns the concepts contained in this namespace

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

◆ getExceptions()

virtual ClassLinkedRefMap NamespaceDef::getExceptions ( ) const
pure virtual

Returns the Slice exceptions contained in this namespace

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

◆ getInterfaces()

virtual ClassLinkedRefMap NamespaceDef::getInterfaces ( ) const
pure virtual

Returns the Slice interfaces contained in this namespace

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

◆ getMemberGroups()

virtual const MemberGroupList& NamespaceDef::getMemberGroups ( ) const
pure virtual

Returns the user defined member groups

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

◆ getNamespaces()

virtual NamespaceLinkedRefMap NamespaceDef::getNamespaces ( ) const
pure virtual

Returns the namespaces contained in this namespace

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

◆ getOutputFileBase()

virtual QCString NamespaceDef::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 NamespaceDefAliasImpl, and NamespaceDefImpl.

◆ getStructs()

virtual ClassLinkedRefMap NamespaceDef::getStructs ( ) const
pure virtual

Returns the Slice structs contained in this namespace

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

◆ isLinkable()

virtual bool NamespaceDef::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 NamespaceDefAliasImpl, and NamespaceDefImpl.

◆ isLinkableInProject()

virtual bool NamespaceDef::isLinkableInProject ( ) const
pure virtual

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

Implements Definition.

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.13