src/frontends/qt4/GuiWorkArea_Private.h

   1 // -*- C++ -*-
   2 /**
   3  * \file GuiWorkArea_Private.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Abdelrazak Younes
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef WORKAREA_PRIVATE_H
  13 #define WORKAREA_PRIVATE_H
  14
  15 #include "FuncRequest.h"
  16 #include "LyXRC.h"
  17
  18 #include "support/FileName.h"
  19 #include "support/Timeout.h"
  20
  21 #include <QMouseEvent>
  22 #include <QImage>
  23 #include <QPixmap>
  24 #include <QTimer>
  25
  26 class QContextMenuEvent;
  27 class QDragEnterEvent;
  28 class QDropEvent;
  29 class QKeyEvent;
  30 class QPaintEvent;
  31 class QResizeEvent;
  32 class QToolButton;
  33 class QWheelEvent;
  34 class QWidget;
  35
  36 #ifdef CursorShape
  37 #undef CursorShape
  38 #endif
  39
  40 namespace lyx {
  41
  42 class Buffer;
  43
  44 namespace frontend {
  45
  46 class GuiCompleter;
  47 class GuiView;
  48 class GuiWorkArea;
  49
  50 /// for emulating triple click
  51 class DoubleClick {
  52 public:
  53         ///
  54         DoubleClick() : state(Qt::NoButton), active(false) {}
  55         ///
  56         DoubleClick(QMouseEvent * e) : state(e->button()), active(true) {}
  57         ///
  58         bool operator==(QMouseEvent const & e) { return state == e.button(); }
  59         ///
  60 public:
  61         ///
  62         Qt::MouseButton state;
  63         ///
  64         bool active;
  65 };
  66
  67 /** Qt only emits mouse events when the mouse is being moved, but
  68  *  we want to generate 'pseudo' mouse events when the mouse button is
  69  *  pressed and the mouse cursor is below the bottom, or above the top
  70  *  of the work area. In this way, we'll be able to continue scrolling
  71  *  (and selecting) the text.
  72  *
  73  *  This class stores all the parameters needed to make this happen.
  74  */
  75 class SyntheticMouseEvent
  76 {
  77 public:
  78         SyntheticMouseEvent();
  79
  80         FuncRequest cmd;
  81         Timeout timeout;
  82         bool restart_timeout;
  83 };
  84
  85
  86 /**
  87  * Implementation of the work area (buffer view GUI)
  88 */
  89 class CursorWidget;
  90
  91 struct GuiWorkArea::Private
  92 {
  93         Private(GuiWorkArea *);
  94
  95         /// update the passed area.
  96         void update(int x, int y, int w, int h);
  97         ///
  98         void updateScreen();
  99         ///
 100         void resizeBufferView();
 101
 102         /// paint the cursor and store the background
 103         void showCursor(int x, int y, int h,
 104                 bool l_shape, bool rtl, bool completable);
 105
 106         /// hide the cursor
 107         void removeCursor();
 108         ///
 109         void dispatch(FuncRequest const & cmd0);
 110         /// hide the visible cursor, if it is visible
 111         void hideCursor();
 112         /// show the cursor if it is not visible
 113         void showCursor();
 114         /// Set the range and value of the scrollbar and connect to its valueChanged
 115         /// signal.
 116         void updateScrollbar();
 117         /// Change the cursor when the mouse hovers over a clickable inset
 118         void updateCursorShape();
 119         ///
 120         void setCursorShape(Qt::CursorShape shape);
 121
 122         bool needResize() const {
 123                 return need_resize_ || p->pixelRatio() != pixel_ratio_;
 124         }
 125
 126         void resetScreen()
 127         {
 128                 delete screen_;
 129                 pixel_ratio_ = p->pixelRatio();
 130                 if (lyxrc.use_qimage) {
 131                         QImage *x =
 132                                 new QImage(static_cast<int>(pixel_ratio_ * p->viewport()->width()),
 133                                                    static_cast<int>(pixel_ratio_ * p->viewport()->height()),
 134                                                    QImage::Format_ARGB32_Premultiplied);
 135 #if QT_VERSION >= 0x050000
 136                         x->setDevicePixelRatio(pixel_ratio_);
 137 #endif
 138                         screen_ = x;
 139                 } else {
 140                         QPixmap *x =
 141                                 new QPixmap(static_cast<int>(pixel_ratio_ * p->viewport()->width()),
 142                                                         static_cast<int>(pixel_ratio_ * p->viewport()->height()));
 143 #if QT_VERSION >= 0x050000
 144                         x->setDevicePixelRatio(pixel_ratio_);
 145 #endif
 146                         screen_ = x;
 147                 }
 148         }
 149         ///
 150         GuiWorkArea * p;
 151         ///
 152         QPaintDevice * screen_;
 153         ///
 154         BufferView * buffer_view_;
 155         ///
 156         GuiView * lyx_view_;
 157         /// is the cursor currently displayed
 158         bool cursor_visible_;
 159
 160         ///
 161         QTimer cursor_timeout_;
 162         ///
 163         SyntheticMouseEvent synthetic_mouse_event_;
 164         ///
 165         DoubleClick dc_event_;
 166
 167         ///
 168         CursorWidget * cursor_;
 169         ///
 170         bool need_resize_;
 171         ///
 172         bool schedule_redraw_;
 173         ///
 174         int preedit_lines_;
 175         /// Ratio between physical pixels and device-independent pixels
 176         /// We save the last used value to detect changes of the
 177         /// current pixel_ratio of the viewport.
 178         double pixel_ratio_;
 179         ///
 180         GuiCompleter * completer_;
 181
 182         /// Special mode in which Esc and Enter (with or without Shift)
 183         /// are ignored
 184         bool dialog_mode_;
 185         /// store the name of the context menu when the mouse is
 186         /// pressed. This is used to get the correct context menu
 187         /// when the menu is actually shown (after releasing on Windows)
 188         /// and after the DEPM has done its job.
 189         std::string context_menu_name_;
 190
 191         /// stuff related to window title
 192         ///
 193         support::FileName file_name_;
 194         ///
 195         bool shell_escape_;
 196         ///
 197         bool read_only_;
 198         ///
 199         docstring vc_status_;
 200         ///
 201         bool clean_;
 202         ///
 203         bool externally_modified_;
 204
 205 }; // GuiWorkArea
 206
 207 } // namespace frontend
 208 } // namespace lyx
 209
 210 #endif // WORKAREA_H