DocVerbatim Class Reference

Node representing a verbatim, unparsed text fragment. More...

#include <docparser.h>

Inheritance diagram for DocVerbatim:

DocNode List of all members.

Public Types

enum  Type {
  Code, HtmlOnly, ManOnly, LatexOnly,
  XmlOnly, Verbatim, Dot, Msc
}

Public Member Functions

 DocVerbatim (DocNode *parent, const QString &context, const QString &text, Type t, bool isExample, const QString &exampleFile)
Kind kind () const
Type type () const
QString text () const
QString context () const
DocNodeparent () const
void accept (DocVisitor *v)
bool isExample () const
QString exampleFile () const
QString relPath () const

Detailed Description

Node representing a verbatim, unparsed text fragment.

Definition at line 362 of file docparser.h.


Member Enumeration Documentation

enum DocVerbatim::Type

Enumerator:
Code 
HtmlOnly 
ManOnly 
LatexOnly 
XmlOnly 
Verbatim 
Dot 
Msc 

Definition at line 365 of file docparser.h.


Constructor & Destructor Documentation

DocVerbatim::DocVerbatim ( DocNode parent,
const QString &  context,
const QString &  text,
Type  t,
bool  isExample,
const QString &  exampleFile 
)

Definition at line 1581 of file docparser.cpp.


Member Function Documentation

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

Returns the kind of node. Provides runtime type information

Implements DocNode.

Definition at line 369 of file docparser.h.

References DocNode::Kind_Verbatim.

Type DocVerbatim::type (  )  const [inline]

Definition at line 370 of file docparser.h.

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

QString DocVerbatim::text (  )  const [inline]

Definition at line 371 of file docparser.h.

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

QString DocVerbatim::context (  )  const [inline]

Definition at line 372 of file docparser.h.

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

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

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

Implements DocNode.

Definition at line 373 of file docparser.h.

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

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

Parameters:
v Abstract visitor.

Implements DocNode.

Definition at line 374 of file docparser.h.

References DocVisitor::visit().

bool DocVerbatim::isExample (  )  const [inline]

Definition at line 375 of file docparser.h.

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

QString DocVerbatim::exampleFile (  )  const [inline]

Definition at line 376 of file docparser.h.

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

QString DocVerbatim::relPath (  )  const [inline]

Definition at line 377 of file docparser.h.

Referenced by HtmlDocVisitor::visit().


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



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