DocNode Class Reference

Abstract node interface with type information. More...

#include <docparser.h>

Inheritance diagram for DocNode:

Public Types
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 }

Public Member Functions
	DocNode ()
virtual	~DocNode ()
virtual Kind	kind () const =0
DocNode *	parent () const
void	setParent (DocNode *parent)
virtual void	accept (DocVisitor *v)=0
bool	isPreformatted () const

Protected Member Functions
void	setInsidePreformatted (bool p)

Protected Attributes
DocNode *	m_parent

Detailed Description

Abstract node interface with type information.

Member Enumeration Documentation

Kind

enum DocNode::Kind

Available node types.

Constructor & Destructor Documentation

DocNode()

DocNode::DocNode ( )

inline

Creates a new node

~DocNode()

virtual DocNode::~DocNode ( )

inlinevirtual

Destroys a node.

Member Function Documentation

accept()

virtual void DocNode::accept ( DocVisitor *  v )

pure virtual

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

Parameters

v	Abstract visitor.

Implemented in 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, DocCopy, DocIndexEntry, DocFormula, DocIncOperator, DocInclude, DocVerbatim, DocWhiteSpace, DocSymbol, DocStyleChange, DocCite, DocAnchor, DocHorRuler, DocLineBreak, DocURL, DocLinkedWord, and DocWord.

isPreformatted()

bool DocNode::isPreformatted ( ) const

inline

Returns TRUE iff this node is inside a preformatted section

kind()

virtual Kind DocNode::kind ( ) const

pure virtual

Returns the kind of node. Provides runtime type information

Implemented in 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, DocCopy, DocIndexEntry, DocFormula, DocIncOperator, DocInclude, DocVerbatim, DocWhiteSpace, DocSymbol, DocStyleChange, DocCite, DocAnchor, DocHorRuler, DocLineBreak, DocURL, DocLinkedWord, and DocWord.

parent()

DocNode* DocNode::parent ( ) const

inline

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

setInsidePreformatted()

void DocNode::setInsidePreformatted ( bool  p )

inlineprotected

Sets whether or not this item is inside a preformatted section

setParent()

void DocNode::setParent ( DocNode *  parent )

inline

Sets a new parent for this node.

---

The documentation for this class was generated from the following file:

• src/docparser.h