DocLinkedWord类 参考

Node representing a word that can be linked to something 更多...

#include <docparser.h>

类 DocLinkedWord 继承关系图:

DocLinkedWord 的协作图:

Public 成员函数
	DocLinkedWord (DocParser &parser, DocNode *parent, const QCString &word, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &tooltip)
QCString	word () const
Kind	kind () const override
QCString	file () const
QCString	relPath () const
QCString	ref () const
QCString	anchor () const
QCString	tooltip () const
void	accept (DocVisitor *v) override
Public 成员函数 继承自 DocNode
	DocNode (DocParser &parser)
virtual	~DocNode ()
DocNode *	parent () const
void	setParent (DocNode *parent)
bool	isPreformatted () const

Private 属性
QCString	m_word
QCString	m_ref
QCString	m_file
QCString	m_relPath
QCString	m_anchor
QCString	m_tooltip

额外继承的成员函数
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 a word that can be linked to something

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

构造及析构函数说明

DocLinkedWord()

DocLinkedWord::DocLinkedWord	(	DocParser &	parser,
		DocNode *	parent,
		const QCString &	word,
		const QCString &	ref,
		const QCString &	file,
		const QCString &	anchor,
		const QCString &	tooltip
	)

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

                                                                  :
      DocNode(parser), m_word(word), m_ref(ref),
      m_file(file), m_relPath(parser.context.relPath), m_anchor(anchor),
      m_tooltip(tooltip)
{
  m_parent = parent;
  //printf("DocLinkedWord: new word %s url=%s tooltip='%s'\n",
  //    qPrint(word),qPrint(parser.context.searchUrl),qPrint(tooltip));
  if (Doxygen::searchIndex && !parser.context.searchUrl.isEmpty())
  {
    Doxygen::searchIndex->addWord(word,FALSE);
  }
}

引用了 SearchIndexIntf::addWord(), DocParser::context, FALSE, QCString::isEmpty(), DocNode::m_parent, DocNode::parent(), Doxygen::searchIndex, DocParserContext::searchUrl , 以及 word().

成员函数说明

accept()

void DocLinkedWord::accept ( DocVisitor *  v )

inlineoverridevirtual

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

参数

v	Abstract visitor.

实现了 DocNode.

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

{ v->visit(this); }

引用了 DocVisitor::visit().

anchor()

QCString DocLinkedWord::anchor ( ) const

inline

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

{ return m_anchor; }

引用了 m_anchor.

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

file()

QCString DocLinkedWord::file ( ) const

inline

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

{ return m_file; }

引用了 m_file.

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

kind()

Kind DocLinkedWord::kind ( ) const

inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

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

{ return Kind_LinkedWord; }

引用了 DocNode::Kind_LinkedWord.

ref()

QCString DocLinkedWord::ref ( ) const

inline

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

{ return m_ref; }

引用了 m_ref.

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

relPath()

QCString DocLinkedWord::relPath ( ) const

inline

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

{ return m_relPath; }

引用了 m_relPath.

被这些函数引用 HtmlDocVisitor::visit().

tooltip()

QCString DocLinkedWord::tooltip ( ) const

inline

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

{ return m_tooltip; }

引用了 m_tooltip.

被这些函数引用 HtmlDocVisitor::visit().

word()

QCString DocLinkedWord::word ( ) const

inline

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

{ return m_word; }

引用了 m_word.

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

类成员变量说明

m_anchor

QCString DocLinkedWord::m_anchor

private

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

被这些函数引用 anchor().

m_file

QCString DocLinkedWord::m_file

private

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

被这些函数引用 file().

m_ref

QCString DocLinkedWord::m_ref

private

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

被这些函数引用 ref().

m_relPath

QCString DocLinkedWord::m_relPath

private

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

被这些函数引用 relPath().

m_tooltip

QCString DocLinkedWord::m_tooltip

private

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

被这些函数引用 tooltip().

m_word

QCString DocLinkedWord::m_word

private

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

被这些函数引用 word().

---

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

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