Skip to content
qwt_plot_zoomer.h 4.19 KiB
Newer Older
pixhawk's avatar
pixhawk committed
/* -*- mode: C++ ; c-file-style: "stroustrup" -*- *****************************
 * Qwt Widget Library
 * Copyright (C) 1997   Josef Wilgen
 * Copyright (C) 2002   Uwe Rathmann
pixhawk's avatar
pixhawk committed
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the Qwt License, Version 1.0
 *****************************************************************************/

#ifndef QWT_PLOT_ZOOMER_H
#define QWT_PLOT_ZOOMER_H

Bryant's avatar
Bryant committed
#include "qwt_global.h"
pixhawk's avatar
pixhawk committed
#include "qwt_plot_picker.h"
Bryant's avatar
Bryant committed
#include <qstack.h>
pixhawk's avatar
pixhawk committed

/*!
  \brief QwtPlotZoomer provides stacked zooming for a plot widget

Bryant's avatar
Bryant committed
  QwtPlotZoomer selects rectangles from user inputs ( mouse or keyboard )
  translates them into plot coordinates and adjusts the axes to them.
  The selection is supported by a rubber band and optionally by displaying
  the coordinates of the current mouse position.

  Zooming can be repeated as often as possible, limited only by 
  maxStackDepth() or minZoomSize().  Each rectangle is pushed on a stack.

  The default setting how to select rectangles is 
  a QwtPickerDragRectMachine with the following bindings:

  - QwtEventPattern::MouseSelect1\n
    The first point of the zoom rectangle is selected by a mouse press, 
    the second point from the position, where the mouse is released.

  - QwtEventPattern::KeySelect1\n
    The first key press selects the first, the second key press
    selects the second point.

  - QwtEventPattern::KeyAbort\n
    Discard the selection in the state, where the first point
    is selected.

  To traverse the zoom stack the following bindings are used:

  - QwtEventPattern::MouseSelect3, QwtEventPattern::KeyUndo\n
    Zoom out one position on the zoom stack
    
  - QwtEventPattern::MouseSelect6, QwtEventPattern::KeyRedo\n
    Zoom in one position on the zoom stack

  - QwtEventPattern::MouseSelect2, QwtEventPattern::KeyHome\n
    Zoom to the zoom base

  The setKeyPattern() and setMousePattern() functions can be used
  to configure the zoomer actions. The following example 
  shows, how to configure the 'I' and 'O' keys for zooming in and out 
  one position on the zoom stack. The "Home" key is used to 
  "unzoom" the plot.
pixhawk's avatar
pixhawk committed

Bryant's avatar
Bryant committed
  \code
   zoomer = new QwtPlotZoomer( plot );
   zoomer->setKeyPattern( QwtEventPattern::KeyRedo, Qt::Key_I, Qt::ShiftModifier );
   zoomer->setKeyPattern( QwtEventPattern::KeyUndo, Qt::Key_O, Qt::ShiftModifier );
   zoomer->setKeyPattern( QwtEventPattern::KeyHome, Qt::Key_Home );
  \endcode
pixhawk's avatar
pixhawk committed
  QwtPlotZoomer is tailored for plots with one x and y axis, but it is
Bryant's avatar
Bryant committed
  allowed to attach a second QwtPlotZoomer ( without rubber band and tracker )
  for the other axes.
pixhawk's avatar
pixhawk committed

  \note The realtime example includes an derived zoomer class that adds
pixhawk's avatar
pixhawk committed
        scrollbars to the plot canvas.
Bryant's avatar
Bryant committed

  \sa QwtPlotPanner, QwtPlotMagnifier
pixhawk's avatar
pixhawk committed
*/

class QWT_EXPORT QwtPlotZoomer: public QwtPlotPicker
{
    Q_OBJECT
public:
Bryant's avatar
Bryant committed
    explicit QwtPlotZoomer( QWidget *, bool doReplot = true );
    explicit QwtPlotZoomer( int xAxis, int yAxis,
                            QWidget *, bool doReplot = true );
pixhawk's avatar
pixhawk committed

    virtual ~QwtPlotZoomer();

Bryant's avatar
Bryant committed
    virtual void setZoomBase( bool doReplot = true );
    virtual void setZoomBase( const QRectF & );
pixhawk's avatar
pixhawk committed

Bryant's avatar
Bryant committed
    QRectF zoomBase() const;
    QRectF zoomRect() const;
pixhawk's avatar
pixhawk committed

Bryant's avatar
Bryant committed
    virtual void setAxis( int xAxis, int yAxis );
pixhawk's avatar
pixhawk committed

Bryant's avatar
Bryant committed
    void setMaxStackDepth( int );
pixhawk's avatar
pixhawk committed
    int maxStackDepth() const;

Bryant's avatar
Bryant committed
    const QStack<QRectF> &zoomStack() const;
    void setZoomStack( const QStack<QRectF> &,
        int zoomRectIndex = -1 );
Don Gagne's avatar
Don Gagne committed

Bryant's avatar
Bryant committed
    uint zoomRectIndex() const;
pixhawk's avatar
pixhawk committed

Bryant's avatar
Bryant committed
public Q_SLOTS:
    void moveBy( double x, double y );
    virtual void moveTo( const QPointF & );
Don Gagne's avatar
Don Gagne committed

Bryant's avatar
Bryant committed
    virtual void zoom( const QRectF & );
    virtual void zoom( int up );
pixhawk's avatar
pixhawk committed

Bryant's avatar
Bryant committed
Q_SIGNALS:
pixhawk's avatar
pixhawk committed
    /*!
      A signal emitting the zoomRect(), when the plot has been
pixhawk's avatar
pixhawk committed
      zoomed in or out.

      \param rect Current zoom rectangle.
    */

Bryant's avatar
Bryant committed
    void zoomed( const QRectF &rect );
pixhawk's avatar
pixhawk committed

protected:
    virtual void rescale();

Bryant's avatar
Bryant committed
    virtual QSizeF minZoomSize() const;
pixhawk's avatar
pixhawk committed

Bryant's avatar
Bryant committed
    virtual void widgetMouseReleaseEvent( QMouseEvent * );
    virtual void widgetKeyPressEvent( QKeyEvent * );
pixhawk's avatar
pixhawk committed

    virtual void begin();
Bryant's avatar
Bryant committed
    virtual bool end( bool ok = true );
    virtual bool accept( QPolygon & ) const;
pixhawk's avatar
pixhawk committed

private:
Bryant's avatar
Bryant committed
    void init( bool doReplot );
pixhawk's avatar
pixhawk committed

    class PrivateData;
    PrivateData *d_data;
};
pixhawk's avatar
pixhawk committed
#endif