4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
8 * \author Abdelrazak Younes
10 * Full author contact details are available in file CREDITS.
16 #include "frontends/WorkArea.h"
18 #include "DocIterator.h"
19 #include "FuncRequest.h"
20 #include "qt_helpers.h"
21 #include "support/docstring.h"
22 #include "support/Timeout.h"
24 #include <QAbstractScrollArea>
25 #include <QMouseEvent>
27 #include <QResizeEvent>
32 class QContextMenuEvent;
33 class QDragEnterEvent;
55 /// for emulating triple click
59 DoubleClick() : state(Qt::NoButton), active(false) {}
61 DoubleClick(QMouseEvent * e) : state(e->button()), active(true) {}
63 bool operator==(QMouseEvent const & e) { return state == e.button(); }
67 Qt::MouseButton state;
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.
78 * This class stores all the parameters needed to make this happen.
80 class SyntheticMouseEvent
83 SyntheticMouseEvent();
92 * Implementation of the work area (buffer view GUI)
96 class GuiWorkArea : public QAbstractScrollArea, public WorkArea
102 GuiWorkArea(QWidget *);
104 GuiWorkArea(Buffer & buffer, GuiView & gv);
111 void setBuffer(Buffer &);
113 void setGuiView(GuiView &);
115 void setFullScreen(bool full_screen);
116 /// is GuiView in fullscreen mode?
119 void scheduleRedraw() { schedule_redraw_ = true; }
121 BufferView & bufferView();
123 BufferView const & bufferView() const;
125 void redraw(bool update_metrics);
127 void stopBlinkingCursor();
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);
134 void resizeBufferView();
136 bool inDialogMode() const { return dialog_mode_; }
137 void setDialogMode(bool mode) { dialog_mode_ = mode; }
140 GuiCompleter & completer() { return *completer_; }
142 Qt::CursorShape cursorShape() const;
143 void setCursorShape(Qt::CursorShape shape);
146 /// Return the GuiView this workArea belongs to
147 GuiView const & view() const { return *lyx_view_; }
148 GuiView & view() { return *lyx_view_; }
152 void titleChanged(GuiWorkArea *);
155 /// Scroll the BufferView.
157 * This is a slot for the valueChanged() signal of the vertical scrollbar.
158 * \p value value of the scrollbar.
160 void scrollTo(int value);
161 /// timer to limit triple clicks
162 void doubleClickTimeout();
163 /// toggle the cursor's visibility
165 /// close this work area.
166 /// Slot for Buffer::closing signal.
168 /// Slot to restore proper scrollbar behaviour.
169 void fixVerticalScrollBar();
172 friend class GuiCompleter;
174 /// update the passed area.
175 void update(int x, int y, int w, int h);
179 /// paint the cursor and store the background
180 virtual void showCursor(int x, int y, int h,
181 bool l_shape, bool rtl, bool completable);
184 virtual void removeCursor();
186 /// This function should be called to update the buffer readonly status.
187 void setReadOnly(bool);
189 /// Update window titles of all users.
190 void updateWindowTitle();
192 bool event(QEvent *);
194 void contextMenuEvent(QContextMenuEvent *);
196 void focusInEvent(QFocusEvent *);
198 void focusOutEvent(QFocusEvent *);
199 /// repaint part of the widget
200 void paintEvent(QPaintEvent * ev);
201 /// widget has been resized
202 void resizeEvent(QResizeEvent * ev);
203 /// mouse button press
204 void mousePressEvent(QMouseEvent * ev);
205 /// mouse button release
206 void mouseReleaseEvent(QMouseEvent * ev);
207 /// mouse double click of button
208 void mouseDoubleClickEvent(QMouseEvent * ev);
210 void mouseMoveEvent(QMouseEvent * ev);
212 void wheelEvent(QWheelEvent * ev);
214 void keyPressEvent(QKeyEvent * ev);
216 void inputMethodEvent(QInputMethodEvent * ev);
218 QVariant inputMethodQuery(Qt::InputMethodQuery query) const;
220 /// The slot connected to SyntheticMouseEvent::timeout.
221 void generateSyntheticMouseEvent();
223 void dispatch(FuncRequest const & cmd0, KeyModifier = NoModifier);
224 /// hide the visible cursor, if it is visible
226 /// show the cursor if it is not visible
229 void updateScrollbar();
232 BufferView * buffer_view_;
233 /// Read only Buffer status cache.
237 /// is the cursor currently displayed
238 bool cursor_visible_;
241 QTimer cursor_timeout_;
243 SyntheticMouseEvent synthetic_mouse_event_;
245 DoubleClick dc_event_;
248 CursorWidget * cursor_;
254 bool schedule_redraw_;
259 GuiCompleter * completer_;
261 /// Special mode in which Esc and Enter (with or without Shift)
264 /// store the position of the rightclick when the mouse is
265 /// pressed. This is used to get the correct context menu
266 /// when the menu is actually shown (after releasing on Windwos).
267 QPoint context_target_pos_;
271 class EmbeddedWorkArea : public GuiWorkArea
276 EmbeddedWorkArea(QWidget *);
279 /// Dummy methods for Designer.
280 void setWidgetResizable(bool) {}
281 void setWidget(QWidget *) {}
283 QSize sizeHint () const;
289 void closeEvent(QCloseEvent * ev);
291 void hideEvent(QHideEvent *ev);
296 }; // EmbeddedWorkArea
299 /// A tabbed set of GuiWorkAreas.
300 class TabWorkArea : public QTabWidget
304 TabWorkArea(QWidget * parent = 0);
307 void setFullScreen(bool full_screen);
308 void showBar(bool show);
310 bool setCurrentWorkArea(GuiWorkArea *);
311 GuiWorkArea * addWorkArea(Buffer & buffer, GuiView & view);
312 bool removeWorkArea(GuiWorkArea *);
313 GuiWorkArea * currentWorkArea();
314 GuiWorkArea * workArea(Buffer & buffer);
315 GuiWorkArea * workArea(int index);
319 void currentWorkAreaChanged(GuiWorkArea *);
321 void lastWorkAreaRemoved();
324 /// close current buffer, or the one given by \c clicked_tab_
325 void closeCurrentBuffer();
326 /// hide current tab, or the one given by \c clicked_tab_
327 void hideCurrentTab();
328 /// close the tab given by \c index
329 void closeTab(int index);
331 void updateTabTexts();
335 void on_currentTabChanged(int index);
337 void showContextMenu(const QPoint & pos);
339 void moveTab(int fromIndex, int toIndex);
341 void mouseDoubleClickEvent(QMouseEvent * event);
347 QToolButton * closeBufferButton;
351 class DragTabBar : public QTabBar
356 DragTabBar(QWidget * parent = 0);
358 #if QT_VERSION < 0x040300
360 int tabAt(QPoint const & position) const;
365 void mousePressEvent(QMouseEvent * event);
367 void mouseMoveEvent(QMouseEvent * event);
369 void dragEnterEvent(QDragEnterEvent * event);
371 void dropEvent(QDropEvent * event);
375 QPoint dragStartPos_;
377 int dragCurrentIndex_;
381 void tabMoveRequested(int fromIndex, int toIndex);
384 } // namespace frontend