WQtNetworkEditorView.h

//---------------------------------------------------------------------------
//
// Project: OpenWalnut ( http://www.openwalnut.org )
//
// Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
// For more information see http://www.openwalnut.org/copying
//
// This file is part of OpenWalnut.
//
// OpenWalnut is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// OpenWalnut 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
//
//---------------------------------------------------------------------------
 
#ifndef WQTNETWORKEDITORVIEW_H
#define WQTNETWORKEDITORVIEW_H
 
#include <QtCore/QTimeLine>
#include <QGraphicsView>
 
class QGraphicsItem;
 
/**
 * This class extends the basic functionality of QGraphicsView to allow comfortable panning and zooming.
 */
class WQtNetworkEditorView: public QGraphicsView
{
    Q_OBJECT
public:
    /**
     * Constructs empty view.
     *
     * \param parent parent widgets containing the view
     */
    explicit WQtNetworkEditorView( QWidget* parent = NULL );
 
    /**
     * The Item to focus on. Use this instead of QGraphicsView::ensureVisible.
     *
     * \param item the item.
     */
    void focusOn( QGraphicsItem* item );
 
    /**
     * Improved version of QGraphicsView::ensureVisible for smooth scrolling.
     *
     * \param item the item to make visible.
     * \param xmargin the margin to ensure between item border and visible scene border (x direction)
     * \param ymargin the margin to ensure between item border and visible scene border (y direction)
     */
    void ensureVisibleSmooth( QGraphicsItem* item , int xmargin = 50, int ymargin = 50 );
 
    /**
     * Set the given menu as new global add-modules menu. Can be NULL to disable.
     *
     * \param menu the menu to set.
     */
    void setGlobalAddMenu( QMenu* menu );
signals:
    /**
     * Emitted whenever the user caused a load event.
     */
    void loadAction();
 
    /**
     * Emitted whenever the user drops something into the widget
     *
     * \param event event containing further info on the dropped item.
     */
    void dragDrop( QDropEvent* event );
 
protected:
    /**
     * Double clicked into the view
     *
     * \param event contains event information.
     */
    virtual void mouseDoubleClickEvent( QMouseEvent* event );
 
    /**
     * Mouse button pressed.
     *
     * \param event contains event information.
     */
    virtual void mousePressEvent( QMouseEvent* event );
 
    /**
     * Mouse button released
     *
     * \param event contains event information.
     */
    virtual void mouseReleaseEvent( QMouseEvent* event );
 
    /**
     * Mouse moved
     *
     * \param event contains event information.
     */
    virtual void mouseMoveEvent( QMouseEvent* event );
 
    /**
     * Mouse wheel used.
     *
     * \param event contains event information.
     */
    virtual void wheelEvent( QWheelEvent* event );
 
    /**
     * View resized. This automatically updates the virtual center for zooming after resize
     *
     * \param event contains event information.
     */
    virtual void resizeEvent( QResizeEvent* event );
 
    /**
     * Key pressed.
     *
     * \param event contains event information.
     */
    void keyPressEvent( QKeyEvent *event );
 
    /**
     * Mouse leaves the widget.
     *
     * \param event the event
     */
    void leaveEvent( QEvent* event );
 
    /**
     * Handles the drop event for a tree item.
     *
     * \param event the event.
     */
    virtual void dropEvent( QDropEvent *event );
 
    /**
     * Move scene in the view by delta units
     *
     * \param delta move vector.
     */
    void moveBy( const QPointF& delta );
 
    /**
     * Move scrollarea to absolute position.
     *
     * \param target the new scroll position
     */
    void moveTo( const QPointF& target );
 
private:
    /**
     * To keep track of mouse movement, cache last known mouse event point
     */
    QPoint m_lastPanPoint;
 
    /**
     * If true, we are in pan mode.
     */
    bool m_panning;
 
    /**
     * The menu containing the add actions in m_addModuleActionList.
     */
    QMenu* m_addMenu;
 
    /**
     * Auto-pan vector
     */
    QPoint m_autoPanTarget;
 
    /**
     * Origin of auto-pan movement for proper interpolation.
     */
    QPoint m_autoPanOrig;
 
    /**
     * Auto-pan timer
     */
    QTimeLine* m_autoPanTimer;
 
private slots:
    /**
     * Called every tick of the auto pan timer
     *
     * \param value
     */
    void autoPanTick( qreal value );
};
 
#endif  // WQTNETWORKEDITORVIEW_H