subclass representing a simple instruction node which only accepts string arguments, not LaTeX arguments i.e. it represents instructions like \unicode{...}, ... More...

#include <jkqtmathtextinstructionnode.h>

Inheritance diagram for JKQTMathTextSimpleInstructionNode:

[legend]

Collaboration diagram for JKQTMathTextSimpleInstructionNode:

[legend]

Classes
struct	InstructionProperties
	defines the implementation of an instruction represented by JKQTMathTextModifiedTextPropsInstructionNode More...

Public Member Functions
	JKQTMathTextSimpleInstructionNode (JKQTMathText *parent, const QString &name, const QStringList &parameters=QStringList())
virtual	~JKQTMathTextSimpleInstructionNode () override
virtual double	draw (QPainter &painter, double x, double y, JKQTMathTextEnvironment currentEv) const override
	draw the contents at the designated position
const QString &	getInstructionName () const
	instruction name
const QStringList &	getParameters () const
	additional string-parameters
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
	convert node to HTML and returns `true` on success
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
virtual void	setDrawBoxes (bool draw)
	enables the drawing of colored boxes (for DEBUGGING) around the actual output of the node
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}`

Static Public Member Functions
static size_t	countParametersOfInstruction (const QString &instructionName)
	returns the number of additional string parameters, required for the given instructionName
static bool	supportsInstructionName (const QString &instructionName)
	returns true, if the given instructionName can be represented by this node
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
QString	executeInstruction () const
	executes the instruction on ev
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

Static Protected Member Functions
static const QHash< QString, InstructionProperties > &	instructions ()
	defines all implemented instructions in this node

Protected Attributes
QString	instructionName
	instruction name
QStringList	parameters
	additional string-parameters
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 a simple instruction node which only accepts string arguments, not LaTeX arguments i.e. it represents instructions like \unicode{...}, ...

Constructor & Destructor Documentation

◆ JKQTMathTextSimpleInstructionNode()

JKQTMathTextSimpleInstructionNode::JKQTMathTextSimpleInstructionNode	(	JKQTMathText *	parent,
		const QString &	name,
		const QStringList &	parameters = QStringList() )

explicit

◆ ~JKQTMathTextSimpleInstructionNode()

virtual JKQTMathTextSimpleInstructionNode::~JKQTMathTextSimpleInstructionNode ( )

overridevirtual

Member Function Documentation

◆ countParametersOfInstruction()

size_t JKQTMathTextSimpleInstructionNode::countParametersOfInstruction ( const QString & instructionName )

static

returns the number of additional string parameters, required for the given instructionName

See also: instructions

◆ draw()

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

◆ executeInstruction()

QString JKQTMathTextSimpleInstructionNode::executeInstruction ( ) const

protected

executes the instruction on ev

◆ getInstructionName()

const QString & JKQTMathTextSimpleInstructionNode::getInstructionName ( ) const

instruction name

◆ getParameters()

const QStringList & JKQTMathTextSimpleInstructionNode::getParameters ( ) const

additional string-parameters

◆ getSizeInternal()

virtual JKQTMathTextNodeSize JKQTMathTextSimpleInstructionNode::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 JKQTMathTextSimpleInstructionNode::getTypeName ( ) const

overridevirtual

return the name of this class as a string

Reimplemented from JKQTMathTextNode.

◆ instructions()

const QHash< QString, InstructionProperties > & JKQTMathTextSimpleInstructionNode::instructions ( )

staticprotected

defines all implemented instructions in this node

Note: this is the customization point for new instructions!

◆ supportsInstructionName()

bool JKQTMathTextSimpleInstructionNode::supportsInstructionName ( const QString & instructionName )

static

returns true, if the given instructionName can be represented by this node

See also: instructions

◆ toHtml()

virtual bool JKQTMathTextSimpleInstructionNode::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

◆ instructionName

QString JKQTMathTextSimpleInstructionNode::instructionName

protected

instruction name

◆ parameters

QStringList JKQTMathTextSimpleInstructionNode::parameters

protected

additional string-parameters

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

jkqtmathtextinstructionnode.h

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ JKQTMathTextSimpleInstructionNode()

◆ ~JKQTMathTextSimpleInstructionNode()

Member Function Documentation

◆ countParametersOfInstruction()

◆ draw()

◆ executeInstruction()

◆ getInstructionName()

◆ getParameters()

◆ getSizeInternal()

◆ getTypeName()

◆ instructions()

◆ supportsInstructionName()

◆ toHtml()

Member Data Documentation

◆ instructionName

◆ parameters