QhpXmlWriter类 参考

#include <qhpxmlwriter.h>

QhpXmlWriter 的协作图:

Public 成员函数
	QhpXmlWriter ()
	~QhpXmlWriter ()
void	setIndentLevel (int level)
void	setCompressionEnabled (bool enabled)
void	insert (QhpXmlWriter const &source)
void	dumpTo (TextStream &file)
void	open (const QCString &elementName, const char *const attributes[]=0)
void	openClose (const QCString &elementName, const char *const attributes[]=0)
void	openCloseContent (const QCString &elementName, const QCString &content)
void	close (const QCString &elementName)
void	declaration (const QCString &version, const QCString &encoding)

Private 成员函数
void	indent ()
void	newLine ()
void	openPureHelper (const QCString &elementName, const char *const attributes[], bool close)
void	openPure (const QCString &elementName, const char *const attributes[]=0)
void	openClosePure (const QCString &elementName, const char *const attributes[]=0)
void	closePure (const QCString &elementName)

Private 属性
TextStream	m_backend
int	m_indentLevel
bool	m_curLineIndented
bool	m_compress

详细描述

在文件 qhpxmlwriter.h 第 23 行定义.

构造及析构函数说明

QhpXmlWriter()

QhpXmlWriter::QhpXmlWriter

(

)

在文件 qhpxmlwriter.cpp 第 21 行定义.

    : m_indentLevel(0), m_curLineIndented(false), m_compress(false)
{
}

~QhpXmlWriter()

QhpXmlWriter::~QhpXmlWriter

(

)

在文件 qhpxmlwriter.cpp 第 26 行定义.

{
}

成员函数说明

close()

void QhpXmlWriter::close

(

const QCString &

elementName

)

在文件 qhpxmlwriter.cpp 第 77 行定义.

{
  m_indentLevel--;
  indent();
  closePure(elementName);
  newLine();
}

引用了 closePure(), indent(), m_indentLevel , 以及 newLine().

被这些函数引用 Qhp::addContentsItem(), Qhp::finalize(), Qhp::initialize() , 以及 openPureHelper().

closePure()

void QhpXmlWriter::closePure ( const QCString &  elementName )

private

在文件 qhpxmlwriter.cpp 第 151 行定义.

{
  m_backend << "</" << elementName << ">";
}

引用了 m_backend.

被这些函数引用 close() , 以及 openCloseContent().

declaration()

void QhpXmlWriter::declaration	(	const QCString &	version,
		const QCString &	encoding
	)

在文件 qhpxmlwriter.cpp 第 85 行定义.

{
  m_backend << "<?xml version=\"" << version << "\" encoding=\"" << encoding << "\"?>";
  newLine();
}

引用了 m_backend, newLine() , 以及 version().

被这些函数引用 Qhp::initialize().

dumpTo()

void QhpXmlWriter::dumpTo

(

TextStream &

file

)

在文件 qhpxmlwriter.cpp 第 45 行定义.

{
  file << m_backend.str();
}

引用了 m_backend , 以及 TextStream::str().

被这些函数引用 Qhp::finalize().

indent()

void QhpXmlWriter::indent ( )

private

在文件 qhpxmlwriter.cpp 第 91 行定义.

{
  if (m_curLineIndented)
  {
    return;
  }
  for (int i = 0; i < m_indentLevel; i++)
  {
    m_backend << "  ";
  }
  m_curLineIndented = true;
}

引用了 m_backend, m_curLineIndented , 以及 m_indentLevel.

被这些函数引用 close(), open(), openClose() , 以及 openCloseContent().

insert()

void QhpXmlWriter::insert

(

QhpXmlWriter const &

source

)

在文件 qhpxmlwriter.cpp 第 40 行定义.

{
  m_backend << source.m_backend.str();
}

引用了 m_backend , 以及 TextStream::str().

被这些函数引用 Qhp::finalize().

newLine()

void QhpXmlWriter::newLine ( )

private

在文件 qhpxmlwriter.cpp 第 104 行定义.

{
  if (!m_compress)
  {
    m_backend << "\n";
    m_curLineIndented = false;
  }
}

引用了 m_backend, m_compress , 以及 m_curLineIndented.

被这些函数引用 close(), declaration(), open(), openClose() , 以及 openCloseContent().

open()

void QhpXmlWriter::open	(	const QCString &	elementName,
		const char *const	attributes[] = 0
	)

在文件 qhpxmlwriter.cpp 第 50 行定义.

{
  indent();
  openPure(elementName, attributes);
  newLine();
  m_indentLevel++;
}

引用了 indent(), m_indentLevel, newLine() , 以及 openPure().

被这些函数引用 Qhp::handlePrevSection() , 以及 Qhp::initialize().

openClose()

void QhpXmlWriter::openClose	(	const QCString &	elementName,
		const char *const	attributes[] = 0
	)

在文件 qhpxmlwriter.cpp 第 59 行定义.

{
  indent();
  openClosePure(elementName, attributes);
  newLine();
}

引用了 indent(), newLine() , 以及 openClosePure().

被这些函数引用 Qhp::addIndexItem() , 以及 Qhp::handlePrevSection().

openCloseContent()

void QhpXmlWriter::openCloseContent	(	const QCString &	elementName,
		const QCString &	content
	)

在文件 qhpxmlwriter.cpp 第 67 行定义.

{
  indent();
  openPure(elementName);
  m_backend << convertToXML(content);
  closePure(elementName);
  newLine();
}

引用了 closePure(), convertToXML(), indent(), m_backend, newLine() , 以及 openPure().

被这些函数引用 Qhp::addFile() , 以及 Qhp::initialize().

openClosePure()

void QhpXmlWriter::openClosePure ( const QCString &  elementName, const char *const  attributes[] = 0  )

private

在文件 qhpxmlwriter.cpp 第 145 行定义.

{
  openPureHelper(elementName, attributes, true);
}

引用了 openPureHelper().

被这些函数引用 openClose().

openPure()

void QhpXmlWriter::openPure ( const QCString &  elementName, const char *const  attributes[] = 0  )

private

在文件 qhpxmlwriter.cpp 第 139 行定义.

{
  openPureHelper(elementName, attributes, false);
}

引用了 openPureHelper().

被这些函数引用 open() , 以及 openCloseContent().

openPureHelper()

void QhpXmlWriter::openPureHelper ( const QCString &  elementName, const char *const  attributes[], bool  close  )

private

在文件 qhpxmlwriter.cpp 第 113 行定义.

{
  m_backend << "<" << elementName;
  if (attributes)
  {
    for (const char * const * walker = attributes;
        walker[0]; walker += 2)
    {
      const char *const key = walker[0];
      const char *const value = walker[1];
      if (!value)
      {
        continue;
      }
      m_backend << " " << key << "=\"" << convertToXML(value) << "\"";
    }
  }
 
  if (close)
  {
    m_backend << " /";
  }
  m_backend << ">";
}

引用了 close(), convertToXML() , 以及 m_backend.

被这些函数引用 openClosePure() , 以及 openPure().

setCompressionEnabled()

void QhpXmlWriter::setCompressionEnabled

(

bool

enabled

)

在文件 qhpxmlwriter.cpp 第 35 行定义.

{
  m_compress = enabled;
}

引用了 m_compress.

setIndentLevel()

void QhpXmlWriter::setIndentLevel

(

int

level

)

在文件 qhpxmlwriter.cpp 第 30 行定义.

{
  m_indentLevel = level;
}

引用了 m_indentLevel.

被这些函数引用 Qhp::Qhp().

类成员变量说明

m_backend

TextStream QhpXmlWriter::m_backend

private

在文件 qhpxmlwriter.h 第 52 行定义.

被这些函数引用 closePure(), declaration(), dumpTo(), indent(), insert(), newLine(), openCloseContent() , 以及 openPureHelper().

m_compress

bool QhpXmlWriter::m_compress

private

在文件 qhpxmlwriter.h 第 55 行定义.

被这些函数引用 newLine() , 以及 setCompressionEnabled().

m_curLineIndented

bool QhpXmlWriter::m_curLineIndented

private

在文件 qhpxmlwriter.h 第 54 行定义.

被这些函数引用 indent() , 以及 newLine().

m_indentLevel

int QhpXmlWriter::m_indentLevel

private

在文件 qhpxmlwriter.h 第 53 行定义.

被这些函数引用 close(), indent(), open() , 以及 setIndentLevel().

---

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

• src/qhpxmlwriter.h
• src/qhpxmlwriter.cpp