DocXRefItem Class Reference

Node representing an item of a cross-referenced list. More...

#include <docparser.h>

Inheritance diagram for DocXRefItem:

CompAccept< DocXRefItem > DocNode List of all members.

Public Member Functions

 DocXRefItem (DocNode *parent, int id, const char *key)
Kind kind () const
QString file () const
QString anchor () const
QString title () const
DocNodeparent () const
QString relPath () const
QString key () const
void accept (DocVisitor *v)
bool parse ()

Detailed Description

Node representing an item of a cross-referenced list.

Definition at line 560 of file docparser.h.


Constructor & Destructor Documentation

DocXRefItem::DocXRefItem ( DocNode parent,
int  id,
const char *  key 
)

Definition at line 1786 of file docparser.cpp.


Member Function Documentation

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

Returns the kind of node. Provides runtime type information

Implements DocNode.

Definition at line 565 of file docparser.h.

References DocNode::Kind_XRefItem.

QString DocXRefItem::file (  )  const [inline]

Definition at line 566 of file docparser.h.

Referenced by XmlDocVisitor::visitPre(), RTFDocVisitor::visitPre(), PrintDocVisitor::visitPre(), LatexDocVisitor::visitPre(), and HtmlDocVisitor::visitPre().

QString DocXRefItem::anchor (  )  const [inline]

Definition at line 567 of file docparser.h.

Referenced by XmlDocVisitor::visitPre(), RTFDocVisitor::visitPre(), PrintDocVisitor::visitPre(), LatexDocVisitor::visitPre(), and HtmlDocVisitor::visitPre().

QString DocXRefItem::title (  )  const [inline]

Definition at line 568 of file docparser.h.

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

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

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

Implements DocNode.

Definition at line 569 of file docparser.h.

QString DocXRefItem::relPath (  )  const [inline]

Definition at line 570 of file docparser.h.

Referenced by HtmlDocVisitor::visitPre().

QString DocXRefItem::key (  )  const [inline]

Definition at line 571 of file docparser.h.

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

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

Parameters:
v Abstract visitor.

Implements DocNode.

Definition at line 572 of file docparser.h.

References CompAccept< T >::accept().

bool DocXRefItem::parse (  ) 

Definition at line 1791 of file docparser.cpp.

References Config_getBool, RefList::getRefItem(), RefItem::listAnchor, RefList::listName(), CompAccept< DocXRefItem >::m_children, MemberDef::name, RefList::sectionTitle(), RefItem::text, and Doxygen::xrefLists.

Referenced by DocPara::handleXRefItem().


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