DocFormula类 参考

Node representing an item of a cross-referenced list 更多...

#include <docparser.h>

类 DocFormula 继承关系图:

DocFormula 的协作图:

Public 成员函数
	DocFormula (DocParser &parser, DocNode *parent, int id)
Kind	kind () const override
QCString	name () const
QCString	text () const
QCString	relPath () const
int	id () const
void	accept (DocVisitor *v) override
bool	isInline ()
Public 成员函数 继承自 DocNode
	DocNode (DocParser &parser)
virtual	~DocNode ()
DocNode *	parent () const
void	setParent (DocNode *parent)
bool	isPreformatted () const

Private 属性
QCString	m_name
QCString	m_text
QCString	m_relPath
int	m_id = 0

额外继承的成员函数
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 }
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 an item of a cross-referenced list

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

构造及析构函数说明

DocFormula()

DocFormula::DocFormula	(	DocParser &	parser,
		DocNode *	parent,
		int	id
	)

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

                                                               : DocNode(parser),
      m_relPath(parser.context.relPath)
{
  m_parent = parent;
  QCString text = FormulaManager::instance().findFormula(id);
  if (!text.isEmpty())
  {
    m_id = id;
    m_name.sprintf("form_%d",m_id);
    m_text = text;
  }
  else // wrong \_form#<n> command
  {
    warn_doc_error(parser.context.fileName,parser.tokenizer.getLineNr(),"Wrong formula id %d",id);
    m_id = -1;
  }
}

引用了 DocParser::context, DocParserContext::fileName, FormulaManager::findFormula(), DocTokenizer::getLineNr(), id(), FormulaManager::instance(), QCString::isEmpty(), m_id, m_name, DocNode::m_parent, m_text, DocNode::parent(), QCString::sprintf(), text(), DocParser::tokenizer , 以及 warn_doc_error().

成员函数说明

accept()

void DocFormula::accept ( DocVisitor *  v )

inlineoverridevirtual

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

参数

v	Abstract visitor.

实现了 DocNode.

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

{ v->visit(this); }

引用了 DocVisitor::visit().

id()

int DocFormula::id ( ) const

inline

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

{ return m_id; }

引用了 m_id.

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

isInline()

bool DocFormula::isInline ( )

inline

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

                               {
      if (m_text.length()>1 && m_text.at(0)=='\\' && m_text.at(1)=='[') return false;
      if (m_text.length()>7 && m_text.startsWith("\\begin{")) return false;
      return true;
    }

引用了 QCString::at(), QCString::length(), m_text , 以及 QCString::startsWith().

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

kind()

Kind DocFormula::kind ( ) const

inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

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

{ return Kind_Formula; }

引用了 DocNode::Kind_Formula.

name()

QCString DocFormula::name ( ) const

inline

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

{ return m_name; }

引用了 m_name.

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

relPath()

QCString DocFormula::relPath ( ) const

inline

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

{ return m_relPath; }

引用了 m_relPath.

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

text()

QCString DocFormula::text ( ) const

inline

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

{ return m_text; }

引用了 m_text.

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

类成员变量说明

m_id

int DocFormula::m_id = 0

private

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

被这些函数引用 DocFormula() , 以及 id().

m_name

QCString DocFormula::m_name

private

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

被这些函数引用 DocFormula() , 以及 name().

m_relPath

QCString DocFormula::m_relPath

private

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

被这些函数引用 relPath().

m_text

QCString DocFormula::m_text

private

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

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

---

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

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