Public Member Functions | List of all members
FileDef Class Referenceabstract

A model of a file symbol. More...

#include <filedef.h>

Inheritance diagram for FileDef:
Inheritance graph
Collaboration diagram for FileDef:
Collaboration graph

Public Member Functions

virtual DefType definitionType () const =0
virtual QCString name () const =0
virtual QCString displayName (bool=TRUE) const =0
virtual QCString fileName () const =0
virtual QCString getOutputFileBase () const =0
virtual QCString anchor () const =0
virtual QCString getSourceFileBase () const =0
virtual QCString includeName () const =0
virtual QCString includeDependencyGraphFileName () const =0
virtual QCString includedByDependencyGraphFileName () const =0
virtual QCString absFilePath () const =0
virtual const QCStringdocName () const =0
virtual bool isSource () const =0
virtual bool isDocumentationFile () const =0
virtual const DefinitiongetSourceDefinition (int lineNr) const =0
virtual const MemberDefgetSourceMember (int lineNr) const =0
virtual QCString getPath () const =0
virtual QCString getVersion () const =0
virtual bool isLinkableInProject () const =0
virtual bool isLinkable () const =0
virtual bool isIncluded (const QCString &name) const =0
virtual PackageDef * packageDef () const =0
virtual DirDefgetDirDef () const =0
virtual LinkedRefMap< const NamespaceDefgetUsedNamespaces () const =0
virtual LinkedRefMap< const ClassDefgetUsedClasses () const =0
virtual const IncludeInfoListincludeFileList () const =0
virtual const IncludeInfoListincludedByFileList () const =0
virtual void getAllIncludeFilesRecursively (StringVector &incFiles) const =0
virtual MemberListgetMemberList (MemberListType lt) const =0
virtual const MemberListsgetMemberLists () const =0
virtual const MemberGroupListgetMemberGroups () const =0
virtual const NamespaceLinkedRefMapgetNamespaces () const =0
virtual const ConceptLinkedRefMapgetConcepts () const =0
virtual const ClassLinkedRefMapgetClasses () const =0
virtual QCString title () const =0
virtual bool hasDetailedDescription () const =0
virtual QCString fileVersion () const =0
virtual bool subGrouping () const =0
virtual void countMembers ()=0
virtual int numDocMembers () const =0
virtual int numDecMembers () const =0
virtual void addSourceRef (int line, const Definition *d, const MemberDef *md)=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 writeSummaryLinks (OutputList &ol) const =0
virtual void writeTagFile (TextStream &t)=0
virtual void writeSourceHeader (OutputList &ol)=0
virtual void writeSourceBody (OutputList &ol, ClangTUParser *clangParser)=0
virtual void writeSourceFooter (OutputList &ol)=0
virtual void parseSource (ClangTUParser *clangParser)=0
virtual void setDiskName (const QCString &name)=0
virtual void insertMember (MemberDef *md)=0
virtual void insertClass (const ClassDef *cd)=0
virtual void insertConcept (const ConceptDef *cd)=0
virtual void insertNamespace (const NamespaceDef *nd)=0
virtual void computeAnchors ()=0
virtual void setPackageDef (PackageDef *pd)=0
virtual void setDirDef (DirDef *dd)=0
virtual void addUsingDirective (const NamespaceDef *nd)=0
virtual void addUsingDeclaration (const ClassDef *cd)=0
virtual void combineUsingRelations ()=0
virtual bool generateSourceFile () const =0
virtual void sortMemberLists ()=0
virtual void addIncludeDependency (const FileDef *fd, const QCString &incName, bool local, bool imported)=0
virtual void addIncludedByDependency (const FileDef *fd, const QCString &incName, bool local, bool imported)=0
virtual void addMembersToMemberGroup ()=0
virtual void distributeMemberGroupDocumentation ()=0
virtual void findSectionsInDocumentation ()=0
virtual void addIncludedUsingDirectives (FileDefSet &visitedFiles)=0
virtual void addListReferences ()=0
- Public Member Functions inherited from DefinitionMutable
virtual void setName (const QCString &name)=0
virtual void setId (const QCString &name)=0
virtual void setDefFile (const QCString &df, int defLine, int defColumn)=0
virtual void setDocumentation (const QCString &d, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE)=0
virtual void setBriefDescription (const QCString &b, const QCString &briefFile, int briefLine)=0
virtual void setInbodyDocumentation (const QCString &d, const QCString &docFile, int docLine)=0
virtual void setReference (const QCString &r)=0
virtual void setBodySegment (int defLine, int bls, int ble)=0
virtual void setBodyDef (const 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 QCString &scopeName) const =0
virtual void writeInlineCode (OutputList &ol, const QCString &scopeName) const =0
virtual bool hasSourceRefs () const =0
virtual bool hasSourceReffedBy () const =0
virtual void writeSourceRefs (OutputList &ol, const QCString &scopeName) const =0
virtual void writeSourceReffedBy (OutputList &ol, const QCString &scopeName) const =0
virtual void writeNavigationPath (OutputList &ol) const =0
virtual void writeDocAnchorsToTagFile (TextStream &) const =0
virtual void writeToc (OutputList &ol, const LocalToc &lt) const =0
- Public Member Functions inherited from Definition
virtual CodeSymbolType codeSymbolType () const =0
virtual bool isAlias () const =0
virtual bool isAnonymous () const =0
virtual QCString localName () const =0
virtual QCString qualifiedName () const =0
virtual QCString symbolName () 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 const FileDefgetBodyDef () const =0
virtual SrcLangExt getLanguage () const =0
 Returns the programming language this definition was written in. More...
virtual const GroupListpartOfGroups () const =0
virtual bool isLinkableViaGroup () const =0
virtual const RefItemVector & xrefListItems () const =0
virtual const DefinitionfindInnerCompound (const QCString &name) const =0
virtual DefinitiongetOuterScope () const =0
virtual const MemberVectorgetReferencesMembers () const =0
virtual const MemberVectorgetReferencedByMembers () 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 SectionRefsgetSectionRefs () 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 Cookiecookie () 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, TypeMember = 3,
  TypeGroup = 4, TypePackage = 5, TypePage = 6, TypeDir = 7,
  TypeConcept = 8

Detailed Description

A model of a file symbol.

An object of this class contains all file information that is gathered. This includes the members and compounds defined in the file.

The member writeDocumentation() can be used to generate the page of documentation to HTML and LaTeX.

Member Function Documentation

◆ absFilePath()

virtual QCString FileDef::absFilePath ( ) const
pure virtual

Returns the absolute path including the file name.

Implemented in FileDefImpl.

◆ anchor()

virtual QCString FileDef::anchor ( ) const
pure virtual

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

Implements Definition.

Implemented in FileDefImpl.

◆ definitionType()

virtual DefType FileDef::definitionType ( ) const
pure virtual

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

Implements Definition.

Implemented in FileDefImpl.

◆ displayName()

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

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

Implements Definition.

Implemented in FileDefImpl.

◆ docName()

virtual const QCString& FileDef::docName ( ) const
pure virtual

Returns the name as it is used in the documentation

Implemented in FileDefImpl.

◆ getOutputFileBase()

virtual QCString FileDef::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 FileDefImpl.

◆ getPath()

virtual QCString FileDef::getPath ( ) const
pure virtual

Returns the absolute path of this file.

Implemented in FileDefImpl.

◆ getSourceFileBase()

virtual QCString FileDef::getSourceFileBase ( ) const
pure virtual

Returns the name of the source listing of this definition.

Implements Definition.

Implemented in FileDefImpl.

◆ getVersion()

virtual QCString FileDef::getVersion ( ) const
pure virtual

Returns version of this file.

Implemented in FileDefImpl.

◆ includeName()

virtual QCString FileDef::includeName ( ) const
pure virtual

Returns the name of the verbatim copy of this file (if any).

Implemented in FileDefImpl.

◆ isLinkable()

virtual bool FileDef::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 FileDefImpl.

◆ isLinkableInProject()

virtual bool FileDef::isLinkableInProject ( ) const
pure virtual

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

Implements Definition.

Implemented in FileDefImpl.

◆ isSource()

virtual bool FileDef::isSource ( ) const
pure virtual

Returns TRUE if this file is a source file.

Implemented in FileDefImpl.

◆ name()

virtual QCString FileDef::name ( ) const
pure virtual

Returns the unique file name (this may include part of the path).

Implements Definition.

Implemented in FileDefImpl.

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