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 "DocIterator.h"
  19 #include "FuncRequest.h"
  20 #include "qt_helpers.h"
  21 #include "support/docstring.h"
  22 #include "support/Timeout.h"
  23
  24 #include <QAbstractScrollArea>
  25 #include <QMouseEvent>
  26 #include <QPixmap>
  27 #include <QResizeEvent>
  28 #include <QTabBar>
  29 #include <QTabWidget>
  30 #include <QTimer>
  31
  32 class QContextMenuEvent;
  33 class QDragEnterEvent;
  34 class QDropEvent;
  35 class QKeyEvent;
  36 class QWheelEvent;
  37 class QPaintEvent;
  38 class QWidget;
  39
  40 #ifdef CursorShape
  41 #undef CursorShape
  42 #endif
  43
  44 namespace lyx {
  45
  46 class Buffer;
  47
  48 namespace frontend {
  49
  50 class GuiCompleter;
  51 class GuiView;
  52 class GuiWorkArea;
  53
  54 /// for emulating triple click
  55 class DoubleClick {
  56 public:
  57         ///
  58         DoubleClick() : state(Qt::NoButton), active(false) {}
  59         ///
  60         DoubleClick(QMouseEvent * e) : state(e->button()), active(true) {}
  61         ///
  62         bool operator==(QMouseEvent const & e) { return state == e.button(); }
  63         ///
  64 public:
  65         ///
  66         Qt::MouseButton state;
  67         ///
  68         bool active;
  69 };
  70
  71 /** Qt only emits mouse events when the mouse is being moved, but
  72  *  we want to generate 'pseudo' mouse events when the mouse button is
  73  *  pressed and the mouse cursor is below the bottom, or above the top
  74  *  of the work area. In this way, we'll be able to continue scrolling
  75  *  (and selecting) the text.
  76  *
  77  *  This class stores all the parameters needed to make this happen.
  78  */
  79 class SyntheticMouseEvent
  80 {
  81 public:
  82         SyntheticMouseEvent();
  83
  84         FuncRequest cmd;
  85         Timeout timeout;
  86         bool restart_timeout;
  87         int x_old;
  88         int y_old;
  89         double scrollbar_value_old;
  90 };
  91
  92
  93 /**
  94  * Implementation of the work area (buffer view GUI)
  95 */
  96 class CursorWidget;
  97
  98 class GuiWorkArea : public QAbstractScrollArea, public WorkArea
  99 {
 100         Q_OBJECT
 101
 102 public:
 103         ///
 104         GuiWorkArea(Buffer & buffer, GuiView & lv);
 105         ///
 106         ~GuiWorkArea();
 107
 108         ///
 109         void setFullScreen(bool full_screen);
 110         /// is LyXView in fullscreen mode?
 111         bool isFullScreen();
 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         ///
 131         GuiCompleter & completer() { return *completer_; }
 132
 133 Q_SIGNALS:
 134         ///
 135         void titleChanged(GuiWorkArea *);
 136
 137 private Q_SLOTS:
 138         /// Scroll the BufferView.
 139         /**
 140           * This is a slot for the valueChanged() signal of the vertical scrollbar.
 141           * \p value value of the scrollbar.
 142         */
 143         void scrollTo(int value);
 144         /// timer to limit triple clicks
 145         void doubleClickTimeout();
 146         /// toggle the cursor's visibility
 147         void toggleCursor();
 148         /// close this work area.
 149         /// Slot for Buffer::closing signal.
 150         void close();
 151         /// Slot to restore proper scrollbar behaviour.
 152         void fixVerticalScrollBar();
 153
 154 private:
 155         friend class GuiCompleter;
 156
 157         /// update the passed area.
 158         void update(int x, int y, int w, int h);
 159         ///
 160         void updateScreen();
 161
 162         /// paint the cursor and store the background
 163         virtual void showCursor(int x, int y, int h,
 164                 bool l_shape, bool rtl, bool completable);
 165
 166         /// hide the cursor
 167         virtual void removeCursor();
 168
 169         /// This function is called when the buffer readonly status change.
 170         void setReadOnly(bool);
 171
 172         /// Update window titles of all users.
 173         void updateWindowTitle();
 174         ///
 175         bool event(QEvent *);
 176         ///
 177         void contextMenuEvent(QContextMenuEvent *);
 178         ///
 179         void focusInEvent(QFocusEvent *);
 180         ///
 181         void focusOutEvent(QFocusEvent *);
 182         /// repaint part of the widget
 183         void paintEvent(QPaintEvent * ev);
 184         /// widget has been resized
 185         void resizeEvent(QResizeEvent * ev);
 186         /// mouse button press
 187         void mousePressEvent(QMouseEvent * ev);
 188         /// mouse button release
 189         void mouseReleaseEvent(QMouseEvent * ev);
 190         /// mouse double click of button
 191         void mouseDoubleClickEvent(QMouseEvent * ev);
 192         /// mouse motion
 193         void mouseMoveEvent(QMouseEvent * ev);
 194         /// wheel event
 195         void wheelEvent(QWheelEvent * ev);
 196         /// key press
 197         void keyPressEvent(QKeyEvent * ev);
 198         /// IM events
 199         void inputMethodEvent(QInputMethodEvent * ev);
 200         /// IM query
 201         QVariant inputMethodQuery(Qt::InputMethodQuery query) const;
 202
 203         /// The slot connected to SyntheticMouseEvent::timeout.
 204         void generateSyntheticMouseEvent();
 205         ///
 206         void dispatch(FuncRequest const & cmd0, KeyModifier = NoModifier);
 207         /// hide the visible cursor, if it is visible
 208         void hideCursor();
 209         /// show the cursor if it is not visible
 210         void showCursor();
 211         ///
 212         void updateScrollbar();
 213
 214         ///
 215         BufferView * buffer_view_;
 216         ///
 217         GuiView * lyx_view_;
 218         /// is the cursor currently displayed
 219         bool cursor_visible_;
 220
 221         ///
 222         QTimer cursor_timeout_;
 223         ///
 224         SyntheticMouseEvent synthetic_mouse_event_;
 225         ///
 226         DoubleClick dc_event_;
 227
 228         ///
 229         CursorWidget * cursor_;
 230         ///
 231         QPixmap screen_;
 232         ///
 233         bool need_resize_;
 234         ///
 235         bool schedule_redraw_;
 236         ///
 237         int preedit_lines_;
 238
 239         ///
 240         GuiCompleter * completer_;
 241 }; // GuiWorkArea
 242
 243
 244 /// A tabbed set of GuiWorkAreas.
 245 class TabWorkArea : public QTabWidget
 246 {
 247         Q_OBJECT
 248 public:
 249         TabWorkArea(QWidget * parent = 0);
 250
 251         ///
 252         void setFullScreen(bool full_screen);
 253         void showBar(bool show);
 254         void closeAll();
 255         bool setCurrentWorkArea(GuiWorkArea *);
 256         GuiWorkArea * addWorkArea(Buffer & buffer, GuiView & view);
 257         bool removeWorkArea(GuiWorkArea *);
 258         GuiWorkArea * currentWorkArea();
 259         GuiWorkArea * workArea(Buffer & buffer);
 260
 261 Q_SIGNALS:
 262         ///
 263         void currentWorkAreaChanged(GuiWorkArea *);
 264         ///
 265         void lastWorkAreaRemoved();
 266
 267 public Q_SLOTS:
 268         /// close current buffer, or the one given by \c clicked_tab_
 269         void closeCurrentBuffer();
 270         /// close current tab, or the one given by \c clicked_tab_
 271         void closeCurrentTab();
 272         ///
 273         void updateTabTexts();
 274
 275 private Q_SLOTS:
 276         ///
 277         void on_currentTabChanged(int index);
 278         ///
 279         void showContextMenu(const QPoint & pos);
 280         ///
 281         void moveTab(int fromIndex, int toIndex);
 282
 283 private:
 284         int clicked_tab_;
 285 }; // TabWorkArea
 286
 287
 288 class DragTabBar : public QTabBar
 289 {
 290         Q_OBJECT
 291 public:
 292         ///
 293         DragTabBar(QWidget * parent = 0);
 294
 295 #if QT_VERSION < 0x040300
 296         ///
 297         int tabAt(QPoint const & position) const;
 298 #endif
 299
 300 protected:
 301         ///
 302         void mousePressEvent(QMouseEvent * event);
 303         ///
 304         void mouseMoveEvent(QMouseEvent * event);
 305         ///
 306         void dragEnterEvent(QDragEnterEvent * event);
 307         ///
 308         void dropEvent(QDropEvent * event);
 309
 310 private:
 311         ///
 312         QPoint dragStartPos_;
 313         ///
 314         int dragCurrentIndex_;
 315
 316 Q_SIGNALS:
 317         ///
 318         void tabMoveRequested(int fromIndex, int toIndex);
 319 };
 320
 321 } // namespace frontend
 322 } // namespace lyx
 323
 324 #endif // WORKAREA_H