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

Member Enumeration Documentation

◆ Type

Enumerator
None 
Html 
Latex 
Xml 
Docbook 
numTocTypes 

Definition at line 624 of file types.h.

624 {
625 None = 0, // initial value
626 Html = 0, // index / also to be used as bit position in mask (1 << Html)
627 Latex = 1, // ...
628 Xml = 2, // ...
629 Docbook = 3, // ...
630 numTocTypes = 4 // number of enum values
631 };
@ Xml
Definition types.h:628
@ None
Definition types.h:625
@ Html
Definition types.h:626
@ Docbook
Definition types.h:629
@ Latex
Definition types.h:627
@ numTocTypes
Definition types.h:630

Member Function Documentation

◆ docbookLevel()

int LocalToc::docbookLevel ( ) const
inlineconstexprnoexcept

Definition at line 664 of file types.h.

664{ return m_level[Docbook]; }
int m_level[numTocTypes]
Definition types.h:669

References Docbook, and m_level.

Referenced by DefinitionImpl::writeToc().

◆ enableDocbook()

void LocalToc::enableDocbook ( int level)
inlineconstexprnoexcept

Definition at line 649 of file types.h.

650 {
651 m_mask|=(1<<Docbook);
652 m_level[Docbook]=level;
653 }
int m_mask
Definition types.h:668

References Docbook, m_level, and m_mask.

◆ enableHtml()

void LocalToc::enableHtml ( int level)
inlineconstexprnoexcept

Definition at line 634 of file types.h.

635 {
636 m_mask|=(1<<Html);
637 m_level[Html]=level;
638 }

References Html, m_level, and m_mask.

◆ enableLatex()

void LocalToc::enableLatex ( int level)
inlineconstexprnoexcept

Definition at line 639 of file types.h.

640 {
641 m_mask|=(1<<Latex);
642 m_level[Latex]=level;
643 }

References Latex, m_level, and m_mask.

◆ enableXml()

void LocalToc::enableXml ( int level)
inlineconstexprnoexcept

Definition at line 644 of file types.h.

645 {
646 m_mask|=(1<<Xml);
647 m_level[Xml]=level;
648 }

References m_level, m_mask, and Xml.

◆ htmlLevel()

int LocalToc::htmlLevel ( ) const
inlineconstexprnoexcept

Definition at line 661 of file types.h.

661{ return m_level[Html]; }

References Html, and m_level.

Referenced by DefinitionImpl::writeToc().

◆ isDocbookEnabled()

bool LocalToc::isDocbookEnabled ( ) const
inlineconstexprnoexcept

Definition at line 659 of file types.h.

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

References Docbook, and m_mask.

Referenced by PageDefImpl::writeDocumentation(), and DefinitionImpl::writeToc().

◆ isHtmlEnabled()

bool LocalToc::isHtmlEnabled ( ) const
inlineconstexprnoexcept

Definition at line 656 of file types.h.

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

References Html, and m_mask.

Referenced by PageDefImpl::writeDocumentation(), and DefinitionImpl::writeToc().

◆ isLatexEnabled()

bool LocalToc::isLatexEnabled ( ) const
inlineconstexprnoexcept

Definition at line 657 of file types.h.

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

References Latex, and m_mask.

Referenced by PageDefImpl::writeDocumentation(), and DefinitionImpl::writeToc().

◆ isXmlEnabled()

bool LocalToc::isXmlEnabled ( ) const
inlineconstexprnoexcept

Definition at line 658 of file types.h.

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

References m_mask, and Xml.

Referenced by generateXMLForPage().

◆ latexLevel()

int LocalToc::latexLevel ( ) const
inlineconstexprnoexcept

Definition at line 662 of file types.h.

662{ return m_level[Latex]; }

References Latex, and m_level.

Referenced by DefinitionImpl::writeToc().

◆ mask()

int LocalToc::mask ( ) const
inlineconstexprnoexcept

Definition at line 665 of file types.h.

665{ return m_mask; }

References m_mask.

◆ nothingEnabled()

bool LocalToc::nothingEnabled ( ) const
inlineconstexprnoexcept

Definition at line 660 of file types.h.

660{ return m_mask == None; }

References m_mask, and None.

◆ xmlLevel()

int LocalToc::xmlLevel ( ) const
inlineconstexprnoexcept

Definition at line 663 of file types.h.

663{ return m_level[Xml]; }

References m_level, and Xml.

Referenced by generateXMLForPage().

Member Data Documentation

◆ m_level

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

◆ m_mask

int LocalToc::m_mask = None
private

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