doxygen
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
DocNode Class Referenceabstract

Abstract node interface with type information. More...

#include <docparser.h>

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

Collaboration diagram for DocNode:
Collaboration graph
[legend]

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, Kind_Emoji = 53, Kind_Sep = 54
}
 

Public Member Functions

 DocNode (DocParser &parser)
 
virtual ~DocNode ()
 
virtual Kind kind () const =0
 
DocNodeparent () const
 
void setParent (DocNode *parent)
 
virtual void accept (DocVisitor *v)=0
 
bool isPreformatted () const
 

Protected Types

enum  RefType { Unknown, Anchor, Section, Table }
 

Protected Member Functions

void setInsidePreformatted (bool p)
 

Protected Attributes

DocNodem_parent = 0
 
DocParserm_parser
 

Detailed Description

Abstract node interface with type information.

Member Enumeration Documentation

◆ Kind

Available node types.

Constructor & Destructor Documentation

◆ DocNode()

DocNode::DocNode ( DocParser parser)
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

◆ isPreformatted()

bool DocNode::isPreformatted ( ) const
inline

Returns TRUE iff this node is inside a preformatted section

◆ kind()

virtual Kind DocNode::kind ( ) const
pure virtual

◆ 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: