src/frontends/qt4/GuiWorkArea.h

   1 // -*- C++ -*-
   2 /**
   3  * \file GuiWorkArea.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author John Levon
   8  * \author Abdelrazak Younes
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef WORKAREA_H
  14 #define WORKAREA_H
  15
  16 #include "frontends/WorkArea.h"
  17
  18 #include "funcrequest.h"
  19 #include "frontends/Timeout.h"
  20
  21 #include <QAbstractScrollArea>
  22 #include <QMouseEvent>
  23 #include <QResizeEvent>
  24 #include <QKeyEvent>
  25 #include <QTimer>
  26 #include <QPixmap>
  27
  28 #include <queue>
  29
  30 class QWidget;
  31 class QDragEnterEvent;
  32 class QDropEvent;
  33 class QWheelEvent;
  34 class QPaintEvent;
  35
  36 namespace lyx {
  37 namespace frontend {
  38
  39 class GuiView;
  40 class QLPainter;
  41
  42 /// for emulating triple click
  43 class double_click {
  44 public:
  45         int x;
  46         int y;
  47         Qt::MouseButton state;
  48         bool active;
  49
  50         bool operator==(QMouseEvent const & e) {
  51                 return x == e.x() && y == e.y()
  52                         && state == e.button();
  53         }
  54
  55         double_click()
  56                 : x(0), y(0), state(Qt::NoButton), active(false) {}
  57
  58         double_click(QMouseEvent * e)
  59                 : x(e->x()), y(e->y()),
  60                 state(e->button()), active(true) {}
  61 };
  62
  63 /** Qt only emits mouse events when the mouse is being moved, but
  64  *  we want to generate 'pseudo' mouse events when the mouse button is
  65  *  pressed and the mouse cursor is below the bottom, or above the top
  66  *  of the work area. In this way, we'll be able to continue scrolling
  67  *  (and selecting) the text.
  68  *
  69  *  This class stores all the parameters needed to make this happen.
  70  */
  71 class SyntheticMouseEvent
  72 {
  73 public:
  74         SyntheticMouseEvent();
  75
  76         FuncRequest cmd;
  77         Timeout timeout;
  78         bool restart_timeout;
  79         int x_old;
  80         int y_old;
  81         double scrollbar_value_old;
  82 };
  83
  84 /**
  85  * Qt-specific implementation of the work area
  86  * (buffer view GUI)
  87 */
  88         class CursorWidget;
  89 class GuiWorkArea : public QAbstractScrollArea, public WorkArea
  90 {
  91         Q_OBJECT
  92
  93 public:
  94         ///
  95         GuiWorkArea(int width, int height, int id, LyXView & lyx_view);
  96
  97         /// return the width of the content pane
  98         virtual int width() const { return viewport()->width(); }
  99         /// return the height of the content pane
 100         virtual int height() const { return viewport()->height(); }
 101         ///
 102         virtual void setScrollbarParams(int height, int pos, int line_height);
 103
 104         /// update the passed area.
 105         void update(int x, int y, int w, int h);
 106
 107         /// copies specified area of pixmap to screen
 108         virtual void expose(int x, int y, int exp_width, int exp_height);
 109
 110         /// paint the cursor and store the background
 111         virtual void showCursor(int x, int y, int h, CursorShape shape);
 112
 113         /// hide the cursor
 114         virtual void removeCursor();
 115
 116 private:
 117         void doGreyOut(QLPainter & pain);
 118         ///
 119         void dragEnterEvent(QDragEnterEvent * ev);
 120         ///
 121         void dropEvent(QDropEvent * ev);
 122         ///
 123         void focusInEvent(QFocusEvent *);
 124         ///
 125         void focusOutEvent(QFocusEvent *);
 126         /// repaint part of the widget
 127         void paintEvent(QPaintEvent * ev);
 128         /// widget has been resized
 129         void resizeEvent(QResizeEvent * ev);
 130         /// mouse button press
 131         void mousePressEvent(QMouseEvent * ev);
 132         /// mouse button release
 133         void mouseReleaseEvent(QMouseEvent * ev);
 134         /// mouse double click of button
 135         void mouseDoubleClickEvent(QMouseEvent * ev);
 136         /// mouse motion
 137         void mouseMoveEvent(QMouseEvent * ev);
 138         /// wheel event
 139         void wheelEvent(QWheelEvent * ev);
 140         /// key press
 141         void keyPressEvent(QKeyEvent * ev);
 142         /// IM events
 143         void inputMethodEvent(QInputMethodEvent * ev);
 144
 145 public Q_SLOTS:
 146         /// Timeout event Slot for keyboard bufferring.
 147         /// \todo This is not used currently in the code, remove?
 148         void keyeventTimeout();
 149
 150         /// Adjust the LyX buffer view with the position of the scrollbar.
 151         /**
 152         * The action argument is not used in the the code, it is there
 153         * only for the connection to the vertical srollbar signal which
 154         * emits an 'int' action.
 155         */
 156         void adjustViewWithScrollBar(int action = 0);
 157
 158 private:
 159         /// The slot connected to SyntheticMouseEvent::timeout.
 160         void generateSyntheticMouseEvent();
 161
 162         ///
 163         SyntheticMouseEvent synthetic_mouse_event_;
 164         /// \todo remove
 165         QTimer step_timer_;
 166         /// \todo remove
 167         std::queue<boost::shared_ptr<QKeyEvent> > keyeventQueue_;
 168         ///
 169         double_click dc_event_;
 170
 171         ///
 172         CursorWidget * cursor_;
 173         ///
 174         QPixmap screen_;
 175 };
 176
 177 } // namespace frontend
 178 } // namespace lyx
 179
 180 #endif // WORKAREA_H