Doxygen
Loading...
Searching...
No Matches
LocalToc Class Reference

#include <src/types.h>

Public Types

enum  Type {
  None = 0 , Html = 0 , Latex = 1 , Xml = 2 ,
  Docbook = 3 , numTocTypes = 4
}

Public Member Functions

constexpr void enableHtml (int level) noexcept
constexpr void enableLatex (int level) noexcept
constexpr void enableXml (int level) noexcept
constexpr void enableDocbook (int level) noexcept
constexpr bool isHtmlEnabled () const noexcept
constexpr bool isLatexEnabled () const noexcept
constexpr bool isXmlEnabled () const noexcept
constexpr bool isDocbookEnabled () const noexcept
constexpr bool nothingEnabled () const noexcept
constexpr int htmlLevel () const noexcept
constexpr int latexLevel () const noexcept
constexpr int xmlLevel () const noexcept
constexpr int docbookLevel () const noexcept
constexpr int mask () const noexcept

Private Attributes

int m_mask = None
int m_level [numTocTypes] = {}

Detailed Description

Definition at line 579 of file types.h.

Member Enumeration Documentation

◆ Type

Enumerator
None 
Html 
Latex 
Xml 
Docbook 
numTocTypes 

Definition at line 582 of file types.h.

582 {
583 None = 0, // initial value
584 Html = 0, // index / also to be used as bit position in mask (1 << Html)
585 Latex = 1, // ...
586 Xml = 2, // ...
587 Docbook = 3, // ...
588 numTocTypes = 4 // number of enum values
589 };
@ Xml
Definition types.h:586
@ None
Definition types.h:583
@ Html
Definition types.h:584
@ Docbook
Definition types.h:587
@ Latex
Definition types.h:585
@ numTocTypes
Definition types.h:588

Member Function Documentation

◆ docbookLevel()

int LocalToc::docbookLevel ( ) const
inlineconstexprnoexcept

Definition at line 622 of file types.h.

622{ return m_level[Docbook]; }
int m_level[numTocTypes]
Definition types.h:627

References Docbook, and m_level.

Referenced by DefinitionImpl::writeToc().

◆ enableDocbook()

void LocalToc::enableDocbook ( int level)
inlineconstexprnoexcept

Definition at line 607 of file types.h.

608 {
609 m_mask|=(1<<Docbook);
610 m_level[Docbook]=level;
611 }
int m_mask
Definition types.h:626

References Docbook, m_level, and m_mask.

◆ enableHtml()

void LocalToc::enableHtml ( int level)
inlineconstexprnoexcept

Definition at line 592 of file types.h.

593 {
594 m_mask|=(1<<Html);
595 m_level[Html]=level;
596 }

References Html, m_level, and m_mask.

◆ enableLatex()

void LocalToc::enableLatex ( int level)
inlineconstexprnoexcept

Definition at line 597 of file types.h.

598 {
599 m_mask|=(1<<Latex);
600 m_level[Latex]=level;
601 }

References Latex, m_level, and m_mask.

◆ enableXml()

void LocalToc::enableXml ( int level)
inlineconstexprnoexcept

Definition at line 602 of file types.h.

603 {
604 m_mask|=(1<<Xml);
605 m_level[Xml]=level;
606 }

References m_level, m_mask, and Xml.

◆ htmlLevel()

int LocalToc::htmlLevel ( ) const
inlineconstexprnoexcept

Definition at line 619 of file types.h.

619{ return m_level[Html]; }

References Html, and m_level.

Referenced by DefinitionImpl::writeToc().

◆ isDocbookEnabled()

bool LocalToc::isDocbookEnabled ( ) const
inlineconstexprnoexcept

Definition at line 617 of file types.h.

617{ return (m_mask & (1<<Docbook))!=0; }

References Docbook, and m_mask.

Referenced by DefinitionImpl::writeToc().

◆ isHtmlEnabled()

bool LocalToc::isHtmlEnabled ( ) const
inlineconstexprnoexcept

Definition at line 614 of file types.h.

614{ return (m_mask & (1<<Html))!=0; }

References Html, and m_mask.

Referenced by DefinitionImpl::writeToc().

◆ isLatexEnabled()

bool LocalToc::isLatexEnabled ( ) const
inlineconstexprnoexcept

Definition at line 615 of file types.h.

615{ return (m_mask & (1<<Latex))!=0; }

References Latex, and m_mask.

Referenced by DefinitionImpl::writeToc().

◆ isXmlEnabled()

bool LocalToc::isXmlEnabled ( ) const
inlineconstexprnoexcept

Definition at line 616 of file types.h.

616{ return (m_mask & (1<<Xml))!=0; }

References m_mask, and Xml.

Referenced by generateXMLForPage().

◆ latexLevel()

int LocalToc::latexLevel ( ) const
inlineconstexprnoexcept

Definition at line 620 of file types.h.

620{ return m_level[Latex]; }

References Latex, and m_level.

Referenced by DefinitionImpl::writeToc().

◆ mask()

int LocalToc::mask ( ) const
inlineconstexprnoexcept

Definition at line 623 of file types.h.

623{ return m_mask; }

References m_mask.

◆ nothingEnabled()

bool LocalToc::nothingEnabled ( ) const
inlineconstexprnoexcept

Definition at line 618 of file types.h.

618{ return m_mask == None; }

References m_mask, and None.

◆ xmlLevel()

int LocalToc::xmlLevel ( ) const
inlineconstexprnoexcept

Definition at line 621 of file types.h.

621{ return m_level[Xml]; }

References m_level, and Xml.

Referenced by generateXMLForPage().

Member Data Documentation

◆ m_level

int LocalToc::m_level[numTocTypes] = {}
private

Definition at line 627 of file types.h.

627{};

Referenced by docbookLevel(), enableDocbook(), enableHtml(), enableLatex(), enableXml(), htmlLevel(), latexLevel(), and xmlLevel().

◆ m_mask

int LocalToc::m_mask = None
private

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