The LocalToc Class Reference

Declaration

class LocalToc { ... }

Included Headers

#include <src/types.h>

Enumerations Index

enum	Type { ... }

Public Constructors Index

	LocalToc ()

Public Member Functions Index

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 Member Attributes Index

int	m_mask
int	m_level[numTocTypes]

Definition at line 579 of file types.h.

Enumerations

Type

enum LocalToc::Type

Enumeration values

None	(= 0)
Html	(= 0)
Latex	(= 1)
Xml	(= 2)
Docbook	(= 3)
numTocTypes	(= 4)

Definition at line 582 of file types.h.

582 enum Type {

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 };

Public Constructors

LocalToc()

LocalToc::LocalToc ()

inline

Definition at line 590 of file types.h.

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

References m_level, m_mask and None.

Public Member Functions

docbookLevel()

int LocalToc::docbookLevel ()

inline

Definition at line 623 of file types.h.

623 int docbookLevel() const { return m_level[Docbook]; }

References Docbook and m_level.

Referenced by DefinitionImpl::writeToc.

enableDocbook()

void LocalToc::enableDocbook (int level)

inline

Definition at line 608 of file types.h.

608 void enableDocbook(int level)

609 {

610 m_mask|=(1<<Docbook);

611 m_level[Docbook]=level;

612 }

References Docbook, m_level and m_mask.

enableHtml()

void LocalToc::enableHtml (int level)

inline

Definition at line 593 of file types.h.

593 void enableHtml(int level)

594 {

595 m_mask|=(1<<Html);

596 m_level[Html]=level;

597 }

References Html, m_level and m_mask.

enableLatex()

void LocalToc::enableLatex (int level)

inline

Definition at line 598 of file types.h.

598 void enableLatex(int level)

599 {

600 m_mask|=(1<<Latex);

601 m_level[Latex]=level;

602 }

References Latex, m_level and m_mask.

enableXml()

void LocalToc::enableXml (int level)

inline

Definition at line 603 of file types.h.

603 void enableXml(int level)

604 {

605 m_mask|=(1<<Xml);

606 m_level[Xml]=level;

607 }

References m_level, m_mask and Xml.

htmlLevel()

int LocalToc::htmlLevel ()

inline

Definition at line 620 of file types.h.

620 int htmlLevel() const { return m_level[Html]; }

References Html and m_level.

Referenced by DefinitionImpl::writeToc.

isDocbookEnabled()

bool LocalToc::isDocbookEnabled ()

inline

Definition at line 618 of file types.h.

618 bool isDocbookEnabled() const { return (m_mask & (1<<Docbook))!=0; }

References Docbook and m_mask.

Referenced by DefinitionImpl::writeToc.

isHtmlEnabled()

bool LocalToc::isHtmlEnabled ()

inline

Definition at line 615 of file types.h.

615 bool isHtmlEnabled() const { return (m_mask & (1<<Html))!=0; }

References Html and m_mask.

Referenced by DefinitionImpl::writeToc.

isLatexEnabled()

bool LocalToc::isLatexEnabled ()

inline

Definition at line 616 of file types.h.

616 bool isLatexEnabled() const { return (m_mask & (1<<Latex))!=0; }

References Latex and m_mask.

Referenced by DefinitionImpl::writeToc.

isXmlEnabled()

bool LocalToc::isXmlEnabled ()

inline

Definition at line 617 of file types.h.

617 bool isXmlEnabled() const { return (m_mask & (1<<Xml))!=0; }

References m_mask and Xml.

Referenced by generateXMLForPage.

latexLevel()

int LocalToc::latexLevel ()

inline

Definition at line 621 of file types.h.

621 int latexLevel() const { return m_level[Latex]; }

References Latex and m_level.

Referenced by DefinitionImpl::writeToc.

mask()

int LocalToc::mask ()

inline

Definition at line 624 of file types.h.

624 int mask() const { return m_mask; }

Reference m_mask.

nothingEnabled()

bool LocalToc::nothingEnabled ()

inline

Definition at line 619 of file types.h.

619 bool nothingEnabled() const { return m_mask == None; }

References m_mask and None.

xmlLevel()

int LocalToc::xmlLevel ()

inline

Definition at line 622 of file types.h.

622 int xmlLevel() const { return m_level[Xml]; }

References m_level and Xml.

Referenced by generateXMLForPage.

Private Member Attributes

m_level

int LocalToc::m_level[numTocTypes]

Definition at line 628 of file types.h.

628 int m_level[numTocTypes];

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

m_mask

int LocalToc::m_mask

Definition at line 627 of file types.h.

627 int m_mask;

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:

• types.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.