DocLinkedWord Class Reference

Node representing a word that can be linked to something. More...

#include <src/docnode.h>

Inheritance diagram for DocLinkedWord:

Collaboration diagram for DocLinkedWord:

Public Member Functions
	DocLinkedWord (DocParser *parser, DocNodeVariant *parent, const DString &word, const DString &ref, const DString &file, const DString &anchor, const DString &tooltip)
DString	word () const
DString	file () const
DString	relPath () const
DString	ref () const
DString	anchor () const
DString	tooltip () 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
DString	m_word
DString	m_ref
DString	m_file
DString	m_relPath
DString	m_anchor
DString	m_tooltip

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 a word that can be linked to something.

Definition at line 164 of file docnode.h.

Constructor & Destructor Documentation

DocLinkedWord()

DocLinkedWord::DocLinkedWord	(	DocParser *	parser,
		DocNodeVariant *	parent,
		const DString &	word,
		const DString &	ref,
		const DString &	file,
		const DString &	anchor,
		const DString &	tooltip )

Definition at line 196 of file docnode.cpp.

                                                                :
      DocNode(parser,parent), m_word(word), m_ref(ref),
      m_file(file), m_relPath(parser->context.relPath), m_anchor(anchor),
      m_tooltip(tooltip)
{
  //printf("DocLinkedWord: new word %s url=%s tooltip='%s'\n",
  //    qPrint(word),qPrint(parser->context.searchUrl),qPrint(tooltip));
  if (Doxygen::searchIndex.enabled() && !parser->context.searchUrl.empty())
  {
    Doxygen::searchIndex.addWord(word,false);
  }
}

References anchor(), DocParser::context, DocNode::DocNode(), DString::empty(), file(), m_anchor, m_file, m_ref, m_relPath, m_tooltip, m_word, DocNode::parent(), DocNode::parser(), ref(), relPath(), Doxygen::searchIndex, DocParserContext::searchUrl, tooltip(), and word().

Member Function Documentation

anchor()

DString DocLinkedWord::anchor ( ) const

inline

Definition at line 174 of file docnode.h.

{ return m_anchor; }

References m_anchor.

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

file()

DString DocLinkedWord::file ( ) const

inline

Definition at line 171 of file docnode.h.

{ return m_file; }

References m_file.

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

ref()

DString DocLinkedWord::ref ( ) const

inline

Definition at line 173 of file docnode.h.

{ return m_ref; }

References m_ref.

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

relPath()

DString DocLinkedWord::relPath ( ) const

inline

Definition at line 172 of file docnode.h.

{ return m_relPath; }

References m_relPath.

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

tooltip()

DString DocLinkedWord::tooltip ( ) const

inline

Definition at line 175 of file docnode.h.

{ return m_tooltip; }

References m_tooltip.

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

word()

DString DocLinkedWord::word ( ) const

inline

Definition at line 170 of file docnode.h.

{ return m_word; }

References m_word.

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

Member Data Documentation

m_anchor

DString DocLinkedWord::m_anchor

private

Definition at line 182 of file docnode.h.

Referenced by anchor(), and DocLinkedWord().

m_file

DString DocLinkedWord::m_file

private

Definition at line 180 of file docnode.h.

Referenced by DocLinkedWord(), and file().

m_ref

DString DocLinkedWord::m_ref

private

Definition at line 179 of file docnode.h.

Referenced by DocLinkedWord(), and ref().

m_relPath

DString DocLinkedWord::m_relPath

private

Definition at line 181 of file docnode.h.

Referenced by DocLinkedWord(), and relPath().

m_tooltip

DString DocLinkedWord::m_tooltip

private

Definition at line 183 of file docnode.h.

Referenced by DocLinkedWord(), and tooltip().

m_word

DString DocLinkedWord::m_word

private

Definition at line 178 of file docnode.h.

Referenced by DocLinkedWord(), and word().

---

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

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