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(QWidget *);
 105         ///
 106         GuiWorkArea(Buffer & buffer, GuiView & gv);
 107         ///
 108         ~GuiWorkArea();
 109
 110         ///
 111         void setBuffer(Buffer &);
 112         ///
 113         void setGuiView(GuiView &);
 114         /// Dummy methods for Designer.
 115         void setWidgetResizable(bool) {}
 116         void setWidget(QWidget *) {}
 117         ///
 118         void setFullScreen(bool full_screen);
 119         /// is LyXView in fullscreen mode?
 120         bool isFullScreen();
 121         ///
 122         void scheduleRedraw() { schedule_redraw_ = true; }
 123         ///
 124         BufferView & bufferView();
 125         ///
 126         BufferView const & bufferView() const;
 127         ///
 128         void redraw();
 129         ///
 130         void stopBlinkingCursor();
 131         ///
 132         void startBlinkingCursor();
 133         /// Process Key pressed event.
 134         /// This needs to be public because it is accessed externally by GuiView.
 135         void processKeySym(KeySymbol const & key, KeyModifier mod);
 136         ///
 137         void resizeBufferView();
 138
 139         bool isInDialog() {
 140                 return dialogMode_;
 141         }
 142
 143         ///
 144         GuiCompleter & completer() { return *completer_; }
 145
 146         /// Return true if dialogMode is set
 147         bool& dialogMode() { return dialogMode_; }
 148
 149         /// Return the GuiView this workArea belongs to
 150         GuiView const & view() const { return *lyx_view_; }
 151         GuiView & view() { return *lyx_view_; }
 152
 153 Q_SIGNALS:
 154         ///
 155         void titleChanged(GuiWorkArea *);
 156
 157 private Q_SLOTS:
 158         /// Scroll the BufferView.
 159         /**
 160           * This is a slot for the valueChanged() signal of the vertical scrollbar.
 161           * \p value value of the scrollbar.
 162         */
 163         void scrollTo(int value);
 164         /// timer to limit triple clicks
 165         void doubleClickTimeout();
 166         /// toggle the cursor's visibility
 167         void toggleCursor();
 168         /// close this work area.
 169         /// Slot for Buffer::closing signal.
 170         void close();
 171         /// Slot to restore proper scrollbar behaviour.
 172         void fixVerticalScrollBar();
 173
 174 private:
 175         friend class GuiCompleter;
 176         ///
 177         void init();
 178
 179         /// update the passed area.
 180         void update(int x, int y, int w, int h);
 181         ///
 182         void updateScreen();
 183
 184         /// paint the cursor and store the background
 185         virtual void showCursor(int x, int y, int h,
 186                 bool l_shape, bool rtl, bool completable);
 187
 188         /// hide the cursor
 189         virtual void removeCursor();
 190
 191         /// This function is called when the buffer readonly status change.
 192         void setReadOnly(bool);
 193
 194         /// Update window titles of all users.
 195         void updateWindowTitle();
 196         ///
 197         bool event(QEvent *);
 198         ///
 199         void contextMenuEvent(QContextMenuEvent *);
 200         ///
 201         void focusInEvent(QFocusEvent *);
 202         ///
 203         void focusOutEvent(QFocusEvent *);
 204         /// repaint part of the widget
 205         void paintEvent(QPaintEvent * ev);
 206         /// widget has been resized
 207         void resizeEvent(QResizeEvent * ev);
 208         /// mouse button press
 209         void mousePressEvent(QMouseEvent * ev);
 210         /// mouse button release
 211         void mouseReleaseEvent(QMouseEvent * ev);
 212         /// mouse double click of button
 213         void mouseDoubleClickEvent(QMouseEvent * ev);
 214         /// mouse motion
 215         void mouseMoveEvent(QMouseEvent * ev);
 216         /// wheel event
 217         void wheelEvent(QWheelEvent * ev);
 218         /// key press
 219         void keyPressEvent(QKeyEvent * ev);
 220         /// IM events
 221         void inputMethodEvent(QInputMethodEvent * ev);
 222         /// IM query
 223         QVariant inputMethodQuery(Qt::InputMethodQuery query) const;
 224
 225         /// The slot connected to SyntheticMouseEvent::timeout.
 226         void generateSyntheticMouseEvent();
 227         ///
 228         void dispatch(FuncRequest const & cmd0, KeyModifier = NoModifier);
 229         /// hide the visible cursor, if it is visible
 230         void hideCursor();
 231         /// show the cursor if it is not visible
 232         void showCursor();
 233         ///
 234         void updateScrollbar();
 235
 236         ///
 237         BufferView * buffer_view_;
 238         ///
 239         GuiView * lyx_view_;
 240         /// is the cursor currently displayed
 241         bool cursor_visible_;
 242
 243         ///
 244         QTimer cursor_timeout_;
 245         ///
 246         SyntheticMouseEvent synthetic_mouse_event_;
 247         ///
 248         DoubleClick dc_event_;
 249
 250         ///
 251         CursorWidget * cursor_;
 252         ///
 253         QPixmap screen_;
 254         ///
 255         bool need_resize_;
 256         ///
 257         bool schedule_redraw_;
 258         ///
 259         int preedit_lines_;
 260
 261         ///
 262         GuiCompleter * completer_;
 263
 264         /// Special mode in which Esc and Enter (with or without Shift)
 265         /// are ignored
 266         bool dialogMode_;
 267 }; // GuiWorkArea
 268
 269
 270 /// A tabbed set of GuiWorkAreas.
 271 class TabWorkArea : public QTabWidget
 272 {
 273         Q_OBJECT
 274 public:
 275         TabWorkArea(QWidget * parent = 0);
 276
 277         ///
 278         void setFullScreen(bool full_screen);
 279         void showBar(bool show);
 280         void closeAll();
 281         bool setCurrentWorkArea(GuiWorkArea *);
 282         GuiWorkArea * addWorkArea(Buffer & buffer, GuiView & view);
 283         bool removeWorkArea(GuiWorkArea *);
 284         GuiWorkArea * currentWorkArea();
 285         GuiWorkArea * workArea(Buffer & buffer);
 286
 287 Q_SIGNALS:
 288         ///
 289         void currentWorkAreaChanged(GuiWorkArea *);
 290         ///
 291         void lastWorkAreaRemoved();
 292
 293 public Q_SLOTS:
 294         /// close current buffer, or the one given by \c clicked_tab_
 295         void closeCurrentBuffer();
 296         /// close current tab, or the one given by \c clicked_tab_
 297         void closeCurrentTab();
 298         ///
 299         void updateTabTexts();
 300
 301 private Q_SLOTS:
 302         ///
 303         void on_currentTabChanged(int index);
 304         ///
 305         void showContextMenu(const QPoint & pos);
 306         ///
 307         void moveTab(int fromIndex, int toIndex);
 308
 309 private:
 310         int clicked_tab_;
 311 }; // TabWorkArea
 312
 313
 314 class DragTabBar : public QTabBar
 315 {
 316         Q_OBJECT
 317 public:
 318         ///
 319         DragTabBar(QWidget * parent = 0);
 320
 321 #if QT_VERSION < 0x040300
 322         ///
 323         int tabAt(QPoint const & position) const;
 324 #endif
 325
 326 protected:
 327         ///
 328         void mousePressEvent(QMouseEvent * event);
 329         ///
 330         void mouseMoveEvent(QMouseEvent * event);
 331         ///
 332         void dragEnterEvent(QDragEnterEvent * event);
 333         ///
 334         void dropEvent(QDropEvent * event);
 335
 336 private:
 337         ///
 338         QPoint dragStartPos_;
 339         ///
 340         int dragCurrentIndex_;
 341
 342 Q_SIGNALS:
 343         ///
 344         void tabMoveRequested(int fromIndex, int toIndex);
 345 };
 346
 347 } // namespace frontend
 348 } // namespace lyx
 349
 350 #endif // WORKAREA_H