Public Member Functions | Private Attributes | List of all members
DocLinkedWord Class Reference

#include <docparser.h>

Inheritance diagram for DocLinkedWord:
DocNode

Public Member Functions

 DocLinkedWord (DocNode *parent, const QCString &word, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &tooltip)
 
QCString word () const
 
Kind kind () const
 
QCString file () const
 
QCString relPath () const
 
QCString ref () const
 
QCString anchor () const
 
QCString tooltip () const
 
void accept (DocVisitor *v)
 
- Public Member Functions inherited from DocNode
 DocNode ()
 
virtual ~DocNode ()
 
DocNodeparent () const
 
void setParent (DocNode *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

- 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 DocNode
DocNodem_parent
 

Detailed Description

Node representing a word that can be linked to something

Definition at line 209 of file docparser.h.

Constructor & Destructor Documentation

DocLinkedWord::DocLinkedWord ( DocNode parent,
const QCString word,
const QCString ref,
const QCString file,
const QCString anchor,
const QCString tooltip 
)

Definition at line 1817 of file docparser.cpp.

1819  :
1820  m_word(word), m_ref(ref),
1821  m_file(file), m_relPath(g_relPath), m_anchor(anchor),
1822  m_tooltip(tooltip)
1823 {
1824  m_parent = parent;
1825  //printf("DocLinkedWord: new word %s url=%s tooltip='%s'\n",
1826  // word.data(),g_searchUrl.data(),tooltip.data());
1828  {
1830  }
1831 }
DocNode * parent() const
Definition: docparser.h:147
QCString m_ref
Definition: docparser.h:226
QCString m_word
Definition: docparser.h:225
bool isEmpty() const
Definition: qcstring.h:189
QCString m_tooltip
Definition: docparser.h:230
const bool FALSE
Definition: qglobal.h:370
QCString m_anchor
Definition: docparser.h:229
static QCString g_relPath
Definition: docparser.cpp:96
static SearchIndexIntf * searchIndex
Definition: doxygen.h:133
DocNode * m_parent
Definition: docparser.h:163
QCString m_relPath
Definition: docparser.h:228
virtual void addWord(const char *word, bool hiPriority)=0
static QCString g_searchUrl
Definition: docparser.cpp:105
QCString m_file
Definition: docparser.h:227

Member Function Documentation

void DocLinkedWord::accept ( DocVisitor v)
inlinevirtual

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

Parameters
vAbstract visitor.

Implements DocNode.

Definition at line 222 of file docparser.h.

222 { v->visit(this); }
virtual void visit(DocWord *)=0
QCString DocLinkedWord::anchor ( ) const
inline

Definition at line 220 of file docparser.h.

220 { return m_anchor; }
QCString m_anchor
Definition: docparser.h:229
QCString DocLinkedWord::file ( ) const
inline

Definition at line 217 of file docparser.h.

217 { return m_file; }
QCString m_file
Definition: docparser.h:227
Kind DocLinkedWord::kind ( ) const
inlinevirtual

Returns the kind of node. Provides runtime type information

Implements DocNode.

Definition at line 216 of file docparser.h.

QCString DocLinkedWord::ref ( ) const
inline

Definition at line 219 of file docparser.h.

219 { return m_ref; }
QCString m_ref
Definition: docparser.h:226
QCString DocLinkedWord::relPath ( ) const
inline

Definition at line 218 of file docparser.h.

218 { return m_relPath; }
QCString m_relPath
Definition: docparser.h:228
QCString DocLinkedWord::tooltip ( ) const
inline

Definition at line 221 of file docparser.h.

221 { return m_tooltip; }
QCString m_tooltip
Definition: docparser.h:230
QCString DocLinkedWord::word ( ) const
inline

Definition at line 215 of file docparser.h.

215 { return m_word; }
QCString m_word
Definition: docparser.h:225

Member Data Documentation

QCString DocLinkedWord::m_anchor
private

Definition at line 229 of file docparser.h.

QCString DocLinkedWord::m_file
private

Definition at line 227 of file docparser.h.

QCString DocLinkedWord::m_ref
private

Definition at line 226 of file docparser.h.

QCString DocLinkedWord::m_relPath
private

Definition at line 228 of file docparser.h.

QCString DocLinkedWord::m_tooltip
private

Definition at line 230 of file docparser.h.

QCString DocLinkedWord::m_word
private

Definition at line 225 of file docparser.h.


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