The SectionInfo Class Reference

class that provide information about a section. More...

Declaration

class SectionInfo { ... }

Included Headers

#include <src/section.h>

Public Constructors Index

	SectionInfo (const QCString &label, const QCString &fileName, int lineNr, const QCString &title, SectionType type, int level, const QCString &ref)

Public Member Functions Index

QCString	label () const
QCString	title () const
SectionType	type () const
QCString	ref () const
int	lineNr () const
QCString	fileName () const
bool	generated () const
int	level () const
Definition *	definition () const
void	setFileName (const QCString &fn)
void	setType (SectionType t)
void	setGenerated (bool b)
void	setDefinition (Definition *d)
void	setTitle (const QCString &t)
void	setLevel (int l)
void	setReference (const QCString &r)
void	setLineNr (int l)

Private Member Attributes Index

QCString	m_label
QCString	m_title
SectionType	m_type
QCString	m_ref
int	m_lineNr
QCString	m_fileName
bool	m_generated = false
int	m_level
Definition *	m_definition = nullptr

Description

class that provide information about a section.

Definition at line 56 of file section.h.

Public Constructors

SectionInfo()

SectionInfo::SectionInfo (const QCString & label, const QCString & fileName, int lineNr, const QCString & title, SectionType type, int level, const QCString & ref)

inline

Definition at line 59 of file section.h.

59 SectionInfo(const QCString &label, const QCString &fileName, int lineNr,

60 const QCString &title, SectionType type, int level,const QCString &ref) :

61 m_label(label), m_title(title), m_type(type), m_ref(ref),

62 m_lineNr(lineNr), m_fileName(fileName), m_level(level)

63 {

64 //printf("SectionInfo(%p) fileName=%s\n",(void*)this,qPrint(fileName));

65 }

References fileName, label, level, lineNr, m_fileName, m_label, m_level, m_lineNr, m_ref, m_title, m_type, ref, title and type.

Public Member Functions

definition()

Definition * SectionInfo::definition ()

inline

Definition at line 76 of file section.h.

76 Definition *definition() const { return m_definition; }

Reference m_definition.

Referenced by SearchTerm::makeTitle, resolveLink and writeJavasScriptSearchDataPage.

fileName()

QCString SectionInfo::fileName ()

inline

Definition at line 73 of file section.h.

73 QCString fileName() const { return m_fileName; }

Reference m_fileName.

Referenced by SectionManager::add, addAnchor, addRelatedPage, addSection, PageDefImpl::addSectionsToIndex, addXRefItem, DocAnchor::DocAnchor, DocHtmlCaption::DocHtmlCaption, DocRef::DocRef, findMainPage, SearchTerm::makeTitle, DocSecRefItem::parse, DocSection::parse, SectionInfo, DefinitionImpl::writeDocAnchorsToTagFile and writeJavasScriptSearchDataPage.

generated()

bool SectionInfo::generated ()

inline

Definition at line 74 of file section.h.

74 bool generated() const { return m_generated; }

Reference m_generated.

Referenced by DefinitionImpl::writeDocAnchorsToTagFile.

label()

QCString SectionInfo::label ()

inline

Definition at line 68 of file section.h.

68 QCString label() const { return m_label; }

Reference m_label.

Referenced by SectionManager::add, SectionRefs::add, DefinitionImpl::addSectionsToDefinition, PageDefImpl::addSectionsToIndex, DocAnchor::DocAnchor, DocHtmlCaption::DocHtmlCaption, DocRef::DocRef, DocSecRefItem::parse, DocSection::parse, resolveLink, SectionInfo, DocbookGenerator::startTocEntry, HtmlGenerator::startTocEntry, DefinitionImpl::writeDocAnchorsToTagFile, PageDefImpl::writeDocumentation, writeGroupTreeNode, writeJavasScriptSearchDataPage, GroupDefImpl::writePageDocumentation and DefinitionImpl::writeToc.

level()

int SectionInfo::level ()

inline

Definition at line 75 of file section.h.

75 int level() const { return m_level; }

Reference m_level.

Referenced by SectionManager::add and SectionInfo.

lineNr()

int SectionInfo::lineNr ()

inline

Definition at line 72 of file section.h.

72 int lineNr() const { return m_lineNr; }

Reference m_lineNr.

Referenced by SectionManager::add, addAnchor, addRelatedPage, addSection, PageDefImpl::addSectionsToIndex, addXRefItem, findMainPage, SearchTerm::makeTitle, SectionInfo and writeJavasScriptSearchDataPage.

ref()

QCString SectionInfo::ref ()

inline

Definition at line 71 of file section.h.

71 QCString ref() const { return m_ref; }

Reference m_ref.

Referenced by SectionManager::add, addAnchor, addRelatedPage, addSection, addXRefItem, DocRef::DocRef, findMainPage, DocSecRefItem::parse, SectionInfo, DefinitionImpl::writeDocAnchorsToTagFile and writeJavasScriptSearchDataPage.

setDefinition()

void SectionInfo::setDefinition (Definition * d)

inline

Definition at line 82 of file section.h.

82 void setDefinition(Definition *d) { m_definition = d; }

Reference m_definition.

Referenced by DefinitionImpl::addSectionsToDefinition.

setFileName()

void SectionInfo::setFileName (const QCString & fn)

inline

Definition at line 79 of file section.h.

79 void setFileName(const QCString &fn) { m_fileName = fn; }

Reference m_fileName.

Referenced by processSection and SectionManager::replace.

setGenerated()

void SectionInfo::setGenerated (bool b)

inline

Definition at line 81 of file section.h.

81 void setGenerated(bool b) { m_generated = b; }

Reference m_generated.

setLevel()

void SectionInfo::setLevel (int l)

inline

Definition at line 84 of file section.h.

84 void setLevel(int l) { m_level = l; }

Reference m_level.

Referenced by SectionManager::replace.

setLineNr()

void SectionInfo::setLineNr (int l)

inline

Definition at line 86 of file section.h.

86 void setLineNr(int l) { m_lineNr = l; }

Reference m_lineNr.

Referenced by SectionManager::replace.

setReference()

void SectionInfo::setReference (const QCString & r)

inline

Definition at line 85 of file section.h.

85 void setReference(const QCString &r) { m_ref = r; }

Reference m_ref.

Referenced by SectionManager::replace.

setTitle()

void SectionInfo::setTitle (const QCString & t)

inline

Definition at line 83 of file section.h.

83 void setTitle(const QCString &t) { m_title = t; }

Reference m_title.

Referenced by addRelatedPage and SectionManager::replace.

setType()

void SectionInfo::setType (SectionType t)

inline

Definition at line 80 of file section.h.

80 void setType(SectionType t) { m_type = t; }

Reference m_type.

Referenced by processSection and SectionManager::replace.

title()

QCString SectionInfo::title ()

inline

Definition at line 69 of file section.h.

69 QCString title() const { return m_title; }

Reference m_title.

Referenced by SectionManager::add, PageDefImpl::addSectionsToIndex, DocRef::DocRef, PerlModGenerator::generatePerlModForPage, generateSqlite3ForPage, generateXMLForPage, SearchTerm::makeTitle, DocSection::parse, SectionInfo, DefinitionImpl::writeDocAnchorsToTagFile, PageDefImpl::writeDocumentation, writeJavasScriptSearchDataPage, GroupDefImpl::writePageDocumentation and DefinitionImpl::writeToc.

type()

SectionType SectionInfo::type ()

inline

Definition at line 70 of file section.h.

70 SectionType type() const { return m_type; }

Reference m_type.

Referenced by SectionManager::add, PageDefImpl::addSectionsToIndex, DocRef::DocRef, DocbookGenerator::endTocEntry, HtmlGenerator::endTocEntry, DefinitionImpl::hasSections, DocSecRefItem::parse, SectionInfo, DocbookGenerator::startTocEntry, HtmlGenerator::startTocEntry, PageDefImpl::writeDocumentation and DefinitionImpl::writeToc.

Private Member Attributes

m_definition

Definition* SectionInfo::m_definition = nullptr

Definition at line 97 of file section.h.

97 Definition *m_definition = nullptr;

Referenced by definition and setDefinition.

m_fileName

QCString SectionInfo::m_fileName

Definition at line 94 of file section.h.

94 QCString m_fileName;

Referenced by fileName, SectionInfo and setFileName.

m_generated

bool SectionInfo::m_generated = false

Definition at line 95 of file section.h.

95 bool m_generated = false;

Referenced by generated and setGenerated.

m_label

QCString SectionInfo::m_label

Definition at line 89 of file section.h.

89 QCString m_label;

Referenced by label and SectionInfo.

m_level

int SectionInfo::m_level

Definition at line 96 of file section.h.

96 int m_level;

Referenced by level, SectionInfo and setLevel.

m_lineNr

int SectionInfo::m_lineNr

Definition at line 93 of file section.h.

93 int m_lineNr;

Referenced by lineNr, SectionInfo and setLineNr.

m_ref

QCString SectionInfo::m_ref

Definition at line 92 of file section.h.

92 QCString m_ref;

Referenced by ref, SectionInfo and setReference.

m_title

QCString SectionInfo::m_title

Definition at line 90 of file section.h.

90 QCString m_title;

Referenced by SectionInfo, setTitle and title.

m_type

SectionType SectionInfo::m_type

Definition at line 91 of file section.h.

91 SectionType m_type;

Referenced by SectionInfo, setType and type.

---

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

• section.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.