JKQTPlotter trunk/v5.0.0
an extensive Qt5+Qt6 Plotter framework (including a feature-richt plotter widget, a speed-optimized, but limited variant and a LaTeX equation renderer!), written fully in C/C++ and without external dependencies
Loading...
Searching...
No Matches

generates whitespace with the size of the contained node More...

#include <jkqtmathtextwhitespacenode.h>

Inheritance diagram for JKQTMathTextPhantomNode:
[legend]
Collaboration diagram for JKQTMathTextPhantomNode:
[legend]

Public Types

enum  Mode {
  FMwidthAndHeight ,
  FMwidth ,
  FMheight
}
 type of the phantom instrcution More...
 

Public Member Functions

 JKQTMathTextPhantomNode (JKQTMathText *parent, const QString &mode, JKQTMathTextNode *child)
 
 JKQTMathTextPhantomNode (JKQTMathText *parent, Mode mode, JKQTMathTextNode *child)
 
virtual ~JKQTMathTextPhantomNode () 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
 
JKQTMathTextNodegetChild ()
 child node of this node
 
const JKQTMathTextNodegetChild () 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
 
JKQTMathTextNodereplaceChild (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
 
JKQTMathTextNodegetParentNode ()
 parent node of this node (i.e. one level up, ode nullptr )
 
const JKQTMathTextNodegetParentNode () 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}
 
JKQTMathTextNodeoperator= (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 QString Mode2Instruction (Mode mode)
 convert a Mode into a LaTeX instruction name
 
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
 
- 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, Mode > & 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
JKQTMathTextNodechild
 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
 
JKQTMathTextparentMathText
 parent JKQTMathText object (required for several drawing operations
 
JKQTMathTextNodeparentNode
 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

generates whitespace with the size of the contained node

Member Enumeration Documentation

◆ Mode

type of the phantom instrcution

Enumerator
FMwidthAndHeight 

implementes \phantom{CHILD} which is whitespace in the width and height of CHILD

FMwidth 

implementes \hphantom{CHILD} which is whitespace in the width of CHILD and height 0.

FMheight 

implementes \vphantom{CHILD} which is whitespace in the height of CHILD and width 0.

Constructor & Destructor Documentation

◆ JKQTMathTextPhantomNode() [1/2]

JKQTMathTextPhantomNode::JKQTMathTextPhantomNode ( JKQTMathText parent,
const QString &  mode,
JKQTMathTextNode child 
)
explicit

◆ JKQTMathTextPhantomNode() [2/2]

JKQTMathTextPhantomNode::JKQTMathTextPhantomNode ( JKQTMathText parent,
Mode  mode,
JKQTMathTextNode child 
)
explicit

◆ ~JKQTMathTextPhantomNode()

virtual JKQTMathTextPhantomNode::~JKQTMathTextPhantomNode ( )
overridevirtual

Member Function Documentation

◆ draw()

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

draw the contents at the designated position

Parameters
painterQPainter to use
xx-position, where the drawing starts [Pixel]
yY-position of the baseline, where the drawing starts [Pixel]
currentEvJKQTMathTextEnvironment 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 JKQTMathTextPhantomNode::getSizeInternal ( QPainter &  painter,
JKQTMathTextEnvironment  currentEv 
) const
overrideprotectedvirtual

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

Parameters
painterpainter to use for determining the size
currentEvcurrent environment object
Returns
all important box size parameters packed as JKQTMathTextNodeSize

Implements JKQTMathTextNode.

◆ getTypeName()

virtual QString JKQTMathTextPhantomNode::getTypeName ( ) const
overridevirtual

return the name of this class as a string

Reimplemented from JKQTMathTextNode.

◆ instructions()

static const QHash< QString, Mode > & JKQTMathTextPhantomNode::instructions ( )
staticprotected

defines all implemented instructions in this node

Note
this is the customization point for new instructions!

◆ Mode2Instruction()

static QString JKQTMathTextPhantomNode::Mode2Instruction ( Mode  mode)
static

convert a Mode into a LaTeX instruction name

◆ supportsInstructionName()

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

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

See also
instructions

◆ toHtml()

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

convert node to HTML and returns true on success

Parameters
[out]htmlnew HTML code is APPENDED to this string
currentEvJKQTMathTextEnvironment object describing the current drawing environment/settings
defaultEvJKQTMathTextEnvironment 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: