src/frontends/qt/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
  17 #include "support/FileName.h"
  18 #include "support/Timeout.h"
  19
  20 #include <QMouseEvent>
  21 #include <QTimer>
  22
  23 namespace lyx {
  24
  25 namespace frontend {
  26
  27 class GuiCompleter;
  28 class GuiPainter;
  29 class GuiView;
  30 class GuiWorkArea;
  31
  32 /// for emulating triple click
  33 class DoubleClick {
  34 public:
  35         ///
  36         DoubleClick() : state(Qt::NoButton), active(false) {}
  37         ///
  38         DoubleClick(QMouseEvent * e) : state(e->button()), active(true) {}
  39         ///
  40         bool operator==(QMouseEvent const & e) { return state == e.button(); }
  41         ///
  42 public:
  43         ///
  44         Qt::MouseButton state;
  45         ///
  46         bool active;
  47 };
  48
  49 /** Qt only emits mouse events when the mouse is being moved, but
  50  *  we want to generate 'pseudo' mouse events when the mouse button is
  51  *  pressed and the mouse cursor is below the bottom, or above the top
  52  *  of the work area. In this way, we'll be able to continue scrolling
  53  *  (and selecting) the text.
  54  *
  55  *  This class stores all the parameters needed to make this happen.
  56  */
  57 class SyntheticMouseEvent
  58 {
  59 public:
  60         SyntheticMouseEvent();
  61
  62         FuncRequest cmd;
  63         Timeout timeout;
  64         bool restart_timeout;
  65 };
  66
  67
  68 /**
  69  * Implementation of the work area (buffer view GUI)
  70 */
  71
  72 struct GuiWorkArea::Private
  73 {
  74         ///
  75         Private(GuiWorkArea *);
  76
  77         ///
  78         ~Private();
  79
  80         ///
  81         void resizeBufferView();
  82
  83         ///
  84         void dispatch(FuncRequest const & cmd0);
  85         /// Make caret visible and signal that its geometry needs to be updated
  86         void resetCaret();
  87         /// recompute the shape and position of the caret
  88         void updateCaretGeometry();
  89         /// show the caret if it is not visible
  90         void showCaret();
  91         /// hide the caret if it is visible
  92         void hideCaret();
  93         /* Draw the caret. Parameter \c horiz_offset is not 0 when there
  94          * has been horizontal scrolling in current row
  95          */
  96         void drawCaret(QPainter & painter, int horiz_offset) const;
  97         /// Set the range and value of the scrollbar and connect to its valueChanged
  98         /// signal.
  99         void updateScrollbar();
 100         /// Change the cursor when the mouse hovers over a clickable inset
 101         void updateCursorShape();
 102
 103         void paintPreeditText(GuiPainter & pain);
 104
 105         /// Prepare screen for next painting
 106         void resetScreen();
 107         /// Where painting takes place
 108         QPaintDevice * screenDevice();
 109         /// Put backingstore to screen if necessary
 110         void updateScreen(QRectF const & rc);
 111
 112         ///
 113         GuiWorkArea * p = nullptr;
 114         ///
 115         BufferView * buffer_view_ = nullptr;
 116         ///
 117         GuiView * lyx_view_ = nullptr;
 118
 119         /// Do we need an intermediate image when painting (for now macOS and Wayland)
 120         bool use_backingstore_ = false;
 121         ///
 122         QImage screen_;
 123
 124         /// is the caret currently displayed
 125         bool caret_visible_ = false;
 126         ///
 127         bool needs_caret_geometry_update_ = true;
 128         ///
 129         QTimer caret_timeout_;
 130
 131         ///
 132         SyntheticMouseEvent synthetic_mouse_event_;
 133         ///
 134         DoubleClick dc_event_;
 135
 136         ///
 137         bool need_resize_ = false;
 138
 139         /// the current preedit text of the input method
 140         docstring preedit_string_;
 141         /// Number of lines used by preedit text
 142         int preedit_lines_ = 1;
 143         /// the attributes of the preedit text
 144         QList<QInputMethodEvent::Attribute> preedit_attr_;
 145
 146         /// Ratio between physical pixels and device-independent pixels
 147         /// We save the last used value to detect changes of the
 148         /// current pixel_ratio of the viewport.
 149         double last_pixel_ratio_ = 1.0;
 150         ///
 151         GuiCompleter * completer_;
 152
 153         /// Special mode in which Esc and Enter (with or without Shift)
 154         /// are ignored
 155         bool dialog_mode_ = false;
 156         /// store the name of the context menu when the mouse is
 157         /// pressed. This is used to get the correct context menu
 158         /// when the menu is actually shown (after releasing on Windows)
 159         /// and after the DEPM has done its job.
 160         std::string context_menu_name_;
 161
 162         /// stuff related to window title
 163         ///
 164         support::FileName file_name_;
 165         ///
 166         bool shell_escape_ = false;
 167         ///
 168         bool read_only_ = false;
 169         ///
 170         docstring vc_status_;
 171         ///
 172         bool clean_ = true;
 173         ///
 174         bool externally_modified_ = false;
 175
 176 }; // GuiWorkArea
 177
 178 } // namespace frontend
 179 } // namespace lyx
 180
 181 #endif // WORKAREA_H