You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
549 lines
16 KiB
549 lines
16 KiB
/* This file is part of the KDE project
|
|
Copyright (C) 2001 Andrea Rizzi <rizzi@kde.org>
|
|
Ulrich Kuettler <ulrich.kuettler@mailbox.tu-dresden.de>
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Library General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2 of the License, or (at your option) any later version.
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Library General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Library General Public License
|
|
along with this library; see the file COPYING.LIB. If not, write to
|
|
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
* Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef BASICELEMENT_H
|
|
#define BASICELEMENT_H
|
|
|
|
// TQt Include
|
|
#include <tqdom.h>
|
|
#include <tqptrlist.h>
|
|
#include <tqstring.h>
|
|
|
|
// KDE Include
|
|
|
|
// Formula include
|
|
#include "contextstyle.h"
|
|
#include "kformuladefs.h"
|
|
|
|
class TQKeyEvent;
|
|
|
|
class KCommand;
|
|
|
|
KFORMULA_NAMESPACE_BEGIN
|
|
|
|
class ComplexElement;
|
|
class Container;
|
|
class ElementType;
|
|
class ElementVisitor;
|
|
class FontCommand;
|
|
class FormulaCursor;
|
|
class FormulaElement;
|
|
class SequenceElement;
|
|
class StyleElement;
|
|
|
|
|
|
/**
|
|
* Basis of every formula element. An element is used basically by
|
|
* other elements and by the @ref FormulaCursor .
|
|
*
|
|
* Each element knows its size (a rect that includes all children)
|
|
* and how to draw itself. See @ref calcSizes and @ref 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 @ref moveLeft ,
|
|
* @ref moveRight , @ref moveUp , @ref 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 @ref getMainChild().
|
|
*
|
|
* If there can be children you might want to @ref insert and @ref remove
|
|
* them. After a removal the element might be senseless.
|
|
* (See @ref isSenseless )
|
|
* If it is it must be removed.
|
|
*/
|
|
class BasicElement
|
|
{
|
|
friend class SequenceElement;
|
|
friend class SequenceParser;
|
|
|
|
BasicElement& operator= ( const BasicElement& ) { return *this; }
|
|
public:
|
|
|
|
/*
|
|
* Each element might contain children. Each child needs
|
|
* its own unique number. It is not guaranteed, however,
|
|
* that the number stays the same all the time.
|
|
* (The SequenceElement's children are simply counted.)
|
|
*/
|
|
|
|
BasicElement(BasicElement* parent = 0);
|
|
virtual ~BasicElement();
|
|
|
|
// deep copy
|
|
BasicElement( const BasicElement& );
|
|
|
|
virtual BasicElement* clone() = 0;
|
|
|
|
/**
|
|
* Visit this element. An implementation of the visitor pattern.
|
|
*/
|
|
virtual bool accept( ElementVisitor* ) = 0;
|
|
|
|
/**
|
|
* @returns whether the child should be read-only. The idea is
|
|
* that a read-only parent has read-only children.
|
|
*/
|
|
virtual bool readOnly( const BasicElement* child ) const;
|
|
|
|
/**
|
|
* Provide fast access to the rootElement for each child.
|
|
*/
|
|
virtual FormulaElement* formula();
|
|
|
|
/**
|
|
* Provide fast access to the rootElement for each child.
|
|
*/
|
|
virtual const FormulaElement* formula() const { return parent->formula(); }
|
|
|
|
/**
|
|
* @returns the character that represents this element. Used for
|
|
* parsing a sequence.
|
|
* This is guaranteed to be TQChar::null for all non-text elements.
|
|
*/
|
|
virtual TQChar getCharacter() const { return TQChar::null; }
|
|
|
|
/**
|
|
* @returns the type of this element. Used for
|
|
* parsing a sequence.
|
|
*/
|
|
virtual TokenType getTokenType() const { return ELEMENT; }
|
|
|
|
/**
|
|
* @returns true if we don't want to see the element.
|
|
*/
|
|
virtual bool isInvisible() const { return false; }
|
|
|
|
/**
|
|
* Sets the cursor and 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.
|
|
*/
|
|
virtual BasicElement* goToPos( FormulaCursor*, bool& handled,
|
|
const LuPixelPoint& point, const LuPixelPoint& parentOrigin );
|
|
|
|
/**
|
|
* Returns our position inside the widget.
|
|
*/
|
|
LuPixelPoint widgetPos();
|
|
|
|
|
|
// drawing
|
|
//
|
|
// Drawing depends on a context which knows the required properties like
|
|
// fonts, spaces and such.
|
|
// It is essential to calculate elements size with the same context
|
|
// before you draw.
|
|
|
|
/**
|
|
* Calculates our width and height and
|
|
* our children's parentPosition.
|
|
*/
|
|
virtual void calcSizes( const ContextStyle& context,
|
|
ContextStyle::TextStyle tstyle,
|
|
ContextStyle::IndexStyle istyle,
|
|
StyleAttributes& style ) = 0;
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
virtual void draw( TQPainter& painter, const LuPixelRect& r,
|
|
const ContextStyle& context,
|
|
ContextStyle::TextStyle tstyle,
|
|
ContextStyle::IndexStyle istyle,
|
|
StyleAttributes& style,
|
|
const LuPixelPoint& parentOrigin ) = 0;
|
|
|
|
|
|
/**
|
|
* Dispatch this FontCommand to all our TextElement children.
|
|
*/
|
|
virtual void dispatchFontCommand( FontCommand* /*cmd*/ ) {}
|
|
|
|
// navigation
|
|
//
|
|
// The elements are responsible to handle cursor movement themselves.
|
|
// To do this they need to know the direction the cursor moves and
|
|
// the element it comes from.
|
|
//
|
|
// The cursor might be in normal or in selection mode.
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
virtual void moveLeft(FormulaCursor* cursor, BasicElement* from);
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
virtual void moveRight(FormulaCursor* cursor, BasicElement* from);
|
|
|
|
/**
|
|
* Enters this element while moving up starting inside
|
|
* the element `from'. Searches for a cursor position inside
|
|
* this element or above it.
|
|
*/
|
|
virtual void moveUp(FormulaCursor*, BasicElement*) {}
|
|
|
|
/**
|
|
* Enters this element while moving down starting inside
|
|
* the element `from'. Searches for a cursor position inside
|
|
* this element or below it.
|
|
*/
|
|
virtual void moveDown(FormulaCursor*, BasicElement* ) {}
|
|
|
|
/**
|
|
* Moves the cursor to the first position in this sequence.
|
|
* (That is before the first child.)
|
|
*/
|
|
virtual void moveHome(FormulaCursor*) {}
|
|
|
|
/**
|
|
* Moves the cursor to the last position in this sequence.
|
|
* (That is behind the last child.)
|
|
*/
|
|
virtual void moveEnd(FormulaCursor*) {}
|
|
|
|
/**
|
|
* Sets the cursor inside this element to its start position.
|
|
* For most elements that is the main child.
|
|
*/
|
|
virtual void goInside(FormulaCursor* cursor);
|
|
|
|
/**
|
|
* The cursor has entered one of our child sequences.
|
|
* This is a good point to tell the user where he is.
|
|
*/
|
|
virtual void entered( SequenceElement* /*child*/ );
|
|
|
|
// children
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
//virtual void removeChild(FormulaCursor* cursor, BasicElement* child) {}
|
|
|
|
|
|
// main child
|
|
//
|
|
// If an element has children one has to become the main one.
|
|
|
|
virtual SequenceElement* getMainChild() { return 0; }
|
|
//virtual void setMainChild(SequenceElement*) {}
|
|
|
|
|
|
// editing
|
|
//
|
|
// Insert and remove children.
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
virtual void insert(FormulaCursor*, TQPtrList<BasicElement>&, Direction) {}
|
|
|
|
/**
|
|
* Removes all selected children and returns them. Places the
|
|
* cursor to where the children have been.
|
|
*/
|
|
virtual void remove(FormulaCursor*, TQPtrList<BasicElement>&, Direction) {}
|
|
|
|
/**
|
|
* Moves the cursor to a normal place where new elements
|
|
* might be inserted.
|
|
*/
|
|
virtual void normalize(FormulaCursor*, Direction);
|
|
|
|
|
|
/**
|
|
* Returns wether the element has no more useful
|
|
* children (except its main child) and should therefore
|
|
* be replaced by its main child's content.
|
|
*/
|
|
virtual bool isSenseless() { return false; }
|
|
|
|
/**
|
|
* Returns the child at the cursor.
|
|
*/
|
|
virtual BasicElement* getChild(FormulaCursor*, Direction = beforeCursor) { return 0; }
|
|
|
|
|
|
/**
|
|
* Sets the cursor to select the child. The mark is placed before,
|
|
* the position behind it.
|
|
*/
|
|
virtual void selectChild(FormulaCursor*, BasicElement*) {}
|
|
|
|
|
|
/**
|
|
* Moves the cursor away from the given child. The cursor is
|
|
* guaranteed to be inside this element.
|
|
*/
|
|
virtual void childWillVanish(FormulaCursor*, BasicElement*) {}
|
|
|
|
|
|
/**
|
|
* Callback for the tabs among our children. Needed for alignment.
|
|
*/
|
|
virtual void registerTab( BasicElement* /*tab*/ ) {}
|
|
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
virtual KCommand* buildCommand( Container*, Request* ) { return 0; }
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
virtual KCommand* input( Container*, TQKeyEvent* ) { return 0; }
|
|
|
|
// basic support
|
|
|
|
const BasicElement* getParent() const { return parent; }
|
|
BasicElement* getParent() { return parent; }
|
|
void setParent(BasicElement* p) { parent = p; }
|
|
|
|
luPixel getX() const { return m_x; }
|
|
luPixel getY() const { return m_y; }
|
|
|
|
void setX( luPixel x ) { m_x = x; }
|
|
void setY( luPixel y ) { m_y = y; }
|
|
|
|
//TQSize getSize() { return size; }
|
|
|
|
luPixel getWidth() const { return m_width; }
|
|
luPixel getHeight() const { return m_height; }
|
|
|
|
void setWidth( luPixel width ) { m_width = width; }
|
|
void setHeight( luPixel height ) { m_height = height; }
|
|
|
|
luPixel getBaseline() const { return m_baseline; }
|
|
void setBaseline( luPixel line ) { m_baseline = line; }
|
|
|
|
luPixel axis( const ContextStyle& style,
|
|
ContextStyle::TextStyle tstyle,
|
|
double factor ) const {
|
|
return getBaseline() - style.axisHeight( tstyle, factor ); }
|
|
|
|
/**
|
|
* @return a TQDomElement that contain as DomChildren the
|
|
* children, and as attribute the attribute of this
|
|
* element.
|
|
*/
|
|
TQDomElement getElementDom( TQDomDocument& doc);
|
|
|
|
/**
|
|
* Same as above, just MathML.
|
|
* It shouldn't be redefined but for exceptional cases, use the general writeMathML* API instead
|
|
*/
|
|
virtual void writeMathML( TQDomDocument& doc, TQDomNode& parent, bool oasisFormat = false ) const ;
|
|
|
|
/**
|
|
* Set this element attribute, build children and
|
|
* call their buildFromDom.
|
|
*/
|
|
bool buildFromDom(TQDomElement element);
|
|
|
|
/**
|
|
* Set this element attribute, build children and call
|
|
* their builFromMathMLDom.
|
|
* Returns the number of nodes processed or -1 if it failed.
|
|
*/
|
|
int buildFromMathMLDom( TQDomElement element );
|
|
|
|
// debug
|
|
static int getEvilDestructionCount() { return evilDestructionCount; }
|
|
|
|
/**
|
|
* @returns our type. This is an object from our parent's syntax tree
|
|
* or 0 if there was a very bad parsing error.
|
|
*/
|
|
ElementType* getElementType() const { return elementType; }
|
|
|
|
/**
|
|
* Sets a new type. This is done during parsing.
|
|
*/
|
|
virtual void setElementType(ElementType* t) { elementType = t; }
|
|
|
|
virtual void setStyle(StyleElement*) {}
|
|
|
|
virtual TQString getElementName() const { return ""; };
|
|
protected:
|
|
|
|
//Save/load support
|
|
|
|
/**
|
|
* Returns the tag name of this element type.
|
|
*/
|
|
virtual TQString getTagName() const { return "BASIC"; }
|
|
|
|
/**
|
|
* Appends our attributes to the dom element.
|
|
*/
|
|
virtual void writeDom(TQDomElement element);
|
|
|
|
virtual void writeMathMLAttributes( TQDomElement& /*element*/ ) const {};
|
|
virtual void writeMathMLContent( TQDomDocument& /*doc*/,
|
|
TQDomElement& /*element*/,
|
|
bool /*oasisFormat*/ ) const {};
|
|
|
|
/**
|
|
* Reads our attributes from the element.
|
|
* Returns false if it failed.
|
|
*/
|
|
virtual bool readAttributesFromDom(TQDomElement element);
|
|
|
|
/**
|
|
* Reads our content from the node. Sets the node to the next node
|
|
* that needs to be read.
|
|
* Returns false if it failed.
|
|
*/
|
|
virtual bool readContentFromDom(TQDomNode& node);
|
|
|
|
/**
|
|
* Returns if the SequenceElement could be constructed from the nodes first child.
|
|
* The node name must match the given name.
|
|
*
|
|
* This is a service for all subclasses that contain children.
|
|
*/
|
|
bool buildChild( SequenceElement* child, TQDomNode node, TQString name );
|
|
|
|
|
|
/**
|
|
* Reads our attributes from the MathML element.
|
|
* Returns false if it failed.
|
|
*/
|
|
virtual bool readAttributesFromMathMLDom(const TQDomElement& element);
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
virtual int readContentFromMathMLDom(TQDomNode& node);
|
|
|
|
|
|
/**
|
|
* @returns the latex representation of the element and
|
|
* of the element's children
|
|
*/
|
|
virtual TQString toLatex();
|
|
|
|
virtual TQString formulaString() { return ""; }
|
|
|
|
/**
|
|
* 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
|
|
*
|
|
* @param str the attribute string.
|
|
* @param st size type container. It will be properly assigned to its size
|
|
* type or NoSize if str is invalid
|
|
*/
|
|
double getSize( const TQString& str, SizeType* st );
|
|
|
|
SizeType getSpace( const TQString& str );
|
|
|
|
private:
|
|
|
|
/**
|
|
* Used internally by getSize()
|
|
*/
|
|
double str2size( const TQString& str, SizeType* st, uint index, SizeType type );
|
|
|
|
/**
|
|
* Our parent.
|
|
* The parent might not be null except for the FormulaElement
|
|
* that is the top of the element tree.
|
|
*/
|
|
BasicElement* parent;
|
|
|
|
/**
|
|
* This elements size.
|
|
*/
|
|
//TQSize size;
|
|
luPixel m_width;
|
|
luPixel m_height;
|
|
|
|
/**
|
|
* Our position relative to our parent.
|
|
*/
|
|
//KoPoint position;
|
|
luPixel m_x;
|
|
luPixel m_y;
|
|
|
|
/**
|
|
* The position of our base line from
|
|
* the upper border. A sequence aligns its elements
|
|
* along this line.
|
|
*
|
|
* There are elements (like matrix) that don't have a base line. It is
|
|
* -1 in this case. The alignment is done using the middle line.
|
|
*/
|
|
luPixel m_baseline;
|
|
|
|
/**
|
|
* The position of our middle line from
|
|
* the upper border. The strike out position.
|
|
*
|
|
* This will have to go. (?)
|
|
*/
|
|
//luPixel m_axis;
|
|
|
|
/**
|
|
* The token that describes our type. Please note that we don't
|
|
* own it.
|
|
*/
|
|
ElementType* elementType;
|
|
|
|
// debug
|
|
static int evilDestructionCount;
|
|
};
|
|
|
|
KFORMULA_NAMESPACE_END
|
|
|
|
#endif // BASICELEMENT_H
|