doxygen  1.8.18
About: Doxygen is a source code documentation generator tool for C++, C, Objective-C, C#, PHP, Java, Python, IDL (diverse flavors), Fortran, VHDL, Tcl, and to some extent D. Different output formats are supported.
  Fossies Dox: doxygen-1.8.18.src.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

PageDef Class Referenceabstract

A model of a page symbol. More...

#include <pagedef.h>

+ Inheritance diagram for PageDef:
+ Collaboration diagram for PageDef:

Public Member Functions

virtual ~PageDef ()
 
virtual void setFileName (const char *name)=0
 
virtual void setLocalToc (const LocalToc &tl)=0
 
virtual void setShowLineNo (bool)=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 GroupDefgetGroupDef () const =0
 
virtual PageSDictgetSubPages () 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 DefinitiongetPageScope () const =0
 
virtual QCString displayName (bool=TRUE) const =0
 
virtual bool showLineNo () const =0
 
virtual void writeDocumentation (OutputList &)=0
 
virtual void writeTagFile (FTextStream &)=0
 
virtual void setNestingLevel (int)=0
 
virtual void writePageDocumentation (OutputList &)=0
 
- Public Member Functions inherited from Definition
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 FileDefgetBodyDef () const =0
 
virtual SrcLangExt getLanguage () const =0
 Returns the programming language this definition was written in. More...
 
virtual GroupListpartOfGroups () const =0
 
virtual bool isLinkableViaGroup () const =0
 
virtual const std::vector< RefItem * > & xrefListItems () const =0
 
virtual DefinitionfindInnerCompound (const char *name) const =0
 
virtual DefinitiongetOuterScope () const =0
 
virtual MemberSDictgetReferencesMembers () const =0
 
virtual MemberSDictgetReferencedByMembers () 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 More...
 
virtual QCString id () const =0
 
virtual const SectionRefsgetSectionRefs () const =0
 returns the section dictionary, only of importance for pagedef More...
 
virtual QCString navigationPathAsString () const =0
 
virtual QCString pathFragment () const =0
 
virtual void setName (const char *name)=0
 
virtual void setId (const char *name)=0
 
virtual void setDefFile (const QCString &df, int defLine, int defColumn)=0
 
virtual void setDocumentation (const char *d, const char *docFile, int docLine, bool stripWhiteSpace=TRUE)=0
 
virtual void setBriefDescription (const char *b, const char *briefFile, int briefLine)=0
 
virtual void setInbodyDocumentation (const char *d, const char *docFile, int docLine)=0
 
virtual void setReference (const char *r)=0
 
virtual void setBodySegment (int defLine, int bls, int ble)=0
 
virtual void setBodyDef (FileDef *fd)=0
 
virtual void setRefItems (const std::vector< RefItem * > &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 (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 writeSourceDef (OutputList &ol, const char *scopeName) const =0
 
virtual void writeInlineCode (OutputList &ol, const char *scopeName) const =0
 
virtual void writeSourceRefs (OutputList &ol, const char *scopeName) const =0
 
virtual void writeSourceReffedBy (OutputList &ol, const char *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 (FTextStream &) const =0
 
virtual void writeToc (OutputList &ol, const LocalToc &lt) const =0
 
virtual void setCookie (Cookie *cookie) const =0
 
virtual Cookiecookie () const =0
 
virtual void _setSymbolName (const QCString &name)=0
 
virtual QCString _symbolName () const =0
 
- Public Member Functions inherited from DefinitionIntf
 DefinitionIntf ()
 
virtual ~DefinitionIntf ()
 

Additional Inherited Members

- Public Types inherited from DefinitionIntf
enum  DefType {
  TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeMember = 3,
  TypeGroup = 4, TypePackage = 5, TypePage = 6, TypeDir = 7,
  TypeSymbolList = 8
}
 

Detailed Description

A model of a page symbol.

Definition at line 29 of file pagedef.h.

Constructor & Destructor Documentation

◆ ~PageDef()

virtual PageDef::~PageDef ( )
inlinevirtual

Definition at line 32 of file pagedef.h.

Member Function Documentation

◆ addInnerCompound()

virtual void PageDef::addInnerCompound ( const Definition )
pure virtual

Implements Definition.

Implemented in PageDefImpl.

Referenced by computePageRelations().

◆ anchor()

virtual QCString PageDef::anchor ( ) const
pure virtual

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

Implements Definition.

Implemented in PageDefImpl.

◆ definitionType()

virtual DefType PageDef::definitionType ( ) const
pure virtual

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

Implements DefinitionIntf.

Implemented in PageDefImpl.

◆ displayName()

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

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

Implements Definition.

Implemented in PageDefImpl.

◆ documentedPage()

virtual bool PageDef::documentedPage ( ) const
pure virtual

Implemented in PageDefImpl.

Referenced by countRelatedPages().

◆ findSectionsInDocumentation()

virtual void PageDef::findSectionsInDocumentation ( )
pure virtual

Implemented in PageDefImpl.

Referenced by findSectionsInDocumentation().

◆ getGroupDef()

◆ getOutputFileBase()

virtual QCString PageDef::getOutputFileBase ( ) const
pure virtual

◆ getPageScope()

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

Implemented in PageDefImpl.

◆ getSubPages()

virtual PageSDict* PageDef::getSubPages ( ) const
pure virtual

◆ hasParentPage()

virtual bool PageDef::hasParentPage ( ) const
pure virtual

Implemented in PageDefImpl.

Referenced by DocRef::DocRef(), and writeIndex().

◆ hasSubPages()

virtual bool PageDef::hasSubPages ( ) const
pure virtual

Implemented in PageDefImpl.

Referenced by writeGroupTreeNode(), and writePages().

◆ hasTitle()

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

Implements Definition.

Implemented in PageDefImpl.

Referenced by createJavaScriptSearchIndex().

◆ isLinkableInProject()

virtual bool PageDef::isLinkableInProject ( ) const
pure virtual

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

Implements Definition.

Implemented in PageDefImpl.

Referenced by GroupDefImpl::writeTagFile(), and writeTagFile().

◆ localToc()

virtual LocalToc PageDef::localToc ( ) const
pure virtual

Implemented in PageDefImpl.

Referenced by generateXMLForPage().

◆ setFileName()

virtual void PageDef::setFileName ( const char *  name)
pure virtual

◆ setLocalToc()

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

Implemented in PageDefImpl.

Referenced by addRelatedPage(), and findMainPage().

◆ setNestingLevel()

virtual void PageDef::setNestingLevel ( int  )
pure virtual

Implemented in PageDefImpl.

Referenced by PageDefImpl::addInnerCompound().

◆ setPageScope()

virtual void PageDef::setPageScope ( Definition )
pure virtual

Implemented in PageDefImpl.

Referenced by addPageToContext().

◆ setShowLineNo()

virtual void PageDef::setShowLineNo ( bool  )
pure virtual

Implemented in PageDefImpl.

Referenced by buildExampleList().

◆ showLineNo()

virtual bool PageDef::showLineNo ( ) const
pure virtual

Implemented in PageDefImpl.

Referenced by generateExampleDocs().

◆ title()

◆ visibleInIndex()

virtual bool PageDef::visibleInIndex ( ) const
pure virtual

Implemented in PageDefImpl.

Referenced by countRelatedPages(), and writePages().

◆ writeDocumentation()

virtual void PageDef::writeDocumentation ( OutputList )
pure virtual

Implemented in PageDefImpl.

Referenced by generatePageDocs().

◆ writePageDocumentation()

virtual void PageDef::writePageDocumentation ( OutputList )
pure virtual

Implemented in PageDefImpl.

Referenced by PageDefImpl::writePageDocumentation().

◆ writeTagFile()

virtual void PageDef::writeTagFile ( FTextStream )
pure virtual

Implemented in PageDefImpl.

Referenced by writeTagFile().


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