Public Member Functions | List of all members
PageDefImpl Class Reference
Inheritance diagram for PageDefImpl:
Inheritance graph
Collaboration diagram for PageDefImpl:
Collaboration graph

Public Member Functions

 PageDefImpl (const QCString &f, int l, const QCString &n, const QCString &d, const QCString &t)
virtual void setFileName (const QCString &name)
virtual void setLocalToc (const LocalToc &tl)
virtual void setShowLineNo (bool)
virtual DefType definitionType () const
virtual CodeSymbolType codeSymbolType () const
virtual bool isLinkableInProject () const
virtual bool isLinkable () const
virtual QCString getOutputFileBase () const
virtual QCString anchor () const
virtual void findSectionsInDocumentation ()
virtual QCString title () const
virtual const GroupDefgetGroupDef () const
virtual const PageLinkedRefMapgetSubPages () const
virtual void addInnerCompound (const Definition *d)
virtual bool visibleInIndex () const
virtual bool documentedPage () const
virtual bool hasSubPages () const
virtual bool hasParentPage () const
virtual bool hasTitle () const
virtual LocalToc localToc () const
virtual void setPageScope (Definition *d)
virtual DefinitiongetPageScope () const
virtual QCString displayName (bool=TRUE) const
virtual bool showLineNo () const
virtual void setTitle (const QCString &title)
virtual void writeDocumentation (OutputList &ol)
virtual void writeTagFile (TextStream &)
virtual void setNestingLevel (int l)
virtual void writePageDocumentation (OutputList &ol) const
- Public Member Functions inherited from DefinitionMixin< PageDef >
 DefinitionMixin (const QCString &defFileName, int defLine, int defColumn, const QCString &name, const char *b=0, const char *d=0, bool isSymbol=TRUE)
virtual bool isAlias () const
virtual QCString name () const
virtual bool isAnonymous () const
virtual QCString localName () const
virtual QCString qualifiedName () const
virtual QCString symbolName () const
virtual QCString getSourceFileBase () const
virtual QCString getSourceAnchor () const
virtual QCString documentation () const
virtual int docLine () const
virtual QCString docFile () const
virtual QCString briefDescription (bool abbreviate=FALSE) const
virtual QCString briefDescriptionAsTooltip () const
virtual int briefLine () const
virtual QCString inbodyDocumentation () const
virtual QCString inbodyFile () const
virtual int inbodyLine () const
virtual QCString briefFile () const
virtual QCString getDefFileName () const
virtual QCString getDefFileExtension () const
virtual int getDefLine () const
virtual int getDefColumn () const
virtual bool hasDocumentation () const
virtual bool hasUserDocumentation () const
virtual bool isVisibleInProject () const
virtual bool isVisible () const
virtual bool isHidden () const
virtual bool isArtificial () const
virtual QCString getReference () const
virtual bool isReference () const
virtual QCString externalReference (const QCString &relPath) const
virtual int getStartDefLine () const
virtual int getStartBodyLine () const
virtual int getEndBodyLine () const
virtual const FileDefgetBodyDef () const
virtual SrcLangExt getLanguage () const
virtual const GroupListpartOfGroups () const
virtual bool isLinkableViaGroup () const
virtual const RefItemVector & xrefListItems () const
virtual const DefinitionfindInnerCompound (const QCString &name) const
virtual DefinitiongetOuterScope () const
virtual const MemberVectorgetReferencesMembers () const
virtual const MemberVectorgetReferencedByMembers () const
virtual bool hasSections () const
virtual bool hasSources () const
virtual bool hasBriefDescription () const
virtual QCString id () const
virtual const SectionRefsgetSectionRefs () const
virtual void setName (const QCString &name)
virtual void setId (const QCString &name)
virtual void setDefFile (const QCString &df, int defLine, int defColumn)
virtual void setDocumentation (const QCString &doc, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE)
virtual void setBriefDescription (const QCString &brief, const QCString &briefFile, int briefLine)
virtual void setInbodyDocumentation (const QCString &doc, const QCString &docFile, int docLine)
virtual void setReference (const QCString &r)
virtual void addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList)
virtual void setBodySegment (int defLine, int bls, int ble)
virtual void setBodyDef (const FileDef *fd)
virtual void addSourceReferencedBy (const MemberDef *md)
virtual void addSourceReferences (const MemberDef *md)
virtual void setRefItems (const RefItemVector &sli)
virtual void mergeRefItems (Definition *def)
virtual void mergeReferences (const Definition *other)
virtual void mergeReferencedBy (const Definition *other)
virtual void setOuterScope (Definition *def)
virtual void setHidden (bool b)
virtual void setArtificial (bool b)
virtual void setLanguage (SrcLangExt lang)
virtual void writeSourceDef (OutputList &ol, const QCString &scopeName) const
virtual void writeInlineCode (OutputList &ol, const QCString &scopeName) const
virtual bool hasSourceRefs () const
virtual bool hasSourceReffedBy () const
virtual void writeSourceRefs (OutputList &ol, const QCString &scopeName) const
virtual void writeSourceReffedBy (OutputList &ol, const QCString &scopeName) const
virtual void makePartOfGroup (const GroupDef *gd)
virtual void writeNavigationPath (OutputList &ol) const
virtual QCString navigationPathAsString () const
virtual void writeQuickMemberLinks (OutputList &ol, const MemberDef *md) const
virtual void writeSummaryLinks (OutputList &ol) const
virtual QCString pathFragment () const
virtual void writeDocAnchorsToTagFile (TextStream &fs) const
virtual void setLocalName (const QCString &name)
virtual void addSectionsToIndex ()
virtual void writeToc (OutputList &ol, const LocalToc &lt) const
virtual void computeTooltip ()
virtual void _setSymbolName (const QCString &name)
virtual QCString _symbolName () const

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
- Protected Member Functions inherited from DefinitionMixin< PageDef >
 DefinitionMixin (const DefinitionMixin &def)=default

Member Function Documentation

◆ anchor()

virtual QCString PageDefImpl::anchor ( ) const

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

Implements PageDef.

◆ codeSymbolType()

virtual CodeSymbolType PageDefImpl::codeSymbolType ( ) const

Used for syntax highlighting symbol class

Implements Definition.

◆ definitionType()

virtual DefType PageDefImpl::definitionType ( ) const

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

Implements PageDef.

◆ displayName()

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

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

Implements PageDef.

◆ getOutputFileBase()

QCString PageDefImpl::getOutputFileBase ( ) const

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

Implements PageDef.

◆ isLinkable()

virtual bool PageDefImpl::isLinkable ( ) const

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

◆ isLinkableInProject()

virtual bool PageDefImpl::isLinkableInProject ( ) const

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

Implements PageDef.

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