kmag/kmagzoomview.h

   1 /***************************************************************************
   2                           kmagview.h  -  description
   3                              -------------------
   4     begin                : Mon Feb 12 23:45:41 EST 2001
   5     copyright            : (C) 2001-2003 by Sarang Lakare
   6     email                : sarang#users.sf.net
   7     copyright            : (C) 2003-2004 by Olaf Schmidt
   8     email                : ojschmidt@kde.org
   9  ***************************************************************************/
  10
  11 /***************************************************************************
  12  *                                                                         *
  13  *   This program is free software; you can redistribute it and/or modify  *
  14  *   it under the terms of the GNU General Public License as published by  *
  15  *   the Free Software Foundation; version 2 of the License        *
  16  *                                                                         *
  17  ***************************************************************************/
  18
  19
  20 #ifndef KMagZoomView_h_
  21 #define KMagZoomView_h_
  22
  23 // include files for Qt
  24 #include <qwidget.h>
  25 #include <QPainter>
  26 #include <QPixmap>
  27 #include <QTimer>
  28 #include <q3scrollview.h>
  29 #include <QStringList>
  30 #include <QRect>
  31 #include <QCursor>
  32 //Added by qt3to4:
  33 #include <QFocusEvent>
  34 #include <QHideEvent>
  35 #include <QKeyEvent>
  36 #include <QShowEvent>
  37 #include <QResizeEvent>
  38 #include <QMouseEvent>
  39
  40 //class KMagSelRect;
  41 #include "kmagselrect.h"
  42
  43 /**
  44  * The KMagZoomView class provides the view widget for the KmagApp instance.
  45  *
  46  * @author Sarang Lakare <sarang#users.sourceforge.net>
  47  */
  48 class KMagZoomView : public Q3ScrollView
  49 {
  50   Q_OBJECT
  51   public:
  52     /// Constructor for the main view
  53     KMagZoomView(QWidget *parent = 0, const char *name=0);
  54
  55     /// Destructor for the main view
  56     ~KMagZoomView();
  57
  58     /// Toggles the refreshing of the window
  59     void toggleRefresh();
  60
  61     /// Returns the currently displayed zoomed view
  62     QPixmap getPixmap();
  63
  64     /// Returns the state of the refresh switch
  65     bool getRefreshStatus() const { return m_refreshSwitch; };
  66
  67     /// Returns teh status of followMouse
  68     bool getFollowMouse() const { return m_followMouse; };
  69
  70     /// Get the status of "show rect. always"
  71     bool getShowSelRect() const { return (m_selRect.getAlwaysVisible()); };
  72
  73     /// Get the coordinates of the selection rectangle
  74     QRect getSelRectPos() const { return static_cast<QRect>(m_selRect); };
  75
  76     /// Returns the current state of show mouse
  77     unsigned int getShowMouseType() const;
  78
  79     /// Returns the different ways of showing mouse cursor
  80     QStringList getShowMouseStringList() const;
  81
  82     /// Returns the status of "fit to window" option
  83     bool getFitToWindow() const { return (m_fitToWindow); };
  84
  85   public slots:
  86
  87     /// Sets zoom to the given value
  88     void setZoom(float zoom = 0.0);
  89
  90     /// Sets the rotation to the given value
  91     void setRotation(int rotation = 0);
  92
  93     /// Grabs a frame from the given portion of the display
  94     void grabFrame();
  95
  96     /// Update the mouse cursor in the zoom view
  97     void updateMouseView();
  98
  99     /// Set grab-window-follows-mouse mode
 100     void followMouse(bool follow = true);
 101
 102     /// Shows/Hides the selection marker
 103     void showSelRect(bool show=true);
 104
 105     /// Set the position of the selection region to the given pos
 106     void setSelRectPos(const QRect & rect);
 107
 108     /// Set the refresh rate in fps (frames per second)
 109     void setRefreshRate(float fps);
 110
 111     /// Shows/Hides mouse cursor in the zoomed view
 112     bool showMouse(unsigned int type);
 113
 114     /// Set the status of "fit to window" option
 115     void setFitToWindow (bool fit=true);
 116
 117     /// Fits the zoom view to the zoom view window
 118     void fitToWindow();
 119
 120   protected:
 121     /// Called when the widget is hidden
 122     void hideEvent( QHideEvent * e);
 123
 124     /// Called when the widget is shown
 125     void showEvent( QShowEvent * e);
 126
 127     /// Called when the widget has been resized
 128     void resizeEvent(QResizeEvent *e);
 129
 130     /// Called when the widget is to be repainted
 131     void drawContents ( QPainter * p, int clipx, int clipy, int clipw, int cliph );
 132
 133     /// This function calculates the mouse position relative to the image
 134     QPoint calcMousePos(bool updateMousePos=true);
 135
 136     /// This function draws the mouse cursor
 137     void paintMouseCursor(QPaintDevice *dev, QPoint mousePos);
 138
 139     /// Called when mouse click is detected
 140     void mousePressEvent (QMouseEvent *e);
 141
 142     /// Called when mouse is moved
 143     void mouseMoveEvent(QMouseEvent *e);
 144
 145     /// Mouse button release event handler
 146     void mouseReleaseEvent(QMouseEvent *e);
 147
 148     /// Mouse button release event handler
 149     void keyPressEvent(QKeyEvent *e);
 150
 151     /// Mouse button release event handler
 152     void keyReleaseEvent(QKeyEvent *e);
 153
 154     /// Mouse button release event handler
 155     void focusOutEvent(QFocusEvent *e);
 156
 157     /// Returns the rectangle where the pixmap will be drawn
 158     QRect pixmapRect();
 159
 160   private:
 161     /// Stores the pixmap grabbed from the screen - to be zoomed
 162     QPixmap m_grabbedPixmap;
 163
 164     /// Stores the pixmap which is zoomed from the grabbed one - this will be actaully drawn
 165     QPixmap m_grabbedZoomedPixmap;
 166
 167     /// The selected rectangle which is to be grabbed
 168     KMagSelRect m_selRect;
 169
 170     /// Grabs a window when the timer goes off
 171     QTimer m_grabTimer;
 172
 173     /// Updates the mouse view
 174     QTimer m_mouseViewTimer;
 175
 176     /// Zoom matrix
 177     QMatrix m_zoomMatrix;
 178
 179     /// Saves the mouse position when a button is clicked and b4 the cursor is moved to new position
 180     QPoint m_oldMousePos;
 181
 182     /// Saves the center of the grab window
 183     QPoint m_oldCenter;
 184
 185     /// Possible modes for the mouse to be in
 186     enum KMagMouseMode {
 187       Normal,
 188       StartSelect,
 189       ResizeSelection,
 190       MoveSelection,
 191       GrabSelection
 192     };
 193
 194     /// The current mode which the mouse is
 195     KMagMouseMode m_mouseMode;
 196
 197     /// stores the state of the Ctrl key
 198     bool m_ctrlKeyPressed;
 199
 200     /// stores the state of the Shift key
 201     bool m_shiftKeyPressed;
 202
 203     /// Store the more recent updated cursor position
 204     QPoint m_latestCursorPos;
 205
 206     /// Various ways of showing mouse cursor
 207     QStringList m_showMouseTypes;
 208
 209     // configuration options:
 210
 211     /// To follow mouse motion or not when no key is pressed
 212     bool m_followMouse;
 213
 214     /// State of refreshing - on or off
 215     bool m_refreshSwitch;
 216
 217     /// Stores the state of the refresh switch on hide event
 218     bool m_refreshSwitchStateOnHide;
 219
 220     /// Show mouse cursor type - 0 : do not show, non zero: show
 221     unsigned int m_showMouse;
 222
 223     /// Frames per second for refresh
 224     unsigned int m_fps;
 225
 226     /// Stores the amount to zoom the pixmap
 227     float m_zoom;
 228
 229     /// Stores the degrees to rotate the pixmap
 230     int m_rotation;
 231
 232     /// Fit the zoom view to the zoom window
 233     bool m_fitToWindow;
 234 };
 235
 236 #endif // KMagZoomView_h_