The PageDef Class Reference

A model of a page symbol. More...

Declaration

class PageDef { ... }

Included Headers

#include <src/pagedef.h>

Base classes

class	DefinitionMutable
class	Definition
	The common base class of all entity definitions found in the sources. More...

Derived Classes

class	DefinitionMixin<Base>

Public Member Functions Index

void	setFileName (const QCString &name)=0
void	setLocalToc (const LocalToc &tl)=0
void	setShowLineNo (bool)=0
void	setTitle (const QCString &title)=0
void	findSectionsInDocumentation ()=0
QCString	title () const =0
const GroupDef *	getGroupDef () const =0
const PageLinkedRefMap &	getSubPages () const =0
bool	visibleInIndex () const =0
bool	documentedPage () const =0
bool	hasSubPages () const =0
bool	hasParentPage () const =0
bool	hasTitle () const =0
LocalToc	localToc () const =0
void	setPageScope (Definition *)=0
Definition *	getPageScope () const =0
bool	showLineNo () const =0
void	writeDocumentation (OutputList &)=0
void	writeTagFile (TextStream &)=0
void	setNestingLevel (int)=0
void	writePageDocumentation (OutputList &) const =0
void	addSectionsToIndex ()=0

Description

A model of a page symbol.

Definition at line 25 of file pagedef.h.

Public Member Functions

addSectionsToIndex()

virtual void PageDef::addSectionsToIndex ()

Definition at line 55 of file pagedef.h.

References addSectionsToIndex, createPageDef and toPageDef.

Referenced by addSectionsToIndex and writePages.

documentedPage()

virtual bool PageDef::documentedPage ()

Definition at line 42 of file pagedef.h.

Reference documentedPage.

Referenced by documentedPage.

findSectionsInDocumentation()

virtual void PageDef::findSectionsInDocumentation ()

Definition at line 37 of file pagedef.h.

Reference findSectionsInDocumentation.

Referenced by findSectionsInDocumentation.

getGroupDef()

virtual const GroupDef * PageDef::getGroupDef ()

Definition at line 39 of file pagedef.h.

Reference getGroupDef.

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

getPageScope()

virtual Definition * PageDef::getPageScope ()

Definition at line 48 of file pagedef.h.

Reference getPageScope.

Referenced by getPageScope.

getSubPages()

virtual const PageLinkedRefMap & PageDef::getSubPages ()

Definition at line 40 of file pagedef.h.

Reference getSubPages.

Referenced by generateSqlite3ForPage, generateXMLForPage, getSubPages and writePages.

hasParentPage()

virtual bool PageDef::hasParentPage ()

Definition at line 44 of file pagedef.h.

Reference hasParentPage.

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

hasSubPages()

virtual bool PageDef::hasSubPages ()

Definition at line 43 of file pagedef.h.

Reference hasSubPages.

Referenced by hasSubPages and writePages.

hasTitle()

virtual bool PageDef::hasTitle ()

Definition at line 45 of file pagedef.h.

Reference hasTitle.

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

localToc()

virtual LocalToc PageDef::localToc ()

Definition at line 46 of file pagedef.h.

Reference localToc.

Referenced by generateXMLForPage and localToc.

setFileName()

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

Definition at line 31 of file pagedef.h.

References Definition::name and setFileName.

Referenced by addRelatedPage, buildExampleList and setFileName.

setLocalToc()

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

Definition at line 32 of file pagedef.h.

Reference setLocalToc.

Referenced by addRelatedPage and setLocalToc.

setNestingLevel()

virtual void PageDef::setNestingLevel (int)

Definition at line 53 of file pagedef.h.

Reference setNestingLevel.

Referenced by PageDefImpl::addInnerCompound, addRelatedPage and setNestingLevel.

setPageScope()

virtual void PageDef::setPageScope (Definition *)

Definition at line 47 of file pagedef.h.

Reference setPageScope.

Referenced by addPageToContext, addRelatedPage and setPageScope.

setShowLineNo()

virtual void PageDef::setShowLineNo (bool)

Definition at line 33 of file pagedef.h.

Reference setShowLineNo.

Referenced by addRelatedPage, buildExampleList and setShowLineNo.

setTitle()

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

Definition at line 34 of file pagedef.h.

References setTitle and title.

Referenced by addRelatedPage and setTitle.

showLineNo()

virtual bool PageDef::showLineNo ()

Definition at line 49 of file pagedef.h.

Reference showLineNo.

Referenced by showLineNo.

title()

virtual QCString PageDef::title ()

Definition at line 38 of file pagedef.h.

Reference title.

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

visibleInIndex()

virtual bool PageDef::visibleInIndex ()

Definition at line 41 of file pagedef.h.

Reference visibleInIndex.

Referenced by visibleInIndex and writePages.

writeDocumentation()

virtual void PageDef::writeDocumentation (OutputList &)

Definition at line 51 of file pagedef.h.

Reference writeDocumentation.

Referenced by writeDocumentation.

writePageDocumentation()

virtual void PageDef::writePageDocumentation (OutputList &)

Definition at line 54 of file pagedef.h.

Reference writePageDocumentation.

Referenced by writePageDocumentation.

writeTagFile()

virtual void PageDef::writeTagFile (TextStream &)

Definition at line 52 of file pagedef.h.

Reference writeTagFile.

Referenced by writeTagFile.

---

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

• pagedef.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.