DocIncOperator Class Reference

Node representing a include/dontinclude operator block. More...

#include <docparser.h>

Inheritance diagram for DocIncOperator:

DocNode List of all members.

Public Types

enum  Type { Line, SkipLine, Skip, Until }

Public Member Functions

 DocIncOperator (DocNode *parent, Type t, const QString &pat, const QString &context, bool isExample, const QString &exampleFile)
Kind kind () const
Type type () const
QString text () const
QString pattern () const
QString context () const
DocNodeparent () const
void accept (DocVisitor *v)
bool isFirst () const
bool isLast () const
void markFirst (bool v=TRUE)
void markLast (bool v=TRUE)
bool isExample () const
QString exampleFile () const
void parse ()

Detailed Description

Node representing a include/dontinclude operator block.

Definition at line 428 of file docparser.h.


Member Enumeration Documentation

enum DocIncOperator::Type

Enumerator:
Line 
SkipLine 
Skip 
Until 

Definition at line 431 of file docparser.h.


Constructor & Destructor Documentation

DocIncOperator::DocIncOperator ( DocNode parent,
Type  t,
const QString &  pat,
const QString &  context,
bool  isExample,
const QString &  exampleFile 
) [inline]

Definition at line 432 of file docparser.h.


Member Function Documentation

Kind DocIncOperator::kind (  )  const [inline, virtual]

Returns the kind of node. Provides runtime type information

Implements DocNode.

Definition at line 437 of file docparser.h.

References DocNode::Kind_IncOperator.

Type DocIncOperator::type (  )  const [inline]

Definition at line 438 of file docparser.h.

Referenced by parse(), XmlDocVisitor::visit(), RTFDocVisitor::visit(), PrintDocVisitor::visit(), ManDocVisitor::visit(), LatexDocVisitor::visit(), and HtmlDocVisitor::visit().

QString DocIncOperator::text (  )  const [inline]

Definition at line 439 of file docparser.h.

Referenced by XmlDocVisitor::visit(), RTFDocVisitor::visit(), ManDocVisitor::visit(), LatexDocVisitor::visit(), and HtmlDocVisitor::visit().

QString DocIncOperator::pattern (  )  const [inline]

Definition at line 440 of file docparser.h.

Referenced by PrintDocVisitor::visit().

QString DocIncOperator::context (  )  const [inline]

Definition at line 441 of file docparser.h.

Referenced by XmlDocVisitor::visit(), RTFDocVisitor::visit(), ManDocVisitor::visit(), LatexDocVisitor::visit(), and HtmlDocVisitor::visit().

DocNode* DocIncOperator::parent (  )  const [inline, virtual]

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

Implements DocNode.

Definition at line 442 of file docparser.h.

void DocIncOperator::accept ( DocVisitor v  )  [inline, virtual]

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

Parameters:
v Abstract visitor.

Implements DocNode.

Definition at line 443 of file docparser.h.

References DocVisitor::visit().

bool DocIncOperator::isFirst (  )  const [inline]

Definition at line 444 of file docparser.h.

Referenced by XmlDocVisitor::visit(), RTFDocVisitor::visit(), ManDocVisitor::visit(), LatexDocVisitor::visit(), and HtmlDocVisitor::visit().

bool DocIncOperator::isLast (  )  const [inline]

Definition at line 445 of file docparser.h.

Referenced by XmlDocVisitor::visit(), RTFDocVisitor::visit(), ManDocVisitor::visit(), LatexDocVisitor::visit(), and HtmlDocVisitor::visit().

void DocIncOperator::markFirst ( bool  v = TRUE  )  [inline]

Definition at line 446 of file docparser.h.

Referenced by DocPara::handleIncludeOperator().

void DocIncOperator::markLast ( bool  v = TRUE  )  [inline]

Definition at line 447 of file docparser.h.

Referenced by DocPara::handleIncludeOperator().

bool DocIncOperator::isExample (  )  const [inline]

Definition at line 448 of file docparser.h.

Referenced by XmlDocVisitor::visit(), RTFDocVisitor::visit(), ManDocVisitor::visit(), LatexDocVisitor::visit(), and HtmlDocVisitor::visit().

QString DocIncOperator::exampleFile (  )  const [inline]

Definition at line 449 of file docparser.h.

Referenced by XmlDocVisitor::visit(), RTFDocVisitor::visit(), ManDocVisitor::visit(), LatexDocVisitor::visit(), and HtmlDocVisitor::visit().

void DocIncOperator::parse (  ) 

Definition at line 1618 of file docparser.cpp.

References DBG, Line, Skip, SkipLine, type(), and Until.

Referenced by DocPara::handleIncludeOperator().


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



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