A model of a page symbol. More...
#include <pagedef.h>
Inheritance diagram for PageDef:
Public Member Functions | |
| PageDef (const char *f, int l, const char *n, const char *d, const char *t) | |
| void | setFileName (const char *name) |
| void | setShowToc (bool b) |
| DefType | definitionType () const |
| bool | isLinkableInProject () const |
| bool | isLinkable () const |
| QCString | getOutputFileBase () const |
| QCString | anchor () const |
| void | findSectionsInDocumentation () |
| QCString | title () const |
| GroupDef * | getGroupDef () const |
| PageSDict * | getSubPages () const |
| void | addInnerCompound (Definition *d) |
| bool | visibleInIndex () const |
| bool | documentedPage () const |
| bool | hasSubPages () const |
| bool | hasParentPage () const |
| bool | showToc () const |
| void | setPageScope (Definition *d) |
| Definition * | getPageScope () const |
| QCString | displayName (bool=TRUE) const |
| void | writeDocumentation (OutputList &ol) |
| void | writeTagFile (FTextStream &) |
 Public Member Functions inherited from Definition | |
| Definition (const char *defFileName, int defLine, int defColumn, const char *name, const char *b=0, const char *d=0, bool isSymbol=TRUE) | |
| virtual | ~Definition () |
| const QCString & | name () const |
| QCString | localName () const |
| virtual QCString | qualifiedName () const |
| QCString | symbolName () const |
| virtual QCString | getSourceFileBase () const |
| virtual QCString | getSourceAnchor () const |
| virtual QCString | documentation () const |
| int | docLine () const |
| QCString | docFile () const |
| virtual QCString | briefDescription (bool abbreviate=FALSE) const |
| QCString | briefDescriptionAsTooltip () const |
| int | briefLine () const |
| QCString | inbodyDocumentation () const |
| QCString | inbodyFile () const |
| int | inbodyLine () const |
| QCString | briefFile () const |
| QCString | getDefFileName () const |
| QCString | getDefFileExtension () const |
| int | getDefLine () const |
| int | getDefColumn () const |
| virtual bool | hasDocumentation () const |
| virtual bool | hasUserDocumentation () const |
| virtual bool | isVisibleInProject () const |
| virtual bool | isVisible () const |
| bool | isHidden () const |
| bool | isArtificial () const |
| virtual QCString | getReference () const |
| virtual bool | isReference () const |
| QCString | externalReference (const QCString &relPath) const |
| int | getStartBodyLine () const |
| int | getEndBodyLine () const |
| FileDef * | getBodyDef () const |
| SrcLangExt | getLanguage () const |
| Returns the programming language this definition was written in. More... | |
| GroupList * | partOfGroups () const |
| bool | isLinkableViaGroup () const |
| QList< ListItemInfo > * | xrefListItems () const |
| virtual Definition * | findInnerCompound (const char *name) |
| virtual Definition * | getOuterScope () const |
| MemberSDict * | getReferencesMembers () const |
| MemberSDict * | getReferencedByMembers () const |
| bool | hasSections () const |
| bool | hasSources () const |
| bool | hasBriefDescription () const |
| returns TRUE if this class has a brief description | |
| QCString | id () const |
| virtual void | setName (const char *name) |
| void | setId (const char *name) |
| virtual void | setDocumentation (const char *d, const char *docFile, int docLine, bool stripWhiteSpace=TRUE) |
| virtual void | setBriefDescription (const char *b, const char *briefFile, int briefLine) |
| virtual void | setInbodyDocumentation (const char *d, const char *docFile, int docLine) |
| void | setReference (const char *r) |
| void | addSectionsToDefinition (QList< SectionInfo > *anchorList) |
| void | setBodySegment (int bls, int ble) |
| void | setBodyDef (FileDef *fd) |
| void | addSourceReferencedBy (MemberDef *d) |
| void | addSourceReferences (MemberDef *d) |
| void | setRefItems (const QList< ListItemInfo > *sli) |
| void | mergeRefItems (Definition *d) |
| virtual void | setOuterScope (Definition *d) |
| virtual void | setHidden (bool b) |
| void | setArtificial (bool b) |
| void | setLanguage (SrcLangExt lang) |
| void | writeSourceDef (OutputList &ol, const char *scopeName) |
| void | writeInlineCode (OutputList &ol, const char *scopeName) |
| void | writeSourceRefs (OutputList &ol, const char *scopeName) |
| void | writeSourceReffedBy (OutputList &ol, const char *scopeName) |
| void | makePartOfGroup (GroupDef *gd) |
| void | writeNavigationPath (OutputList &ol) const |
| QCString | navigationPathAsString () const |
| virtual void | writeQuickMemberLinks (OutputList &, MemberDef *) const |
| virtual void | writeSummaryLinks (OutputList &) |
| QCString | pathFragment () const |
| void | writeDocAnchorsToTagFile (FTextStream &) |
| void | setLocalName (const QCString name) |
| void | addSectionsToIndex () |
| void | writeToc (OutputList &ol) |
| void | setCookie (Cookie *cookie) |
| Cookie * | cookie () const |
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 } |
| Protected Member Functions inherited from Definition | |
| Definition (const Definition &d) | |
Detailed Description
A model of a page symbol.
Member Function Documentation
§ anchor()
|
inlinevirtual |
Returns the anchor within a page where this item can be found
Implements Definition.
§ definitionType()
|
inlinevirtual |
Use this for dynamic inspection of the type of the derived class
Implements DefinitionIntf.
§ displayName()
|
inlinevirtual |
Returns the name of the definition as it appears in the output
Implements Definition.
§ getOutputFileBase()
|
virtual |
Returns the base file name (without extension) of this definition. as it is referenced to/written to disk.
Implements Definition.
§ isLinkable()
|
inlinevirtual |
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.
§ isLinkableInProject()
|
inlinevirtual |
Returns TRUE iff it is possible to link to this item within this project.
Implements Definition.
The documentation for this class was generated from the following files:
- src/pagedef.h
- src/pagedef.cpp
