Formula Class Reference

Class representing a LaTeX formula as found in the documentation. More...

#include <src/formula.h>

Collaboration diagram for Formula:

Public Member Functions
	Formula (const QCString &text, int id, int width=-1, int height=-1)
int	width () const
int	height () const
int	id () const
QCString	text () const
bool	isCached () const
bool	isCachedDark () const
void	setWidth (int width)
void	setHeight (int height)

Private Member Functions
void	setCached (bool cached)
void	setCachedDark (bool cached)

Private Attributes
QCString	m_text
int	m_id
int	m_width
int	m_height
bool	m_cached = false
bool	m_cachedDark = false
bool	m_forceRegen = false

Friends
class	FormulaManager

Detailed Description

Class representing a LaTeX formula as found in the documentation.

Definition at line 28 of file formula.h.

Constructor & Destructor Documentation

Formula()

Formula::Formula ( const QCString & text, int id, int width = -1, int height = -1 )

inline

Definition at line 31 of file formula.h.

      : m_text(text), m_id(id), m_width(width), m_height(height) {}

References height(), id(), m_height, m_id, m_text, m_width, text(), and width().

Member Function Documentation

height()

int Formula::height ( ) const

inline

Definition at line 35 of file formula.h.

{ return m_height; }

References m_height.

Referenced by Formula(), HtmlDocVisitor::operator()(), and setHeight().

id()

int Formula::id ( ) const

inline

Definition at line 36 of file formula.h.

{ return m_id;     }

References m_id.

Referenced by FormulaManager::addFormula(), Formula(), and FormulaManager::initFromRepository().

isCached()

bool Formula::isCached ( ) const

inline

Definition at line 38 of file formula.h.

{ return m_cached && !m_forceRegen; }

References m_cached, and m_forceRegen.

isCachedDark()

bool Formula::isCachedDark ( ) const

inline

Definition at line 39 of file formula.h.

{ return m_cached && !m_forceRegen; }

References m_cached, and m_forceRegen.

setCached()

void Formula::setCached ( bool cached )

inlineprivate

Definition at line 45 of file formula.h.

{ m_cached = cached; m_forceRegen = m_forceRegen || !cached; }

References m_cached, and m_forceRegen.

Referenced by FormulaManager::initFromRepository().

setCachedDark()

void Formula::setCachedDark ( bool cached )

inlineprivate

Definition at line 46 of file formula.h.

{ m_cachedDark = cached; m_forceRegen = m_forceRegen || !cached; }

References m_cachedDark, and m_forceRegen.

Referenced by FormulaManager::initFromRepository().

setHeight()

void Formula::setHeight ( int height )

inline

Definition at line 41 of file formula.h.

{ m_height = height; }

References height(), and m_height.

Referenced by updateFormulaSize().

setWidth()

void Formula::setWidth ( int width )

inline

Definition at line 40 of file formula.h.

{ m_width  = width;  }

References m_width, and width().

Referenced by updateFormulaSize().

text()

QCString Formula::text ( ) const

inline

Definition at line 37 of file formula.h.

{ return m_text;   }

References m_text.

Referenced by DocFormula::DocFormula(), Formula(), and FormulaManager::initFromRepository().

width()

int Formula::width ( ) const

inline

Definition at line 34 of file formula.h.

{ return m_width;  }

References m_width.

Referenced by Formula(), HtmlDocVisitor::operator()(), and setWidth().

Friends And Related Symbol Documentation

FormulaManager

friend class FormulaManager

friend

Definition at line 44 of file formula.h.

References FormulaManager.

Referenced by FormulaManager.

Member Data Documentation

m_cached

bool Formula::m_cached = false

private

Definition at line 52 of file formula.h.

Referenced by isCached(), isCachedDark(), and setCached().

m_cachedDark

bool Formula::m_cachedDark = false

private

Definition at line 53 of file formula.h.

Referenced by setCachedDark().

m_forceRegen

bool Formula::m_forceRegen = false

private

Definition at line 54 of file formula.h.

Referenced by isCached(), isCachedDark(), setCached(), and setCachedDark().

m_height

int Formula::m_height

private

Definition at line 51 of file formula.h.

Referenced by Formula(), height(), and setHeight().

m_id

int Formula::m_id

private

Definition at line 49 of file formula.h.

Referenced by Formula(), and id().

m_text

QCString Formula::m_text

private

Definition at line 48 of file formula.h.

Referenced by Formula(), and text().

m_width

int Formula::m_width

private

Definition at line 50 of file formula.h.

Referenced by Formula(), setWidth(), and width().

---

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

• src/formula.h