A model of a page symbol. 更多...

#include <pagedef.h>

类 PageDef 继承关系图:

PageDef 的协作图:

Public 成员函数
virtual	~PageDef ()

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 DefType	definitionType () const =0

virtual bool	isLinkableInProject () const =0

virtual bool	isLinkable () const =0

virtual QCString	getOutputFileBase () const =0

virtual QCString	anchor () const =0

virtual void	findSectionsInDocumentation ()=0

virtual QCString	title () const =0

virtual const GroupDef *	getGroupDef () const =0

virtual const PageLinkedRefMap &	getSubPages () const =0

virtual void	addInnerCompound (const Definition *)=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 QCString	displayName (bool=TRUE) 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

Public 成员函数继承自 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	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	writeQuickMemberLinks (OutputList &, const MemberDef *) const =0

virtual void	writeSummaryLinks (OutputList &) const =0

virtual void	writeDocAnchorsToTagFile (TextStream &) const =0

virtual void	writeToc (OutputList &ol, const LocalToc &lt) const =0

virtual	~DefinitionMutable ()=default

Public 成员函数继承自 Definition
virtual CodeSymbolType	codeSymbolType () 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 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

virtual	~Definition ()=default

额外继承的成员函数
Public 类型继承自 Definition
enum	DefType { TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeMember = 3, TypeGroup = 4, TypePackage = 5, TypePage = 6, TypeDir = 7, TypeConcept = 8 }

详细描述

A model of a page symbol.

在文件 pagedef.h 第 25 行定义.

构造及析构函数说明

◆ ~PageDef()

virtual PageDef::~PageDef ( )

inlinevirtual

在文件 pagedef.h 第 28 行定义.

28 {}

成员函数说明

◆ addInnerCompound()

virtual void PageDef::addInnerCompound ( const Definition * )

pure virtual

实现了 DefinitionMutable.

在 DefinitionMixin< PageDef > , 以及 PageDefImpl 内被实现.

被这些函数引用 computePageRelations().

◆ anchor()

virtual QCString PageDef::anchor ( ) const

pure virtual

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

实现了 Definition.

在 PageDefImpl 内被实现.

◆ definitionType()

virtual DefType PageDef::definitionType ( ) const

pure virtual

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

实现了 Definition.

在 PageDefImpl 内被实现.

◆ displayName()

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

pure virtual

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

实现了 Definition.

在 PageDefImpl 内被实现.

◆ documentedPage()

virtual bool PageDef::documentedPage ( ) const

pure virtual

在 PageDefImpl 内被实现.

◆ findSectionsInDocumentation()

virtual void PageDef::findSectionsInDocumentation ( )

pure virtual

在 PageDefImpl 内被实现.

◆ getGroupDef()

virtual const GroupDef* PageDef::getGroupDef ( ) const

pure virtual

在 PageDefImpl 内被实现.

被这些函数引用 generateXMLForPage(), resolveLink() , 以及 resolveUserReferences().

◆ getOutputFileBase()

virtual QCString PageDef::getOutputFileBase ( ) const

pure virtual

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

实现了 Definition.

在 PageDefImpl 内被实现.

被这些函数引用 addRelatedPage(), generateXMLForPage() , 以及 writePages().

◆ getPageScope()

virtual Definition* PageDef::getPageScope ( ) const

pure virtual

在 PageDefImpl 内被实现.

◆ getSubPages()

virtual const PageLinkedRefMap& PageDef::getSubPages ( ) const

pure virtual

在 PageDefImpl 内被实现.

被这些函数引用 NestingNodeContext::Private::addPages(), generateXMLForPage() , 以及 writePages().

◆ hasParentPage()

virtual bool PageDef::hasParentPage ( ) const

pure virtual

在 PageDefImpl 内被实现.

被这些函数引用 DocRef::DocRef() , 以及 DocSecRefItem::parse().

◆ hasSubPages()

virtual bool PageDef::hasSubPages ( ) const

pure virtual

在 PageDefImpl 内被实现.

被这些函数引用 writePages().

◆ hasTitle()

virtual bool PageDef::hasTitle ( ) const

pure virtual

在 PageDefImpl 内被实现.

◆ isLinkable()

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

实现了 Definition.

在 PageDefImpl 内被实现.

◆ isLinkableInProject()

virtual bool PageDef::isLinkableInProject ( ) const

pure virtual

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

实现了 Definition.

在 PageDefImpl 内被实现.

◆ localToc()

virtual LocalToc PageDef::localToc ( ) const

pure virtual

在 PageDefImpl 内被实现.

被这些函数引用 generateXMLForPage().

◆ setFileName()

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

pure virtual

在 PageDefImpl 内被实现.

被这些函数引用 addRelatedPage() , 以及 buildExampleList().

◆ setLocalToc()

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

pure virtual

在 PageDefImpl 内被实现.

被这些函数引用 addRelatedPage().

◆ setNestingLevel()

virtual void PageDef::setNestingLevel ( int )

pure virtual

在 PageDefImpl 内被实现.

被这些函数引用 PageDefImpl::addInnerCompound() , 以及 addRelatedPage().

◆ setPageScope()

virtual void PageDef::setPageScope ( Definition * )

pure virtual

在 PageDefImpl 内被实现.

被这些函数引用 addPageToContext() , 以及 addRelatedPage().

◆ setShowLineNo()

virtual void PageDef::setShowLineNo ( bool )

pure virtual

在 PageDefImpl 内被实现.

被这些函数引用 addRelatedPage() , 以及 buildExampleList().

◆ setTitle()

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

pure virtual

在 PageDefImpl 内被实现.

被这些函数引用 addRelatedPage().

◆ showLineNo()

virtual bool PageDef::showLineNo ( ) const

pure virtual

在 PageDefImpl 内被实现.

◆ title()

virtual QCString PageDef::title ( ) const

pure virtual

在 PageDefImpl 内被实现.

◆ visibleInIndex()

virtual bool PageDef::visibleInIndex ( ) const

pure virtual

在 PageDefImpl 内被实现.

被这些函数引用 writePages().

◆ writeDocumentation()

virtual void PageDef::writeDocumentation ( OutputList & )

pure virtual

在 PageDefImpl 内被实现.

◆ writePageDocumentation()

virtual void PageDef::writePageDocumentation ( OutputList & ) const

pure virtual

在 PageDefImpl 内被实现.

◆ writeTagFile()

virtual void PageDef::writeTagFile ( TextStream & )

pure virtual

在 PageDefImpl 内被实现.

该类的文档由以下文件生成:

src/pagedef.h

Public 成员函数

额外继承的成员函数

详细描述

构造及析构函数说明

◆ ~PageDef()

成员函数说明

◆ addInnerCompound()

◆ anchor()

◆ definitionType()

◆ displayName()

◆ documentedPage()

◆ findSectionsInDocumentation()

◆ getGroupDef()

◆ getOutputFileBase()

◆ getPageScope()

◆ getSubPages()

◆ hasParentPage()

◆ hasSubPages()

◆ hasTitle()

◆ isLinkable()

◆ isLinkableInProject()

◆ localToc()

◆ setFileName()

◆ setLocalToc()

◆ setNestingLevel()

◆ setPageScope()

◆ setShowLineNo()

◆ setTitle()

◆ showLineNo()

◆ title()

◆ visibleInIndex()

◆ writeDocumentation()

◆ writePageDocumentation()

◆ writeTagFile()