lib
BasicElement Class Reference
#include <basicelement.h>

Detailed Description
Basis of every formula element.An element is used basically by other elements and by the FormulaCursor .
Each element knows its size (a rect that includes all children) and how to draw itself. See calcSizes and draw .
An element might contain valid cursor position. If the cursor enters the element it must find the next valid position depending on the direction in that the cursor moves and the element it comes from. There might also be some flags inside the cursor that tell how it wants to move. See moveLeft , moveRight , moveUp , moveDown .
To build a tree an element must own children. If there are children there must be a main child. This is the child that might be used to replace the element. See getMainChild().
If there can be children you might want to insert and remove them. After a removal the element might be senseless. (See isSenseless ) If it is it must be removed.
Definition at line 75 of file basicelement.h.
Public Member Functions | |
BasicElement (BasicElement *parent=0) | |
BasicElement (const BasicElement &) | |
virtual BasicElement * | clone ()=0 |
virtual bool | accept (ElementVisitor *)=0 |
virtual bool | readOnly (const BasicElement *child) const |
virtual FormulaElement * | formula () |
virtual const FormulaElement * | formula () const |
virtual QChar | getCharacter () const |
virtual TokenType | getTokenType () const |
virtual bool | isInvisible () const |
virtual BasicElement * | goToPos (FormulaCursor *, bool &handled, const LuPixelPoint &point, const LuPixelPoint &parentOrigin) |
LuPixelPoint | widgetPos () |
virtual void | calcSizes (const ContextStyle &context, ContextStyle::TextStyle tstyle, ContextStyle::IndexStyle istyle, StyleAttributes &style)=0 |
virtual void | draw (QPainter &painter, const LuPixelRect &r, const ContextStyle &context, ContextStyle::TextStyle tstyle, ContextStyle::IndexStyle istyle, StyleAttributes &style, const LuPixelPoint &parentOrigin)=0 |
virtual void | dispatchFontCommand (FontCommand *) |
virtual void | moveLeft (FormulaCursor *cursor, BasicElement *from) |
virtual void | moveRight (FormulaCursor *cursor, BasicElement *from) |
virtual void | moveUp (FormulaCursor *, BasicElement *) |
virtual void | moveDown (FormulaCursor *, BasicElement *) |
virtual void | moveHome (FormulaCursor *) |
virtual void | moveEnd (FormulaCursor *) |
virtual void | goInside (FormulaCursor *cursor) |
virtual void | entered (SequenceElement *) |
virtual SequenceElement * | getMainChild () |
virtual void | insert (FormulaCursor *, QPtrList< BasicElement > &, Direction) |
virtual void | remove (FormulaCursor *, QPtrList< BasicElement > &, Direction) |
virtual void | normalize (FormulaCursor *, Direction) |
virtual bool | isSenseless () |
virtual BasicElement * | getChild (FormulaCursor *, Direction=beforeCursor) |
virtual void | selectChild (FormulaCursor *, BasicElement *) |
virtual void | childWillVanish (FormulaCursor *, BasicElement *) |
virtual void | registerTab (BasicElement *) |
virtual KCommand * | buildCommand (Container *, Request *) |
virtual KCommand * | input (Container *, QKeyEvent *) |
const BasicElement * | getParent () const |
BasicElement * | getParent () |
void | setParent (BasicElement *p) |
luPixel | getX () const |
luPixel | getY () const |
void | setX (luPixel x) |
void | setY (luPixel y) |
luPixel | getWidth () const |
luPixel | getHeight () const |
void | setWidth (luPixel width) |
void | setHeight (luPixel height) |
luPixel | getBaseline () const |
void | setBaseline (luPixel line) |
luPixel | axis (const ContextStyle &style, ContextStyle::TextStyle tstyle, double factor) const |
QDomElement | getElementDom (QDomDocument &doc) |
virtual void | writeMathML (QDomDocument &doc, QDomNode &parent, bool oasisFormat=false) const |
bool | buildFromDom (QDomElement element) |
int | buildFromMathMLDom (QDomElement element) |
ElementType * | getElementType () const |
virtual void | setElementType (ElementType *t) |
virtual void | setStyle (StyleElement *) |
virtual QString | getElementName () const |
Static Public Member Functions | |
static int | getEvilDestructionCount () |
Protected Member Functions | |
virtual QString | getTagName () const |
virtual void | writeDom (QDomElement element) |
virtual void | writeMathMLAttributes (QDomElement &) const |
virtual void | writeMathMLContent (QDomDocument &, QDomElement &, bool) const |
virtual bool | readAttributesFromDom (QDomElement element) |
virtual bool | readContentFromDom (QDomNode &node) |
bool | buildChild (SequenceElement *child, QDomNode node, QString name) |
virtual bool | readAttributesFromMathMLDom (const QDomElement &element) |
virtual int | readContentFromMathMLDom (QDomNode &node) |
virtual QString | toLatex () |
virtual QString | formulaString () |
double | getSize (const QString &str, SizeType *st) |
SizeType | getSpace (const QString &str) |
Friends | |
class | SequenceElement |
class | SequenceParser |
Member Function Documentation
virtual bool BasicElement::accept | ( | ElementVisitor * | ) | [pure virtual] |
Visit this element.
An implementation of the visitor pattern.
Implemented in BracketElement, OverlineElement, UnderlineElement, FractionElement, IndexElement, MatrixElement, MultilineElement, RootElement, SequenceElement, NameSequence, SpaceElement, SymbolElement, TextElement, and EmptyElement.
bool BasicElement::readOnly | ( | const BasicElement * | child | ) | const [virtual] |
- Returns:
- whether the child should be read-only. The idea is that a read-only parent has read-only children.
Reimplemented in FormulaElement.
Definition at line 64 of file basicelement.cc.
FormulaElement * BasicElement::formula | ( | ) | [virtual] |
Provide fast access to the rootElement for each child.
Reimplemented in FormulaElement.
Definition at line 70 of file basicelement.cc.
virtual const FormulaElement* BasicElement::formula | ( | ) | const [inline, virtual] |
Provide fast access to the rootElement for each child.
Reimplemented in FormulaElement.
Definition at line 117 of file basicelement.h.
virtual QChar BasicElement::getCharacter | ( | ) | const [inline, virtual] |
- Returns:
- the character that represents this element. Used for parsing a sequence. This is guaranteed to be QChar::null for all non-text elements.
Reimplemented in SingleContentElement, IndexElement, NameSequence, SpaceElement, TextElement, and EmptyElement.
Definition at line 124 of file basicelement.h.
virtual TokenType BasicElement::getTokenType | ( | ) | const [inline, virtual] |
- Returns:
- the type of this element. Used for parsing a sequence.
Reimplemented in BracketElement, FractionElement, NameSequence, and TextElement.
Definition at line 130 of file basicelement.h.
virtual bool BasicElement::isInvisible | ( | ) | const [inline, virtual] |
- Returns:
- true if we don't want to see the element.
Reimplemented in TextElement.
Definition at line 135 of file basicelement.h.
BasicElement * BasicElement::goToPos | ( | FormulaCursor * | , | |
bool & | handled, | |||
const LuPixelPoint & | point, | |||
const LuPixelPoint & | parentOrigin | |||
) | [virtual] |
Sets the cursor and returns the element the point is in.
Returns the element the point is in.
The handled flag shows whether the cursor has been set. This is needed because only the innermost matching element is allowed to set the cursor.
Reimplemented in SingleContentElement, BracketElement, FractionElement, IndexElement, MatrixElement, MultilineElement, RootElement, SequenceElement, and SymbolElement.
Definition at line 82 of file basicelement.cc.
LuPixelPoint BasicElement::widgetPos | ( | ) |
virtual void BasicElement::calcSizes | ( | const ContextStyle & | context, | |
ContextStyle::TextStyle | tstyle, | |||
ContextStyle::IndexStyle | istyle, | |||
StyleAttributes & | style | |||
) | [pure virtual] |
Calculates our width and height and our children's parentPosition.
Implemented in BracketElement, OverlineElement, UnderlineElement, FormulaElement, FractionElement, IndexElement, MatrixElement, MultilineElement, RootElement, SequenceElement, SpaceElement, SymbolElement, TextElement, EmptyElement, and TokenStyleElement.
virtual void BasicElement::draw | ( | QPainter & | painter, | |
const LuPixelRect & | r, | |||
const ContextStyle & | context, | |||
ContextStyle::TextStyle | tstyle, | |||
ContextStyle::IndexStyle | istyle, | |||
StyleAttributes & | style, | |||
const LuPixelPoint & | parentOrigin | |||
) | [pure virtual] |
Draws the whole element including its children.
The `parentOrigin' is the point this element's parent starts. We can use our parentPosition to get our own origin then.
Implemented in BracketElement, OverlineElement, UnderlineElement, FormulaElement, FractionElement, IndexElement, MatrixElement, MultilineElement, RootElement, SequenceElement, SpaceElement, SymbolElement, TextElement, EmptyElement, and TokenStyleElement.
virtual void BasicElement::dispatchFontCommand | ( | FontCommand * | ) | [inline, virtual] |
Dispatch this FontCommand to all our TextElement children.
Reimplemented in SingleContentElement, FractionElement, IndexElement, MatrixElement, MultilineElement, RootElement, SequenceElement, SymbolElement, and TextElement.
Definition at line 184 of file basicelement.h.
void BasicElement::moveLeft | ( | FormulaCursor * | cursor, | |
BasicElement * | from | |||
) | [virtual] |
Enters this element while moving to the left starting inside the element `from'.
Searches for a cursor position inside this element or to the left of it.
Reimplemented in SingleContentElement, FractionElement, IndexElement, MatrixElement, MultilineElement, RootElement, SequenceElement, and SymbolElement.
Definition at line 134 of file basicelement.cc.
void BasicElement::moveRight | ( | FormulaCursor * | cursor, | |
BasicElement * | from | |||
) | [virtual] |
Enters this element while moving to the right starting inside the element `from'.
Searches for a cursor position inside this element or to the right of it.
Reimplemented in SingleContentElement, FractionElement, IndexElement, MatrixElement, MultilineElement, RootElement, SequenceElement, and SymbolElement.
Definition at line 145 of file basicelement.cc.
virtual void BasicElement::moveUp | ( | FormulaCursor * | , | |
BasicElement * | ||||
) | [inline, virtual] |
Enters this element while moving up starting inside the element `from'.
Searches for a cursor position inside this element or above it.
Reimplemented in SingleContentElement, FractionElement, IndexElement, MatrixElement, MultilineElement, RootElement, SequenceElement, and SymbolElement.
Definition at line 213 of file basicelement.h.
virtual void BasicElement::moveDown | ( | FormulaCursor * | , | |
BasicElement * | ||||
) | [inline, virtual] |
Enters this element while moving down starting inside the element `from'.
Searches for a cursor position inside this element or below it.
Reimplemented in SingleContentElement, FractionElement, IndexElement, MatrixElement, MultilineElement, RootElement, SequenceElement, and SymbolElement.
Definition at line 220 of file basicelement.h.
virtual void BasicElement::moveHome | ( | FormulaCursor * | ) | [inline, virtual] |
Moves the cursor to the first position in this sequence.
(That is before the first child.)
Reimplemented in SequenceElement.
Definition at line 226 of file basicelement.h.
virtual void BasicElement::moveEnd | ( | FormulaCursor * | ) | [inline, virtual] |
Moves the cursor to the last position in this sequence.
(That is behind the last child.)
Reimplemented in SequenceElement.
Definition at line 232 of file basicelement.h.
void BasicElement::goInside | ( | FormulaCursor * | cursor | ) | [virtual] |
Sets the cursor inside this element to its start position.
For most elements that is the main child.
Reimplemented in MatrixElement, MultilineElement, and SequenceElement.
Definition at line 114 of file basicelement.cc.
void BasicElement::entered | ( | SequenceElement * | ) | [virtual] |
The cursor has entered one of our child sequences.
This is a good point to tell the user where he is.
Reimplemented in BracketElement, OverlineElement, UnderlineElement, FractionElement, IndexElement, MatrixElement, MultilineElement, and RootElement.
Definition at line 123 of file basicelement.cc.
virtual SequenceElement* BasicElement::getMainChild | ( | ) | [inline, virtual] |
Removes the child.
If this was the main child this element might request its own removal. The cursor is the one that caused the removal. It has to be moved to the place any user expects the cursor after that particular element has been removed.
Reimplemented in SingleContentElement, FractionElement, IndexElement, MatrixElement, MultilineElement, RootElement, NameSequence, and SymbolElement.
Definition at line 262 of file basicelement.h.
virtual void BasicElement::insert | ( | FormulaCursor * | , | |
QPtrList< BasicElement > & | , | |||
Direction | ||||
) | [inline, virtual] |
Inserts all new children at the cursor position.
Places the cursor according to the direction.
The list will be emptied but stays the property of the caller.
Reimplemented in FractionElement, IndexElement, MultilineElement, RootElement, SequenceElement, and SymbolElement.
Definition at line 276 of file basicelement.h.
virtual void BasicElement::remove | ( | FormulaCursor * | , | |
QPtrList< BasicElement > & | , | |||
Direction | ||||
) | [inline, virtual] |
Removes all selected children and returns them.
Places the cursor to where the children have been.
Reimplemented in SingleContentElement, FractionElement, IndexElement, MultilineElement, RootElement, SequenceElement, and SymbolElement.
Definition at line 282 of file basicelement.h.
void BasicElement::normalize | ( | FormulaCursor * | cursor, | |
Direction | direction | |||
) | [virtual] |
Moves the cursor to a normal place where new elements might be inserted.
Reimplemented in SingleContentElement, IndexElement, MultilineElement, RootElement, SequenceElement, and SymbolElement.
Definition at line 155 of file basicelement.cc.
virtual bool BasicElement::isSenseless | ( | ) | [inline, virtual] |
Returns wether the element has no more useful children (except its main child) and should therefore be replaced by its main child's content.
Reimplemented in FractionElement, and IndexElement.
Definition at line 296 of file basicelement.h.
virtual BasicElement* BasicElement::getChild | ( | FormulaCursor * | , | |
Direction | = beforeCursor | |||
) | [inline, virtual] |
Returns the child at the cursor.
Reimplemented in IndexElement, SequenceElement, and SymbolElement.
Definition at line 301 of file basicelement.h.
virtual void BasicElement::selectChild | ( | FormulaCursor * | , | |
BasicElement * | ||||
) | [inline, virtual] |
Sets the cursor to select the child.
The mark is placed before, the position behind it.
Reimplemented in SingleContentElement, FractionElement, IndexElement, MatrixElement, MultilineElement, RootElement, SequenceElement, and SymbolElement.
Definition at line 308 of file basicelement.h.
virtual void BasicElement::childWillVanish | ( | FormulaCursor * | , | |
BasicElement * | ||||
) | [inline, virtual] |
Moves the cursor away from the given child.
The cursor is guaranteed to be inside this element.
Reimplemented in SequenceElement.
Definition at line 315 of file basicelement.h.
virtual void BasicElement::registerTab | ( | BasicElement * | ) | [inline, virtual] |
Callback for the tabs among our children.
Needed for alignment.
Definition at line 321 of file basicelement.h.
This is called by the container to get a command depending on the current cursor position (this is how the element gets chosen) and the request.
- Returns:
- the command that performs the requested action with the containers active cursor.
Reimplemented in FormulaElement, SequenceElement, and NameSequence.
Definition at line 332 of file basicelement.h.
Parses the input.
It's the container which does create new elements because it owns the undo stack. But only the sequence knows what chars are allowed.
Reimplemented in FormulaElement, and SequenceElement.
Definition at line 339 of file basicelement.h.
QDomElement BasicElement::getElementDom | ( | QDomDocument & | doc | ) |
- Returns:
- a QDomElement that contain as DomChildren the children, and as attribute the attribute of this element.
Definition at line 169 of file basicelement.cc.
void BasicElement::writeMathML | ( | QDomDocument & | doc, | |
QDomNode & | parent, | |||
bool | oasisFormat = false | |||
) | const [virtual] |
Same as above, just MathML.
It shouldn't be redefined but for exceptional cases, use the general writeMathML* API instead
Reimplemented in OverlineElement, UnderlineElement, FormulaElement, MultilineElement, SymbolElement, and TextElement.
Definition at line 177 of file basicelement.cc.
bool BasicElement::buildFromDom | ( | QDomElement | element | ) |
Set this element attribute, build children and call their buildFromDom.
Definition at line 185 of file basicelement.cc.
int BasicElement::buildFromMathMLDom | ( | QDomElement | element | ) |
Set this element attribute, build children and call their builFromMathMLDom.
Returns the number of nodes processed or -1 if it failed.
Definition at line 198 of file basicelement.cc.
ElementType* BasicElement::getElementType | ( | ) | const [inline] |
- Returns:
- our type. This is an object from our parent's syntax tree or 0 if there was a very bad parsing error.
Definition at line 402 of file basicelement.h.
virtual void BasicElement::setElementType | ( | ElementType * | t | ) | [inline, virtual] |
Sets a new type.
This is done during parsing.
Reimplemented in NameSequence.
Definition at line 407 of file basicelement.h.
virtual QString BasicElement::getTagName | ( | ) | const [inline, protected, virtual] |
Returns the tag name of this element type.
Reimplemented in BracketElement, OverlineElement, UnderlineElement, FormulaElement, FractionElement, IndexElement, MatrixElement, MultilineElement, RootElement, SequenceElement, NameSequence, SpaceElement, SymbolElement, TextElement, and EmptyElement.
Definition at line 419 of file basicelement.h.
void BasicElement::writeDom | ( | QDomElement | element | ) | [protected, virtual] |
Appends our attributes to the dom element.
Reimplemented in SingleContentElement, BracketElement, FormulaElement, FractionElement, IndexElement, MatrixElement, MultilineElement, RootElement, SequenceElement, SpaceElement, SymbolElement, and TextElement.
Definition at line 214 of file basicelement.cc.
bool BasicElement::readAttributesFromDom | ( | QDomElement | element | ) | [protected, virtual] |
Reads our attributes from the element.
Returns false if it failed.
Reimplemented in BracketElement, FormulaElement, FractionElement, IndexElement, MatrixElement, MultilineElement, RootElement, SequenceElement, SpaceElement, SymbolElement, and TextElement.
Definition at line 222 of file basicelement.cc.
bool BasicElement::readContentFromDom | ( | QDomNode & | node | ) | [protected, virtual] |
Reads our content from the node.
Sets the node to the next node that needs to be read. Returns false if it failed.
Reimplemented in SingleContentElement, FormulaElement, FractionElement, IndexElement, MatrixElement, MultilineElement, RootElement, SequenceElement, SpaceElement, SymbolElement, and TextElement.
Definition at line 232 of file basicelement.cc.
bool BasicElement::buildChild | ( | SequenceElement * | child, | |
QDomNode | node, | |||
QString | name | |||
) | [protected] |
Returns if the SequenceElement could be constructed from the nodes first child.
Returns a SequenceElement constructed from the nodes first child if the nodes name matches the given name.
The node name must match the given name.
This is a service for all subclasses that contain children.
Definition at line 241 of file basicelement.cc.
bool BasicElement::readAttributesFromMathMLDom | ( | const QDomElement & | element | ) | [protected, virtual] |
Reads our attributes from the MathML element.
Returns false if it failed.
Reimplemented in BracketElement, FractionElement, IndexElement, MatrixElement, RootElement, SpaceElement, and TokenStyleElement.
Definition at line 260 of file basicelement.cc.
int BasicElement::readContentFromMathMLDom | ( | QDomNode & | node | ) | [protected, virtual] |
Reads our content from the MathML node.
Sets the node to the next node that needs to be read. It is sometimes needed to read more than one node (e. g. for fence operators). Returns the number of nodes processed or -1 if it failed.
Sets the node to the next node that needs to be read. Returns false if it failed.
Reimplemented in SingleContentElement, BracketElement, FractionElement, IndexElement, MatrixElement, RootElement, and SequenceElement.
Definition at line 270 of file basicelement.cc.
QString BasicElement::toLatex | ( | ) | [protected, virtual] |
- Returns:
- the latex representation of the element and of the element's children
Reimplemented in BracketElement, OverlineElement, UnderlineElement, FormulaElement, FractionElement, IndexElement, MatrixElement, MultilineElement, RootElement, SequenceElement, SpaceElement, SymbolElement, TextElement, and EmptyElement.
Definition at line 275 of file basicelement.cc.
double BasicElement::getSize | ( | const QString & | str, | |
SizeType * | st | |||
) | [protected] |
Utility function that sets the size type and returns the size value from a MathML attribute string with unit as defined in Section 2.4.4.2.
- Returns:
- the size value
- Parameters:
-
str the attribute string. st size type container. It will be properly assigned to its size type or NoSize if str is invalid
Definition at line 290 of file basicelement.cc.
The documentation for this class was generated from the following files: