DocNode Class Reference

Abstract node interface with type information. More...

#include <docparser.h>

Inheritance diagram for DocNode:

List of all members.


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_LinkedWord = 42, Kind_ParamSect = 43, Kind_ParamList = 44, Kind_InternalRef = 45, Kind_Copy = 46, Kind_Text = 47 }
Public Member Functions
	DocNode ()
virtual	~DocNode ()
virtual Kind	kind () const=0
virtual DocNode *	parent () const=0
virtual void	accept (DocVisitor *v)=0
bool	isPreformatted () const
Protected Member Functions
void	setInsidePreformatted (bool p)

Detailed Description

Abstract node interface with type information.

Definition at line 84 of file docparser.h.

Member Enumeration Documentation

enum DocNode::Kind

Available node types.

Enumerator:

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_LinkedWord
Kind_ParamSect
Kind_ParamList
Kind_InternalRef
Kind_Copy
Kind_Text

Definition at line 88 of file docparser.h.

Constructor & Destructor Documentation

DocNode::DocNode ( ) [inline]

Creates a new node

Definition at line 138 of file docparser.h.

virtual DocNode::~DocNode ( ) [inline, virtual]

Destroys a node.

Definition at line 141 of file docparser.h.

Member Function Documentation

virtual Kind DocNode::kind ( ) const [pure virtual]

Returns the kind of node. Provides runtime type information

Implemented in DocWord, DocLinkedWord, DocURL, DocLineBreak, DocHorRuler, DocAnchor, DocStyleChange, DocSymbol, DocWhiteSpace, DocVerbatim, DocInclude, DocIncOperator, DocFormula, DocIndexEntry, DocCopy, DocAutoList, DocTitle, DocXRefItem, DocImage, DocDotFile, DocLink, DocRef, DocInternalRef, DocHRef, DocHtmlHeader, DocHtmlDescTitle, DocHtmlDescList, DocSection, DocSecRefItem, DocSecRefList, DocInternal, DocSimpleList, DocHtmlList, DocSimpleSect, DocParamSect, DocPara, DocParamList, DocAutoListItem, DocSimpleListItem, DocHtmlListItem, DocHtmlDescData, DocHtmlCell, DocHtmlCaption, DocHtmlRow, DocHtmlTable, DocText, and DocRoot.

Referenced by DocPara::handleHtmlStartTag(), DocPara::handleIncludeOperator(), DocHtmlTable::numCols(), DocPara::parse(), RTFDocVisitor::visitPost(), ManDocVisitor::visitPost(), LatexDocVisitor::visitPost(), and HtmlDocVisitor::visitPost().

virtual DocNode* DocNode::parent ( ) const [pure virtual]

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

Implemented in DocWord, DocLinkedWord, DocURL, DocLineBreak, DocHorRuler, DocAnchor, DocStyleChange, DocSymbol, DocWhiteSpace, DocVerbatim, DocInclude, DocIncOperator, DocFormula, DocIndexEntry, DocCopy, DocAutoList, DocTitle, DocXRefItem, DocImage, DocDotFile, DocLink, DocRef, DocInternalRef, DocHRef, DocHtmlHeader, DocHtmlDescTitle, DocHtmlDescList, DocSection, DocSecRefItem, DocSecRefList, DocInternal, DocSimpleList, DocHtmlList, DocSimpleSect, DocParamSect, DocPara, DocParamList, DocAutoListItem, DocSimpleListItem, DocHtmlListItem, DocHtmlDescData, DocHtmlCell, DocHtmlCaption, DocHtmlRow, DocHtmlTable, DocText, and DocRoot.

Referenced by DocPara::parse().

virtual void DocNode::accept ( DocVisitor * v ) [pure virtual]

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

Parameters:

v

Abstract visitor.

Implemented in DocWord, DocLinkedWord, DocURL, DocLineBreak, DocHorRuler, DocAnchor, DocStyleChange, DocSymbol, DocWhiteSpace, DocVerbatim, DocInclude, DocIncOperator, DocFormula, DocIndexEntry, DocCopy, DocAutoList, DocTitle, DocXRefItem, DocImage, DocDotFile, DocLink, DocRef, DocInternalRef, DocHRef, DocHtmlHeader, DocHtmlDescTitle, DocHtmlDescList, DocSection, DocSecRefItem, DocSecRefList, DocInternal, DocSimpleList, DocHtmlList, DocSimpleSect, DocParamSect, DocPara, DocParamList, DocAutoListItem, DocSimpleListItem, DocHtmlListItem, DocHtmlDescData, DocHtmlCell, DocHtmlCaption, DocHtmlRow, DocHtmlTable, DocText, and DocRoot.

Referenced by DocParamList::accept(), CompAccept< DocHtmlTable >::accept(), DocSimpleSect::accept(), DocHtmlTable::accept(), parseCommentAsText(), RTFGenerator::printDoc(), ManGenerator::printDoc(), LatexGenerator::printDoc(), and HtmlGenerator::printDoc().

bool DocNode::isPreformatted ( ) const [inline]

Returns TRUE iff this node is inside a preformatted section

Definition at line 155 of file docparser.h.

Referenced by HtmlDocVisitor::visitPost(), and HtmlDocVisitor::visitPre().

void DocNode::setInsidePreformatted ( bool p ) [inline, protected]

Sets whether or not this item is inside a preformatted section

Definition at line 159 of file docparser.h.

Referenced by DocPara::handleHtmlEndTag(), and DocPara::handleHtmlStartTag().

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

docparser.h

Generated on Mon Mar 31 10:58:58 2008 by

doxygen

1.5.1