DocNode类 参考

Abstract node interface with type information. 更多...

#include <docparser.h>

类 DocNode 继承关系图:

DocNode 的协作图:

Public 类型
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 成员函数
	DocNode (DocParser &parser)
virtual	~DocNode ()
virtual Kind	kind () const =0
DocNode *	parent () const
void	setParent (DocNode *parent)
virtual void	accept (DocVisitor *v)=0
bool	isPreformatted () const

Protected 类型
enum	RefType { Unknown, Anchor, Section, Table }

Protected 成员函数
void	setInsidePreformatted (bool p)

Protected 属性
DocNode *	m_parent = 0
DocParser &	m_parser

Private 属性
bool	m_insidePre = false

详细描述

Abstract node interface with type information.

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

成员枚举类型说明

Kind

enum DocNode::Kind

Available node types.

枚举值
Kind_Root
Kind_Word
Kind_WhiteSpace
Kind_Para
Kind_AutoList
Kind_AutoListItem
Kind_Symbol
Kind_URL
Kind_StyleChange
Kind_SimpleSect
Kind_Title
Kind_SimpleList
Kind_SimpleListItem
Kind_Section
Kind_Verbatim
Kind_XRefItem
Kind_HtmlList
Kind_HtmlListItem
Kind_HtmlDescList
Kind_HtmlDescData
Kind_HtmlDescTitle
Kind_HtmlTable
Kind_HtmlRow
Kind_HtmlCell
Kind_HtmlCaption
Kind_LineBreak
Kind_HorRuler
Kind_Anchor
Kind_IndexEntry
Kind_Internal
Kind_HRef
Kind_Include
Kind_IncOperator
Kind_HtmlHeader
Kind_Image
Kind_DotFile
Kind_Link
Kind_Ref
Kind_Formula
Kind_SecRefItem
Kind_SecRefList
Kind_SimpleSectSep
Kind_LinkedWord
Kind_ParamSect
Kind_ParamList
Kind_InternalRef
Kind_Copy
Kind_Text
Kind_MscFile
Kind_HtmlBlockQuote
Kind_VhdlFlow
Kind_ParBlock
Kind_DiaFile
Kind_Emoji
Kind_Sep

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

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

RefType

enum DocNode::RefType

protected

枚举值
Unknown
Anchor
Section
Table

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

{ Unknown, Anchor, Section, Table };

构造及析构函数说明

DocNode()

DocNode::DocNode ( DocParser &  parser )

inline

Creates a new node

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

: m_parser(parser) {}

~DocNode()

virtual DocNode::~DocNode ( )

inlinevirtual

Destroys a node.

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

{}

成员函数说明

accept()

virtual void DocNode::accept ( DocVisitor *  v )

pure virtual

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

参数

v	Abstract visitor.

在 DocHtmlTable, DocSimpleListItem, DocParamList, DocSimpleSectSep, DocSimpleSect, DocIndexEntry, DocFormula, DocIncOperator, DocInclude, DocVerbatim, DocWhiteSpace, DocEmoji, DocSymbol, DocStyleChange, DocCite, DocAnchor, DocHorRuler, DocLineBreak, DocURL, DocLinkedWord, DocWord, CompAccept< T >, CompAccept< DocParamSect >, CompAccept< DocHtmlDescList >, CompAccept< DocHtmlCaption >, CompAccept< DocSimpleList >, CompAccept< DocRef >, CompAccept< DocParBlock >, CompAccept< DocXRefItem >, CompAccept< DocLink >, CompAccept< DocMscFile >, CompAccept< DocTitle >, CompAccept< DocHtmlRow >, CompAccept< DocHtmlBlockQuote >, CompAccept< DocHtmlDescTitle >, CompAccept< DocHtmlListItem >, CompAccept< DocInternal >, CompAccept< DocDiaFile >, CompAccept< DocImage >, CompAccept< DocRoot >, CompAccept< DocDotFile >, CompAccept< DocSection >, CompAccept< DocText >, CompAccept< DocHtmlList >, CompAccept< DocHtmlCell >, CompAccept< DocHRef >, CompAccept< DocAutoList >, CompAccept< DocPara >, CompAccept< DocHtmlDescData >, CompAccept< DocVhdlFlow >, CompAccept< DocSecRefItem >, CompAccept< DocInternalRef >, CompAccept< DocHtmlHeader >, CompAccept< DocHtmlTable >, CompAccept< DocSimpleSect >, CompAccept< DocSecRefList >, CompAccept< DocAutoListItem > , 以及 DocSeparator 内被实现.

被这些函数引用 ManGenerator::writeDoc(), RTFGenerator::writeDoc(), HtmlGenerator::writeDoc(), LatexGenerator::writeDoc() , 以及 DocbookGenerator::writeDoc().

isPreformatted()

bool DocNode::isPreformatted ( ) const

inline

Returns TRUE iff this node is inside a preformatted section

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

{ return m_insidePre; }

引用了 m_insidePre.

被这些函数引用 insidePRE(), HtmlDocVisitor::visitPost() , 以及 HtmlDocVisitor::visitPre().

kind()

virtual Kind DocNode::kind ( ) const

pure virtual

Returns the kind of node. Provides runtime type information

在 DocRoot, DocText, DocHtmlBlockQuote, DocHtmlTable, DocHtmlRow, DocHtmlCaption, DocHtmlCell, DocHtmlDescData, DocHtmlListItem, DocSimpleListItem, DocParamList, DocPara, DocParamSect, DocSimpleSectSep, DocSimpleSect, DocHtmlList, DocSimpleList, DocParBlock, DocInternal, DocSecRefList, DocSecRefItem, DocSection, DocHtmlDescList, DocHtmlDescTitle, DocHtmlHeader, DocHRef, DocInternalRef, DocRef, DocLink, DocVhdlFlow, DocDiaFile, DocMscFile, DocDotFile, DocImage, DocXRefItem, DocTitle, DocAutoListItem, DocAutoList, DocIndexEntry, DocFormula, DocIncOperator, DocInclude, DocVerbatim, DocSeparator, DocWhiteSpace, DocEmoji, DocSymbol, DocStyleChange, DocCite, DocAnchor, DocHorRuler, DocLineBreak, DocURL, DocLinkedWord , 以及 DocWord 内被实现.

被这些函数引用 classEqualsReflist(), HtmlDocVisitor::forceEndParagraph(), HtmlDocVisitor::forceStartParagraph(), getParagraphContext(), DocPara::handleIncludeOperator(), insideLI(), insideOL(), insideStyleChangeThatIsOutsideParagraph(), insideTable(), insideUL(), isInvisibleNode(), listIsNested(), mustBeOutsideParagraph(), DocPara::parse(), tableIsNested(), XmlDocVisitor::visit(), HtmlDocVisitor::visitPost(), LatexDocVisitor::visitPost(), ManDocVisitor::visitPost(), RTFDocVisitor::visitPost(), HtmlDocVisitor::visitPre(), LatexDocVisitor::visitPre(), DocbookDocVisitor::visitPre(), RTFDocVisitor::visitPre() , 以及 PerlModDocVisitor::visitPre().

parent()

DocNode* DocNode::parent ( ) const

inline

Returns the parent of this node or 0 for the root node.

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

{ return m_parent; }

引用了 m_parent.

被这些函数引用 DocAnchor::DocAnchor(), DocAutoList::DocAutoList(), DocAutoListItem::DocAutoListItem(), DocCite::DocCite(), DocDiaFile::DocDiaFile(), DocDotFile::DocDotFile(), DocEmoji::DocEmoji(), DocFormula::DocFormula(), DocHorRuler::DocHorRuler(), DocHRef::DocHRef(), DocHtmlBlockQuote::DocHtmlBlockQuote(), DocHtmlCaption::DocHtmlCaption(), DocHtmlCell::DocHtmlCell(), DocHtmlDescData::DocHtmlDescData(), DocHtmlDescList::DocHtmlDescList(), DocHtmlDescTitle::DocHtmlDescTitle(), DocHtmlHeader::DocHtmlHeader(), DocHtmlList::DocHtmlList(), DocHtmlListItem::DocHtmlListItem(), DocHtmlRow::DocHtmlRow(), DocHtmlTable::DocHtmlTable(), DocImage::DocImage(), DocInclude::DocInclude(), DocIncOperator::DocIncOperator(), DocIndexEntry::DocIndexEntry(), DocInternal::DocInternal(), DocInternalRef::DocInternalRef(), DocLineBreak::DocLineBreak(), DocLink::DocLink(), DocLinkedWord::DocLinkedWord(), DocMscFile::DocMscFile(), DocPara::DocPara(), DocParamList::DocParamList(), DocParamSect::DocParamSect(), DocParBlock::DocParBlock(), DocRef::DocRef(), DocSecRefItem::DocSecRefItem(), DocSecRefList::DocSecRefList(), DocSection::DocSection(), DocSeparator::DocSeparator(), DocSimpleList::DocSimpleList(), DocSimpleListItem::DocSimpleListItem(), DocSimpleSect::DocSimpleSect(), DocSimpleSectSep::DocSimpleSectSep(), DocStyleChange::DocStyleChange(), DocSymbol::DocSymbol(), DocTitle::DocTitle(), DocURL::DocURL(), DocVerbatim::DocVerbatim(), DocVhdlFlow::DocVhdlFlow(), DocWhiteSpace::DocWhiteSpace(), DocWord::DocWord(), DocXRefItem::DocXRefItem(), HtmlDocVisitor::forceEndParagraph(), HtmlDocVisitor::forceStartParagraph(), getParagraphContext(), insideLI(), insideOL(), insidePRE(), insideTable(), insideUL(), listIsNested(), DocPara::parse(), DocParamList::parse(), setParent(), tableIsNested(), XmlDocVisitor::visit(), HtmlDocVisitor::visitPost(), LatexDocVisitor::visitPost(), ManDocVisitor::visitPost(), RTFDocVisitor::visitPost(), ManDocVisitor::visitPre(), HtmlDocVisitor::visitPre(), DocbookDocVisitor::visitPre(), LatexDocVisitor::visitPre(), RTFDocVisitor::visitPre() , 以及 PerlModDocVisitor::visitPre().

setInsidePreformatted()

void DocNode::setInsidePreformatted ( bool  p )

inlineprotected

Sets whether or not this item is inside a preformatted section

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

{ m_insidePre = p; }

引用了 m_insidePre.

被这些函数引用 DocPara::handleHtmlEndTag() , 以及 DocPara::handleHtmlStartTag().

setParent()

void DocNode::setParent ( DocNode *  parent )

inline

Sets a new parent for this node.

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

{ m_parent = parent; }

引用了 m_parent , 以及 parent().

被这些函数引用 flattenParagraphs().

类成员变量说明

m_insidePre

bool DocNode::m_insidePre = false

private

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

被这些函数引用 isPreformatted() , 以及 setInsidePreformatted().

m_parent

DocNode* DocNode::m_parent = 0

protected

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

被这些函数引用 DocAnchor::DocAnchor(), DocAutoList::DocAutoList(), DocAutoListItem::DocAutoListItem(), DocCite::DocCite(), DocDiaFile::DocDiaFile(), DocDotFile::DocDotFile(), DocEmoji::DocEmoji(), DocFormula::DocFormula(), DocHorRuler::DocHorRuler(), DocHRef::DocHRef(), DocHtmlBlockQuote::DocHtmlBlockQuote(), DocHtmlCaption::DocHtmlCaption(), DocHtmlCell::DocHtmlCell(), DocHtmlDescData::DocHtmlDescData(), DocHtmlDescList::DocHtmlDescList(), DocHtmlDescTitle::DocHtmlDescTitle(), DocHtmlHeader::DocHtmlHeader(), DocHtmlList::DocHtmlList(), DocHtmlListItem::DocHtmlListItem(), DocHtmlRow::DocHtmlRow(), DocHtmlTable::DocHtmlTable(), DocImage::DocImage(), DocInclude::DocInclude(), DocIncOperator::DocIncOperator(), DocIndexEntry::DocIndexEntry(), DocInternal::DocInternal(), DocInternalRef::DocInternalRef(), DocLineBreak::DocLineBreak(), DocLink::DocLink(), DocLinkedWord::DocLinkedWord(), DocMscFile::DocMscFile(), DocPara::DocPara(), DocParamList::DocParamList(), DocParamSect::DocParamSect(), DocParBlock::DocParBlock(), DocRef::DocRef(), DocSecRefItem::DocSecRefItem(), DocSecRefList::DocSecRefList(), DocSection::DocSection(), DocSeparator::DocSeparator(), DocSimpleList::DocSimpleList(), DocSimpleListItem::DocSimpleListItem(), DocSimpleSect::DocSimpleSect(), DocSimpleSectSep::DocSimpleSectSep(), DocStyleChange::DocStyleChange(), DocSymbol::DocSymbol(), DocTitle::DocTitle(), DocURL::DocURL(), DocVerbatim::DocVerbatim(), DocVhdlFlow::DocVhdlFlow(), DocWhiteSpace::DocWhiteSpace(), DocWord::DocWord(), DocXRefItem::DocXRefItem(), parent() , 以及 setParent().

m_parser

DocParser& DocNode::m_parser

protected

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

被这些函数引用 DocSimpleSect::appendLinkWord(), DocPara::handleCite(), DocPara::handleCommand(), DocPara::handleEmoji(), DocPara::handleFile(), DocPara::handleHtmlEndTag(), DocPara::handleHtmlHeader(), DocPara::handleHtmlStartTag(), DocPara::handleIline(), DocPara::handleImage(), DocPara::handleInclude(), DocPara::handleIncludeOperator(), DocPara::handleInheritDoc(), DocPara::handleLink(), DocPara::handleParamSection(), DocPara::handleRef(), DocPara::handleSection(), DocPara::handleSimpleSection(), DocPara::handleStartCode(), DocPara::handleVhdlFlow(), DocPara::handleXRefItem(), DocPara::injectToken(), DocInclude::parse(), DocIncOperator::parse(), DocIndexEntry::parse(), DocAutoList::parse(), DocAutoListItem::parse(), DocTitle::parse(), DocXRefItem::parse(), DocImage::parse(), DocDotFile::parse(), DocMscFile::parse(), DocDiaFile::parse(), DocVhdlFlow::parse(), DocLink::parse(), DocRef::parse(), DocInternalRef::parse(), DocHRef::parse(), DocHtmlHeader::parse(), DocHtmlDescTitle::parse(), DocHtmlDescList::parse(), DocSection::parse(), DocSecRefItem::parse(), DocSecRefList::parse(), DocInternal::parse(), DocParBlock::parse(), DocSimpleList::parse(), DocHtmlList::parse(), DocSimpleSect::parse(), DocParamSect::parse(), DocPara::parse(), DocParamList::parse(), DocSimpleListItem::parse(), DocHtmlListItem::parse(), DocHtmlDescData::parse(), DocHtmlCell::parse(), DocHtmlCaption::parse(), DocHtmlRow::parse(), DocHtmlTable::parse(), DocHtmlBlockQuote::parse(), DocText::parse(), DocRoot::parse(), DocTitle::parseFromString(), DocSimpleSect::parseRcs(), DocHtmlList::parseXml(), DocSimpleSect::parseXml(), DocParamList::parseXml(), DocHtmlListItem::parseXml(), DocHtmlCell::parseXml(), DocHtmlRow::parseXml() , 以及 DocHtmlTable::parseXml().

---

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

• src/docparser.h