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         /// events to be triggered by general_timer_ should go here
 146         void handleRegularEvents();
 147         /// close this work area.
 148         /// Slot for Buffer::closing signal.
 149         void close();
 150
 151 private:
 152         /// update the passed area.
 153         void update(int x, int y, int w, int h);
 154         ///
 155         void updateScreen();
 156
 157         /// paint the cursor and store the background
 158         virtual void showCursor(int x, int y, int h, CursorShape shape);
 159
 160         /// hide the cursor
 161         virtual void removeCursor();
 162
 163         /// This function is called when the buffer readonly status change.
 164         void setReadOnly(bool);
 165
 166         /// Update window titles of all users.
 167         void updateWindowTitle();
 168         ///
 169         bool event(QEvent *);
 170         ///
 171         void contextMenuEvent(QContextMenuEvent *);
 172         ///
 173         void focusInEvent(QFocusEvent *);
 174         ///
 175         void focusOutEvent(QFocusEvent *);
 176         /// repaint part of the widget
 177         void paintEvent(QPaintEvent * ev);
 178         /// widget has been resized
 179         void resizeEvent(QResizeEvent * ev);
 180         /// mouse button press
 181         void mousePressEvent(QMouseEvent * ev);
 182         /// mouse button release
 183         void mouseReleaseEvent(QMouseEvent * ev);
 184         /// mouse double click of button
 185         void mouseDoubleClickEvent(QMouseEvent * ev);
 186         /// mouse motion
 187         void mouseMoveEvent(QMouseEvent * ev);
 188         /// wheel event
 189         void wheelEvent(QWheelEvent * ev);
 190         /// key press
 191         void keyPressEvent(QKeyEvent * ev);
 192         /// IM events
 193         void inputMethodEvent(QInputMethodEvent * ev);
 194         /// IM query
 195         QVariant inputMethodQuery(Qt::InputMethodQuery query) const;
 196
 197         /// The slot connected to SyntheticMouseEvent::timeout.
 198         void generateSyntheticMouseEvent();
 199         ///
 200         void dispatch(FuncRequest const & cmd0, KeyModifier = NoModifier);
 201         /// hide the visible cursor, if it is visible
 202         void hideCursor();
 203         /// show the cursor if it is not visible
 204         void showCursor();
 205         ///
 206         void updateScrollbar();
 207
 208         ///
 209         BufferView * buffer_view_;
 210         ///
 211         GuiView * lyx_view_;
 212         /// is the cursor currently displayed
 213         bool cursor_visible_;
 214
 215         ///
 216         QTimer cursor_timeout_;
 217         /// this timer is used for any regular events one wants to
 218         /// perform. at present it is used to check if forked processes
 219         /// are done.
 220         QTimer general_timer_;
 221         ///
 222         SyntheticMouseEvent synthetic_mouse_event_;
 223         ///
 224         DoubleClick dc_event_;
 225
 226         ///
 227         CursorWidget * cursor_;
 228         ///
 229         QPixmap screen_;
 230         ///
 231         bool need_resize_;
 232         ///
 233         bool schedule_redraw_;
 234         ///
 235         int preedit_lines_;
 236 }; // GuiWorkArea
 237
 238
 239 /// A tabbed set of GuiWorkAreas.
 240 class TabWorkArea : public QTabWidget
 241 {
 242         Q_OBJECT
 243 public:
 244         TabWorkArea(QWidget * parent = 0);
 245
 246         void showBar(bool show);
 247         void closeAll();
 248         bool setCurrentWorkArea(GuiWorkArea *);
 249         GuiWorkArea * addWorkArea(Buffer & buffer, GuiView & view);
 250         bool removeWorkArea(GuiWorkArea *);
 251         GuiWorkArea * currentWorkArea();
 252         GuiWorkArea * workArea(Buffer & buffer);
 253
 254 Q_SIGNALS:
 255         ///
 256         void currentWorkAreaChanged(GuiWorkArea *);
 257
 258 public Q_SLOTS:
 259         ///
 260         void on_currentTabChanged(int index);
 261         ///
 262         void closeCurrentTab();
 263         ///
 264         void updateTabText(GuiWorkArea *);
 265 }; // TabWorkArea
 266
 267 } // namespace frontend
 268 } // namespace lyx
 269
 270 #endif // WORKAREA_H