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_; }
143 /// Return the GuiView this workArea belongs to
144 GuiView const & view() const { return *lyx_view_; }
145 GuiView & view() { return *lyx_view_; }
149 void titleChanged(GuiWorkArea *);
152 /// Scroll the BufferView.
154 * This is a slot for the valueChanged() signal of the vertical scrollbar.
155 * \p value value of the scrollbar.
157 void scrollTo(int value);
158 /// timer to limit triple clicks
159 void doubleClickTimeout();
160 /// toggle the cursor's visibility
162 /// close this work area.
163 /// Slot for Buffer::closing signal.
165 /// Slot to restore proper scrollbar behaviour.
166 void fixVerticalScrollBar();
169 friend class GuiCompleter;
171 /// update the passed area.
172 void update(int x, int y, int w, int h);
176 /// paint the cursor and store the background
177 virtual void showCursor(int x, int y, int h,
178 bool l_shape, bool rtl, bool completable);
181 virtual void removeCursor();
183 /// This function should be called to update the buffer readonly status.
184 void setReadOnly(bool);
186 /// Update window titles of all users.
187 void updateWindowTitle();
189 bool event(QEvent *);
191 void contextMenuEvent(QContextMenuEvent *);
193 void focusInEvent(QFocusEvent *);
195 void focusOutEvent(QFocusEvent *);
196 /// repaint part of the widget
197 void paintEvent(QPaintEvent * ev);
198 /// widget has been resized
199 void resizeEvent(QResizeEvent * ev);
200 /// mouse button press
201 void mousePressEvent(QMouseEvent * ev);
202 /// mouse button release
203 void mouseReleaseEvent(QMouseEvent * ev);
204 /// mouse double click of button
205 void mouseDoubleClickEvent(QMouseEvent * ev);
207 void mouseMoveEvent(QMouseEvent * ev);
209 void wheelEvent(QWheelEvent * ev);
211 void keyPressEvent(QKeyEvent * ev);
213 void inputMethodEvent(QInputMethodEvent * ev);
215 QVariant inputMethodQuery(Qt::InputMethodQuery query) const;
217 /// The slot connected to SyntheticMouseEvent::timeout.
218 void generateSyntheticMouseEvent();
220 void dispatch(FuncRequest const & cmd0, KeyModifier = NoModifier);
221 /// hide the visible cursor, if it is visible
223 /// show the cursor if it is not visible
226 void updateScrollbar();
229 BufferView * buffer_view_;
230 /// Read only Buffer status cache.
234 /// is the cursor currently displayed
235 bool cursor_visible_;
238 QTimer cursor_timeout_;
240 SyntheticMouseEvent synthetic_mouse_event_;
242 DoubleClick dc_event_;
245 CursorWidget * cursor_;
251 bool schedule_redraw_;
256 GuiCompleter * completer_;
258 /// Special mode in which Esc and Enter (with or without Shift)
261 /// store the position of the rightclick when the mouse is
262 /// pressed. This is used to get the correct context menu
263 /// when the menu is actually shown (after releasing on Windwos).
264 QPoint context_target_pos_;
268 class EmbeddedWorkArea : public GuiWorkArea
273 EmbeddedWorkArea(QWidget *);
276 /// Dummy methods for Designer.
277 void setWidgetResizable(bool) {}
278 void setWidget(QWidget *) {}
280 QSize sizeHint () const;
286 void closeEvent(QCloseEvent * ev);
288 void hideEvent(QHideEvent *ev);
293 }; // EmbeddedWorkArea
296 /// A tabbed set of GuiWorkAreas.
297 class TabWorkArea : public QTabWidget
301 TabWorkArea(QWidget * parent = 0);
304 void setFullScreen(bool full_screen);
305 void showBar(bool show);
307 bool setCurrentWorkArea(GuiWorkArea *);
308 GuiWorkArea * addWorkArea(Buffer & buffer, GuiView & view);
309 bool removeWorkArea(GuiWorkArea *);
310 GuiWorkArea * currentWorkArea();
311 GuiWorkArea * workArea(Buffer & buffer);
315 void currentWorkAreaChanged(GuiWorkArea *);
317 void lastWorkAreaRemoved();
320 /// close current buffer, or the one given by \c clicked_tab_
321 void closeCurrentBuffer();
322 /// hide current tab, or the one given by \c clicked_tab_
323 void hideCurrentTab();
324 /// close the tab given by \c index
325 void closeTab(int index);
327 void updateTabTexts();
331 void on_currentTabChanged(int index);
333 void showContextMenu(const QPoint & pos);
335 void moveTab(int fromIndex, int toIndex);
337 void mouseDoubleClickEvent(QMouseEvent * event);
343 QToolButton * closeBufferButton;
347 class DragTabBar : public QTabBar
352 DragTabBar(QWidget * parent = 0);
354 #if QT_VERSION < 0x040300
356 int tabAt(QPoint const & position) const;
361 void mousePressEvent(QMouseEvent * event);
363 void mouseMoveEvent(QMouseEvent * event);
365 void dragEnterEvent(QDragEnterEvent * event);
367 void dropEvent(QDropEvent * event);
371 QPoint dragStartPos_;
373 int dragCurrentIndex_;
377 void tabMoveRequested(int fromIndex, int toIndex);
380 } // namespace frontend