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 "support/Timeout.h"
  20
  21 #include <QAbstractScrollArea>
  22 #include <QMouseEvent>
  23 #include <QPixmap>
  24 #include <QResizeEvent>
  25 #include <QTabWidget>
  26 #include <QTimer>
  27
  28 class QContextMenuEvent;
  29 class QDragEnterEvent;
  30 class QDropEvent;
  31 class QKeyEvent;
  32 class QWheelEvent;
  33 class QPaintEvent;
  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 GuiView;
  47
  48 /// types of cursor in work area
  49 enum CursorShape {
  50         /// normal I-beam
  51         BAR_SHAPE,
  52         /// L-shape for locked insets of a different language
  53         L_SHAPE,
  54         /// reverse L-shape for RTL text
  55         REVERSED_L_SHAPE
  56 };
  57
  58 /// for emulating triple click
  59 class DoubleClick {
  60 public:
  61         ///
  62         DoubleClick() : state(Qt::NoButton), active(false) {}
  63         ///
  64         DoubleClick(QMouseEvent * e) : state(e->button()), active(true) {}
  65         ///
  66         bool operator==(QMouseEvent const & e) { return state == e.button(); }
  67         ///
  68 public:
  69         ///
  70         Qt::MouseButton state;
  71         ///
  72         bool active;
  73 };
  74
  75 /** Qt only emits mouse events when the mouse is being moved, but
  76  *  we want to generate 'pseudo' mouse events when the mouse button is
  77  *  pressed and the mouse cursor is below the bottom, or above the top
  78  *  of the work area. In this way, we'll be able to continue scrolling
  79  *  (and selecting) the text.
  80  *
  81  *  This class stores all the parameters needed to make this happen.
  82  */
  83 class SyntheticMouseEvent
  84 {
  85 public:
  86         SyntheticMouseEvent();
  87
  88         FuncRequest cmd;
  89         Timeout timeout;
  90         bool restart_timeout;
  91         int x_old;
  92         int y_old;
  93         double scrollbar_value_old;
  94 };
  95
  96
  97 /**
  98  * Implementation of the work area (buffer view GUI)
  99 */
 100 class CursorWidget;
 101
 102 class GuiWorkArea : public QAbstractScrollArea, public WorkArea
 103 {
 104         Q_OBJECT
 105
 106 public:
 107         ///
 108         GuiWorkArea(Buffer & buffer, GuiView & lv);
 109         ///
 110         ~GuiWorkArea();
 111
 112         ///
 113         void scheduleRedraw() { schedule_redraw_ = true; }
 114         ///
 115         BufferView & bufferView();
 116         ///
 117         BufferView const & bufferView() const;
 118         ///
 119         void redraw();
 120         ///
 121         void stopBlinkingCursor();
 122         ///
 123         void startBlinkingCursor();
 124         /// Process Key pressed event.
 125         /// This needs to be public because it is accessed externally by GuiView.
 126         void processKeySym(KeySymbol const & key, KeyModifier mod);
 127         ///
 128         void resizeBufferView();
 129
 130 Q_SIGNALS:
 131         ///
 132         void titleChanged(GuiWorkArea *);
 133
 134 private Q_SLOTS:
 135         /// Scroll the BufferView.
 136         /**
 137           * This is a slot for the valueChanged() signal of the vertical scrollbar.
 138           * \p value value of the scrollbar.
 139         */
 140         void scrollTo(int value);
 141         /// timer to limit triple clicks
 142         void doubleClickTimeout();
 143         /// toggle the cursor's visibility
 144         void toggleCursor();
 145         /// close this work area.
 146         /// Slot for Buffer::closing signal.
 147         void close();
 148
 149 private:
 150         /// update the passed area.
 151         void update(int x, int y, int w, int h);
 152         ///
 153         void updateScreen();
 154
 155         /// paint the cursor and store the background
 156         virtual void showCursor(int x, int y, int h, CursorShape shape);
 157
 158         /// hide the cursor
 159         virtual void removeCursor();
 160
 161         /// This function is called when the buffer readonly status change.
 162         void setReadOnly(bool);
 163
 164         /// Update window titles of all users.
 165         void updateWindowTitle();
 166         ///
 167         bool event(QEvent *);
 168         ///
 169         void contextMenuEvent(QContextMenuEvent *);
 170         ///
 171         void focusInEvent(QFocusEvent *);
 172         ///
 173         void focusOutEvent(QFocusEvent *);
 174         /// repaint part of the widget
 175         void paintEvent(QPaintEvent * ev);
 176         /// widget has been resized
 177         void resizeEvent(QResizeEvent * ev);
 178         /// mouse button press
 179         void mousePressEvent(QMouseEvent * ev);
 180         /// mouse button release
 181         void mouseReleaseEvent(QMouseEvent * ev);
 182         /// mouse double click of button
 183         void mouseDoubleClickEvent(QMouseEvent * ev);
 184         /// mouse motion
 185         void mouseMoveEvent(QMouseEvent * ev);
 186         /// wheel event
 187         void wheelEvent(QWheelEvent * ev);
 188         /// key press
 189         void keyPressEvent(QKeyEvent * ev);
 190         /// IM events
 191         void inputMethodEvent(QInputMethodEvent * ev);
 192         /// IM query
 193         QVariant inputMethodQuery(Qt::InputMethodQuery query) const;
 194
 195         /// The slot connected to SyntheticMouseEvent::timeout.
 196         void generateSyntheticMouseEvent();
 197         ///
 198         void dispatch(FuncRequest const & cmd0, KeyModifier = NoModifier);
 199         /// hide the visible cursor, if it is visible
 200         void hideCursor();
 201         /// show the cursor if it is not visible
 202         void showCursor();
 203         ///
 204         void updateScrollbar();
 205
 206         ///
 207         BufferView * buffer_view_;
 208         ///
 209         GuiView * lyx_view_;
 210         /// is the cursor currently displayed
 211         bool cursor_visible_;
 212
 213         ///
 214         QTimer cursor_timeout_;
 215         ///
 216         SyntheticMouseEvent synthetic_mouse_event_;
 217         ///
 218         DoubleClick dc_event_;
 219
 220         ///
 221         CursorWidget * cursor_;
 222         ///
 223         QPixmap screen_;
 224         ///
 225         bool need_resize_;
 226         ///
 227         bool schedule_redraw_;
 228         ///
 229         int preedit_lines_;
 230 }; // GuiWorkArea
 231
 232
 233 /// A tabbed set of GuiWorkAreas.
 234 class TabWorkArea : public QTabWidget
 235 {
 236         Q_OBJECT
 237 public:
 238         TabWorkArea(QWidget * parent = 0);
 239
 240         void showBar(bool show);
 241         void closeAll();
 242         bool setCurrentWorkArea(GuiWorkArea *);
 243         GuiWorkArea * addWorkArea(Buffer & buffer, GuiView & view);
 244         bool removeWorkArea(GuiWorkArea *);
 245         GuiWorkArea * currentWorkArea();
 246         GuiWorkArea * workArea(Buffer & buffer);
 247
 248 Q_SIGNALS:
 249         ///
 250         void currentWorkAreaChanged(GuiWorkArea *);
 251
 252 public Q_SLOTS:
 253         ///
 254         void on_currentTabChanged(int index);
 255         ///
 256         void closeCurrentTab();
 257         ///
 258         void updateTabText(GuiWorkArea *);
 259 }; // TabWorkArea
 260
 261 } // namespace frontend
 262 } // namespace lyx
 263
 264 #endif // WORKAREA_H