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.
koffice/lib/kformula/rootelement.h

274 lines
8.3 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 ROOTELEMENT_H
#define ROOTELEMENT_H
#include <qpoint.h>
#include "basicelement.h"
KFORMULA_NAMESPACE_BEGIN
class SequenceElement;
/**
* A nice graphical root.
*/
class RootElement : public BasicElement {
RootElement& operator=( const RootElement& ) { return *this; }
public:
//enum { contentPos, indexPos };
RootElement(BasicElement* parent = 0);
~RootElement();
RootElement( const RootElement& );
virtual RootElement* clone() {
return new RootElement( *this );
}
virtual bool accept( ElementVisitor* visitor );
/**
* 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 );
/**
* 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 );
/**
* Calculates our width and height and
* our children's parentPosition.
*/
virtual void calcSizes( const ContextStyle& cstyle,
ContextStyle::TextStyle tstyle,
ContextStyle::IndexStyle istyle,
StyleAttributes& style );
/**
* 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( QPainter& painter, const LuPixelRect& r,
const ContextStyle& cstyle,
ContextStyle::TextStyle tstyle,
ContextStyle::IndexStyle istyle,
StyleAttributes& style,
const LuPixelPoint& parentOrigin );
/**
* Dispatch this FontCommand to all our TextElement children.
*/
virtual void dispatchFontCommand( FontCommand* cmd );
/**
* 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* cursor, BasicElement* from);
/**
* 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* cursor, BasicElement* from);
/**
* Reinserts the index if it has been removed.
*/
virtual void insert(FormulaCursor*, QPtrList<BasicElement>&, Direction);
/**
* Removes all selected children and returns them. Places the
* cursor to where the children have been.
*
* We remove ourselve if we are requested to remove our content.
*/
virtual void remove(FormulaCursor*, QPtrList<BasicElement>&, Direction);
/**
* Moves the cursor to a normal place where new elements
* might be inserted.
*/
virtual void normalize(FormulaCursor*, Direction);
// main child
//
// If an element has children one has to become the main one.
virtual SequenceElement* getMainChild();
SequenceElement* getRadiant() { return index; }
//virtual void setMainChild(SequenceElement*);
/**
* Sets the cursor to select the child. The mark is placed before,
* the position behind it.
*/
virtual void selectChild(FormulaCursor* cursor, BasicElement* child);
/**
* Moves the cursor away from the given child. The cursor is
* guaranteed to be inside this element.
*/
//virtual void childWillVanish(FormulaCursor* cursor, BasicElement* child) = 0;
// Moves the cursor inside the index. The index has to exist.
void moveToIndex(FormulaCursor*, Direction);
// Sets the cursor to point to the place where the index normaly
// is. These functions are only used if there is no such index and
// we want to insert them.
void setToIndex(FormulaCursor*);
bool hasIndex() const { return index != 0; }
ElementIndexPtr getIndex() { return ElementIndexPtr( new RootElementIndex( this ) ); }
// Save&load
//virtual QDomElement getElementDom(QDomDocument *doc);
//virtual bool buildFromDom(QDomElement *elem);
/**
* @returns the latex representation of the element and
* of the element's children
*/
virtual QString toLatex();
virtual QString formulaString();
protected:
//Save/load support
/**
* Returns the tag name of this element type.
*/
virtual QString getTagName() const { return "ROOT"; }
/**
* Appends our attributes to the dom element.
*/
virtual void writeDom(QDomElement element);
/**
* Reads our attributes from the element.
* Returns false if it failed.
*/
virtual bool readAttributesFromDom(QDomElement 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(QDomNode& node);
/**
* Reads our attributes from the MathML element.
* Also checks whether it's a msqrt or mroot.
* Returns false if it failed.
*/
virtual bool readAttributesFromMathMLDom(const QDomElement& element);
/**
* Reads our content from the MathML node. Sets the node to the next node
* that needs to be read.
* Returns false if it failed.
*/
virtual int readContentFromMathMLDom(QDomNode& node);
private:
virtual QString getElementName() const { return hasIndex() ? "mroot" : "msqrt"; }
virtual void writeMathMLContent( QDomDocument& doc,
QDomElement& element,
bool oasisFormat ) const ;
class RootElementIndex : public ElementIndex {
public:
RootElementIndex(RootElement* p) : parent(p) {}
virtual void moveToIndex(FormulaCursor* cursor, Direction direction)
{ parent->moveToIndex(cursor, direction); }
virtual void setToIndex(FormulaCursor* cursor)
{ parent->setToIndex(cursor); }
virtual bool hasIndex() const
{ return parent->hasIndex(); }
virtual RootElement* getElement() { return parent; }
protected:
RootElement* parent;
};
/**
* The one below the graph.
*/
SequenceElement* content;
/**
* An optional index.
*/
SequenceElement* index;
/**
* The point the artwork relates to.
*/
LuPixelPoint rootOffset;
/**
* Whether it is msqrt or mroot element. It is only used while reading
* from MathML. When reading element contents we must know which of them
* it is. After reading, hasIndex() should be used instead.
*/
bool square;
};
KFORMULA_NAMESPACE_END
#endif // ROOTELEMENT_H