3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
7 * \author Abdelrazak Younes
9 * Full author contact details are available in file CREDITS.
14 #include "GuiWorkArea.h"
16 #include "GuiApplication.h"
17 #include "QLPainter.h"
18 #include "QLyXKeySym.h"
19 #include "qt_helpers.h"
23 #include "BufferView.h"
25 #include "funcrequest.h"
28 #include "support/os.h"
31 #include <QMainWindow>
34 #include <QDragEnterEvent>
39 #include <boost/bind.hpp>
40 #include <boost/current_function.hpp>
42 // Abdel (26/06/2006):
43 // On windows-XP the UserGuide PageDown scroll test is faster without event pruning (16 s)
44 // than with it (23 s).
46 #define USE_EVENT_PRUNING 0
48 #define USE_EVENT_PRUNING 0
54 namespace os = lyx::support::os;
58 /// return the LyX key state from Qt's
59 static key_modifier::state q_key_state(Qt::KeyboardModifiers state)
61 key_modifier::state k = key_modifier::none;
62 if (state & Qt::ControlModifier)
63 k |= key_modifier::ctrl;
64 if (state & Qt::ShiftModifier)
65 k |= key_modifier::shift;
66 if (state & Qt::AltModifier || state & Qt::MetaModifier)
67 k |= key_modifier::alt;
72 /// return the LyX mouse button state from Qt's
73 static mouse_button::state q_button_state(Qt::MouseButton button)
75 mouse_button::state b = mouse_button::none;
78 b = mouse_button::button1;
81 b = mouse_button::button2;
84 b = mouse_button::button3;
93 /// retddurn the LyX mouse button state from Qt's
94 mouse_button::state q_motion_state(Qt::MouseButton state)
96 mouse_button::state b = mouse_button::none;
97 if (state & Qt::LeftButton)
98 b |= mouse_button::button1;
99 if (state & Qt::MidButton)
100 b |= mouse_button::button2;
101 if (state & Qt::RightButton)
102 b |= mouse_button::button3;
109 // This is a 'heartbeat' generating synthetic mouse move events when the
110 // cursor is at the top or bottom edge of the viewport. One scroll per 0.2 s
111 SyntheticMouseEvent::SyntheticMouseEvent()
112 : timeout(200), restart_timeout(true),
113 x_old(-1), y_old(-1), scrollbar_value_old(-1.0)
117 GuiWorkArea::GuiWorkArea(int w, int h, LyXView & lyx_view)
118 : WorkArea(lyx_view), painter_(this)
120 setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOn);
121 setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
123 setAcceptDrops(true);
125 setMinimumSize(100, 70);
127 viewport()->setAutoFillBackground(false);
128 viewport()->setAttribute(Qt::WA_OpaquePaintEvent);
129 setFocusPolicy(Qt::WheelFocus);
131 viewport()->setCursor(Qt::IBeamCursor);
135 synthetic_mouse_event_.timeout.timeout.connect(
136 boost::bind(&GuiWorkArea::generateSyntheticMouseEvent,
139 // Initialize the vertical Scroll Bar
140 QObject::connect(verticalScrollBar(), SIGNAL(actionTriggered(int)),
141 this, SLOT(adjustViewWithScrollBar(int)));
143 // PageStep only depends on the viewport height.
144 verticalScrollBar()->setPageStep(viewport()->height());
146 lyxerr[Debug::GUI] << BOOST_CURRENT_FUNCTION
147 << "\n Area width\t" << width()
148 << "\n Area height\t" << height()
149 << "\n viewport width\t" << viewport()->width()
150 << "\n viewport height\t" << viewport()->height()
153 if (USE_EVENT_PRUNING) {
154 // This is the keyboard buffering stuff...
155 // I don't see any need for this under windows. The keyboard is reactive
158 if ( !QObject::connect(&step_timer_, SIGNAL(timeout()),
159 this, SLOT(keyeventTimeout())) )
160 lyxerr[Debug::GUI] << "ERROR: keyeventTimeout cannot connect!" << endl;
162 // Start the timer, one-shot.
163 step_timer_.setSingleShot(true);
164 step_timer_.start(50);
167 // Enables input methods for asian languages.
168 // Must be set when creating custom text editing widgets.
169 setAttribute(Qt::WA_InputMethodEnabled, true);
173 GuiWorkArea::~GuiWorkArea()
178 void GuiWorkArea::setScrollbarParams(int h, int scroll_pos, int scroll_line_step)
180 verticalScrollBar()->setTracking(false);
182 // do what cursor movement does (some grey)
184 int scroll_max_ = std::max(0, h - height());
186 verticalScrollBar()->setRange(0, scroll_max_);
187 verticalScrollBar()->setSliderPosition(scroll_pos);
188 verticalScrollBar()->setSingleStep(scroll_line_step);
190 verticalScrollBar()->setTracking(true);
194 void GuiWorkArea::adjustViewWithScrollBar(int)
196 scrollBufferView(verticalScrollBar()->sliderPosition());
200 void GuiWorkArea::dragEnterEvent(QDragEnterEvent * event)
202 if (event->mimeData()->hasUrls())
204 /// \todo Ask lyx-devel is this is enough:
205 /// if (event->mimeData()->hasFormat("text/plain"))
206 /// event->acceptProposedAction();
210 void GuiWorkArea::dropEvent(QDropEvent* event)
212 QList<QUrl> files = event->mimeData()->urls();
216 lyxerr[Debug::GUI] << "GuiWorkArea::dropEvent: got URIs!" << endl;
217 for (int i = 0; i!=files.size(); ++i) {
218 string const file = os::internal_path(fromqstr(files.at(i).toLocalFile()));
220 dispatch(FuncRequest(LFUN_FILE_OPEN, file));
225 void GuiWorkArea::mousePressEvent(QMouseEvent * e)
227 if (dc_event_.active && dc_event_ == *e) {
228 dc_event_.active = false;
229 FuncRequest cmd(LFUN_MOUSE_TRIPLE,
230 dc_event_.x, dc_event_.y,
231 q_button_state(dc_event_.state));
236 FuncRequest const cmd(LFUN_MOUSE_PRESS, e->x(), e->y(),
237 q_button_state(e->button()));
242 void GuiWorkArea::mouseReleaseEvent(QMouseEvent * e)
244 if (synthetic_mouse_event_.timeout.running())
245 synthetic_mouse_event_.timeout.stop();
247 FuncRequest const cmd(LFUN_MOUSE_RELEASE, e->x(), e->y(),
248 q_button_state(e->button()));
253 void GuiWorkArea::mouseMoveEvent(QMouseEvent * e)
255 FuncRequest cmd(LFUN_MOUSE_MOTION, e->x(), e->y(),
256 q_motion_state(e->button()));
258 // If we're above or below the work area...
259 if (e->y() <= 20 || e->y() >= viewport()->height() - 20) {
260 // Make sure only a synthetic event can cause a page scroll,
261 // so they come at a steady rate:
263 // _Force_ a scroll up:
266 cmd.y = viewport()->height();
267 // Store the event, to be handled when the timeout expires.
268 synthetic_mouse_event_.cmd = cmd;
270 if (synthetic_mouse_event_.timeout.running())
271 // Discard the event. Note that it _may_ be handled
272 // when the timeout expires if
273 // synthetic_mouse_event_.cmd has not been overwritten.
274 // Ie, when the timeout expires, we handle the
275 // most recent event but discard all others that
276 // occurred after the one used to start the timeout
277 // in the first place.
280 synthetic_mouse_event_.restart_timeout = true;
281 synthetic_mouse_event_.timeout.start();
282 // Fall through to handle this event...
285 } else if (synthetic_mouse_event_.timeout.running()) {
286 // Store the event, to be possibly handled when the timeout
288 // Once the timeout has expired, normal control is returned
289 // to mouseMoveEvent (restart_timeout = false).
290 // This results in a much smoother 'feel' when moving the
291 // mouse back into the work area.
292 synthetic_mouse_event_.cmd = cmd;
293 synthetic_mouse_event_.restart_timeout = false;
297 // Has anything changed on-screen since the last QMouseEvent
299 double const scrollbar_value = verticalScrollBar()->value();
300 if (e->x() != synthetic_mouse_event_.x_old ||
301 e->y() != synthetic_mouse_event_.y_old ||
302 scrollbar_value != synthetic_mouse_event_.scrollbar_value_old) {
303 // Yes it has. Store the params used to check this.
304 synthetic_mouse_event_.x_old = e->x();
305 synthetic_mouse_event_.y_old = e->y();
306 synthetic_mouse_event_.scrollbar_value_old = scrollbar_value;
308 // ... and dispatch the event to the LyX core.
314 void GuiWorkArea::wheelEvent(QWheelEvent * e)
316 // Wheel rotation by one notch results in a delta() of 120 (see
317 // documentation of QWheelEvent)
318 int const lines = qApp->wheelScrollLines() * e->delta() / 120;
319 verticalScrollBar()->setValue(verticalScrollBar()->value() -
320 lines * verticalScrollBar()->singleStep());
321 adjustViewWithScrollBar();
325 void GuiWorkArea::generateSyntheticMouseEvent()
327 // Set things off to generate the _next_ 'pseudo' event.
328 if (synthetic_mouse_event_.restart_timeout)
329 synthetic_mouse_event_.timeout.start();
331 // Has anything changed on-screen since the last timeout signal
333 double const scrollbar_value = verticalScrollBar()->value();
334 if (scrollbar_value != synthetic_mouse_event_.scrollbar_value_old) {
335 // Yes it has. Store the params used to check this.
336 synthetic_mouse_event_.scrollbar_value_old = scrollbar_value;
338 // ... and dispatch the event to the LyX core.
339 dispatch(synthetic_mouse_event_.cmd);
344 void GuiWorkArea::keyPressEvent(QKeyEvent * e)
346 lyxerr[Debug::KEY] << BOOST_CURRENT_FUNCTION
347 << " count=" << e->count()
348 << " text=" << fromqstr(e->text())
349 << " isAutoRepeat=" << e->isAutoRepeat()
350 << " key=" << e->key()
353 if (USE_EVENT_PRUNING) {
354 keyeventQueue_.push(boost::shared_ptr<QKeyEvent>(new QKeyEvent(*e)));
357 boost::shared_ptr<QLyXKeySym> sym(new QLyXKeySym);
359 processKeySym(sym, q_key_state(e->modifiers()));
364 // This is used only if USE_EVENT_PRUNING is defined...
365 void GuiWorkArea::keyeventTimeout()
367 bool handle_autos = true;
369 while (!keyeventQueue_.empty()) {
370 boost::shared_ptr<QKeyEvent> ev = keyeventQueue_.front();
372 // We never handle more than one auto repeated
373 // char in a list of queued up events.
374 if (!handle_autos && ev->isAutoRepeat()) {
375 keyeventQueue_.pop();
379 boost::shared_ptr<QLyXKeySym> sym(new QLyXKeySym);
382 lyxerr[Debug::GUI] << BOOST_CURRENT_FUNCTION
383 << " count=" << ev->count()
384 << " text=" << fromqstr(ev->text())
385 << " isAutoRepeat=" << ev->isAutoRepeat()
386 << " key=" << ev->key()
389 processKeySym(sym, q_key_state(ev->modifiers()));
390 keyeventQueue_.pop();
392 handle_autos = false;
395 // Restart the timer.
396 step_timer_.setSingleShot(true);
397 step_timer_.start(25);
401 void GuiWorkArea::mouseDoubleClickEvent(QMouseEvent * e)
403 dc_event_ = double_click(e);
405 if (!dc_event_.active)
408 dc_event_.active = false;
410 FuncRequest cmd(LFUN_MOUSE_DOUBLE,
411 dc_event_.x, dc_event_.y,
412 q_button_state(dc_event_.state));
417 void GuiWorkArea::resizeEvent(QResizeEvent *)
419 verticalScrollBar()->setPageStep(viewport()->height());
420 paint_device_ = QPixmap(viewport()->width(), viewport()->height());
425 void GuiWorkArea::update(int x, int y, int w, int h)
427 viewport()->repaint(x, y, w, h);
431 void GuiWorkArea::paintEvent(QPaintEvent * e)
434 lyxerr[Debug::GUI] << BOOST_CURRENT_FUNCTION
435 << "\n QWidget width\t" << this->width()
436 << "\n QWidget height\t" << this->height()
437 << "\n viewport width\t" << viewport()->width()
438 << "\n viewport height\t" << viewport()->height()
439 << "\n pixmap width\t" << pixmap_->width()
440 << "\n pixmap height\t" << pixmap_->height()
441 << "\n QPaintEvent x\t" << e->rect().x()
442 << "\n QPaintEvent y\t" << e->rect().y()
443 << "\n QPaintEvent w\t" << e->rect().width()
444 << "\n QPaintEvent h\t" << e->rect().height()
448 QPainter q(viewport());
449 q.drawPixmap(e->rect(), paint_device_, e->rect());
452 q.drawPixmap(cursor_x_, cursor_y_, vcursor_);
455 q.drawPixmap(cursor_x_, cursor_y_ + cursor_h_ - 1, hcursor_);
459 QPixmap GuiWorkArea::copyScreen(int x, int y, int w, int h) const
461 return paint_device_.copy(x, y, w, h);
465 void GuiWorkArea::drawScreen(int x, int y, QPixmap pixmap)
467 QPainter q(&paint_device_);
468 q.drawPixmap(x, y, pixmap);
469 update(x, y, pixmap.width(), pixmap.height());
473 void GuiWorkArea::expose(int x, int y, int w, int h)
476 if (x == 0 && y == 0 && w == viewport()->width() && h == viewport()->height()) {
477 viewport()->repaint(x, y, w, h);
486 void GuiWorkArea::showCursor(int x, int y, int h, CursorShape shape)
488 if (!qApp->focusWidget())
491 show_vcursor_ = true;
493 QColor const & required_color = guiApp->colorCache().get(LColor::cursor);
495 if (x==cursor_x_ && y==cursor_y_ && h==cursor_h_
496 && cursor_color_ == required_color
497 && cursor_shape_ == shape) {
498 show_hcursor_ = lshape_cursor_;
499 update(cursor_x_, cursor_y_, cursor_w_, cursor_h_);
503 // Cache the dimensions of the cursor.
507 cursor_color_ = required_color;
508 cursor_shape_ = shape;
510 switch (cursor_shape_) {
512 // FIXME the cursor width shouldn't be hard-coded!
514 lshape_cursor_ = false;
517 cursor_w_ = cursor_h_ / 3;
518 lshape_cursor_ = true;
520 case REVERSED_L_SHAPE:
521 cursor_w_ = cursor_h_ / 3;
522 cursor_x_ -= cursor_w_ - 1;
523 lshape_cursor_ = true;
527 // We cache two pixmaps:
528 // 1 the vertical line of the cursor.
529 // 2 the horizontal line of the L-shaped cursor (if necessary).
531 // Draw the new (vertical) cursor.
532 vcursor_ = QPixmap(cursor_w_, cursor_h_);
533 vcursor_.fill(cursor_color_);
535 // Draw the new (horizontal) cursor if necessary.
536 if (lshape_cursor_) {
537 hcursor_ = QPixmap(cursor_w_, 1);
538 hcursor_.fill(cursor_color_);
539 show_hcursor_ = true;
542 update(cursor_x_, cursor_y_, cursor_w_, cursor_h_);
546 void GuiWorkArea::removeCursor()
548 show_vcursor_ = false;
549 show_hcursor_ = false;
551 update(cursor_x_, cursor_y_, cursor_w_, cursor_h_);
555 void GuiWorkArea::inputMethodEvent(QInputMethodEvent * e)
557 QString const & text = e->commitString();
558 if (!text.isEmpty()) {
560 lyxerr[Debug::KEY] << BOOST_CURRENT_FUNCTION
561 << " preeditString =" << fromqstr(e->preeditString())
562 << " commitString =" << fromqstr(e->commitString())
566 // needed to make math superscript work on some systems
567 // ideally, such special coding should not be necessary
569 key = Qt::Key_AsciiCircum;
570 // FIXME: Needs for investigation, this key is not really used,
571 // the ctor below just check if key is different from 0.
572 QKeyEvent ev(QEvent::KeyPress, key,
573 Qt::NoModifier, text);
579 } // namespace frontend
582 #include "GuiWorkArea_moc.cpp"