subclass representing an instruction node with exactly one argument and possibly additional parameters in the syntax tree This is a base-class without concrete implementations ... Implementations can be found in derived classes! More...

#include <jkqtmathtextinstructionnode.h>

Inheritance diagram for JKQTMathTextInstruction1Node:

[legend]

Collaboration diagram for JKQTMathTextInstruction1Node:

[legend]

Public Member Functions
	JKQTMathTextInstruction1Node (JKQTMathText parent, const QString &name, JKQTMathTextNode child, const QStringList &parameters=QStringList())

virtual	~JKQTMathTextInstruction1Node () override

const QString &	getInstructionName () const
	instruction name

const QStringList &	getParameters () const
	additional string-parameters

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 ()

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

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

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

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

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

Protected Attributes
QString	instructionName
	instruction name

QStringList	parameters
	additional string-parameters

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

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

virtual JKQTMathTextNodeSize	getSizeInternal (QPainter &painter, JKQTMathTextEnvironment currentEv) const =0
	determine the size of the node, overwrite this function in derived classes

Detailed Description

subclass representing an instruction node with exactly one argument and possibly additional parameters in the syntax tree This is a base-class without concrete implementations ... Implementations can be found in derived classes!

The parameters are sinple strings (e.g. directly for instructions like \textcolor{color}{coloredLatexText}, but they might also be translated into numbers or other properties.

Typically derived nodes will provide static methods to determine the number of instructions and whether an instruction name is supported.

Constructor & Destructor Documentation

◆ JKQTMathTextInstruction1Node()

JKQTMathTextInstruction1Node::JKQTMathTextInstruction1Node	(	JKQTMathText *	parent,
		const QString &	name,
		JKQTMathTextNode *	child,
		const QStringList &	parameters = `QStringList()`
	)

explicit

◆ ~JKQTMathTextInstruction1Node()

virtual JKQTMathTextInstruction1Node::~JKQTMathTextInstruction1Node ( )

overridevirtual

Member Function Documentation

◆ getInstructionName()

const QString & JKQTMathTextInstruction1Node::getInstructionName ( ) const

instruction name

◆ getParameters()

const QStringList & JKQTMathTextInstruction1Node::getParameters ( ) const

additional string-parameters

Member Data Documentation

◆ instructionName

QString JKQTMathTextInstruction1Node::instructionName

protected

instruction name

◆ parameters

QStringList JKQTMathTextInstruction1Node::parameters