DocVerbatim类 参考

Node representing a verbatim, unparsed text fragment 更多...

#include <docparser.h>

类 DocVerbatim 继承关系图:

DocVerbatim 的协作图:

Public 类型
enum	Type {   Code, HtmlOnly, ManOnly, LatexOnly,   RtfOnly, XmlOnly, Verbatim, Dot,   Msc, DocbookOnly, PlantUML }
Public 类型 继承自 DocNode
enum	Kind {   Kind_Root = 0, Kind_Word = 1, Kind_WhiteSpace = 2, Kind_Para = 3,   Kind_AutoList = 4, Kind_AutoListItem = 5, Kind_Symbol = 6, Kind_URL = 7,   Kind_StyleChange = 8, Kind_SimpleSect = 9, Kind_Title = 10, Kind_SimpleList = 11,   Kind_SimpleListItem = 12, Kind_Section = 13, Kind_Verbatim = 14, Kind_XRefItem = 15,   Kind_HtmlList = 16, Kind_HtmlListItem = 17, Kind_HtmlDescList = 18, Kind_HtmlDescData = 19,   Kind_HtmlDescTitle = 20, Kind_HtmlTable = 21, Kind_HtmlRow = 22, Kind_HtmlCell = 23,   Kind_HtmlCaption = 24, Kind_LineBreak = 25, Kind_HorRuler = 26, Kind_Anchor = 27,   Kind_IndexEntry = 28, Kind_Internal = 29, Kind_HRef = 30, Kind_Include = 31,   Kind_IncOperator = 32, Kind_HtmlHeader = 33, Kind_Image = 34, Kind_DotFile = 35,   Kind_Link = 36, Kind_Ref = 37, Kind_Formula = 38, Kind_SecRefItem = 39,   Kind_SecRefList = 40, Kind_SimpleSectSep = 41, Kind_LinkedWord = 42, Kind_ParamSect = 43,   Kind_ParamList = 44, Kind_InternalRef = 45, Kind_Copy = 46, Kind_Text = 47,   Kind_MscFile = 48, Kind_HtmlBlockQuote = 49, Kind_VhdlFlow = 50, Kind_ParBlock = 51,   Kind_DiaFile = 52, Kind_Emoji = 53, Kind_Sep = 54 }

Public 成员函数
	DocVerbatim (DocParser &parser, DocNode *parent, const QCString &context, const QCString &text, Type t, bool isExample, const QCString &exampleFile, bool isBlock=FALSE, const QCString &lang=QCString())
Kind	kind () const override
Type	type () const
QCString	text () const
QCString	context () const
void	accept (DocVisitor *v) override
bool	isExample () const
QCString	exampleFile () const
QCString	relPath () const
QCString	language () const
bool	isBlock () const
bool	hasCaption () const
QCString	width () const
QCString	height () const
QCString	engine () const
bool	useBitmap () const
const DocNodeList &	children () const
DocNodeList &	children ()
QCString	srcFile () const
int	srcLine () const
void	setText (const QCString &t)
void	setWidth (const QCString &w)
void	setHeight (const QCString &h)
void	setEngine (const QCString &e)
void	setUseBitmap (const bool &u)
void	setLocation (const QCString &file, int line)
Public 成员函数 继承自 DocNode
	DocNode (DocParser &parser)
virtual	~DocNode ()
DocNode *	parent () const
void	setParent (DocNode *parent)
bool	isPreformatted () const

Private 属性
QCString	m_context
QCString	m_text
Type	m_type = Code
bool	m_isExample = false
QCString	m_exampleFile
QCString	m_relPath
QCString	m_lang
bool	m_isBlock = false
QCString	m_width
QCString	m_height
QCString	m_engine
bool	m_useBitmap =false
DocNodeList	m_children
QCString	m_srcFile
int	m_srcLine = -1

额外继承的成员函数
Protected 类型 继承自 DocNode
enum	RefType { Unknown, Anchor, Section, Table }
Protected 成员函数 继承自 DocNode
void	setInsidePreformatted (bool p)
Protected 属性 继承自 DocNode
DocNode *	m_parent = 0
DocParser &	m_parser

详细描述

Node representing a verbatim, unparsed text fragment

在文件 docparser.h 第 510 行定义.

成员枚举类型说明

Type

enum DocVerbatim::Type

枚举值
Code
HtmlOnly
ManOnly
LatexOnly
RtfOnly
XmlOnly
Verbatim
Dot
Msc
DocbookOnly
PlantUML

在文件 docparser.h 第 513 行定义.

{ Code, HtmlOnly, ManOnly, LatexOnly, RtfOnly, XmlOnly, Verbatim, Dot, Msc, DocbookOnly, PlantUML };

构造及析构函数说明

DocVerbatim()

DocVerbatim::DocVerbatim	(	DocParser &	parser,
		DocNode *	parent,
		const QCString &	context,
		const QCString &	text,
		Type	t,
		bool	isExample,
		const QCString &	exampleFile,
		bool	isBlock = FALSE,
		const QCString &	lang = QCString()
	)

在文件 docparser.cpp 第 1912 行定义.

  : DocNode(parser), m_context(context), m_text(text), m_type(t),
    m_isExample(isExample), m_exampleFile(exampleFile),
    m_relPath(parser.context.relPath), m_lang(lang), m_isBlock(isBlock)
{
  m_parent = parent;
}

引用了 DocNode::m_parent , 以及 DocNode::parent().

成员函数说明

accept()

void DocVerbatim::accept ( DocVisitor *  v )

inlineoverridevirtual

Acceptor function for node visitors. Part of the visitor pattern.

参数

v	Abstract visitor.

实现了 DocNode.

在文件 docparser.h 第 521 行定义.

{ v->visit(this); }

引用了 DocVisitor::visit().

children() [1/2]

DocNodeList& DocVerbatim::children ( )

inline

在文件 docparser.h 第 533 行定义.

{ return m_children; }

引用了 m_children.

children() [2/2]

const DocNodeList& DocVerbatim::children ( ) const

inline

在文件 docparser.h 第 532 行定义.

{ return m_children; }

引用了 m_children.

被这些函数引用 DocPara::handleCommand(), HtmlDocVisitor::visit(), LatexDocVisitor::visit(), RTFDocVisitor::visit(), XmlDocVisitor::visit(), PerlModDocVisitor::visit(), DocbookDocVisitor::writeDiaFile(), LatexDocVisitor::writeDiaFile(), DocbookDocVisitor::writeDotFile(), DocbookDocVisitor::writeMscFile(), LatexDocVisitor::writeMscFile(), DocbookDocVisitor::writePlantUMLFile() , 以及 LatexDocVisitor::writePlantUMLFile().

context()

QCString DocVerbatim::context ( ) const

inline

在文件 docparser.h 第 520 行定义.

{ return m_context; }

引用了 m_context.

被这些函数引用 HtmlDocVisitor::visit(), DocbookDocVisitor::visit(), LatexDocVisitor::visit(), ManDocVisitor::visit(), RTFDocVisitor::visit(), XmlDocVisitor::visit() , 以及 PerlModDocVisitor::visit().

engine()

QCString DocVerbatim::engine ( ) const

inline

在文件 docparser.h 第 530 行定义.

{ return m_engine; }

引用了 m_engine.

被这些函数引用 HtmlDocVisitor::visit(), DocbookDocVisitor::visit(), LatexDocVisitor::visit(), RTFDocVisitor::visit() , 以及 XmlDocVisitor::visit().

exampleFile()

QCString DocVerbatim::exampleFile ( ) const

inline

在文件 docparser.h 第 523 行定义.

{ return m_exampleFile; }

引用了 m_exampleFile.

被这些函数引用 HtmlDocVisitor::visit(), DocbookDocVisitor::visit(), LatexDocVisitor::visit(), ManDocVisitor::visit(), RTFDocVisitor::visit() , 以及 XmlDocVisitor::visit().

hasCaption()

bool DocVerbatim::hasCaption ( ) const

inline

在文件 docparser.h 第 527 行定义.

{ return !m_children.empty(); }

引用了 m_children.

被这些函数引用 LatexDocVisitor::visit(), RTFDocVisitor::visit(), XmlDocVisitor::visit(), PerlModDocVisitor::visit(), visitPostCaption(), visitPreCaption(), DocbookDocVisitor::writeDiaFile(), LatexDocVisitor::writeDiaFile(), DocbookDocVisitor::writeDotFile(), DocbookDocVisitor::writeMscFile(), LatexDocVisitor::writeMscFile(), DocbookDocVisitor::writePlantUMLFile() , 以及 LatexDocVisitor::writePlantUMLFile().

height()

QCString DocVerbatim::height ( ) const

inline

在文件 docparser.h 第 529 行定义.

{ return m_height; }

引用了 m_height.

被这些函数引用 LatexDocVisitor::visit(), XmlDocVisitor::visit(), DocbookDocVisitor::writeDiaFile(), LatexDocVisitor::writeDiaFile(), DocbookDocVisitor::writeDotFile(), DocbookDocVisitor::writeMscFile(), LatexDocVisitor::writeMscFile(), DocbookDocVisitor::writePlantUMLFile() , 以及 LatexDocVisitor::writePlantUMLFile().

isBlock()

bool DocVerbatim::isBlock ( ) const

inline

在文件 docparser.h 第 526 行定义.

{ return m_isBlock; }

引用了 m_isBlock.

被这些函数引用 mustBeOutsideParagraph(), HtmlDocVisitor::visit() , 以及 XmlDocVisitor::visit().

isExample()

bool DocVerbatim::isExample ( ) const

inline

在文件 docparser.h 第 522 行定义.

{ return m_isExample; }

引用了 m_isExample.

被这些函数引用 HtmlDocVisitor::visit(), DocbookDocVisitor::visit(), LatexDocVisitor::visit(), ManDocVisitor::visit(), RTFDocVisitor::visit() , 以及 XmlDocVisitor::visit().

kind()

Kind DocVerbatim::kind ( ) const

inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

在文件 docparser.h 第 517 行定义.

{ return Kind_Verbatim; }

引用了 DocNode::Kind_Verbatim.

被这些函数引用 isInvisibleNode().

language()

QCString DocVerbatim::language ( ) const

inline

在文件 docparser.h 第 525 行定义.

{ return m_lang; }

引用了 m_lang.

被这些函数引用 HtmlDocVisitor::visit(), DocbookDocVisitor::visit(), LatexDocVisitor::visit(), ManDocVisitor::visit(), RTFDocVisitor::visit() , 以及 XmlDocVisitor::visit().

relPath()

QCString DocVerbatim::relPath ( ) const

inline

在文件 docparser.h 第 524 行定义.

{ return m_relPath; }

引用了 m_relPath.

被这些函数引用 HtmlDocVisitor::visit(), DocbookDocVisitor::writeDotFile(), DocbookDocVisitor::writeMscFile() , 以及 DocbookDocVisitor::writePlantUMLFile().

setEngine()

void DocVerbatim::setEngine ( const QCString &  e )

inline

在文件 docparser.h 第 539 行定义.

{ m_engine=e; }

引用了 m_engine.

被这些函数引用 DocPara::handleCommand().

setHeight()

void DocVerbatim::setHeight ( const QCString &  h )

inline

在文件 docparser.h 第 538 行定义.

{ m_height=h; }

引用了 m_height.

被这些函数引用 DocPara::handleCommand().

setLocation()

void DocVerbatim::setLocation ( const QCString &  file, int  line  )

inline

在文件 docparser.h 第 541 行定义.

{ m_srcFile=file; m_srcLine=line; }

引用了 m_srcFile , 以及 m_srcLine.

被这些函数引用 DocPara::handleCommand().

setText()

void DocVerbatim::setText ( const QCString &  t )

inline

在文件 docparser.h 第 536 行定义.

{ m_text=t;   }

引用了 m_text.

被这些函数引用 DocPara::handleCommand().

setUseBitmap()

void DocVerbatim::setUseBitmap ( const bool &  u )

inline

在文件 docparser.h 第 540 行定义.

{ m_useBitmap=u; }

引用了 m_useBitmap.

被这些函数引用 DocPara::handleCommand().

setWidth()

void DocVerbatim::setWidth ( const QCString &  w )

inline

在文件 docparser.h 第 537 行定义.

{ m_width=w;  }

引用了 m_width.

被这些函数引用 DocPara::handleCommand().

srcFile()

QCString DocVerbatim::srcFile ( ) const

inline

在文件 docparser.h 第 534 行定义.

{ return m_srcFile; }

引用了 m_srcFile.

被这些函数引用 HtmlDocVisitor::visit(), DocbookDocVisitor::visit(), LatexDocVisitor::visit(), RTFDocVisitor::visit(), DocbookDocVisitor::writeDiaFile(), LatexDocVisitor::writeDiaFile(), DocbookDocVisitor::writeDotFile(), DocbookDocVisitor::writeMscFile() , 以及 LatexDocVisitor::writeMscFile().

srcLine()

int DocVerbatim::srcLine ( ) const

inline

在文件 docparser.h 第 535 行定义.

{ return m_srcLine; }

引用了 m_srcLine.

被这些函数引用 HtmlDocVisitor::visit(), DocbookDocVisitor::visit(), LatexDocVisitor::visit(), RTFDocVisitor::visit(), DocbookDocVisitor::writeDiaFile(), LatexDocVisitor::writeDiaFile(), DocbookDocVisitor::writeDotFile(), DocbookDocVisitor::writeMscFile() , 以及 LatexDocVisitor::writeMscFile().

text()

QCString DocVerbatim::text ( ) const

inline

在文件 docparser.h 第 519 行定义.

{ return m_text; }

引用了 m_text.

被这些函数引用 HtmlDocVisitor::visit(), DocbookDocVisitor::visit(), LatexDocVisitor::visit(), ManDocVisitor::visit(), RTFDocVisitor::visit(), XmlDocVisitor::visit() , 以及 PerlModDocVisitor::visit().

type()

Type DocVerbatim::type ( ) const

inline

在文件 docparser.h 第 518 行定义.

{ return m_type; }

引用了 m_type.

被这些函数引用 isDocVerbatimVisible(), mustBeOutsideParagraph(), HtmlDocVisitor::visit(), DocbookDocVisitor::visit(), LatexDocVisitor::visit(), RTFDocVisitor::visit(), ManDocVisitor::visit(), XmlDocVisitor::visit() , 以及 PerlModDocVisitor::visit().

useBitmap()

bool DocVerbatim::useBitmap ( ) const

inline

在文件 docparser.h 第 531 行定义.

{ return m_useBitmap; }

引用了 m_useBitmap.

被这些函数引用 LatexDocVisitor::visit() , 以及 LatexDocVisitor::writePlantUMLFile().

width()

QCString DocVerbatim::width ( ) const

inline

在文件 docparser.h 第 528 行定义.

{ return m_width; }

引用了 m_width.

被这些函数引用 LatexDocVisitor::visit(), XmlDocVisitor::visit(), DocbookDocVisitor::writeDiaFile(), LatexDocVisitor::writeDiaFile(), DocbookDocVisitor::writeDotFile(), DocbookDocVisitor::writeMscFile(), LatexDocVisitor::writeMscFile(), DocbookDocVisitor::writePlantUMLFile() , 以及 LatexDocVisitor::writePlantUMLFile().

类成员变量说明

m_children

DocNodeList DocVerbatim::m_children

private

在文件 docparser.h 第 556 行定义.

被这些函数引用 children() , 以及 hasCaption().

m_context

QCString DocVerbatim::m_context

private

在文件 docparser.h 第 544 行定义.

被这些函数引用 context().

m_engine

QCString DocVerbatim::m_engine

private

在文件 docparser.h 第 554 行定义.

被这些函数引用 engine() , 以及 setEngine().

m_exampleFile

QCString DocVerbatim::m_exampleFile

private

在文件 docparser.h 第 548 行定义.

被这些函数引用 exampleFile().

m_height

QCString DocVerbatim::m_height

private

在文件 docparser.h 第 553 行定义.

被这些函数引用 height() , 以及 setHeight().

m_isBlock

bool DocVerbatim::m_isBlock = false

private

在文件 docparser.h 第 551 行定义.

被这些函数引用 isBlock().

m_isExample

bool DocVerbatim::m_isExample = false

private

在文件 docparser.h 第 547 行定义.

被这些函数引用 isExample().

m_lang

QCString DocVerbatim::m_lang

private

在文件 docparser.h 第 550 行定义.

被这些函数引用 language().

m_relPath

QCString DocVerbatim::m_relPath

private

在文件 docparser.h 第 549 行定义.

被这些函数引用 relPath().

m_srcFile

QCString DocVerbatim::m_srcFile

private

在文件 docparser.h 第 557 行定义.

被这些函数引用 setLocation() , 以及 srcFile().

m_srcLine

int DocVerbatim::m_srcLine = -1

private

在文件 docparser.h 第 558 行定义.

被这些函数引用 setLocation() , 以及 srcLine().

m_text

QCString DocVerbatim::m_text

private

在文件 docparser.h 第 545 行定义.

被这些函数引用 setText() , 以及 text().

m_type

Type DocVerbatim::m_type = Code

private

在文件 docparser.h 第 546 行定义.

被这些函数引用 type().

m_useBitmap

bool DocVerbatim::m_useBitmap =false

private

在文件 docparser.h 第 555 行定义.

被这些函数引用 setUseBitmap() , 以及 useBitmap().

m_width

QCString DocVerbatim::m_width

private

在文件 docparser.h 第 552 行定义.

被这些函数引用 setWidth() , 以及 width().

---

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

• src/docparser.h
• src/docparser.cpp