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 QToolButton;
  39 class QWidget;
  40
  41 #ifdef CursorShape
  42 #undef CursorShape
  43 #endif
  44
  45 namespace lyx {
  46
  47 class Buffer;
  48
  49 namespace frontend {
  50
  51 class GuiCompleter;
  52 class GuiView;
  53 class GuiWorkArea;
  54
  55 /// for emulating triple click
  56 class DoubleClick {
  57 public:
  58         ///
  59         DoubleClick() : state(Qt::NoButton), active(false) {}
  60         ///
  61         DoubleClick(QMouseEvent * e) : state(e->button()), active(true) {}
  62         ///
  63         bool operator==(QMouseEvent const & e) { return state == e.button(); }
  64         ///
  65 public:
  66         ///
  67         Qt::MouseButton state;
  68         ///
  69         bool active;
  70 };
  71
  72 /** Qt only emits mouse events when the mouse is being moved, but
  73  *  we want to generate 'pseudo' mouse events when the mouse button is
  74  *  pressed and the mouse cursor is below the bottom, or above the top
  75  *  of the work area. In this way, we'll be able to continue scrolling
  76  *  (and selecting) the text.
  77  *
  78  *  This class stores all the parameters needed to make this happen.
  79  */
  80 class SyntheticMouseEvent
  81 {
  82 public:
  83         SyntheticMouseEvent();
  84
  85         FuncRequest cmd;
  86         Timeout timeout;
  87         bool restart_timeout;
  88 };
  89
  90
  91 /**
  92  * Implementation of the work area (buffer view GUI)
  93 */
  94 class CursorWidget;
  95
  96 class GuiWorkArea : public QAbstractScrollArea, public WorkArea
  97 {
  98         Q_OBJECT
  99
 100 public:
 101         ///
 102         GuiWorkArea(QWidget *);
 103         ///
 104         GuiWorkArea(Buffer & buffer, GuiView & gv);
 105         ///
 106         ~GuiWorkArea();
 107
 108         ///
 109         void init();
 110         ///
 111         void setBuffer(Buffer &);
 112         ///
 113         void setGuiView(GuiView &);
 114         ///
 115         void setFullScreen(bool full_screen);
 116         /// is GuiView in fullscreen mode?
 117         bool isFullScreen();
 118         ///
 119         void scheduleRedraw() { schedule_redraw_ = true; }
 120         ///
 121         BufferView & bufferView();
 122         ///
 123         BufferView const & bufferView() const;
 124         ///
 125         void redraw(bool update_metrics);
 126         ///
 127         void stopBlinkingCursor();
 128         ///
 129         void startBlinkingCursor();
 130         /// Process Key pressed event.
 131         /// This needs to be public because it is accessed externally by GuiView.
 132         void processKeySym(KeySymbol const & key, KeyModifier mod);
 133         ///
 134         void resizeBufferView();
 135
 136         bool inDialogMode() const { return dialog_mode_; }
 137         void setDialogMode(bool mode) { dialog_mode_ = mode; }
 138
 139         ///
 140         GuiCompleter & completer() { return *completer_; }
 141
 142         Qt::CursorShape cursorShape() const;
 143         void setCursorShape(Qt::CursorShape shape);
 144
 145         /// Change the cursor when the mouse hovers over a clickable inset
 146         void updateCursorShape();
 147
 148         /// Return the GuiView this workArea belongs to
 149         GuiView const & view() const { return *lyx_view_; }
 150         GuiView & view() { return *lyx_view_; }
 151
 152 Q_SIGNALS:
 153         ///
 154         void titleChanged(GuiWorkArea *);
 155
 156 private Q_SLOTS:
 157         /// Scroll the BufferView.
 158         /**
 159           * This is a slot for the valueChanged() signal of the vertical scrollbar.
 160           * \p value value of the scrollbar.
 161         */
 162         void scrollTo(int value);
 163         /// timer to limit triple clicks
 164         void doubleClickTimeout();
 165         /// toggle the cursor's visibility
 166         void toggleCursor();
 167         /// close this work area.
 168         /// Slot for Buffer::closing signal.
 169         void close();
 170         /// Slot to restore proper scrollbar behaviour.
 171         void fixVerticalScrollBar();
 172
 173 private:
 174         friend class GuiCompleter;
 175
 176         /// update the passed area.
 177         void update(int x, int y, int w, int h);
 178         ///
 179         void updateScreen();
 180
 181         /// paint the cursor and store the background
 182         virtual void showCursor(int x, int y, int h,
 183                 bool l_shape, bool rtl, bool completable);
 184
 185         /// hide the cursor
 186         virtual void removeCursor();
 187
 188         /// This function should be called to update the buffer readonly status.
 189         void setReadOnly(bool);
 190
 191         /// Update window titles of all users.
 192         void updateWindowTitle();
 193         ///
 194         bool event(QEvent *);
 195         ///
 196         void contextMenuEvent(QContextMenuEvent *);
 197         ///
 198         void focusInEvent(QFocusEvent *);
 199         ///
 200         void focusOutEvent(QFocusEvent *);
 201         /// repaint part of the widget
 202         void paintEvent(QPaintEvent * ev);
 203         /// widget has been resized
 204         void resizeEvent(QResizeEvent * ev);
 205         /// mouse button press
 206         void mousePressEvent(QMouseEvent * ev);
 207         /// mouse button release
 208         void mouseReleaseEvent(QMouseEvent * ev);
 209         /// mouse double click of button
 210         void mouseDoubleClickEvent(QMouseEvent * ev);
 211         /// mouse motion
 212         void mouseMoveEvent(QMouseEvent * ev);
 213         /// wheel event
 214         void wheelEvent(QWheelEvent * ev);
 215         /// key press
 216         void keyPressEvent(QKeyEvent * ev);
 217         /// IM events
 218         void inputMethodEvent(QInputMethodEvent * ev);
 219         /// IM query
 220         QVariant inputMethodQuery(Qt::InputMethodQuery query) const;
 221
 222         /// The slot connected to SyntheticMouseEvent::timeout.
 223         void generateSyntheticMouseEvent();
 224         ///
 225         void dispatch(FuncRequest const & cmd0, KeyModifier = NoModifier);
 226         /// hide the visible cursor, if it is visible
 227         void hideCursor();
 228         /// show the cursor if it is not visible
 229         void showCursor();
 230         ///
 231         void updateScrollbar();
 232
 233         ///
 234         BufferView * buffer_view_;
 235         /// Read only Buffer status cache.
 236         bool read_only_;
 237         ///
 238         GuiView * lyx_view_;
 239         /// is the cursor currently displayed
 240         bool cursor_visible_;
 241
 242         ///
 243         QTimer cursor_timeout_;
 244         ///
 245         SyntheticMouseEvent synthetic_mouse_event_;
 246         ///
 247         DoubleClick dc_event_;
 248
 249         ///
 250         CursorWidget * cursor_;
 251         ///
 252         QPixmap screen_;
 253         ///
 254         bool need_resize_;
 255         ///
 256         bool schedule_redraw_;
 257         ///
 258         int preedit_lines_;
 259
 260         ///
 261         GuiCompleter * completer_;
 262
 263         /// Special mode in which Esc and Enter (with or without Shift)
 264         /// are ignored
 265         bool dialog_mode_;
 266         /// store the position of the rightclick when the mouse is
 267         /// pressed. This is used to get the correct context menu
 268         /// when the menu is actually shown (after releasing on Windwos).
 269         QPoint context_target_pos_;
 270 }; // GuiWorkArea
 271
 272
 273 class EmbeddedWorkArea : public GuiWorkArea
 274 {
 275         Q_OBJECT
 276 public:
 277         ///
 278         EmbeddedWorkArea(QWidget *);
 279         ~EmbeddedWorkArea();
 280
 281         /// Dummy methods for Designer.
 282         void setWidgetResizable(bool) {}
 283         void setWidget(QWidget *) {}
 284
 285         QSize sizeHint () const;
 286         ///
 287         void disable();
 288
 289 protected:
 290         ///
 291         void closeEvent(QCloseEvent * ev);
 292         ///
 293         void hideEvent(QHideEvent *ev);
 294
 295 private:
 296         /// Embedded Buffer.
 297         Buffer * buffer_;
 298 }; // EmbeddedWorkArea
 299
 300
 301 /// A tabbed set of GuiWorkAreas.
 302 class TabWorkArea : public QTabWidget
 303 {
 304         Q_OBJECT
 305 public:
 306         TabWorkArea(QWidget * parent = 0);
 307
 308         ///
 309         void setFullScreen(bool full_screen);
 310         void showBar(bool show);
 311         void closeAll();
 312         bool setCurrentWorkArea(GuiWorkArea *);
 313         GuiWorkArea * addWorkArea(Buffer & buffer, GuiView & view);
 314         bool removeWorkArea(GuiWorkArea *);
 315         GuiWorkArea * currentWorkArea();
 316         GuiWorkArea * workArea(Buffer & buffer);
 317         GuiWorkArea * workArea(int index);
 318
 319 Q_SIGNALS:
 320         ///
 321         void currentWorkAreaChanged(GuiWorkArea *);
 322         ///
 323         void lastWorkAreaRemoved();
 324
 325 public Q_SLOTS:
 326         /// close current buffer, or the one given by \c clicked_tab_
 327         void closeCurrentBuffer();
 328         /// hide current tab, or the one given by \c clicked_tab_
 329         void hideCurrentTab();
 330         /// close the tab given by \c index
 331         void closeTab(int index);
 332         ///
 333         void updateTabTexts();
 334
 335 private Q_SLOTS:
 336         ///
 337         void on_currentTabChanged(int index);
 338         ///
 339         void showContextMenu(const QPoint & pos);
 340         ///
 341         void moveTab(int fromIndex, int toIndex);
 342         ///
 343         void mouseDoubleClickEvent(QMouseEvent * event);
 344
 345 private:
 346         ///
 347         int clicked_tab_;
 348         ///
 349         QToolButton * closeBufferButton;
 350 }; // TabWorkArea
 351
 352
 353 class DragTabBar : public QTabBar
 354 {
 355         Q_OBJECT
 356 public:
 357         ///
 358         DragTabBar(QWidget * parent = 0);
 359
 360 #if QT_VERSION < 0x040300
 361         ///
 362         int tabAt(QPoint const & position) const;
 363 #endif
 364
 365 protected:
 366         ///
 367         void mousePressEvent(QMouseEvent * event);
 368         ///
 369         void mouseMoveEvent(QMouseEvent * event);
 370         ///
 371         void dragEnterEvent(QDragEnterEvent * event);
 372         ///
 373         void dropEvent(QDropEvent * event);
 374
 375 private:
 376         ///
 377         QPoint dragStartPos_;
 378         ///
 379         int dragCurrentIndex_;
 380
 381 Q_SIGNALS:
 382         ///
 383         void tabMoveRequested(int fromIndex, int toIndex);
 384 };
 385
 386 } // namespace frontend
 387 } // namespace lyx
 388
 389 #endif // WORKAREA_H