The Formula Class Reference

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

Declaration

class Formula { ... }

Included Headers

#include <src/formula.h>

Friends Index

class	FormulaManager

Public Constructors Index

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

Public Member Functions Index

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 Index

void	setCached (bool cached)
void	setCachedDark (bool cached)

Private Member Attributes Index

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

Description

Class representing a LaTeX formula as found in the documentation.

Definition at line 28 of file formula.h.

Friends

FormulaManager

friend class FormulaManager

Definition at line 44 of file formula.h.

44 friend class FormulaManager;

Reference FormulaManager.

Referenced by FormulaManager.

Public Constructors

Formula()

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

inline

Definition at line 31 of file formula.h.

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

32 : 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.

Public Member Functions

height()

int Formula::height ()

inline

Definition at line 35 of file formula.h.

35 int height() const { return m_height; }

Reference m_height.

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

id()

int Formula::id ()

inline

Definition at line 36 of file formula.h.

36 int id() const { return m_id; }

Reference m_id.

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

isCached()

bool Formula::isCached ()

inline

Definition at line 38 of file formula.h.

38 bool isCached() const { return m_cached && !m_forceRegen; }

References m_cached and m_forceRegen.

isCachedDark()

bool Formula::isCachedDark ()

inline

Definition at line 39 of file formula.h.

39 bool isCachedDark() const { return m_cached && !m_forceRegen; }

References m_cached and m_forceRegen.

setHeight()

void Formula::setHeight (int height)

inline

Definition at line 41 of file formula.h.

41 void setHeight(int height) { 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.

40 void setWidth(int width) { m_width = width; }

References m_width and width.

Referenced by updateFormulaSize.

text()

QCString Formula::text ()

inline

Definition at line 37 of file formula.h.

37 QCString text() const { return m_text; }

Reference m_text.

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

width()

int Formula::width ()

inline

Definition at line 34 of file formula.h.

34 int width() const { return m_width; }

Reference m_width.

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

Private Member Functions

setCached()

void Formula::setCached (bool cached)

inline

Definition at line 45 of file formula.h.

45 void setCached(bool cached) { m_cached = cached; m_forceRegen = m_forceRegen || !cached; }

References m_cached and m_forceRegen.

Referenced by FormulaManager::initFromRepository.

setCachedDark()

void Formula::setCachedDark (bool cached)

inline

Definition at line 46 of file formula.h.

46 void setCachedDark(bool cached) { m_cachedDark = cached; m_forceRegen = m_forceRegen || !cached; }

References m_cachedDark and m_forceRegen.

Referenced by FormulaManager::initFromRepository.

Private Member Attributes

m_cached

bool Formula::m_cached = false

Definition at line 52 of file formula.h.

52 bool m_cached = false;

Referenced by isCached, isCachedDark and setCached.

m_cachedDark

bool Formula::m_cachedDark = false

Definition at line 53 of file formula.h.

53 bool m_cachedDark = false; // dark version cached?

Referenced by setCachedDark.

m_forceRegen

bool Formula::m_forceRegen = false

Definition at line 54 of file formula.h.

54 bool m_forceRegen = false; // true if there is an inconsistency in setCache calls

Referenced by isCached, isCachedDark, setCached and setCachedDark.

m_height

int Formula::m_height

Definition at line 51 of file formula.h.

51 int m_height;

Referenced by Formula, height and setHeight.

m_id

int Formula::m_id

Definition at line 49 of file formula.h.

49 int m_id;

Referenced by Formula and id.

m_text

QCString Formula::m_text

Definition at line 48 of file formula.h.

48 QCString m_text;

Referenced by Formula and text.

m_width

int Formula::m_width

Definition at line 50 of file formula.h.

50 int m_width;

Referenced by Formula, setWidth and width.

---

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

• formula.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.