DocInclude Class Reference

Node representing an included text block from file. More...

#include <docparser.h>

Inheritance diagram for DocInclude:

DocNode List of all members.

Public Types

enum  Type {
  Include, DontInclude, VerbInclude, HtmlInclude,
  IncWithLines
}

Public Member Functions

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

Detailed Description

Node representing an included text block from file.

Definition at line 391 of file docparser.h.


Member Enumeration Documentation

enum DocInclude::Type

Enumerator:
Include 
DontInclude 
VerbInclude 
HtmlInclude 
IncWithLines 

Definition at line 394 of file docparser.h.


Constructor & Destructor Documentation

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

Definition at line 395 of file docparser.h.


Member Function Documentation

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

Returns the kind of node. Provides runtime type information

Implements DocNode.

Definition at line 400 of file docparser.h.

References DocNode::Kind_Include.

QString DocInclude::file (  )  const [inline]

Definition at line 401 of file docparser.h.

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

QString DocInclude::extension (  )  const [inline]

Definition at line 402 of file docparser.h.

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

Type DocInclude::type (  )  const [inline]

Definition at line 408 of file docparser.h.

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

QString DocInclude::text (  )  const [inline]

Definition at line 409 of file docparser.h.

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

QString DocInclude::context (  )  const [inline]

Definition at line 410 of file docparser.h.

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

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

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

Implements DocNode.

Definition at line 411 of file docparser.h.

bool DocInclude::isExample (  )  const [inline]

Definition at line 412 of file docparser.h.

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

QString DocInclude::exampleFile (  )  const [inline]

Definition at line 413 of file docparser.h.

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

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

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

Parameters:
v Abstract visitor.

Implements DocNode.

Definition at line 414 of file docparser.h.

References DocVisitor::visit().

void DocInclude::parse (  ) 

Definition at line 1592 of file docparser.cpp.

References DBG, DontInclude, HtmlInclude, Include, IncWithLines, and VerbInclude.

Referenced by DocPara::handleInclude().


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