LocalToc类 参考

#include <types.h>

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

Public 成员函数
	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 属性
int	m_mask
int	m_level [numTocTypes]

详细描述

在文件 types.h 第 301 行定义.

成员枚举类型说明

Type

enum LocalToc::Type

枚举值
None
Html
Latex
Xml
Docbook
numTocTypes

在文件 types.h 第 304 行定义.

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

构造及析构函数说明

LocalToc()

LocalToc::LocalToc ( )

inline

在文件 types.h 第 312 行定义.

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

引用了 m_level.

成员函数说明

docbookLevel()

int LocalToc::docbookLevel ( ) const

inline

在文件 types.h 第 345 行定义.

{ return m_level[Docbook]; }

引用了 Docbook , 以及 m_level.

被这些函数引用 DefinitionImpl::writeToc().

enableDocbook()

void LocalToc::enableDocbook ( int  level )

inline

在文件 types.h 第 330 行定义.

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

引用了 Docbook, m_level , 以及 m_mask.

enableHtml()

void LocalToc::enableHtml ( int  level )

inline

在文件 types.h 第 315 行定义.

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

引用了 Html, m_level , 以及 m_mask.

enableLatex()

void LocalToc::enableLatex ( int  level )

inline

在文件 types.h 第 320 行定义.

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

引用了 Latex, m_level , 以及 m_mask.

enableXml()

void LocalToc::enableXml ( int  level )

inline

在文件 types.h 第 325 行定义.

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

引用了 m_level, m_mask , 以及 Xml.

htmlLevel()

int LocalToc::htmlLevel ( ) const

inline

在文件 types.h 第 342 行定义.

{ return m_level[Html]; }

引用了 Html , 以及 m_level.

被这些函数引用 DefinitionImpl::writeToc().

isDocbookEnabled()

bool LocalToc::isDocbookEnabled ( ) const

inline

在文件 types.h 第 340 行定义.

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

引用了 Docbook , 以及 m_mask.

被这些函数引用 PageDefImpl::writeDocumentation() , 以及 DefinitionImpl::writeToc().

isHtmlEnabled()

bool LocalToc::isHtmlEnabled ( ) const

inline

在文件 types.h 第 337 行定义.

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

引用了 Html , 以及 m_mask.

被这些函数引用 PageDefImpl::writeDocumentation() , 以及 DefinitionImpl::writeToc().

isLatexEnabled()

bool LocalToc::isLatexEnabled ( ) const

inline

在文件 types.h 第 338 行定义.

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

引用了 Latex , 以及 m_mask.

被这些函数引用 PageDefImpl::writeDocumentation() , 以及 DefinitionImpl::writeToc().

isXmlEnabled()

bool LocalToc::isXmlEnabled ( ) const

inline

在文件 types.h 第 339 行定义.

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

引用了 m_mask , 以及 Xml.

被这些函数引用 generateXMLForPage().

latexLevel()

int LocalToc::latexLevel ( ) const

inline

在文件 types.h 第 343 行定义.

{ return m_level[Latex]; }

引用了 Latex , 以及 m_level.

被这些函数引用 DefinitionImpl::writeToc().

mask()

int LocalToc::mask ( ) const

inline

在文件 types.h 第 346 行定义.

{ return m_mask; }

引用了 m_mask.

nothingEnabled()

bool LocalToc::nothingEnabled ( ) const

inline

在文件 types.h 第 341 行定义.

{ return m_mask == None; }

引用了 m_mask , 以及 None.

xmlLevel()

int LocalToc::xmlLevel ( ) const

inline

在文件 types.h 第 344 行定义.

{ return m_level[Xml]; }

引用了 m_level , 以及 Xml.

被这些函数引用 generateXMLForPage().

类成员变量说明

m_level

int LocalToc::m_level[numTocTypes]

private

在文件 types.h 第 350 行定义.

被这些函数引用 docbookLevel(), enableDocbook(), enableHtml(), enableLatex(), enableXml(), htmlLevel(), latexLevel(), LocalToc() , 以及 xmlLevel().

m_mask

int LocalToc::m_mask

private

在文件 types.h 第 349 行定义.

被这些函数引用 enableDocbook(), enableHtml(), enableLatex(), enableXml(), isDocbookEnabled(), isHtmlEnabled(), isLatexEnabled(), isXmlEnabled(), mask() , 以及 nothingEnabled().

---

该类的文档由以下文件生成:

• src/types.h