PageDef Class Reference

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 DString &name)=0
virtual void	setLocalToc (const LocalToc &tl)=0
virtual void	setShowLineNo (bool)=0
virtual void	setTitle (const DString &title)=0
virtual void	findSectionsInDocumentation ()=0
virtual DString	title () const =0
virtual DString	titleAsText () 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
virtual void	addListReferences ()=0
virtual void	addRequirementReferences ()=0
Public Member Functions inherited from DefinitionMutable
virtual void	setName (const DString &name)=0
virtual void	setId (const DString &name)=0
virtual void	setDefFile (const DString &df, int defLine, size_t defColumn)=0
virtual void	setDocumentation (const DString &d, const DString &docFile, int docLine, bool stripWhiteSpace=true)=0
virtual void	setBriefDescription (const DString &b, const DString &briefFile, int briefLine)=0
virtual void	setInbodyDocumentation (const DString &d, const DString &docFile, int docLine)=0
virtual void	setReference (const DString &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	setRequirementReferences (const RequirementRefs &rqli)=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 DString &name)=0
virtual void	makePartOfGroup (GroupDef *gd)=0
virtual void	addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList)=0
virtual void	addSourceReferencedBy (MemberDef *d, const DString &sourceRefName)=0
virtual void	addSourceReferences (MemberDef *d, const DString &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 DString &scopeName) const =0
virtual bool	hasSourceRefs () const =0
virtual bool	hasSourceReffedBy () const =0
virtual void	writeSourceRefs (OutputList &ol, const DString &scopeName) const =0
virtual void	writeSourceReffedBy (OutputList &ol, const DString &scopeName) const =0
virtual bool	hasRequirementRefs () const =0
virtual void	writeRequirementRefs (OutputList &ol) 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 DString &	name () const =0
virtual bool	isAnonymous () const =0
virtual DString	displayName (bool includeScope=true) const =0
virtual const DString &	localName () const =0
virtual DString	qualifiedName () const =0
virtual DString	symbolName () const =0
virtual DString	getOutputFileBase () const =0
virtual DString	anchor () const =0
virtual DString	getSourceFileBase () const =0
virtual DString	getSourceAnchor () const =0
virtual DString	documentation () const =0
virtual int	docLine () const =0
virtual DString	docFile () const =0
virtual DString	briefDescription (bool abbreviate=false) const =0
virtual DString	briefDescriptionAsTooltip () const =0
virtual int	briefLine () const =0
virtual DString	briefFile () const =0
virtual DString	inbodyDocumentation () const =0
virtual DString	inbodyFile () const =0
virtual int	inbodyLine () const =0
virtual DString	getDefFileName () const =0
virtual DString	getDefFileExtension () const =0
virtual int	getDefLine () const =0
virtual size_t	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 DString	getReference () const =0
virtual bool	isReference () const =0
virtual DString	externalReference (const DString &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 RequirementRefs &	requirementReferences () const =0
virtual const Definition *	findInnerCompound (const DString &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 DString	id () const =0
virtual const SectionRefs &	getSectionRefs () const =0
	returns the section dictionary, only of importance for pagedef
virtual DString	navigationPathAsString () const =0
virtual DString	pathFragment () const =0
virtual void	_setSymbolName (const DString &name)=0
virtual DString	_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 26 of file pagedef.h.

Member Function Documentation

addListReferences()

virtual void PageDef::addListReferences ( )

pure virtual

Implemented in PageDefImpl.

References addListReferences().

Referenced by addListReferences().

addRequirementReferences()

virtual void PageDef::addRequirementReferences ( )

pure virtual

Implemented in PageDefImpl.

References addRelatedPage(), addRequirementReferences(), createPageDef(), Definition::docLine(), Definition::name(), and toPageDef().

Referenced by addRequirementReferences().

addSectionsToIndex()

virtual void PageDef::addSectionsToIndex ( )

pure virtual

Implemented in PageDefImpl.

References addSectionsToIndex().

Referenced by addSectionsToIndex().

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(), and getSubPages().

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().

hasTitle()

virtual bool PageDef::hasTitle ( ) const

pure virtual

Implemented in PageDefImpl.

References hasTitle().

Referenced by addRelatedPage(), hasTitle(), DefinitionImpl::navigationPathAsString(), DefinitionImpl::pathFragment(), 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 DString & 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 DString & 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 DString PageDef::title ( ) const

pure virtual

Implemented in PageDefImpl.

References title().

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

titleAsText()

virtual DString PageDef::titleAsText ( ) const

pure virtual

Implemented in PageDefImpl.

References titleAsText().

Referenced by titleAsText().

visibleInIndex()

virtual bool PageDef::visibleInIndex ( ) const

pure virtual

Implemented in PageDefImpl.

References visibleInIndex().

Referenced by visibleInIndex().

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:

• src/pagedef.h