doxygen
|
A model of a directory symbol. More...
#include <dirdef.h>
Classes | |
class | UsedDirLinkedMap |
Public Member Functions | |
virtual DefType | definitionType () const =0 |
virtual QCString | getOutputFileBase () const =0 |
virtual QCString | anchor () const =0 |
virtual bool | isLinkableInProject () const =0 |
virtual bool | isLinkable () const =0 |
virtual QCString | displayName (bool=TRUE) const =0 |
virtual const QCString & | shortName () const =0 |
virtual void | addSubDir (DirDef *subdir)=0 |
virtual FileList * | getFiles () const =0 |
virtual void | addFile (FileDef *fd)=0 |
virtual const DirList & | subDirs () const =0 |
virtual bool | isCluster () const =0 |
virtual int | level () const =0 |
virtual DirDef * | parent () const =0 |
virtual int | dirCount () const =0 |
virtual const UsedDirLinkedMap & | usedDirs () const =0 |
virtual bool | isParentOf (const DirDef *dir) const =0 |
virtual bool | depGraphIsTrivial () const =0 |
virtual QCString | shortTitle () const =0 |
virtual bool | hasDetailedDescription () const =0 |
virtual void | writeDocumentation (OutputList &ol)=0 |
virtual void | writeTagFile (FTextStream &t)=0 |
virtual void | setDiskName (const QCString &name)=0 |
virtual void | sort ()=0 |
virtual void | setParent (DirDef *parent)=0 |
virtual void | setLevel ()=0 |
virtual void | addUsesDependency (DirDef *usedDir, FileDef *srcFd, FileDef *dstFd, bool inherited)=0 |
virtual void | computeDependencies ()=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 defLine, int bls, int ble)=0 |
virtual void | setBodyDef (FileDef *fd)=0 |
virtual void | setRefItems (const RefItemVector &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 (const GroupDef *gd)=0 |
virtual void | addSectionsToDefinition (const std::vector< const 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 | addInnerCompound (const Definition *d)=0 |
virtual void | addSectionsToIndex ()=0 |
virtual void | mergeReferences (const Definition *other)=0 |
virtual void | mergeReferencedBy (const Definition *other)=0 |
virtual void | computeTooltip ()=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 | writeQuickMemberLinks (OutputList &, const MemberDef *) const =0 |
virtual void | writeSummaryLinks (OutputList &) const =0 |
virtual void | writeDocAnchorsToTagFile (FTextStream &) const =0 |
virtual void | writeToc (OutputList &ol, const LocalToc <) const =0 |
![]() | |
virtual bool | isAlias () const =0 |
virtual QCString | name () const =0 |
virtual bool | isAnonymous () const =0 |
virtual 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 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 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 const Definition * | findInnerCompound (const char *name) const =0 |
virtual Definition * | getOuterScope () const =0 |
virtual std::vector< const MemberDef * > | getReferencesMembers () const =0 |
virtual std::vector< const MemberDef * > | 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 | setCookie (Cookie *cookie) const =0 |
virtual Cookie * | cookie () const =0 |
virtual void | _setSymbolName (const QCString &name)=0 |
virtual QCString | _symbolName () const =0 |
Additional Inherited Members | |
![]() | |
enum | DefType { TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeMember = 3, TypeGroup = 4, TypePackage = 5, TypePage = 6, TypeDir = 7 } |
A model of a directory symbol.
|
pure virtual |
Returns the anchor within a page where this item can be found
Implements Definition.
Implemented in DirDefImpl.
|
pure virtual |
Use this for dynamic inspection of the type of the derived class
Implements Definition.
Implemented in DirDefImpl.
|
pure virtual |
Returns the name of the definition as it appears in the output
Implements Definition.
Implemented in DirDefImpl.
|
pure virtual |
Returns the base file name (without extension) of this definition. as it is referenced to/written to disk.
Implements Definition.
Implemented in DirDefImpl.
|
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 DirDefImpl.
|
pure virtual |
Returns TRUE iff it is possible to link to this item within this project.
Implements Definition.
Implemented in DirDefImpl.