DocFormula Class Reference

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

#include <src/docnode.h>

Inheritance diagram for DocFormula:

Collaboration diagram for DocFormula:

Public Member Functions
	DocFormula (DocParser *parser, DocNodeVariant *parent, int id)
QCString	name () const
QCString	text () const
QCString	relPath () const
int	id () const
bool	isInline () 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_name
QCString	m_text
QCString	m_relPath
int	m_id = 0

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 an item of a cross-referenced list.

Definition at line 523 of file docnode.h.

Constructor & Destructor Documentation

DocFormula()

DocFormula::DocFormula	(	DocParser *	parser,
		DocNodeVariant *	parent,
		int	id )

Definition at line 514 of file docnode.cpp.

                                                                      : DocNode(parser,parent),
      m_relPath(parser->context.relPath)
{
  const Formula *formula = FormulaManager::instance().findFormula(id);
  if (formula && !formula->text().isEmpty())
  {
    m_id = id;
    m_name.sprintf("form_%d",m_id);
    m_text = formula->text();
  }
  else // wrong \_form#<n> command
  {
    warn_doc_error(parser->context.fileName,parser->tokenizer.getLineNr(),"Wrong formula id %d",id);
    m_id = -1;
  }
}

References DocNode::DocNode(), FormulaManager::findFormula(), id(), FormulaManager::instance(), QCString::isEmpty(), m_id, m_name, m_relPath, m_text, DocNode::parent(), DocNode::parser(), relPath(), Formula::text(), and warn_doc_error.

Member Function Documentation

id()

int DocFormula::id ( ) const

inline

Definition at line 530 of file docnode.h.

{ return m_id; }

References m_id.

Referenced by DocFormula(), HtmlDocVisitor::operator()(), PerlModDocVisitor::operator()(), and XmlDocVisitor::operator()().

isInline()

bool DocFormula::isInline ( ) const

inline

Definition at line 531 of file docnode.h.

    {
      if (m_text.length()>1 && m_text.at(0)=='\\' && m_text.at(1)=='[') return false;
      if (m_text.startsWith("\\begin{")) return false;
      return true;
    }

References m_text.

Referenced by mustBeOutsideParagraph(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), and RTFDocVisitor::operator()().

name()

QCString DocFormula::name ( ) const

inline

Definition at line 527 of file docnode.h.

{ return m_name; }

References m_name.

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

relPath()

QCString DocFormula::relPath ( ) const

inline

Definition at line 529 of file docnode.h.

{ return m_relPath; }

References m_relPath.

Referenced by DocFormula(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), and RTFDocVisitor::operator()().

text()

QCString DocFormula::text ( ) const

inline

Definition at line 528 of file docnode.h.

{ return m_text; }

References m_text.

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

Member Data Documentation

m_id

int DocFormula::m_id = 0

private

Definition at line 542 of file docnode.h.

Referenced by DocFormula(), and id().

m_name

QCString DocFormula::m_name

private

Definition at line 539 of file docnode.h.

Referenced by DocFormula(), and name().

m_relPath

QCString DocFormula::m_relPath

private

Definition at line 541 of file docnode.h.

Referenced by DocFormula(), and relPath().

m_text

QCString DocFormula::m_text

private

Definition at line 540 of file docnode.h.

Referenced by DocFormula(), isInline(), and text().

---

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

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