subclass representing a sqrt node More...

#include <jkqtmathtextsqrtnode.h>

Inheritance diagram for JKQTMathTextSqrtNode:

Collaboration diagram for JKQTMathTextSqrtNode:

Public Member Functions
	JKQTMathTextSqrtNode (JKQTMathText parent, JKQTMathTextNode child__, JKQTMathTextNode *childDegree__=nullptr)

virtual	~JKQTMathTextSqrtNode () override

virtual int	childCount () const override
	returns the i-th child node

virtual void	clearChildren (bool deleteChildren=true) override
	returns the i-th child node

virtual void	deleteChild (int i) override
	delete the i-th child

virtual double	draw (QPainter &painter, double x, double y, JKQTMathTextEnvironment currentEv) const override
	draw the contents at the designated position

JKQTMathTextNode *	getChild ()
	child node for the part under the root

const JKQTMathTextNode *	getChild () const
	child node for the part under the root

virtual const JKQTMathTextNode *	getChild (int i) const override
	returns the i-th child node

virtual JKQTMathTextNode *	getChild (int i) override
	returns the i-th child node

JKQTMathTextNode *	getChildDegree ()
	second child node for the degree of the root (or nullptr if nothing)

const JKQTMathTextNode *	getChildDegree () const
	second child node for the degree of the root (or nullptr if nothing)

virtual QString	getTypeName () const override
	return the name of this class as a string

virtual JKQTMathTextNode *	replaceChild (int i, JKQTMathTextNode *newChild) override
	returns the i-th child node

virtual bool	toHtml (QString &html, JKQTMathTextEnvironment currentEv, JKQTMathTextEnvironment defaultEv) const override
	convert node to HTML and returns `true` on success

Public Member Functions inherited from JKQTMathTextMultiChildNode
	JKQTMathTextMultiChildNode (JKQTMathText *parentMathText)

virtual	~JKQTMathTextMultiChildNode () override

virtual QList< JKQTMathTextNode * >	getChildren ()
	returns a list of all child node

virtual QList< const JKQTMathTextNode * >	getChildren () const
	returns a list of all child node

virtual JKQTMathTextNode *	getFirstChild ()
	returns the first child node

virtual const JKQTMathTextNode *	getFirstChild () const
	returns the first child node

virtual JKQTMathTextNode *	getLastChild ()
	returns the last child node

virtual const JKQTMathTextNode *	getLastChild () const
	returns the last child node

bool	hasChildren () const
	returns `true` if children exist

bool	isEmpty () const
	returns `true` if there are no children

virtual void	replaceAndDeleteChild (int i, JKQTMathTextNode *newChild)
	replaces the i-th child node with the node newChild , deletes 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

Protected Attributes
JKQTMathTextNode *	child
	child node for the part under the root

JKQTMathTextNode *	childDegree
	second child node for the degree of the root (or nullptr if nothing)

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}`

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

Detailed Description

subclass representing a sqrt node

This node renders square roots without and with an explicitly shown degree:

Constructor & Destructor Documentation

◆ JKQTMathTextSqrtNode()

JKQTMathTextSqrtNode::JKQTMathTextSqrtNode	(	JKQTMathText *	parent,
		JKQTMathTextNode *	child__,
		JKQTMathTextNode *	childDegree__ = `nullptr`
	)

◆ ~JKQTMathTextSqrtNode()

virtual JKQTMathTextSqrtNode::~JKQTMathTextSqrtNode ( )

overridevirtual

Member Function Documentation

◆ childCount()

virtual int JKQTMathTextSqrtNode::childCount ( ) const

overridevirtual

returns the i-th child node

Implements JKQTMathTextMultiChildNode.

◆ clearChildren()

virtual void JKQTMathTextSqrtNode::clearChildren ( bool deleteChildren = true )

overridevirtual

returns the i-th child node

Implements JKQTMathTextMultiChildNode.

◆ deleteChild()

virtual void JKQTMathTextSqrtNode::deleteChild ( int i )

overridevirtual

delete the i-th child

Implements JKQTMathTextMultiChildNode.

◆ draw()

virtual double JKQTMathTextSqrtNode::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.

◆ getChild() [1/4]

JKQTMathTextNode * JKQTMathTextSqrtNode::getChild ( )

child node for the part under the root

◆ getChild() [2/4]

const JKQTMathTextNode * JKQTMathTextSqrtNode::getChild ( ) const

child node for the part under the root

◆ getChild() [3/4]

virtual const JKQTMathTextNode * JKQTMathTextSqrtNode::getChild ( int i ) const

overridevirtual

returns the i-th child node

Implements JKQTMathTextMultiChildNode.

◆ getChild() [4/4]

virtual JKQTMathTextNode * JKQTMathTextSqrtNode::getChild ( int i )

overridevirtual

returns the i-th child node

Implements JKQTMathTextMultiChildNode.

◆ getChildDegree() [1/2]

JKQTMathTextNode * JKQTMathTextSqrtNode::getChildDegree ( )

second child node for the degree of the root (or nullptr if nothing)

◆ getChildDegree() [2/2]

const JKQTMathTextNode * JKQTMathTextSqrtNode::getChildDegree ( ) const

second child node for the degree of the root (or nullptr if nothing)

◆ getSizeInternal()

virtual JKQTMathTextNodeSize JKQTMathTextSqrtNode::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.

◆ getTypeName()

virtual QString JKQTMathTextSqrtNode::getTypeName ( ) const

overridevirtual

return the name of this class as a string

Reimplemented from JKQTMathTextNode.

◆ replaceChild()

virtual JKQTMathTextNode * JKQTMathTextSqrtNode::replaceChild	(	int	i,
		JKQTMathTextNode *	newChild
	)

overridevirtual

returns the i-th child node

Implements JKQTMathTextMultiChildNode.

◆ toHtml()

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

overridevirtual

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.

Member Data Documentation

◆ child

JKQTMathTextNode* JKQTMathTextSqrtNode::child

protected

child node for the part under the root

◆ childDegree

JKQTMathTextNode* JKQTMathTextSqrtNode::childDegree

protected

second child node for the degree of the root (or nullptr if nothing)

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

jkqtmathtextsqrtnode.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ JKQTMathTextSqrtNode()

◆ ~JKQTMathTextSqrtNode()

Member Function Documentation

◆ childCount()

◆ clearChildren()

◆ deleteChild()

◆ draw()

◆ getChild() [1/4]

◆ getChild() [2/4]

◆ getChild() [3/4]

◆ getChild() [4/4]

◆ getChildDegree() [1/2]

◆ getChildDegree() [2/2]

◆ getSizeInternal()

◆ getTypeName()

◆ replaceChild()

◆ toHtml()

Member Data Documentation

◆ child

◆ childDegree