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
	LocalToc ()
void	enableHtml (int level)
void	enableLatex (int level)
void	enableXml (int level)
void	enableDocbook (int level)
bool	isHtmlEnabled () const
bool	isLatexEnabled () const
bool	isXmlEnabled () const
bool	isDocbookEnabled () const
bool	nothingEnabled () const
int	htmlLevel () const
int	latexLevel () const
int	xmlLevel () const
int	docbookLevel () const
int	mask () const

Private Attributes
int	m_mask
int	m_level [numTocTypes]

Detailed Description

Definition at line 417 of file types.h.

Member Enumeration Documentation

Type

enum LocalToc::Type

Enumerator
None
Html
Latex
Xml
Docbook
numTocTypes

Definition at line 420 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
    };

Constructor & Destructor Documentation

LocalToc()

LocalToc::LocalToc ( )

inline

Definition at line 428 of file types.h.

: m_mask(None) { memset(m_level,0,sizeof(m_level)); }

References m_level, m_mask, and None.

Member Function Documentation

docbookLevel()

int LocalToc::docbookLevel ( ) const

inline

Definition at line 461 of file types.h.

{ return m_level[Docbook]; }

References Docbook, and m_level.

Referenced by DocbookGenerator::writeLocalToc().

enableDocbook()

void LocalToc::enableDocbook ( int level )

inline

Definition at line 446 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 )

inline

Definition at line 431 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 )

inline

Definition at line 436 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 )

inline

Definition at line 441 of file types.h.

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

References m_level, m_mask, and Xml.

htmlLevel()

int LocalToc::htmlLevel ( ) const

inline

Definition at line 458 of file types.h.

{ return m_level[Html]; }

References Html, and m_level.

Referenced by HtmlGenerator::writeLocalToc().

isDocbookEnabled()

bool LocalToc::isDocbookEnabled ( ) const

inline

Definition at line 456 of file types.h.

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

References Docbook, and m_mask.

Referenced by DocbookGenerator::writeLocalToc().

isHtmlEnabled()

bool LocalToc::isHtmlEnabled ( ) const

inline

Definition at line 453 of file types.h.

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

References Html, and m_mask.

Referenced by HtmlGenerator::writeLocalToc().

isLatexEnabled()

bool LocalToc::isLatexEnabled ( ) const

inline

Definition at line 454 of file types.h.

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

References Latex, and m_mask.

Referenced by LatexGenerator::writeLocalToc().

isXmlEnabled()

bool LocalToc::isXmlEnabled ( ) const

inline

Definition at line 455 of file types.h.

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

References m_mask, and Xml.

Referenced by generateXMLForPage().

latexLevel()

int LocalToc::latexLevel ( ) const

inline

Definition at line 459 of file types.h.

{ return m_level[Latex]; }

References Latex, and m_level.

Referenced by LatexGenerator::writeLocalToc().

mask()

int LocalToc::mask ( ) const

inline

Definition at line 462 of file types.h.

{ return m_mask; }

References m_mask.

nothingEnabled()

bool LocalToc::nothingEnabled ( ) const

inline

Definition at line 457 of file types.h.

{ return m_mask == None; }

References m_mask, and None.

xmlLevel()

int LocalToc::xmlLevel ( ) const

inline

Definition at line 460 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 466 of file types.h.

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

m_mask

int LocalToc::m_mask

private

Definition at line 465 of file types.h.

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

---

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

• src/types.h