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