src/frontends/qt4/QWorkArea.h

   1 // -*- C++ -*-
   2 /**
   3  * \file QWorkArea.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author unknown
   8  * \author John Levon
   9  * \author Abdelrazak Younes
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #ifndef QWORKAREA_H
  15 #define QWORKAREA_H
  16
  17 #if (defined(Q_WS_X11) && QT_VERSION >= 0x030200)
  18 #define USE_INPUT_METHODS 1
  19 #endif
  20
  21 #ifdef emit
  22 #undef emit
  23 #endif
  24
  25 #include "funcrequest.h"
  26 #include "frontends/Timeout.h"
  27
  28 #include "WorkArea.h"
  29 #include "QLPainter.h"
  30 #include "LyXView.h"
  31
  32 #include <QAbstractScrollArea>
  33 #include <QMouseEvent>
  34 #include <QWheelEvent>
  35 #include <QResizeEvent>
  36 #include <QKeyEvent>
  37 #include <QPaintEvent>
  38 #include <QTimer>
  39
  40 #include <boost/scoped_ptr.hpp>
  41
  42 #include <queue>
  43
  44 class Painter;
  45
  46 class QWidget;
  47 class QDragEnterEvent;
  48 class QDropEvent;
  49 class QMouseEvent;
  50
  51 /// for emulating triple click
  52 class double_click {
  53 public:
  54         int x;
  55         int y;
  56         Qt::ButtonState state;
  57         bool active;
  58
  59         bool operator==(QMouseEvent const & e) {
  60                 return x == e.x() && y == e.y()
  61                         && state == e.button();
  62         }
  63
  64         double_click()
  65                 : x(0), y(0), state(Qt::NoButton), active(false) {}
  66
  67         double_click(QMouseEvent * e)
  68                 : x(e->x()), y(e->y()),
  69                 state(e->button()), active(true) {}
  70 };
  71
  72
  73 /** Qt only emits mouse events when the mouse is being moved, but
  74  *  we want to generate 'pseudo' mouse events when the mouse button is
  75  *  pressed and the mouse cursor is below the bottom, or above the top
  76  *  of the work area. In this way, we'll be able to continue scrolling
  77  *  (and selecting) the text.
  78  *
  79  *  This class stores all the parameters needed to make this happen.
  80  */
  81 class SyntheticMouseEvent
  82 {
  83 public:
  84         SyntheticMouseEvent();
  85
  86         FuncRequest cmd;
  87         Timeout timeout;
  88         bool restart_timeout;
  89         int x_old;
  90         int y_old;
  91         double scrollbar_value_old;
  92 };
  93
  94 /**
  95  * Qt-specific implementation of the work area
  96  * (buffer view GUI)
  97 */
  98 class QWorkArea : public QAbstractScrollArea, public WorkArea {
  99
 100         Q_OBJECT
 101
 102 public:
 103
 104         QWorkArea(LyXView & owner, int w, int h);
 105
 106         virtual ~QWorkArea();
 107         /// return the width of the content pane
 108         virtual int workWidth() const { return workWidth_; }
 109
 110         /// return the height of the content pane
 111         virtual int workHeight() const { return workHeight_; }
 112         ///
 113         virtual void setScrollbarParams(int height, int pos, int line_height);
 114
 115         /// a selection exists
 116         virtual void haveSelection(bool) const;
 117
 118         ///
 119         virtual std::string const getClipboard() const;
 120
 121         ///
 122         virtual void putClipboard(std::string const &) const;
 123
 124         ///
 125         virtual void dragEnterEvent(QDragEnterEvent * event);
 126
 127         ///
 128         virtual void dropEvent(QDropEvent* event);
 129
 130         /// return the widget's painter
 131         virtual Painter & getPainter() { return (Painter &) painter_; }
 132
 133         ///
 134         //virtual QPaintDevice & paintDevice() { return content_->pixmap(); }
 135
 136         /// return the backing pixmap
 137         QPixmap * pixmap() const { return pixmap_.get(); }
 138
 139         /// return the widget's painter
 140         //virtual QLPainter & getQLPainter() const { return painter_; }
 141
 142         /// get the content pane widget
 143         QWidget * getContent() const  { return viewport(); }
 144
 145 protected:
 146
 147         /// repaint part of the widget
 148         void paintEvent(QPaintEvent * e);
 149         /// widget has been resized
 150         void resizeEvent(QResizeEvent * e);
 151         /// mouse button press
 152         void mousePressEvent(QMouseEvent * e);
 153         /// mouse button release
 154         void mouseReleaseEvent(QMouseEvent * e);
 155         /// mouse double click of button
 156         void mouseDoubleClickEvent(QMouseEvent * e);
 157         /// mouse motion
 158         void mouseMoveEvent(QMouseEvent * e);
 159         /// wheel event
 160         void wheelEvent(QWheelEvent * e);
 161         /// key press
 162         void keyPressEvent(QKeyEvent * e);
 163
 164 #if USE_INPUT_METHODS
 165 protected:
 166         /// IM events
 167         void QWorkArea::inputMethodEvent(QInputMethodEvent * e)
 168 #endif
 169
 170 public slots:
 171
 172         void keyeventTimeout();
 173         void adjustViewWithScrollBar(int action);
 174
 175 private:
 176
 177         ///
 178         int workWidth_;
 179         ///
 180         int workHeight_;
 181
 182         /// our painter
 183         QLPainter painter_;
 184
 185         /// The slot connected to SyntheticMouseEvent::timeout.
 186         void generateSyntheticMouseEvent();
 187
 188         SyntheticMouseEvent synthetic_mouse_event_;
 189
 190         /// the double buffered pixmap
 191         boost::scoped_ptr<QPixmap> pixmap_;
 192
 193         QTimer step_timer_;
 194         std::queue<boost::shared_ptr<QKeyEvent> > keyeventQueue_;
 195
 196         double_click dc_event_;
 197
 198         bool scrolled_with_mouse_;
 199         bool scrolled_with_keyboard_;
 200 };
 201
 202 #endif // QWORKAREA_H