#include <docparser.h>

Inheritance diagram for DocXRefItem:

Public Member Functions
	DocXRefItem (DocNode parent, int id, const char key)

Kind	kind () const

QCString	file () const

QCString	anchor () const

QCString	title () const

QCString	relPath () const

QCString	key () const

void	accept (DocVisitor *v)

bool	parse ()

Public Member Functions inherited from CompAccept< DocXRefItem >
	CompAccept ()

virtual	~CompAccept ()

void	accept (DocXRefItem obj, DocVisitor v)

const QList< DocNode > &	children () const

QList< DocNode > &	children ()

Public Member Functions inherited from DocNode
	DocNode ()

virtual	~DocNode ()

DocNode *	parent () const

void	setParent (DocNode *parent)

bool	isPreformatted () const

Private Attributes
int	m_id

QCString	m_key

QCString	m_file

QCString	m_anchor

QCString	m_title

QCString	m_relPath

Additional Inherited Members
Public Types inherited from DocNode
enum	Kind { Kind_Root = 0, Kind_Word = 1, Kind_WhiteSpace = 2, Kind_Para = 3, Kind_AutoList = 4, Kind_AutoListItem = 5, Kind_Symbol = 6, Kind_URL = 7, Kind_StyleChange = 8, Kind_SimpleSect = 9, Kind_Title = 10, Kind_SimpleList = 11, Kind_SimpleListItem = 12, Kind_Section = 13, Kind_Verbatim = 14, Kind_XRefItem = 15, Kind_HtmlList = 16, Kind_HtmlListItem = 17, Kind_HtmlDescList = 18, Kind_HtmlDescData = 19, Kind_HtmlDescTitle = 20, Kind_HtmlTable = 21, Kind_HtmlRow = 22, Kind_HtmlCell = 23, Kind_HtmlCaption = 24, Kind_LineBreak = 25, Kind_HorRuler = 26, Kind_Anchor = 27, Kind_IndexEntry = 28, Kind_Internal = 29, Kind_HRef = 30, Kind_Include = 31, Kind_IncOperator = 32, Kind_HtmlHeader = 33, Kind_Image = 34, Kind_DotFile = 35, Kind_Link = 36, Kind_Ref = 37, Kind_Formula = 38, Kind_SecRefItem = 39, Kind_SecRefList = 40, Kind_SimpleSectSep = 41, Kind_LinkedWord = 42, Kind_ParamSect = 43, Kind_ParamList = 44, Kind_InternalRef = 45, Kind_Copy = 46, Kind_Text = 47, Kind_MscFile = 48, Kind_HtmlBlockQuote = 49, Kind_VhdlFlow = 50, Kind_ParBlock = 51, Kind_DiaFile = 52 }

Protected Member Functions inherited from DocNode
void	setInsidePreformatted (bool p)

Protected Attributes inherited from CompAccept< DocXRefItem >
QList< DocNode >	m_children

Protected Attributes inherited from DocNode
DocNode *	m_parent

Detailed Description

Node representing an item of a cross-referenced list

Definition at line 664 of file docparser.h.

Constructor & Destructor Documentation

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

Definition at line 2168 of file docparser.cpp.

References DocNode::m_parent, and DocNode::parent().

                                                               : 
   m_id(id), m_key(key), m_relPath(g_relPath)
{
   m_parent = parent; 
}

Member Function Documentation

void DocXRefItem::accept ( DocVisitor * v )

inlinevirtual

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

Parameters

v	Abstract visitor.

Implements DocNode.

Definition at line 674 of file docparser.h.

References CompAccept< T >::accept().

{ CompAccept<DocXRefItem>::accept(this,v); }

QCString DocXRefItem::anchor ( ) const

inline

Definition at line 670 of file docparser.h.

References m_anchor.

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

{ return m_anchor; }

QCString DocXRefItem::file ( ) const

inline

Definition at line 669 of file docparser.h.

References m_file.

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

{ return m_file; }

QCString DocXRefItem::key ( ) const

inline

Definition at line 673 of file docparser.h.

References m_key.

Referenced by HtmlDocVisitor::visitPre().

{ return m_key; }

Kind DocXRefItem::kind ( ) const

inlinevirtual

Returns the kind of node. Provides runtime type information

Implements DocNode.

Definition at line 668 of file docparser.h.

References DocNode::Kind_XRefItem.

{ return Kind_XRefItem; }

bool DocXRefItem::parse ( )

Definition at line 2174 of file docparser.cpp.

References Config_getBool, docParserPopContext(), docParserPushContext(), RefList::fileName(), RefList::getRefItem(), internalValidatingParseDoc(), RefItem::listAnchor, m_anchor, CompAccept< DocXRefItem >::m_children, m_file, m_id, m_key, m_title, Definition::name(), RefList::sectionTitle(), RefItem::text, and Doxygen::xrefLists.

Referenced by DocPara::handleXRefItem().

{
  RefList *refList = Doxygen::xrefLists->find(m_key); 
  if (refList && 
      (
       // either not a built-in list or the list is enabled
       (m_key!="todo"       || Config_getBool(GENERATE_TODOLIST)) && 
       (m_key!="test"       || Config_getBool(GENERATE_TESTLIST)) && 
       (m_key!="bug"        || Config_getBool(GENERATE_BUGLIST))  && 
       (m_key!="deprecated" || Config_getBool(GENERATE_DEPRECATEDLIST))
      ) 
     )
  {
    RefItem *item = refList->getRefItem(m_id);
    ASSERT(item!=0);
    if (item)
    {
      if (g_memberDef && g_memberDef->name().at(0)=='@')
      {
        m_file   = "@";  // can't cross reference anonymous enum
        m_anchor = "@";
      }
      else
      {
        m_file   = refList->fileName();
        m_anchor = item->listAnchor;
      }
      m_title  = refList->sectionTitle();
      //printf("DocXRefItem: file=%s anchor=%s title=%s\n",
      //    m_file.data(),m_anchor.data(),m_title.data());
      if (!item->text.isEmpty())
      {
        docParserPushContext();
        internalValidatingParseDoc(this,m_children,item->text);
        docParserPopContext();
      }
    }
    return TRUE;
  }
  return FALSE;
}

QCString DocXRefItem::relPath ( ) const

inline

Definition at line 672 of file docparser.h.

References m_relPath.

Referenced by HtmlDocVisitor::visitPre().

{ return m_relPath; }

QCString DocXRefItem::title ( ) const

inline

Definition at line 671 of file docparser.h.

References m_title.

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

{ return m_title; }

Member Data Documentation

QCString DocXRefItem::m_anchor

private

Definition at line 681 of file docparser.h.

Referenced by anchor(), and parse().

QCString DocXRefItem::m_file

private

Definition at line 680 of file docparser.h.

Referenced by file(), and parse().

int DocXRefItem::m_id

private

Definition at line 678 of file docparser.h.

Referenced by parse().

QCString DocXRefItem::m_key

private

Definition at line 679 of file docparser.h.

Referenced by key(), and parse().

QCString DocXRefItem::m_relPath

private

Definition at line 683 of file docparser.h.

Referenced by relPath().

QCString DocXRefItem::m_title

private

Definition at line 682 of file docparser.h.

Referenced by parse(), and title().

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation