kspread_canvas.h

/* This file is part of the KDE project
 
   Copyright 2006 Stefan Nikolaus <stefan.nikolaus@kdemail.net>
   Copyright 1999-2002,2004 Laurent Montel <montel@kde.org>
   Copyright 2002-2005 Ariya Hidayat <ariya@kde.org>
   Copyright 1999-2001,2003 David Faure <faure@kde.org>
   Copyright 2001-2003 Philipp Mueller <philipp.mueller@gmx.de>
   Copyright 2002-2003 Norbert Andres <nandres@web.de>
   Copyright 2000-2001 Werner Trobin <trobin@kde.org>
   Copyright 2002 Harri Porten <porten@kde.org>
   Copyright 2002 John Dailey <dailey@vt.edu>
   Copyright 1999-2000 Torben Weis <weis@kde.org>
   Copyright 2000 Wilco Greven <greven@kde.org>
   Copyright 1999 Boris Wedl <boris.wedl@kfunigraz.ac.at>
   Copyright 1999 Reginald Stadlbauer <reggie@kde.org>
 
   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 KSPREAD_CANVAS
#define KSPREAD_CANVAS
 
#include <vector>
 
#include <tqlineedit.h>
#include <tqtooltip.h>
#include <tqpen.h>
 
#include <ksharedptr.h>
 
#include <koffice_export.h>
 
#include "kspread_util.h"
 
#define YBORDER_WIDTH 50
#define XBORDER_HEIGHT 20
 
class TQWidget;
class TQTimer;
class TQButton;
class TQPainter;
class TQLabel;
class TQScrollBar;
class KoRect;
class KoPoint;
 
namespace KSpread
{
 
class Cell;
class EditWidget;
class Canvas;
class HBorder;
class VBorder;
class Sheet;
class Doc;
class Point;
class Range;
class Region;
class View;
class Selection;
class CellEditor;
class LocationEditWidget;
class ComboboxLocationEditWidget;
class EmbeddedObject;
 
 
class KSPREAD_EXPORT Canvas : public TQWidget
{
    friend class HBorder;
    friend class VBorder;
    friend class View;
 
    TQ_OBJECT
  
public:
    enum MouseActions
    {
      NoAction,
      Mark,
      ResizeCell,
      AutoFill,
      ResizeSelection
    };
    enum EditorType { CellEditor, EditWidget };
 
    Canvas (View *_view);
    ~Canvas( );
 
    View* view() const;
    Doc* doc() const;
 
    KSpread::EditWidget* editWidget() const;
    KSpread::CellEditor* editor() const;
 
    Selection* selectionInfo() const;
    Selection* choice() const;
 
    TQRect selection() const;
    TQPoint marker() const;
    int markerColumn() const;
    int markerRow() const;
 
    const TQPen& defaultGridPen() const;
 
    double zoom() const;
 
    double xOffset() const;
    double yOffset() const;
    void  setXOffset( double _xOffset );
    void  setYOffset( double _yOffset );
 
    TQRect visibleCells() const;
 
    Sheet* activeSheet() const;
    Sheet* findSheet( const TQString& _name ) const;
 
 
    void validateSelection();
 
 
    void paintUpdates();
 
 
    void scrollToCell(TQPoint location) const;
    void createEditor( bool captureArrowKeys=false );
    bool createEditor( EditorType type, bool addFocus = true, bool captureArrowKeys=false );
    void deleteEditor(bool saveChanges, bool array = false);
 
    void setLastEditorWithFocus( EditorType type );
 
    void startChoose();
    void startChoose( const TQRect& selection );
    void endChoose();
    void setChooseMode(bool state);
    bool chooseMode() const;
 
    void equalizeRow();
    void equalizeColumn();
 
    void updatePosWidget();
    void closeEditor();
 
    // Created by the view since it's layout is managed there,
    // but is in fact a sibling of the canvas, which needs to know about it.
    void setEditWidget( KSpread::EditWidget * ew );
 
    virtual bool focusNextPrevChild( bool );
 
    double autoScrollAccelerationX( int offset );
    double autoScrollAccelerationY( int offset );
 
    //TODO: These embedded-object related methods need API documentation!
    EmbeddedObject* getObject( const TQPoint &pos, Sheet *_sheet );
    void selectAllObjects();
    void deselectAllObjects();
    void selectObject( EmbeddedObject* );
    void deselectObject( EmbeddedObject* );
    void setMouseSelectedObject(bool b);
    bool isObjectSelected();
 
    void moveObjectsByMouse( KoPoint &pos, bool keepXorYunchanged );
 
    //---- stuff needed for resizing ----
    void resizeObject( ModifyType _modType, const KoPoint & point, bool keepRatio );
    void finishResizeObject( const TQString &name, bool layout = true );
 
    void raiseObject( EmbeddedObject *object );
    void lowerObject();
    void displayObjectList( TQPtrList<EmbeddedObject> &list );
 
    KoRect objectRect( bool all ) const;
 
    void repaintObject( EmbeddedObject *obj );
 
    void copyOasisObjects();
    //void insertOasisData();
 
public slots:
    void slotScrollVert( int _value );
    void slotScrollHorz( int _value );
 
    void slotMaxColumn( int _max_column );
    void slotMaxRow( int _max_row );
 
signals:
    void objectSelectedChanged();
    void objectSizeChanged();
 
protected:
    virtual void keyPressEvent ( TQKeyEvent* _ev );
    virtual void paintEvent ( TQPaintEvent* _ev );
    virtual void mousePressEvent( TQMouseEvent* _ev );
    virtual void mouseReleaseEvent( TQMouseEvent* _ev );
    virtual void mouseMoveEvent( TQMouseEvent* _ev );
    virtual void mouseDoubleClickEvent( TQMouseEvent* );
    virtual void wheelEvent( TQWheelEvent* );
    virtual void focusInEvent( TQFocusEvent* );
    virtual void focusOutEvent( TQFocusEvent* );
    virtual void resizeEvent( TQResizeEvent * _ev );
    virtual void dragMoveEvent(TQDragMoveEvent * _ev);
    virtual void dropEvent(TQDropEvent * _ev);
    virtual void dragLeaveEvent(TQDragLeaveEvent * _ev);
 
    bool highlightRangeSizeGripAt(double x, double y);
 
private slots:
 
    void slotAutoScroll(const TQPoint &scrollDist);
 
    void doAutoScroll();
    void speakCell(TQWidget* w, const TQPoint& p, uint flags);
 
private:
    virtual bool eventFilter( TQObject *o, TQEvent *e );
 
    HBorder* hBorderWidget() const;
    VBorder* vBorderWidget() const;
    TQScrollBar* horzScrollBar() const;
    TQScrollBar* vertScrollBar() const;
 
    TQRect painterWindowGeometry( const TQPainter& painter ) const;
    
    void clipoutChildren( TQPainter& painter ) const;
 
    TQRect cellsInArea( const TQRect area ) const;
    
    void paintChildren( TQPainter& painter, TQWMatrix& matrix );
 
    EditorType lastEditorWithFocus() const;
 
private:
  void moveObject( int x, int y, bool key );
 
  void startTheDrag();
 
  /* helpers for the paintUpdates function */
  void paintNormalMarker(TQPainter& painter, const KoRect &viewRect);
 
  void paintHighlightedRanges(TQPainter& painter, const KoRect& viewRect);
 
  void sheetAreaToVisibleRect( const TQRect& sheetArea,
                   KoRect& visibleRect ); 
 
  void sheetAreaToRect( const TQRect& sheetArea, KoRect& rect );
 
 
  void retrieveMarkerInfo( const TQRect &marker, const KoRect &viewRect,
                           double positions[], bool paintSides[] );
 
 
 
 
  bool formatKeyPress( TQKeyEvent * _ev );
 
  bool formatCellByKey(Cell *cell, int key, const TQRect &rect);
 
  void processClickSelectionHandle(TQMouseEvent *event);
  void processLeftClickAnchor();
 
 
  TQPoint cursorPos();
 
  TQRect moveDirection(KSpread::MoveTo direction, bool extendSelection);
 
  void processEnterKey(TQKeyEvent *event);
  void processArrowKey(TQKeyEvent *event);
  void processEscapeKey(TQKeyEvent *event);
  bool processHomeKey(TQKeyEvent *event);
  bool processEndKey(TQKeyEvent *event);
  bool processPriorKey(TQKeyEvent *event);
  bool processNextKey(TQKeyEvent *event);
  void processDeleteKey(TQKeyEvent *event);
  void processF2Key(TQKeyEvent *event);
  void processF4Key(TQKeyEvent *event);
  void processOtherKey(TQKeyEvent *event);
  bool processControlArrowKey(TQKeyEvent *event);
 
  void processIMEvent( TQIMEvent * event );
 
  void updateEditor();
 
  void setSelectionChangePaintDirty(Sheet* sheet, const Region& changedRegion);
 
private:
  class Private;
  Private* d;
};
 
 
 
class HBorder : public TQWidget
{
    TQ_OBJECT
  
public:
    HBorder( TQWidget *_parent, Canvas *_canvas, View *_view  );
    ~HBorder();
 
    int markerColumn() const { return  m_iSelectionAnchor; }
    void equalizeColumn( double resize );
 
    void updateColumns( int from, int to );
 
    TQSize sizeHint() const;
 
private slots:
    void doAutoScroll();
 
protected:
    virtual void paintEvent ( TQPaintEvent* _ev );
    virtual void mousePressEvent( TQMouseEvent* _ev );
    virtual void mouseReleaseEvent( TQMouseEvent* _ev );
    virtual void mouseDoubleClickEvent( TQMouseEvent* _ev );
    virtual void mouseMoveEvent( TQMouseEvent* _ev );
    virtual void wheelEvent( TQWheelEvent* );
    virtual void focusOutEvent( TQFocusEvent* ev );
    virtual void resizeEvent( TQResizeEvent * _ev );
    void paintSizeIndicator( int mouseX, bool firstTime );
 
private:
    Canvas *m_pCanvas;
    View *m_pView;
    TQTimer * m_scrollTimer;
 
    bool m_bSelection;
 
    int m_iSelectionAnchor;
 
    bool m_bResize;
 
    int m_iResizedColumn;
 
    int m_iResizePos;
 
    TQLabel *m_lSize;
 
    bool m_bMousePressed;
 
private:
};
 
 
 
class VBorder : public TQWidget
{
    TQ_OBJECT
  
public:
    VBorder( TQWidget *_parent, Canvas *_canvas, View *_view );
    ~VBorder();
 
    int markerRow() const { return  m_iSelectionAnchor; }
    void equalizeRow( double resize );
    void updateRows( int from, int to );
 
    TQSize sizeHint() const;
 
private slots:
    void doAutoScroll();
 
protected:
    virtual void paintEvent ( TQPaintEvent* _ev );
    virtual void mousePressEvent( TQMouseEvent* _ev );
    virtual void mouseReleaseEvent( TQMouseEvent* _ev );
    virtual void mouseMoveEvent( TQMouseEvent* _ev );
    virtual void mouseDoubleClickEvent( TQMouseEvent* _ev );
    virtual void wheelEvent( TQWheelEvent* );
    virtual void focusOutEvent( TQFocusEvent* ev );
    void paintSizeIndicator( int mouseY, bool firstTime );
 
private:
    Canvas *m_pCanvas;
    View *m_pView;
    TQTimer * m_scrollTimer;
 
    bool m_bSelection;
    int m_iSelectionAnchor;
    bool m_bResize;
    int m_iResizedRow;
    int m_iResizePos;
    TQLabel *m_lSize;
 
    bool m_bMousePressed;
};
 
 
 
class ToolTip : public TQToolTip
{
public:
    ToolTip( Canvas* canvas );
 
protected:
    void maybeTip( const TQPoint& p );
 
private:
    Canvas* m_canvas;
};
 
} // namespace KSpread
 
#endif // KSPREAD_CANVAS