ISLEman
Public Member Functions | Public Attributes | List of all members
NamespaceDef Class Reference

A model of a namespace symbol. More...

#include <namespacedef.h>

Inheritance diagram for NamespaceDef:
Definition DefinitionIntf

Public Member Functions

 NamespaceDef (const char *defFileName, int defLine, int defColumn, const char *name, const char *ref=0, const char *refFile=0, const char *type=0, bool isPublished=false)
 
DefType definitionType () const
 
QCString getOutputFileBase () const
 
QCString anchor () const
 
void insertUsedFile (FileDef *fd)
 
void writeDocumentation (OutputList &ol)
 
void writeMemberPages (OutputList &ol)
 
void writeQuickMemberLinks (OutputList &ol, MemberDef *currentMd) const
 
void writeTagFile (FTextStream &)
 
void insertClass (ClassDef *cd)
 
void insertNamespace (NamespaceDef *nd)
 
void insertMember (MemberDef *md)
 
void computeAnchors ()
 
int countMembers ()
 
void addUsingDirective (NamespaceDef *nd)
 
NamespaceSDict * getUsedNamespaces () const
 
void addUsingDeclaration (Definition *def)
 
SDict< Definition > * getUsedClasses () const
 
void combineUsingRelations ()
 
QCString displayName (bool=TRUE) const
 
QCString localName () const
 
bool isConstantGroup () const
 
bool isModule () const
 
bool isLibrary () const
 
bool isLinkableInProject () const
 
bool isLinkable () const
 
bool hasDetailedDescription () const
 
void addMembersToMemberGroup ()
 
void distributeMemberGroupDocumentation ()
 
void findSectionsInDocumentation ()
 
void sortMemberLists ()
 
virtual Definition * findInnerCompound (const char *name)
 
void addInnerCompound (Definition *d)
 
void addListReferences ()
 
void setFileName (const QCString &fn)
 
bool subGrouping () const
 
MemberList * getMemberList (MemberListType lt) const
 
const QList< MemberList > & getMemberLists () const
 
MemberDef * getMemberByName (const QCString &) const
 
MemberGroupSDict * getMemberGroupSDict () const
 
ClassSDict * getClassSDict () const
 
NamespaceSDict * getNamespaceSDict () const
 
QCString title () const
 
QCString compoundTypeString () const
 
- Public Member Functions inherited from Definition
 Definition (const char *defFileName, int defLine, int defColumn, const char *name, const char *b=0, const char *d=0, bool isSymbol=TRUE)
 
virtual ~Definition ()
 
const QCString & name () const
 
QCString localName () const
 
virtual QCString qualifiedName () const
 
QCString symbolName () const
 
virtual QCString getSourceFileBase () const
 
virtual QCString getSourceAnchor () const
 
virtual QCString documentation () const
 
int docLine () const
 
QCString docFile () const
 
virtual QCString briefDescription (bool abbreviate=FALSE) const
 
QCString briefDescriptionAsTooltip () const
 
int briefLine () const
 
QCString inbodyDocumentation () const
 
QCString inbodyFile () const
 
int inbodyLine () const
 
QCString briefFile () const
 
QCString getDefFileName () const
 
QCString getDefFileExtension () const
 
int getDefLine () const
 
int getDefColumn () const
 
virtual bool hasDocumentation () const
 
virtual bool hasUserDocumentation () const
 
virtual bool isVisibleInProject () const
 
virtual bool isVisible () const
 
bool isHidden () const
 
bool isArtificial () const
 
virtual QCString getReference () const
 
virtual bool isReference () const
 
QCString externalReference (const QCString &relPath) const
 
int getStartBodyLine () const
 
int getEndBodyLine () const
 
FileDef * getBodyDef () const
 
SrcLangExt getLanguage () const
 Returns the programming language this definition was written in. More...
 
GroupList * partOfGroups () const
 
bool isLinkableViaGroup () const
 
QList< ListItemInfo > * xrefListItems () const
 
virtual Definition * getOuterScope () const
 
MemberSDict * getReferencesMembers () const
 
MemberSDict * getReferencedByMembers () const
 
bool hasSections () const
 
bool hasSources () const
 
bool hasBriefDescription () const
 returns TRUE if this class has a brief description
 
QCString id () const
 
virtual void setName (const char *name)
 
void setId (const char *name)
 
virtual void setDocumentation (const char *d, const char *docFile, int docLine, bool stripWhiteSpace=TRUE)
 
virtual void setBriefDescription (const char *b, const char *briefFile, int briefLine)
 
virtual void setInbodyDocumentation (const char *d, const char *docFile, int docLine)
 
void setReference (const char *r)
 
void addSectionsToDefinition (QList< SectionInfo > *anchorList)
 
void setBodySegment (int bls, int ble)
 
void setBodyDef (FileDef *fd)
 
void addSourceReferencedBy (MemberDef *d)
 
void addSourceReferences (MemberDef *d)
 
void setRefItems (const QList< ListItemInfo > *sli)
 
void mergeRefItems (Definition *d)
 
virtual void setOuterScope (Definition *d)
 
virtual void setHidden (bool b)
 
void setArtificial (bool b)
 
void setLanguage (SrcLangExt lang)
 
void writeSourceDef (OutputList &ol, const char *scopeName)
 
void writeInlineCode (OutputList &ol, const char *scopeName)
 
void writeSourceRefs (OutputList &ol, const char *scopeName)
 
void writeSourceReffedBy (OutputList &ol, const char *scopeName)
 
void makePartOfGroup (GroupDef *gd)
 
void writeNavigationPath (OutputList &ol) const
 
QCString navigationPathAsString () const
 
QCString pathFragment () const
 
void writeDocAnchorsToTagFile (FTextStream &)
 
void setLocalName (const QCString name)
 
void addSectionsToIndex ()
 
void writeToc (OutputList &ol)
 
void setCookie (Cookie *cookie)
 
Cookie * cookie () const
 

Public Attributes

bool visited
 

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
}
 
- Protected Member Functions inherited from Definition
 Definition (const Definition &d)
 

Detailed Description

A model of a namespace symbol.

Member Function Documentation

§ anchor()

QCString NamespaceDef::anchor ( ) const
inlinevirtual

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

Implements Definition.

§ definitionType()

DefType NamespaceDef::definitionType ( ) const
inlinevirtual

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

Implements DefinitionIntf.

§ displayName()

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

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

Implements Definition.

§ getClassSDict()

ClassSDict* NamespaceDef::getClassSDict ( ) const
inline

Returns the classes contained in this namespace

§ getMemberGroupSDict()

MemberGroupSDict* NamespaceDef::getMemberGroupSDict ( ) const
inline

Returns the user defined member groups

§ getNamespaceSDict()

NamespaceSDict* NamespaceDef::getNamespaceSDict ( ) const
inline

Returns the namespaces contained in this namespace

§ getOutputFileBase()

QCString NamespaceDef::getOutputFileBase ( ) const
virtual

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

Implements Definition.

§ isLinkable()

bool NamespaceDef::isLinkable ( ) const
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.

§ isLinkableInProject()

bool NamespaceDef::isLinkableInProject ( ) const
virtual

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

Implements Definition.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.12