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 QCString &word, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &tooltip)
QCString	word () const
QCString	file () const
QCString	relPath () const
QCString	ref () const
QCString	anchor () const
QCString	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
QCString	m_word
QCString	m_ref
QCString	m_file
QCString	m_relPath
QCString	m_anchor
QCString	m_tooltip

Additional Inherited Members
Protected Types inherited from DocNode
enum	RefType { Unknown , Anchor , Section , Table }
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 163 of file docnode.h.

Constructor & Destructor Documentation

DocLinkedWord()

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

Definition at line 191 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.isEmpty())
  {
    Doxygen::searchIndex.addWord(word,false);
  }
}

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

Member Function Documentation

anchor()

QCString DocLinkedWord::anchor ( ) const

inline

Definition at line 173 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()

QCString DocLinkedWord::file ( ) const

inline

Definition at line 170 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()

QCString DocLinkedWord::ref ( ) const

inline

Definition at line 172 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()

QCString DocLinkedWord::relPath ( ) const

inline

Definition at line 171 of file docnode.h.

{ return m_relPath; }

References m_relPath.

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

tooltip()

QCString DocLinkedWord::tooltip ( ) const

inline

Definition at line 174 of file docnode.h.

{ return m_tooltip; }

References m_tooltip.

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

word()

QCString DocLinkedWord::word ( ) const

inline

Definition at line 169 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

QCString DocLinkedWord::m_anchor

private

Definition at line 181 of file docnode.h.

Referenced by anchor(), and DocLinkedWord().

m_file

QCString DocLinkedWord::m_file

private

Definition at line 179 of file docnode.h.

Referenced by DocLinkedWord(), and file().

m_ref

QCString DocLinkedWord::m_ref

private

Definition at line 178 of file docnode.h.

Referenced by DocLinkedWord(), and ref().

m_relPath

QCString DocLinkedWord::m_relPath

private

Definition at line 180 of file docnode.h.

Referenced by DocLinkedWord(), and relPath().

m_tooltip

QCString DocLinkedWord::m_tooltip

private

Definition at line 182 of file docnode.h.

Referenced by DocLinkedWord(), and tooltip().

m_word

QCString DocLinkedWord::m_word

private

Definition at line 177 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