subclass representing an instruction node which draws a (possibly colored) box around it's contents i.e. it represents instructions like \fbox{...}, \colorbox{color}{...}, ... More...

#include <jkqtmathtextboxinstructionnode.h>

Inheritance diagram for JKQTMathTextBoxInstructionNode:

[legend]

Collaboration diagram for JKQTMathTextBoxInstructionNode:

[legend]

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

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

virtual	~JKQTMathTextBoxInstructionNode () override

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

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

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

Static Public Member Functions
static size_t	countParametersOfInstruction (const QString &instructionName)
	returns the number of additional string parameters, required for the given instructionName

static void	modifyInMathEnvironment (const QString &instructionName, bool &insideMath, bool &insideMathTextStyle, const QStringList &params=QStringList())
	sets insideMath to `true` if inside the node is to be parsed in math mode and `false` else

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
virtual JKQTMathTextNodeSize	getSizeInternal (QPainter &painter, JKQTMathTextEnvironment currentEv) const override
	determine the size of the node, overwrite this function in derived classes

bool	setupMTenvironment (JKQTMathTextEnvironment &ev) const
	set all properties in ev, as appropriate for the represented instruction

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

Additional Inherited Members
Protected Attributes inherited from JKQTMathTextInstruction1Node
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}`

Detailed Description

subclass representing an instruction node which draws a (possibly colored) box around it's contents i.e. it represents instructions like \fbox{...}, \colorbox{color}{...}, ...

Constructor & Destructor Documentation

◆ JKQTMathTextBoxInstructionNode()

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

explicit

◆ ~JKQTMathTextBoxInstructionNode()

virtual JKQTMathTextBoxInstructionNode::~JKQTMathTextBoxInstructionNode ( )

overridevirtual

Member Function Documentation

◆ countParametersOfInstruction()

static size_t JKQTMathTextBoxInstructionNode::countParametersOfInstruction ( const QString & instructionName )

static

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

See also: instructions

◆ draw()

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

◆ getSizeInternal()

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

overridevirtual

return the name of this class as a string

Reimplemented from JKQTMathTextNode.

◆ instructions()

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

staticprotected

defines all implemented instructions in this node

Note: this is the customization point for new instructions!

◆ modifyInMathEnvironment()

static void JKQTMathTextBoxInstructionNode::modifyInMathEnvironment	(	const QString &	instructionName,
		bool &	insideMath,
		bool &	insideMathTextStyle,
		const QStringList &	params = `QStringList()`
	)

static

sets insideMath to true if inside the node is to be parsed in math mode and false else

See also: instructions

◆ setupMTenvironment()

bool JKQTMathTextBoxInstructionNode::setupMTenvironment ( JKQTMathTextEnvironment & ev ) const

protected

set all properties in ev, as appropriate for the represented instruction

◆ supportsInstructionName()

static bool JKQTMathTextBoxInstructionNode::supportsInstructionName ( const QString & instructionName )

static

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

See also: instructions

◆ toHtml()

virtual bool JKQTMathTextBoxInstructionNode::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.

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

jkqtmathtextboxinstructionnode.h

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ JKQTMathTextBoxInstructionNode()

◆ ~JKQTMathTextBoxInstructionNode()

Member Function Documentation

◆ countParametersOfInstruction()

◆ draw()

◆ getSizeInternal()

◆ getTypeName()

◆ instructions()

◆ modifyInMathEnvironment()

◆ setupMTenvironment()

◆ supportsInstructionName()

◆ toHtml()