symbolelement.h

/* 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 SYMBOLELEMENT_H
#define SYMBOLELEMENT_H
 
#include "fontstyle.h"
#include "basicelement.h"
#include "kformuladefs.h"
 
KFORMULA_NAMESPACE_BEGIN
 
class SymbolElement : public BasicElement {
    SymbolElement operator=( const SymbolElement& ) { return *this; }
public:
 
    //enum { contentPos, upperPos, lowerPos };
 
    SymbolElement(SymbolType type = EmptyBracket, BasicElement* parent = 0);
    ~SymbolElement();
 
    SymbolElement( const SymbolElement& );
 
    virtual SymbolElement* clone() {
        return new SymbolElement( *this );
    }
 
    virtual bool accept( ElementVisitor* visitor );
 
    virtual BasicElement* goToPos( FormulaCursor*, bool& handled,
                                   const LuPixelPoint& point, const LuPixelPoint& parentOrigin );
 
    // 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.
 
    virtual void calcSizes( const ContextStyle& cstyle,
                            ContextStyle::TextStyle tstyle,
                            ContextStyle::IndexStyle istyle,
                            StyleAttributes& style );
 
    virtual void draw( TQPainter& painter, const LuPixelRect& r,
                       const ContextStyle& context,
                       ContextStyle::TextStyle tstyle,
                       ContextStyle::IndexStyle istyle,
                       StyleAttributes& style,
                       const LuPixelPoint& parentOrigin );
 
    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.
 
    virtual void moveLeft(FormulaCursor* cursor, BasicElement* from);
 
    virtual void moveRight(FormulaCursor* cursor, BasicElement* from);
 
    virtual void moveUp(FormulaCursor* cursor, BasicElement* from);
 
    virtual void moveDown(FormulaCursor* cursor, BasicElement* from);
 
    // children
 
    //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 content; }
    //virtual void setMainChild(SequenceElement*);
 
 
    virtual void insert(FormulaCursor*, TQPtrList<BasicElement>&, Direction);
 
    virtual void remove(FormulaCursor*, TQPtrList<BasicElement>&, Direction);
 
    virtual void normalize(FormulaCursor*, Direction);
 
    virtual BasicElement* getChild(FormulaCursor*, Direction = beforeCursor);
 
    virtual void selectChild(FormulaCursor* cursor, BasicElement* child);
 
    //virtual void childWillVanish(FormulaCursor* cursor, BasicElement* child) = 0;
 
    bool hasUpper() const { return upper != 0; }
    bool hasLower() const { return lower != 0; }
 
    // If we want to create an index we need a cursor that points there.
 
    void setToUpper(FormulaCursor* cursor);
    void setToLower(FormulaCursor* cursor);
 
    // Moves the cursor inside the index. The index has to exist.
    void moveToUpper(FormulaCursor*, Direction);
    void moveToLower(FormulaCursor*, Direction);
 
    // Generic access to each index.
 
    ElementIndexPtr getUpperIndex() { return ElementIndexPtr( new UpperIndex( this ) ); }
    ElementIndexPtr getLowerIndex() { return ElementIndexPtr( new LowerIndex( this ) ); }
 
    ElementIndexPtr getIndex( int position );
 
    // Save&load
    //virtual TQDomElement getElementDom(TQDomDocument *doc);
    //virtual bool buildFromDom(TQDomElement *elem);
 
    virtual TQString toLatex();
 
    virtual TQString formulaString();
 
    virtual void writeMathML( TQDomDocument& doc, TQDomNode& parent, bool oasisFormat = false ) const ;
 
protected:
 
    //Save/load support
 
    virtual TQString getTagName() const { return "SYMBOL"; }
 
    virtual void writeDom(TQDomElement element);
 
    virtual bool readAttributesFromDom(TQDomElement element);
 
    virtual bool readContentFromDom(TQDomNode& node);
 
private:
 
    class SymbolElementIndex : public ElementIndex {
    public:
        SymbolElementIndex(SymbolElement* p) : parent(p) {}
        virtual SymbolElement* getElement() { return parent; }
    protected:
        SymbolElement* parent;
    };
 
    // We have a (very simple) type for every index.
 
    class UpperIndex : public SymbolElementIndex {
    public:
        UpperIndex(SymbolElement* parent) : SymbolElementIndex(parent) {}
        virtual void moveToIndex(FormulaCursor* cursor, Direction direction)
            { parent->moveToUpper(cursor, direction); }
        virtual void setToIndex(FormulaCursor* cursor)
            { parent->setToUpper(cursor); }
        virtual bool hasIndex() const
            { return parent->hasUpper(); }
    };
 
    class LowerIndex : public SymbolElementIndex {
    public:
        LowerIndex(SymbolElement* parent) : SymbolElementIndex(parent) {}
        virtual void moveToIndex(FormulaCursor* cursor, Direction direction)
            { parent->moveToLower(cursor, direction); }
        virtual void setToIndex(FormulaCursor* cursor)
            { parent->setToLower(cursor); }
        virtual bool hasIndex() const
            { return parent->hasLower(); }
    };
 
 
    void setToContent(FormulaCursor* cursor);
 
    SequenceElement* content;
    SequenceElement* upper;
    SequenceElement* lower;
 
    Artwork* symbol;
 
    SymbolType symbolType;
};
 
KFORMULA_NAMESPACE_END
 
#endif // SYMBOLELEMENT_H