DocXRefItem Class Reference

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

#include <src/docnode.h>

Inheritance diagram for DocXRefItem:

Collaboration diagram for DocXRefItem:

Public Member Functions
	DocXRefItem (DocParser *parser, DocNodeVariant *parent, int id, const DString &key)
DString	file () const
DString	anchor () const
DString	title () const
DString	relPath () const
DString	key () const
bool	parse ()
Public Member Functions inherited from DocCompoundNode
	DocCompoundNode (DocParser *parser, DocNodeVariant *parent)
DocNodeList &	children ()
const DocNodeList &	children () const
Public Member Functions inherited from DocNode
	DocNode (DocParser *parser, DocNodeVariant *parent)
	~DocNode ()=default
DocNodeVariant *	parent ()
const DocNodeVariant *	parent () const
DocNodeVariant *	thisVariant ()
const DocNodeVariant *	thisVariant () const
void	setThisVariant (DocNodeVariant *thisVariant)
DocParser *	parser ()
const DocParser *	parser () const
void	setParent (DocNodeVariant *parent)
bool	isPreformatted () const

Private Attributes
int	m_id = 0
DString	m_key
DString	m_file
DString	m_anchor
DString	m_title
DString	m_relPath

Additional Inherited Members
Protected Types inherited from DocNode
enum	RefType {   Unknown , Anchor , Section , Table ,   Requirement }
Protected Member Functions inherited from DocNode
void	setInsidePreformatted (bool p)

Detailed Description

Node representing an item of a cross-referenced list.

Definition at line 620 of file docnode.h.

Constructor & Destructor Documentation

DocXRefItem()

DocXRefItem::DocXRefItem	(	DocParser *	parser,
		DocNodeVariant *	parent,
		int	id,
		const DString &	key )

Definition at line 480 of file docnode.cpp.

                                                                                           :
   DocCompoundNode(parser,parent), m_id(id), m_key(key), m_relPath(parser->context.relPath)
{
}

References DocCompoundNode::DocCompoundNode(), key(), m_id, m_key, m_relPath, DocNode::parent(), DocNode::parser(), and relPath().

Member Function Documentation

anchor()

DString DocXRefItem::anchor ( ) const

inline

Definition at line 625 of file docnode.h.

{ return m_anchor; }

References m_anchor.

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

file()

DString DocXRefItem::file ( ) const

inline

Definition at line 624 of file docnode.h.

{ return m_file; }

References m_file.

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

key()

DString DocXRefItem::key ( ) const

inline

Definition at line 628 of file docnode.h.

{ return m_key; }

References m_key.

Referenced by DocXRefItem(), and HtmlDocVisitor::operator()().

parse()

bool DocXRefItem::parse

(

)

Definition at line 485 of file docnode.cpp.

{
  RefList *refList = RefListManager::instance().find(m_key);
  if (refList && refList->isEnabled())
  {
    RefItem *item = refList->find(m_id);
    ASSERT(item!=nullptr);
    if (item)
    {
      if (parser()->context.memberDef && parser()->context.memberDef->name().at(0)=='@')
      {
        m_file   = "@";  // can't cross reference anonymous enum
        m_anchor = "@";
      }
      else
      {
        m_file   = refList->fileName();
        m_anchor = item->anchor();
      }
      m_title  = refList->sectionTitle();
      //printf("DocXRefItem: file=%s anchor=%s title=%s\n",
      //    qPrint(m_file),qPrint(m_anchor),qPrint(m_title));
 
      if (!item->text().empty())
      {
        DocParser::AutoSaveContext saveContext(*parser());
        parser()->internalValidatingParseDoc(thisVariant(),children(),item->text());
      }
    }
    return true;
  }
  return false;
}

References RefItem::anchor(), ASSERT, DocCompoundNode::children(), DString::empty(), RefList::fileName(), LinkedMap< T, Hash, KeyEqual, Map >::find(), RefList::find(), RefListManager::instance(), DocParser::internalValidatingParseDoc(), RefList::isEnabled(), m_anchor, m_file, m_id, m_key, m_title, DocNode::parser(), RefList::sectionTitle(), RefItem::text(), and DocNode::thisVariant().

relPath()

DString DocXRefItem::relPath ( ) const

inline

Definition at line 627 of file docnode.h.

{ return m_relPath; }

References m_relPath.

Referenced by DocXRefItem(), and HtmlDocVisitor::operator()().

title()

DString DocXRefItem::title ( ) const

inline

Definition at line 626 of file docnode.h.

{ return m_title; }

References m_title.

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

Member Data Documentation

m_anchor

DString DocXRefItem::m_anchor

private

Definition at line 635 of file docnode.h.

Referenced by anchor(), and parse().

m_file

DString DocXRefItem::m_file

private

Definition at line 634 of file docnode.h.

Referenced by file(), and parse().

m_id

int DocXRefItem::m_id = 0

private

Definition at line 632 of file docnode.h.

Referenced by DocXRefItem(), and parse().

m_key

DString DocXRefItem::m_key

private

Definition at line 633 of file docnode.h.

Referenced by DocXRefItem(), key(), and parse().

m_relPath

DString DocXRefItem::m_relPath

private

Definition at line 637 of file docnode.h.

Referenced by DocXRefItem(), and relPath().

m_title

DString DocXRefItem::m_title

private

Definition at line 636 of file docnode.h.

Referenced by parse(), and title().

---

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

• src/docnode.h
• src/docnode.cpp