DocSymbol Class Reference

Node representing a special symbol. More...

#include <docparser.h>

Inheritance diagram for DocSymbol:

DocNode List of all members.

Public Types

enum  SymType {
  Unknown = 0, BSlash, At, Less,
  Greater, Amp, Dollar, Hash,
  Percent, Copy, Tm, Reg,
  Apos, Quot, Uml, Acute,
  Grave, Circ, Tilde, Szlig,
  Cedil, Ring, Nbsp, Slash,
  Lsquo, Rsquo, Ldquo, Rdquo,
  Ndash, Mdash
}

Public Member Functions

 DocSymbol (DocNode *parent, SymType s, char letter='\0')
SymType symbol () const
char letter () const
Kind kind () const
DocNodeparent () const
void accept (DocVisitor *v)

Static Public Member Functions

static SymType decodeSymbol (const QString &symName, char *letter)

Detailed Description

Node representing a special symbol.

Definition at line 323 of file docparser.h.


Member Enumeration Documentation

enum DocSymbol::SymType

Enumerator:
Unknown 
BSlash 
At 
Less 
Greater 
Amp 
Dollar 
Hash 
Percent 
Copy 
Tm 
Reg 
Apos 
Quot 
Uml 
Acute 
Grave 
Circ 
Tilde 
Szlig 
Cedil 
Ring 
Nbsp 
Slash 
Lsquo 
Rsquo 
Ldquo 
Rdquo 
Ndash 
Mdash 

Definition at line 326 of file docparser.h.


Constructor & Destructor Documentation

DocSymbol::DocSymbol ( DocNode parent,
SymType  s,
char  letter = '\0' 
) [inline]

Definition at line 331 of file docparser.h.


Member Function Documentation

SymType DocSymbol::symbol (  )  const [inline]

Definition at line 333 of file docparser.h.

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

char DocSymbol::letter (  )  const [inline]

Definition at line 334 of file docparser.h.

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

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

Returns the kind of node. Provides runtime type information

Implements DocNode.

Definition at line 335 of file docparser.h.

References DocNode::Kind_Symbol.

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

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

Implements DocNode.

Definition at line 336 of file docparser.h.

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

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

Parameters:
v Abstract visitor.

Implements DocNode.

Definition at line 337 of file docparser.h.

References DocVisitor::visit().

DocSymbol::SymType DocSymbol::decodeSymbol ( const QString &  symName,
char *  letter 
) [static]

Definition at line 1387 of file docparser.cpp.

References Acute, Amp, Apos, Cedil, Circ, Copy, DBG, Grave, Greater, Ldquo, Less, Lsquo, Mdash, Nbsp, Ndash, Quot, Rdquo, Reg, Ring, Rsquo, Slash, Szlig, Tilde, Tm, Uml, and Unknown.

Referenced by DocText::parse(), DocPara::parse(), and DocIndexEntry::parse().


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