Doxygen
Loading...
Searching...
No Matches
PageDef Class Referenceabstract

A model of a page symbol. More...

#include <src/pagedef.h>

Inheritance diagram for PageDef:
Collaboration diagram for PageDef:

Public Member Functions

virtual void setFileName (const QCString &name)=0
virtual void setLocalToc (const LocalToc &tl)=0
virtual void setShowLineNo (bool)=0
virtual void setTitle (const QCString &title)=0
virtual void findSectionsInDocumentation ()=0
virtual QCString title () const =0
virtual const GroupDef * getGroupDef () const =0
virtual const PageLinkedRefMap & getSubPages () const =0
virtual bool visibleInIndex () const =0
virtual bool documentedPage () const =0
virtual bool hasSubPages () const =0
virtual bool hasParentPage () const =0
virtual bool hasTitle () const =0
virtual LocalToc localToc () const =0
virtual void setPageScope (Definition *)=0
virtual Definition * getPageScope () const =0
virtual bool showLineNo () const =0
virtual void writeDocumentation (OutputList &)=0
virtual void writeTagFile (TextStream &)=0
virtual void setNestingLevel (int)=0
virtual void writePageDocumentation (OutputList &) const =0
virtual void addSectionsToIndex ()=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 setExported (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 (const std::vector< const SectionInfo * > &anchorList)=0
virtual void addSourceReferencedBy (MemberDef *d, const QCString &sourceRefName)=0
virtual void addSourceReferences (MemberDef *d, const QCString &sourceRefName)=0
virtual void mergeRefItems (Definition *d)=0
virtual void addInnerCompound (Definition *d)=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 =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 writeQuickMemberLinks (OutputList &, const MemberDef *) const =0
virtual void writeSummaryLinks (OutputList &) const =0
virtual void writePageNavigation (OutputList &) 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 DefType definitionType () const =0
virtual CodeSymbolType codeSymbolType () const =0
virtual bool isAlias () const =0
virtual const QCString & name () const =0
virtual bool isAnonymous () const =0
virtual QCString displayName (bool includeScope=TRUE) const =0
virtual const QCString & localName () const =0
virtual QCString qualifiedName () const =0
virtual QCString symbolName () const =0
virtual QCString getOutputFileBase () const =0
virtual QCString anchor () 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 isLinkableInProject () const =0
virtual bool isLinkable () const =0
virtual bool isVisibleInProject () const =0
virtual bool isVisible () const =0
virtual bool isHidden () const =0
virtual bool isArtificial () const =0
virtual bool isExported () 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 FileDef * getBodyDef () const =0
virtual SrcLangExt getLanguage () const =0
 Returns the programming language this definition was written in.
virtual const GroupList & partOfGroups () const =0
virtual bool isLinkableViaGroup () const =0
virtual const RefItemVector & xrefListItems () const =0
virtual const Definition * findInnerCompound (const QCString &name) const =0
virtual Definition * getOuterScope () const =0
virtual const MemberVector & getReferencesMembers () const =0
virtual const MemberVector & 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 _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 , TypeModule = 3 ,
  TypeMember = 4 , TypeGroup = 5 , TypePackage = 6 , TypePage = 7 ,
  TypeDir = 8 , TypeConcept = 9
}

Detailed Description

A model of a page symbol.

Definition at line 25 of file pagedef.h.

Member Function Documentation

◆ addSectionsToIndex()

virtual void PageDef::addSectionsToIndex ( )
pure virtual

Implemented in PageDefImpl.

References addSectionsToIndex(), createPageDef(), and toPageDef().

Referenced by addSectionsToIndex(), and writePages().

◆ documentedPage()

virtual bool PageDef::documentedPage ( ) const
pure virtual

Implemented in PageDefImpl.

References documentedPage().

Referenced by documentedPage().

◆ findSectionsInDocumentation()

virtual void PageDef::findSectionsInDocumentation ( )
pure virtual

Implemented in PageDefImpl.

References findSectionsInDocumentation().

Referenced by findSectionsInDocumentation().

◆ getGroupDef()

virtual const GroupDef * PageDef::getGroupDef ( ) const
pure virtual

Implemented in PageDefImpl.

References getGroupDef().

Referenced by generateSqlite3ForPage(), generateXMLForPage(), getGroupDef(), resolveLink(), and resolveUserReferences().

◆ getPageScope()

virtual Definition * PageDef::getPageScope ( ) const
pure virtual

Implemented in PageDefImpl.

References getPageScope().

Referenced by getPageScope().

◆ getSubPages()

virtual const PageLinkedRefMap & PageDef::getSubPages ( ) const
pure virtual

Implemented in PageDefImpl.

References getSubPages().

Referenced by generateSqlite3ForPage(), generateXMLForPage(), getSubPages(), and writePages().

◆ hasParentPage()

virtual bool PageDef::hasParentPage ( ) const
pure virtual

Implemented in PageDefImpl.

References hasParentPage().

Referenced by DocRef::DocRef(), hasParentPage(), DocSecRefItem::parse(), and PageDefImpl::writeDocumentation().

◆ hasSubPages()

virtual bool PageDef::hasSubPages ( ) const
pure virtual

Implemented in PageDefImpl.

References hasSubPages().

Referenced by hasSubPages(), and writePages().

◆ hasTitle()

virtual bool PageDef::hasTitle ( ) const
pure virtual

Implemented in PageDefImpl.

References hasTitle().

Referenced by addRelatedPage(), hasTitle(), SearchIndex::setCurrentDoc(), and SearchIndexExternal::setCurrentDoc().

◆ localToc()

virtual LocalToc PageDef::localToc ( ) const
pure virtual

Implemented in PageDefImpl.

References localToc().

Referenced by generateXMLForPage(), and localToc().

◆ setFileName()

virtual void PageDef::setFileName ( const QCString & name)
pure virtual

Implemented in PageDefImpl.

References Definition::name(), and setFileName().

Referenced by addRelatedPage(), buildExampleList(), and setFileName().

◆ setLocalToc()

virtual void PageDef::setLocalToc ( const LocalToc & tl)
pure virtual

Implemented in PageDefImpl.

References setLocalToc().

Referenced by addRelatedPage(), and setLocalToc().

◆ setNestingLevel()

virtual void PageDef::setNestingLevel ( int )
pure virtual

Implemented in PageDefImpl.

References setNestingLevel().

Referenced by PageDefImpl::addInnerCompound(), addRelatedPage(), and setNestingLevel().

◆ setPageScope()

virtual void PageDef::setPageScope ( Definition * )
pure virtual

Implemented in PageDefImpl.

References setPageScope().

Referenced by addPageToContext(), addRelatedPage(), and setPageScope().

◆ setShowLineNo()

virtual void PageDef::setShowLineNo ( bool )
pure virtual

Implemented in PageDefImpl.

References setShowLineNo().

Referenced by addRelatedPage(), buildExampleList(), and setShowLineNo().

◆ setTitle()

virtual void PageDef::setTitle ( const QCString & title)
pure virtual

Implemented in PageDefImpl.

References setTitle(), and title().

Referenced by addRelatedPage(), and setTitle().

◆ showLineNo()

virtual bool PageDef::showLineNo ( ) const
pure virtual

Implemented in PageDefImpl.

References showLineNo().

Referenced by showLineNo().

◆ title()

virtual QCString PageDef::title ( ) const
pure virtual

Implemented in PageDefImpl.

References title().

Referenced by addRelatedPage(), generateSqlite3ForPage(), generateXMLForPage(), DefinitionImpl::pathFragment(), SearchIndex::setCurrentDoc(), SearchIndexExternal::setCurrentDoc(), setTitle(), title(), and writePages().

◆ visibleInIndex()

virtual bool PageDef::visibleInIndex ( ) const
pure virtual

Implemented in PageDefImpl.

References visibleInIndex().

Referenced by visibleInIndex(), and writePages().

◆ writeDocumentation()

virtual void PageDef::writeDocumentation ( OutputList & )
pure virtual

Implemented in PageDefImpl.

References writeDocumentation().

Referenced by writeDocumentation().

◆ writePageDocumentation()

virtual void PageDef::writePageDocumentation ( OutputList & ) const
pure virtual

Implemented in PageDefImpl.

References writePageDocumentation().

Referenced by writePageDocumentation().

◆ writeTagFile()

virtual void PageDef::writeTagFile ( TextStream & )
pure virtual

Implemented in PageDefImpl.

References writeTagFile().

Referenced by writeTagFile().

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