Skip to main content

The SectionType Class Reference

Declaration​

class SectionType { ... }

Included Headers​

#include <src/section.h>

Public Constructors Index​

constexprSectionType ()
constexprSectionType (int lvl)

Public Member Functions Index​

constexpr intlevel () const
constexpr boolisSection () const

Private Member Attributes Index​

intm_level

Public Static Attributes Index​

static constexpr intPage = 0
static constexpr intMinLevel = 1
static constexpr intSection = 1
static constexpr intSubsection = 2
static constexpr intSubsubsection = 3
static constexpr intParagraph = 4
static constexpr intSubparagraph = 5
static constexpr intSubsubparagraph = 6
static constexpr intMaxLevel = 6
static constexpr intAnchor = 7
static constexpr intTable = 8

Definition at line 28 of file section.h.

Public Constructors​

SectionType()​

SectionType::SectionType ()
 inline constexpr

Definition at line 43 of file section.h.

43 constexpr SectionType() : m_level(0) {}

Reference m_level.

SectionType()​

SectionType::SectionType (int lvl)
 inline constexpr

Definition at line 44 of file section.h.

44 constexpr SectionType(int lvl) : m_level(lvl) {}

Reference m_level.

Public Member Functions​

isSection()​

bool SectionType::isSection ()
 inline constexpr

Definition at line 46 of file section.h.

46 constexpr bool isSection() const
47 {
48 return m_level>=SectionType::MinLevel && m_level<=SectionType::MaxLevel;
49 }

References m_level, MaxLevel and MinLevel.

Referenced by PageDefImpl::addSectionsToIndex, DefinitionImpl::hasSections and DefinitionImpl::writeToc.

level()​

int SectionType::level ()
 inline constexpr

Definition at line 45 of file section.h.

45 constexpr int level() const { return m_level; }

Reference m_level.

Referenced by PageDefImpl::addSectionsToIndex, DocRef::DocRef, LatexDocVisitor::endLink and DocSecRefItem::parse.

Private Member Attributes​

m_level​

int SectionType::m_level

Definition at line 52 of file section.h.

52 int m_level;

Referenced by isSection, level, SectionType and SectionType.

Public Static Attributes​

Anchor​

int SectionType::Anchor = 7
 constexpr static

Definition at line 40 of file section.h.

40 static constexpr int Anchor = 7;

Referenced by addAnchor, anonymous{tagreader.cpp}::TagFileParser::addDocAnchors, addXRefItem, anonymous{tagreader.cpp}::TagFileParser::buildLists, DocRef::DocRef, DocSecRefItem::parse and sectionLevelToType.

MaxLevel​

int SectionType::MaxLevel = 6
 constexpr static

Definition at line 39 of file section.h.

39 static constexpr int MaxLevel = 6;

Referenced by handleSection, handleToc, Markdown::Private::isAtxHeader, isSection, RTFDocVisitor::operator(), parseIncludeOptions, Markdown::Private::processLink, sectionLevelToType and RTFGenerator::startSection.

MinLevel​

int SectionType::MinLevel = 1
 constexpr static

Definition at line 32 of file section.h.

32 static constexpr int MinLevel = 1;

Referenced by isSection, RTFDocVisitor::operator(), Markdown::Private::processLink and RTFGenerator::startSection.

Page​

int SectionType::Page = 0
 constexpr static

Definition at line 31 of file section.h.

31 static constexpr int Page = 0;

Referenced by addRelatedPage, DocRef::DocRef, HtmlGenerator::endSection, ManGenerator::endSection, findMainPage, DocSecRefItem::parse, HtmlGenerator::startSection, LatexGenerator::startSection, ManGenerator::startSection and RTFGenerator::startSection.

Paragraph​

int SectionType::Paragraph = 4
 constexpr static

Definition at line 36 of file section.h.

36 static constexpr int Paragraph = 4;

Referenced by HtmlGenerator::endSection, ManGenerator::endSection, handleSection, HtmlGenerator::startSection, LatexGenerator::startSection, ManGenerator::startSection, RTFGenerator::startSection and Markdown::Private::writeOneLineHeaderOrRuler.

Section​

int SectionType::Section = 1
 constexpr static

Definition at line 33 of file section.h.

33 static constexpr int Section = 1;

Referenced by HtmlGenerator::endSection, ManGenerator::endSection, handleSection, HtmlGenerator::startSection, LatexGenerator::startSection, ManGenerator::startSection, RTFGenerator::startSection and Markdown::Private::writeOneLineHeaderOrRuler.

Subparagraph​

int SectionType::Subparagraph = 5
 constexpr static

Definition at line 37 of file section.h.

37 static constexpr int Subparagraph = 5;

Referenced by HtmlGenerator::endSection, ManGenerator::endSection, handleSection, HtmlGenerator::startSection, LatexGenerator::startSection, ManGenerator::startSection, RTFGenerator::startSection and Markdown::Private::writeOneLineHeaderOrRuler.

Subsection​

int SectionType::Subsection = 2
 constexpr static

Definition at line 34 of file section.h.

34 static constexpr int Subsection = 2;

Referenced by HtmlGenerator::endSection, ManGenerator::endSection, handleSection, HtmlGenerator::startSection, LatexGenerator::startSection, ManGenerator::startSection, RTFGenerator::startSection, writeMemberList, Markdown::Private::writeOneLineHeaderOrRuler and GroupDefImpl::writePageDocumentation.

Subsubparagraph​

int SectionType::Subsubparagraph = 6
 constexpr static

Definition at line 38 of file section.h.

38 static constexpr int Subsubparagraph = 6;

Referenced by HtmlGenerator::endSection, ManGenerator::endSection, handleSection, HtmlGenerator::startSection, LatexGenerator::startSection, ManGenerator::startSection, RTFGenerator::startSection and Markdown::Private::writeOneLineHeaderOrRuler.

Subsubsection​

int SectionType::Subsubsection = 3
 constexpr static

Definition at line 35 of file section.h.

35 static constexpr int Subsubsection = 3;

Referenced by HtmlGenerator::endSection, ManGenerator::endSection, handleSection, HtmlGenerator::startSection, LatexGenerator::startSection, ManGenerator::startSection, RTFGenerator::startSection and Markdown::Private::writeOneLineHeaderOrRuler.

Table​

int SectionType::Table = 8
 constexpr static

Definition at line 41 of file section.h.

41 static constexpr int Table = 8;

Referenced by DocRef::DocRef and DocSecRefItem::parse.

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

Generated via doxygen2docusaurus by Doxygen 1.14.0.