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:
Definition DefinitionIntf NamespaceDefAliasImpl NamespaceDefImpl

Public Member Functions

virtual DefType definitionType () const =0
 
virtual QCString getOutputFileBase () const =0
 
virtual QCString anchor () const =0
 
virtual void insertUsedFile (FileDef *fd)=0
 
virtual void writeDocumentation (OutputList &ol)=0
 
virtual void writeMemberPages (OutputList &ol)=0
 
virtual void writeQuickMemberLinks (OutputList &ol, const MemberDef *currentMd) const =0
 
virtual void writeTagFile (FTextStream &)=0
 
virtual void insertClass (const ClassDef *cd)=0
 
virtual void insertNamespace (const NamespaceDef *nd)=0
 
virtual void insertMember (MemberDef *md)=0
 
virtual void computeAnchors ()=0
 
virtual void countMembers ()=0
 
virtual int numDocMembers () const =0
 
virtual void addUsingDirective (const NamespaceDef *nd)=0
 
virtual const NamespaceSDictgetUsedNamespaces () const =0
 
virtual void addUsingDeclaration (const Definition *def)=0
 
virtual const SDict< Definition > * getUsedClasses () const =0
 
virtual void combineUsingRelations ()=0
 
virtual QCString displayName (bool=TRUE) const =0
 
virtual QCString localName () const =0
 
virtual void setInline (bool isInline)=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 hasDetailedDescription () const =0
 
virtual void addMembersToMemberGroup ()=0
 
virtual void distributeMemberGroupDocumentation ()=0
 
virtual void findSectionsInDocumentation ()=0
 
virtual void sortMemberLists ()=0
 
virtual DefinitionfindInnerCompound (const char *name) const =0
 
virtual void addInnerCompound (const Definition *d)=0
 
virtual void addListReferences ()=0
 
virtual void setFileName (const QCString &fn)=0
 
virtual bool subGrouping () const =0
 
virtual MemberListgetMemberList (MemberListType lt) const =0
 
virtual const QList< MemberList > & getMemberLists () const =0
 
virtual MemberDefgetMemberByName (const QCString &) const =0
 
virtual MemberGroupSDictgetMemberGroupSDict () const =0
 
virtual ClassSDictgetClassSDict () const =0
 
virtual ClassSDictgetInterfaceSDict () const =0
 
virtual ClassSDictgetStructSDict () const =0
 
virtual ClassSDictgetExceptionSDict () const =0
 
virtual const NamespaceSDictgetNamespaceSDict () const =0
 
virtual QCString title () const =0
 
virtual QCString compoundTypeString () const =0
 
virtual void setMetaData (const QCString &m)=0
 
virtual void setVisited (bool v)=0
 
virtual bool isVisited () const =0
 
- Public Member Functions inherited from Definition
virtual bool isAlias () const =0
 
virtual QCString name () 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 QCString getReference () const =0
 
virtual bool isReference () const =0
 
virtual QCString externalReference (const QCString &relPath) const =0
 
virtual int getStartBodyLine () const =0
 
virtual int getEndBodyLine () const =0
 
virtual FileDefgetBodyDef () const =0
 
virtual SrcLangExt getLanguage () const =0
 Returns the programming language this definition was written in. More...
 
virtual GroupListpartOfGroups () const =0
 
virtual bool isLinkableViaGroup () const =0
 
virtual QList< ListItemInfo > * xrefListItems () const =0
 
virtual DefinitiongetOuterScope () const =0
 
virtual MemberSDictgetReferencesMembers () const =0
 
virtual MemberSDictgetReferencedByMembers () 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 SectionDictgetSectionDict () const =0
 returns the section dictionary, only of importance for pagedef
 
virtual QCString navigationPathAsString () const =0
 
virtual QCString pathFragment () const =0
 
virtual void setName (const char *name)=0
 
virtual void setId (const char *name)=0
 
virtual void setDefFile (const QCString &df, int defLine, int defColumn)=0
 
virtual void setDocumentation (const char *d, const char *docFile, int docLine, bool stripWhiteSpace=TRUE)=0
 
virtual void setBriefDescription (const char *b, const char *briefFile, int briefLine)=0
 
virtual void setInbodyDocumentation (const char *d, const char *docFile, int docLine)=0
 
virtual void setReference (const char *r)=0
 
virtual void setBodySegment (int bls, int ble)=0
 
virtual void setBodyDef (FileDef *fd)=0
 
virtual void setRefItems (const QList< ListItemInfo > *sli)=0
 
virtual void setOuterScope (Definition *d)=0
 
virtual void setHidden (bool b)=0
 
virtual void setArtificial (bool b)=0
 
virtual void setLanguage (SrcLangExt lang)=0
 
virtual void setLocalName (const QCString name)=0
 
virtual void makePartOfGroup (GroupDef *gd)=0
 
virtual void addSectionsToDefinition (QList< SectionInfo > *anchorList)=0
 
virtual void addSourceReferencedBy (const MemberDef *d)=0
 
virtual void addSourceReferences (const MemberDef *d)=0
 
virtual void mergeRefItems (Definition *d)=0
 
virtual void addSectionsToIndex ()=0
 
virtual void writeSourceDef (OutputList &ol, const char *scopeName) const =0
 
virtual void writeInlineCode (OutputList &ol, const char *scopeName) const =0
 
virtual void writeSourceRefs (OutputList &ol, const char *scopeName) const =0
 
virtual void writeSourceReffedBy (OutputList &ol, const char *scopeName) const =0
 
virtual void writeNavigationPath (OutputList &ol) const =0
 
virtual void writeSummaryLinks (OutputList &) const =0
 
virtual void writeDocAnchorsToTagFile (FTextStream &) const =0
 
virtual void writeToc (OutputList &ol, const LocalToc &lt) const =0
 
virtual void setCookie (Cookie *cookie) const =0
 
virtual Cookiecookie () const =0
 
virtual void _setSymbolName (const QCString &name)=0
 
virtual QCString _symbolName () const =0
 

Additional Inherited Members

- Public Types inherited from DefinitionIntf
enum  DefType {
  TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeMember = 3,
  TypeGroup = 4, TypePackage = 5, TypePage = 6, TypeDir = 7,
  TypeSymbolList = 8
}
 

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

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.

§ getClassSDict()

virtual ClassSDict* NamespaceDef::getClassSDict ( ) const
pure virtual

Returns the classes contained in this namespace

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

§ getExceptionSDict()

virtual ClassSDict* NamespaceDef::getExceptionSDict ( ) const
pure virtual

Returns the Slice exceptions contained in this namespace

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

§ getInterfaceSDict()

virtual ClassSDict* NamespaceDef::getInterfaceSDict ( ) const
pure virtual

Returns the Slice interfaces contained in this namespace

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

§ getMemberGroupSDict()

virtual MemberGroupSDict* NamespaceDef::getMemberGroupSDict ( ) const
pure virtual

Returns the user defined member groups

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

§ getNamespaceSDict()

virtual const NamespaceSDict* NamespaceDef::getNamespaceSDict ( ) 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.

§ getStructSDict()

virtual ClassSDict* NamespaceDef::getStructSDict ( ) 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.

§ localName()

virtual QCString NamespaceDef::localName ( ) const
pure virtual

Returns the local name without any scope qualifiers.

Implements Definition.

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.


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