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 619 of file types.h.

Member Enumeration Documentation

Type

enum LocalToc::Type

Enumerator
None
Html
Latex
Xml
Docbook
numTocTypes

Definition at line 622 of file types.h.

              {
      None                   = 0, // initial value
      Html                   = 0, // index / also to be used as bit position in mask (1 << Html)
      Latex                  = 1, // ...
      Xml                    = 2, // ...
      Docbook                = 3, // ...
      numTocTypes            = 4  // number of enum values
    };

Member Function Documentation

docbookLevel()

int LocalToc::docbookLevel ( ) const

inlineconstexprnoexcept

Definition at line 662 of file types.h.

{ return m_level[Docbook]; }

References Docbook, and m_level.

Referenced by DefinitionImpl::writeToc().

enableDocbook()

void LocalToc::enableDocbook ( int level )

inlineconstexprnoexcept

Definition at line 647 of file types.h.

    {
      m_mask|=(1<<Docbook);
      m_level[Docbook]=level;
    }

References Docbook, m_level, and m_mask.

enableHtml()

void LocalToc::enableHtml ( int level )

inlineconstexprnoexcept

Definition at line 632 of file types.h.

    {
      m_mask|=(1<<Html);
      m_level[Html]=level;
    }

References Html, m_level, and m_mask.

enableLatex()

void LocalToc::enableLatex ( int level )

inlineconstexprnoexcept

Definition at line 637 of file types.h.

    {
      m_mask|=(1<<Latex);
      m_level[Latex]=level;
    }

References Latex, m_level, and m_mask.

enableXml()

void LocalToc::enableXml ( int level )

inlineconstexprnoexcept

Definition at line 642 of file types.h.

    {
      m_mask|=(1<<Xml);
      m_level[Xml]=level;
    }

References m_level, m_mask, and Xml.

htmlLevel()

int LocalToc::htmlLevel ( ) const

inlineconstexprnoexcept

Definition at line 659 of file types.h.

{ return m_level[Html]; }

References Html, and m_level.

Referenced by DefinitionImpl::writeToc().

isDocbookEnabled()

bool LocalToc::isDocbookEnabled ( ) const

inlineconstexprnoexcept

Definition at line 657 of file types.h.

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

References Docbook, and m_mask.

Referenced by DefinitionImpl::writeToc().

isHtmlEnabled()

bool LocalToc::isHtmlEnabled ( ) const

inlineconstexprnoexcept

Definition at line 654 of file types.h.

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

References Html, and m_mask.

Referenced by DefinitionImpl::writeToc().

isLatexEnabled()

bool LocalToc::isLatexEnabled ( ) const

inlineconstexprnoexcept

Definition at line 655 of file types.h.

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

References Latex, and m_mask.

Referenced by DefinitionImpl::writeToc().

isXmlEnabled()

bool LocalToc::isXmlEnabled ( ) const

inlineconstexprnoexcept

Definition at line 656 of file types.h.

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

References m_mask, and Xml.

Referenced by generateXMLForPage().

latexLevel()

int LocalToc::latexLevel ( ) const

inlineconstexprnoexcept

Definition at line 660 of file types.h.

{ return m_level[Latex]; }

References Latex, and m_level.

Referenced by DefinitionImpl::writeToc().

mask()

int LocalToc::mask ( ) const

inlineconstexprnoexcept

Definition at line 663 of file types.h.

{ return m_mask; }

References m_mask.

nothingEnabled()

bool LocalToc::nothingEnabled ( ) const

inlineconstexprnoexcept

Definition at line 658 of file types.h.

{ return m_mask == None; }

References m_mask, and None.

xmlLevel()

int LocalToc::xmlLevel ( ) const

inlineconstexprnoexcept

Definition at line 661 of file types.h.

{ 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 667 of file types.h.

{};

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

m_mask

int LocalToc::m_mask = None

private

Definition at line 666 of file types.h.

Referenced by enableDocbook(), enableHtml(), enableLatex(), enableXml(), isDocbookEnabled(), isHtmlEnabled(), isLatexEnabled(), isXmlEnabled(), mask(), and nothingEnabled().

---

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

• src/types.h