matrixelement.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>
   Copyright (C) 2006 Alfredo Beaumont Sainz <alfredo.beaumont@gmail.com>
 
   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 MATRIXELEMENT_H
#define MATRIXELEMENT_H
 
#include <tqptrlist.h>
 
#include "basicelement.h"
 
KFORMULA_NAMESPACE_BEGIN
 
 
class MatrixSequenceElement;
 

class MatrixElement : public BasicElement {
    friend class KFCRemoveColumn;
    friend class KFCRemoveRow;
    friend class MatrixSequenceElement;
 
    enum VerticalAlign { NoAlign, TopAlign, BottomAlign, CenterAlign, BaselineAlign, AxisAlign };
    enum LineType { NoLine, NoneLine, SolidLine, DashedLine };
    enum SideType { NoSide, LeftSide, RightSide, LeftOverlapSide, RightOverlapSide };
    MatrixElement& operator=( const MatrixElement& ) { return *this; }
public:
    MatrixElement(uint rows = 1, uint columns = 1, BasicElement* parent = 0);
    ~MatrixElement();
 
    MatrixElement( const MatrixElement& );
 
    virtual MatrixElement* clone() {
        return new MatrixElement( *this );
    }
 
    virtual bool accept( ElementVisitor* visitor );

    virtual void entered( SequenceElement* child );

    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*, BasicElement*);

    virtual void moveDown(FormulaCursor*, BasicElement*);

    virtual void goInside(FormulaCursor* cursor);

    // If there is a main child we must provide the insert/remove semantics.
    virtual SequenceElement* getMainChild();

    //virtual void insert(FormulaCursor*, TQPtrList<BasicElement>&, Direction);

    //virtual void remove(FormulaCursor*, TQPtrList<BasicElement>&, Direction);

    //virtual void normalize(FormulaCursor*, Direction);

    virtual void selectChild(FormulaCursor*, BasicElement*);

    //virtual void childWillVanish(FormulaCursor* cursor, BasicElement* child) = 0;

    //virtual bool isSenseless();

    virtual TQString toLatex();
 
    virtual TQString formulaString();
 
    uint getRows() const { return content.count(); }
    uint getColumns() const { return content.getFirst()->count(); }
 
    SequenceElement* elementAt(uint row, uint column);
 
protected:
 
    //Save/load support

    virtual TQString getTagName() const { return "MATRIX"; }

    virtual void writeDom(TQDomElement element);
 
    virtual TQString getElementName() const { return "mtable"; }
    virtual void writeMathMLAttributes( TQDomElement& element ) const;
    virtual void writeMathMLContent( TQDomDocument& doc, 
                                     TQDomElement& element,
                                     bool oasisFormat ) const;
    virtual bool readAttributesFromDom(TQDomElement element);

    virtual bool readContentFromDom(TQDomNode& node);
 
    virtual bool readAttributesFromMathMLDom( const TQDomElement& element );

    virtual int readContentFromMathMLDom(TQDomNode& node);
 
private:
    void writeMathMLAttributes( TQDomElement& element );
 
    MatrixSequenceElement* getElement(uint row, uint column)
        { return content.at(row)->at(column); }
 
    const MatrixSequenceElement* getElement( uint row, uint column ) const;

    bool searchElement(BasicElement* element, uint& row, uint& column);

    TQPtrList< TQPtrList< MatrixSequenceElement > > content;

    int m_rowNumber;
    VerticalAlign m_align;
    TQValueList< VerticalAlign > m_rowAlign;
    TQValueList< HorizontalAlign > m_columnAlign;
    TQValueList< bool > m_alignmentScope;
    TQValueList< SizeType > m_columnWidthType;
    TQValueList< double > m_columnWidth;
    SizeType m_widthType;
    double m_width;
    TQValueList< SizeType > m_rowSpacingType;
    TQValueList< double > m_rowSpacing;
    TQValueList< SizeType > m_columnSpacingType;
    TQValueList< double > m_columnSpacing;
    TQValueList< LineType > m_rowLines;
    TQValueList< LineType > m_columnLines;
    LineType m_frame;
    SizeType m_frameHSpacingType;
    double m_frameHSpacing;
    SizeType m_frameVSpacingType;
    double m_frameVSpacing;
    SideType m_side;
    SizeType m_minLabelSpacingType;
    double m_minLabelSpacing;
    bool m_equalRows;
    bool m_customEqualRows;
    bool m_equalColumns;
    bool m_customEqualColumns;
    bool m_displayStyle;
    bool m_customDisplayStyle;
};
 
 
 
class MultilineSequenceElement;
 

class MultilineElement : public BasicElement {
    friend class KFCNewLine;
 
    typedef BasicElement inherited;
public:

    MultilineElement( BasicElement* parent = 0 );
    ~MultilineElement();
 
    MultilineElement( const MultilineElement& );
 
    virtual MultilineElement* clone() {
        return new MultilineElement( *this );
    }
 
    virtual bool accept( ElementVisitor* visitor );

    virtual void entered( SequenceElement* child );

    BasicElement* goToPos( FormulaCursor* cursor, bool& handled,
                           const LuPixelPoint& point, const LuPixelPoint& parentOrigin );

    virtual void goInside(FormulaCursor* cursor);

    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 );

    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 );
 
    virtual void insert(FormulaCursor*, TQPtrList<BasicElement>&, Direction);
    virtual void remove(FormulaCursor*, TQPtrList<BasicElement>&, Direction);
 
    virtual void normalize(FormulaCursor*, Direction);
 
    virtual SequenceElement* getMainChild();

    virtual void selectChild(FormulaCursor* cursor, BasicElement* child);

    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 "MULTILINE"; }

    virtual void writeDom(TQDomElement element);

    virtual bool readAttributesFromDom(TQDomElement element);

    virtual bool readContentFromDom(TQDomNode& node);
 
 
private:

    TQPtrList< MultilineSequenceElement > content;
};
 
 
KFORMULA_NAMESPACE_END
 
#endif // MATRIXELEMENT_H