JKQTMathTextSubscriptNode Class Reference

subclass representing an subscript node with exactly one argument in the syntax tree More...

#include <jkqtmathtextsubsupernode.h>

Inheritance diagram for JKQTMathTextSubscriptNode:

Collaboration diagram for JKQTMathTextSubscriptNode:

Public Member Functions
	JKQTMathTextSubscriptNode (JKQTMathText *parent, JKQTMathTextNode *child)
virtual	~JKQTMathTextSubscriptNode () override
virtual double	draw (QPainter &painter, double x, double y, JKQTMathTextEnvironment currentEv) const override
	draw the contents at the designated position
double	drawWithSpecialPlacement (QPainter &painter, double x, double y, JKQTMathTextEnvironment currentEv, const JKQTMathTextNodeSize *prevNodeSizeForSpecialPlacement) const
	like draw(), i.e. draws the node, but allows to draw the subscript with special placement rules after large blocks (e.g. braces), when prevNodeSizeForSpecialPlacement is not nullptr
JKQTMathTextNodeSize	getSizeWithSpecialPlacement (QPainter &painter, JKQTMathTextEnvironment currentEv, const JKQTMathTextNodeSize *prevNodeSizeForSpecialPlacement) const
	like getSize(), i.e. determine the size of the node, but cares for subscript with special placement rules after large blocks (e.g. braces), when prevNodeSizeForSpecialPlacement is not nullptr
virtual QString	getTypeName () const override
	return the name of this class as a string
virtual bool	toHtml (QString &html, JKQTMathTextEnvironment currentEv, JKQTMathTextEnvironment defaultEv) const override
	returns the child node
Public Member Functions inherited from JKQTMathTextSingleChildNode
	JKQTMathTextSingleChildNode (JKQTMathTextNode *_child, JKQTMathText *parentMathText)
virtual	~JKQTMathTextSingleChildNode () override
JKQTMathTextNode *	getChild ()
	child node of this node
const JKQTMathTextNode *	getChild () const
	child node of this node
bool	hasChild () const
	returns true if the child is valie (!=nullptr )
void	replaceAndDeleteChild (JKQTMathTextNode *newChild)
	replaces the child node with the node newChild , deletes the replaced old node
JKQTMathTextNode *	replaceChild (JKQTMathTextNode *newChild)
	replaces the child node with the node newChild , returns the replaced old node
virtual void	setDrawBoxes (bool draw) override
	enables the drawing of colored boxes (for DEBUGGING) around the actual output of the node
Public Member Functions inherited from JKQTMathTextNode
	JKQTMathTextNode (const JKQTMathTextNode &)=delete
	JKQTMathTextNode (JKQTMathText *parentMathText)
virtual	~JKQTMathTextNode ()
bool	getDrawBoxes () const
	returns the drawing of colored boxes (for DEBUGGING) around the actual output of the node is enabled
JKQTMathTextNode *	getParentNode ()
	parent node of this node (i.e. one level up, ode nullptr )
const JKQTMathTextNode *	getParentNode () const
	parent node of this node (i.e. one level up, ode nullptr )
JKQTMathTextNodeSize	getSize (QPainter &painter, JKQTMathTextEnvironment currentEv) const
	determine the size of the node, calls getSizeInternal() implementation of the actual type
bool	isSubSuperscriptAboveBelowNode () const
	if true then following sub- and/or superscripts are placed below and above the node, not besides it. This is activated when \sum\limits_{sub}^{sup} is used in LaTeX instead of simply \sum_{sub}^{sup}
JKQTMathTextNode &	operator= (const JKQTMathTextNode &)=delete
void	setParentNode (JKQTMathTextNode *node)
	parent node of this node (i.e. one level up, ode nullptr )
void	setSubSuperscriptAboveBelowNode (bool __value)
	if true then following sub- and/or superscripts are placed below and above the node, not besides it. This is activated when \sum\limits_{sub}^{sup} is used in LaTeX instead of simply \sum_{sub}^{sup}

Protected Member Functions
virtual JKQTMathTextNodeSize	getSizeInternal (QPainter &painter, JKQTMathTextEnvironment currentEv) const override
	determine the size of the node, overwrite this function in derived classes
Protected Member Functions inherited from JKQTMathTextNode
void	addToErrorList (const QString &error)
	adds a new error to the JKQTMathText referenced by parentMathText
void	doDrawBoxes (QPainter &painter, double x, double y, const JKQTMathTextNodeSize &size) const
	draws colored boxes (for DEBUGGING) around the actual output of the node
void	doDrawBoxes (QPainter &painter, double x, double y, JKQTMathTextEnvironment currentEv) const
	draws colored boxes (for DEBUGGING) around the actual output of the node
template<class T >
QList< T * >	getParents ()
	returns the list of parent, parent-of-parent, ... that can be cast to type T
template<class T >
QList< const T * >	getParents () const
	returns the list of parent, parent-of-parent, ... that can be cast to type T

Additional Inherited Members
Static Public Member Functions inherited from JKQTMathTextNode
static double	getNonItalicXCorretion (QPainter &painter, double width_potentiallyitalic, const JKQTMathTextEnvironment &ev_potentiallyitalic, const JKQTMathTextNode *child)
	calculates the x-size-difference between the given (probably) italic (width externally calculated: width_potentiallyitalic, ev_potentiallyitalic) and the non-italic version of child
Protected Attributes inherited from JKQTMathTextSingleChildNode
JKQTMathTextNode *	child
	child node of this node
Protected Attributes inherited from JKQTMathTextNode
bool	drawBoxes
	enables the drawing of colored boxes (for DEBUGGING) around the actual output of the node
JKQTMathText *	parentMathText
	parent JKQTMathText object (required for several drawing operations
JKQTMathTextNode *	parentNode
	parent node of this node (i.e. one level up, ode nullptr )
bool	subSuperscriptAboveBelowNode
	if true then following sub- and/or superscripts are placed below and above the node, not besides it. This is activated when \sum\limits_{sub}^{sup} is used in LaTeX instead of simply \sum_{sub}^{sup}

Detailed Description

subclass representing an subscript node with exactly one argument in the syntax tree

Constructor & Destructor Documentation

JKQTMathTextSubscriptNode()

JKQTMathTextSubscriptNode::JKQTMathTextSubscriptNode ( JKQTMathText *  parent, JKQTMathTextNode *  child  )

explicit

~JKQTMathTextSubscriptNode()

virtual JKQTMathTextSubscriptNode::~JKQTMathTextSubscriptNode ( )

overridevirtual

Member Function Documentation

draw()

virtual double JKQTMathTextSubscriptNode::draw ( QPainter &  painter, double  x, double  y, JKQTMathTextEnvironment  currentEv  ) const

overridevirtual

draw the contents at the designated position

Parameters

painter	QPainter to use
x	x-position, where the drawing starts [Pixel]
y	Y-position of the baseline, where the drawing starts [Pixel]
currentEv	JKQTMathTextEnvironment object describing the current drawing environment/settings

Returns

the x position which to use for the next part of the text

Implements JKQTMathTextNode.

drawWithSpecialPlacement()

double JKQTMathTextSubscriptNode::drawWithSpecialPlacement	(	QPainter &	painter,
		double	x,
		double	y,
		JKQTMathTextEnvironment	currentEv,
		const JKQTMathTextNodeSize *	prevNodeSizeForSpecialPlacement
	)		const

like draw(), i.e. draws the node, but allows to draw the subscript with special placement rules after large blocks (e.g. braces), when prevNodeSizeForSpecialPlacement is not nullptr

Parameters

	painter	QPainter to use
	x	x-position, where the drawing starts [Pixel]
	y	Y-position of the baseline, where the drawing starts [Pixel]
	currentEv	JKQTMathTextEnvironment object describing the current drawing environment/settings
[in]	prevNodeSizeForSpecialPlacement	optional parameter, describing the size of the previous node (on the left). This may be used for layout of some nodes (e.g. sub/super to move correctly next to large parantheses ...)

Returns

the x position which to use for the next part of the text

getSizeInternal()

virtual JKQTMathTextNodeSize JKQTMathTextSubscriptNode::getSizeInternal ( QPainter &  painter, JKQTMathTextEnvironment  currentEv  ) const

overrideprotectedvirtual

determine the size of the node, overwrite this function in derived classes

Parameters

painter	painter to use for determining the size
currentEv	current environment object

Returns

all important box size parameters packed as JKQTMathTextNodeSize

Implements JKQTMathTextNode.

getSizeWithSpecialPlacement()

JKQTMathTextNodeSize JKQTMathTextSubscriptNode::getSizeWithSpecialPlacement	(	QPainter &	painter,
		JKQTMathTextEnvironment	currentEv,
		const JKQTMathTextNodeSize *	prevNodeSizeForSpecialPlacement
	)		const

like getSize(), i.e. determine the size of the node, but cares for subscript with special placement rules after large blocks (e.g. braces), when prevNodeSizeForSpecialPlacement is not nullptr

Parameters

	painter	painter to use for determining the size
	currentEv	current environment object
[in]	prevNodeSizeForSpecialPlacement	optional parameter, describing the size of the previous node (on the left). This may be used for layout of some nodes (e.g. sub/super to move correctly next to large parantheses ...)

getTypeName()

virtual QString JKQTMathTextSubscriptNode::getTypeName ( ) const

overridevirtual

return the name of this class as a string

Reimplemented from JKQTMathTextNode.

toHtml()

virtual bool JKQTMathTextSubscriptNode::toHtml ( QString &  html, JKQTMathTextEnvironment  currentEv, JKQTMathTextEnvironment  defaultEv  ) const

overridevirtual

returns the child node

convert node to HTML and returns true on success

Parameters

[out]	html	new HTML code is APPENDED to this string
	currentEv	JKQTMathTextEnvironment object describing the current drawing environment/settings
	defaultEv	JKQTMathTextEnvironment object describing the default drawing environment/settings when starting to interpret a node tree

Returns

true on success

Reimplemented from JKQTMathTextNode.

---

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

• jkqtmathtextsubsupernode.h