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"
24 #include "rowpainter.h"
26 #include "funcrequest.h"
31 #include "support/filetools.h" // LibFileSearch
32 #include "support/os.h"
34 #include "graphics/GraphicsImage.h"
35 #include "graphics/GraphicsLoader.h"
38 #include <QMainWindow>
41 #include <QDragEnterEvent>
46 #include <boost/bind.hpp>
47 #include <boost/current_function.hpp>
49 // Abdel (26/06/2006):
50 // On windows-XP the UserGuide PageDown scroll test is faster without event pruning (16 s)
51 // than with it (23 s).
53 #define USE_EVENT_PRUNING 0
55 #define USE_EVENT_PRUNING 0
62 namespace os = lyx::support::os;
67 /// return the LyX key state from Qt's
68 static key_modifier::state q_key_state(Qt::KeyboardModifiers state)
70 key_modifier::state k = key_modifier::none;
71 if (state & Qt::ControlModifier)
72 k |= key_modifier::ctrl;
73 if (state & Qt::ShiftModifier)
74 k |= key_modifier::shift;
75 if (state & Qt::AltModifier || state & Qt::MetaModifier)
76 k |= key_modifier::alt;
81 /// return the LyX mouse button state from Qt's
82 static mouse_button::state q_button_state(Qt::MouseButton button)
84 mouse_button::state b = mouse_button::none;
87 b = mouse_button::button1;
90 b = mouse_button::button2;
93 b = mouse_button::button3;
102 /// return the LyX mouse button state from Qt's
103 mouse_button::state q_motion_state(Qt::MouseButton state)
105 mouse_button::state b = mouse_button::none;
106 if (state & Qt::LeftButton)
107 b |= mouse_button::button1;
108 if (state & Qt::MidButton)
109 b |= mouse_button::button2;
110 if (state & Qt::RightButton)
111 b |= mouse_button::button3;
118 class CursorWidget : public QWidget {
120 CursorWidget(QWidget * parent)
126 void paintEvent(QPaintEvent *)
128 QColor const & col = guiApp->colorCache().get(LColor::cursor);
134 switch (cursor_shape_) {
136 // FIXME the cursor width shouldn't be hard-coded!
138 lshape_cursor_ = false;
141 cursor_w_ = cursor_h_ / 3;
142 lshape_cursor_ = true;
144 case REVERSED_L_SHAPE:
145 cursor_w_ = cursor_h_ / 3;
146 //cursor_x_ -= cursor_w_ - 1;
147 lshape_cursor_ = true;
152 // We cache two pixmaps:
153 // 1 the vertical line of the cursor.
154 // 2 the horizontal line of the L-shaped cursor (if necessary).
156 // Draw the new (vertical) cursor.
158 pain.fillRect(rect(), col);
160 // Draw the new (horizontal) cursor if necessary.
161 if (lshape_cursor_) {
162 hcursor_ = QPixmap(cursor_w_, 1);
164 show_hcursor_ = true;
175 // This is a 'heartbeat' generating synthetic mouse move events when the
176 // cursor is at the top or bottom edge of the viewport. One scroll per 0.2 s
177 SyntheticMouseEvent::SyntheticMouseEvent()
178 : timeout(200), restart_timeout(true),
179 x_old(-1), y_old(-1), scrollbar_value_old(-1.0)
183 GuiWorkArea::GuiWorkArea(int w, int h, int id, LyXView & lyx_view)
184 : WorkArea(id, lyx_view)
186 cursor_ = new frontend::CursorWidget(this);
189 setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOn);
190 setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
191 setAcceptDrops(true);
192 setMinimumSize(100, 70);
194 //viewport()->setAutoFillBackground(false);
195 //viewport()->setAttribute(Qt::WA_OpaquePaintEvent);
196 setFocusPolicy(Qt::WheelFocus);
198 viewport()->setCursor(Qt::IBeamCursor);
202 synthetic_mouse_event_.timeout.timeout.connect(
203 boost::bind(&GuiWorkArea::generateSyntheticMouseEvent,
206 // Initialize the vertical Scroll Bar
207 QObject::connect(verticalScrollBar(), SIGNAL(actionTriggered(int)),
208 this, SLOT(adjustViewWithScrollBar(int)));
210 // PageStep only depends on the viewport height.
211 verticalScrollBar()->setPageStep(viewport()->height());
213 lyxerr[Debug::GUI] << BOOST_CURRENT_FUNCTION
214 << "\n Area width\t" << width()
215 << "\n Area height\t" << height()
216 << "\n viewport width\t" << viewport()->width()
217 << "\n viewport height\t" << viewport()->height()
220 if (USE_EVENT_PRUNING) {
221 // This is the keyboard buffering stuff...
222 // I don't see any need for this under windows. The keyboard is reactive
225 if ( !QObject::connect(&step_timer_, SIGNAL(timeout()),
226 this, SLOT(keyeventTimeout())) )
227 lyxerr[Debug::GUI] << "ERROR: keyeventTimeout cannot connect!" << endl;
229 // Start the timer, one-shot.
230 step_timer_.setSingleShot(true);
231 step_timer_.start(50);
234 // Enables input methods for asian languages.
235 // Must be set when creating custom text editing widgets.
236 setAttribute(Qt::WA_InputMethodEnabled, true);
240 void GuiWorkArea::setScrollbarParams(int h, int scroll_pos, int scroll_line_step)
242 verticalScrollBar()->setTracking(false);
244 // do what cursor movement does (some grey)
246 int scroll_max_ = std::max(0, h - height());
248 verticalScrollBar()->setRange(0, scroll_max_);
249 verticalScrollBar()->setSliderPosition(scroll_pos);
250 verticalScrollBar()->setSingleStep(scroll_line_step);
251 verticalScrollBar()->setValue(scroll_pos);
253 verticalScrollBar()->setTracking(true);
257 void GuiWorkArea::adjustViewWithScrollBar(int)
259 scrollBufferView(verticalScrollBar()->sliderPosition());
263 void GuiWorkArea::dragEnterEvent(QDragEnterEvent * event)
265 if (event->mimeData()->hasUrls())
267 /// \todo Ask lyx-devel is this is enough:
268 /// if (event->mimeData()->hasFormat("text/plain"))
269 /// event->acceptProposedAction();
273 void GuiWorkArea::dropEvent(QDropEvent* event)
275 QList<QUrl> files = event->mimeData()->urls();
279 lyxerr[Debug::GUI] << "GuiWorkArea::dropEvent: got URIs!" << endl;
280 for (int i = 0; i!=files.size(); ++i) {
281 string const file = os::internal_path(fromqstr(files.at(i).toLocalFile()));
283 dispatch(FuncRequest(LFUN_FILE_OPEN, file));
288 void GuiWorkArea::focusInEvent(QFocusEvent * /*event*/)
290 startBlinkingCursor();
294 void GuiWorkArea::focusOutEvent(QFocusEvent * /*event*/)
296 stopBlinkingCursor();
300 void GuiWorkArea::mousePressEvent(QMouseEvent * e)
302 if (dc_event_.active && dc_event_ == *e) {
303 dc_event_.active = false;
304 FuncRequest cmd(LFUN_MOUSE_TRIPLE,
305 dc_event_.x, dc_event_.y,
306 q_button_state(dc_event_.state));
311 FuncRequest const cmd(LFUN_MOUSE_PRESS, e->x(), e->y(),
312 q_button_state(e->button()));
317 void GuiWorkArea::mouseReleaseEvent(QMouseEvent * e)
319 if (synthetic_mouse_event_.timeout.running())
320 synthetic_mouse_event_.timeout.stop();
322 FuncRequest const cmd(LFUN_MOUSE_RELEASE, e->x(), e->y(),
323 q_button_state(e->button()));
328 void GuiWorkArea::mouseMoveEvent(QMouseEvent * e)
330 FuncRequest cmd(LFUN_MOUSE_MOTION, e->x(), e->y(),
331 q_motion_state(e->button()));
333 // If we're above or below the work area...
334 if (e->y() <= 20 || e->y() >= viewport()->height() - 20) {
335 // Make sure only a synthetic event can cause a page scroll,
336 // so they come at a steady rate:
338 // _Force_ a scroll up:
341 cmd.y = viewport()->height();
342 // Store the event, to be handled when the timeout expires.
343 synthetic_mouse_event_.cmd = cmd;
345 if (synthetic_mouse_event_.timeout.running())
346 // Discard the event. Note that it _may_ be handled
347 // when the timeout expires if
348 // synthetic_mouse_event_.cmd has not been overwritten.
349 // Ie, when the timeout expires, we handle the
350 // most recent event but discard all others that
351 // occurred after the one used to start the timeout
352 // in the first place.
355 synthetic_mouse_event_.restart_timeout = true;
356 synthetic_mouse_event_.timeout.start();
357 // Fall through to handle this event...
360 } else if (synthetic_mouse_event_.timeout.running()) {
361 // Store the event, to be possibly handled when the timeout
363 // Once the timeout has expired, normal control is returned
364 // to mouseMoveEvent (restart_timeout = false).
365 // This results in a much smoother 'feel' when moving the
366 // mouse back into the work area.
367 synthetic_mouse_event_.cmd = cmd;
368 synthetic_mouse_event_.restart_timeout = false;
372 // Has anything changed on-screen since the last QMouseEvent
374 double const scrollbar_value = verticalScrollBar()->value();
375 if (e->x() != synthetic_mouse_event_.x_old ||
376 e->y() != synthetic_mouse_event_.y_old ||
377 scrollbar_value != synthetic_mouse_event_.scrollbar_value_old) {
378 // Yes it has. Store the params used to check this.
379 synthetic_mouse_event_.x_old = e->x();
380 synthetic_mouse_event_.y_old = e->y();
381 synthetic_mouse_event_.scrollbar_value_old = scrollbar_value;
383 // ... and dispatch the event to the LyX core.
389 void GuiWorkArea::wheelEvent(QWheelEvent * e)
391 // Wheel rotation by one notch results in a delta() of 120 (see
392 // documentation of QWheelEvent)
393 int const lines = qApp->wheelScrollLines() * e->delta() / 120;
394 verticalScrollBar()->setValue(verticalScrollBar()->value() -
395 lines * verticalScrollBar()->singleStep());
396 adjustViewWithScrollBar();
400 void GuiWorkArea::generateSyntheticMouseEvent()
402 // Set things off to generate the _next_ 'pseudo' event.
403 if (synthetic_mouse_event_.restart_timeout)
404 synthetic_mouse_event_.timeout.start();
406 // Has anything changed on-screen since the last timeout signal
408 double const scrollbar_value = verticalScrollBar()->value();
409 if (scrollbar_value != synthetic_mouse_event_.scrollbar_value_old) {
410 // Yes it has. Store the params used to check this.
411 synthetic_mouse_event_.scrollbar_value_old = scrollbar_value;
413 // ... and dispatch the event to the LyX core.
414 dispatch(synthetic_mouse_event_.cmd);
419 void GuiWorkArea::keyPressEvent(QKeyEvent * e)
421 lyxerr[Debug::KEY] << BOOST_CURRENT_FUNCTION
422 << " count=" << e->count()
423 << " text=" << fromqstr(e->text())
424 << " isAutoRepeat=" << e->isAutoRepeat()
425 << " key=" << e->key()
428 if (USE_EVENT_PRUNING) {
429 keyeventQueue_.push(boost::shared_ptr<QKeyEvent>(new QKeyEvent(*e)));
432 boost::shared_ptr<QLyXKeySym> sym(new QLyXKeySym);
434 processKeySym(sym, q_key_state(e->modifiers()));
439 // This is used only if USE_EVENT_PRUNING is defined...
440 void GuiWorkArea::keyeventTimeout()
442 bool handle_autos = true;
444 while (!keyeventQueue_.empty()) {
445 boost::shared_ptr<QKeyEvent> ev = keyeventQueue_.front();
447 // We never handle more than one auto repeated
448 // char in a list of queued up events.
449 if (!handle_autos && ev->isAutoRepeat()) {
450 keyeventQueue_.pop();
454 boost::shared_ptr<QLyXKeySym> sym(new QLyXKeySym);
457 lyxerr[Debug::GUI] << BOOST_CURRENT_FUNCTION
458 << " count=" << ev->count()
459 << " text=" << fromqstr(ev->text())
460 << " isAutoRepeat=" << ev->isAutoRepeat()
461 << " key=" << ev->key()
464 processKeySym(sym, q_key_state(ev->modifiers()));
465 keyeventQueue_.pop();
467 handle_autos = false;
470 // Restart the timer.
471 step_timer_.setSingleShot(true);
472 step_timer_.start(25);
476 void GuiWorkArea::mouseDoubleClickEvent(QMouseEvent * e)
478 dc_event_ = double_click(e);
480 if (!dc_event_.active)
483 dc_event_.active = false;
485 FuncRequest cmd(LFUN_MOUSE_DOUBLE,
486 dc_event_.x, dc_event_.y,
487 q_button_state(dc_event_.state));
492 void GuiWorkArea::resizeEvent(QResizeEvent * ev)
495 verticalScrollBar()->setPageStep(viewport()->height());
496 QAbstractScrollArea::resizeEvent(ev);
501 void GuiWorkArea::update(int x, int y, int w, int h)
503 viewport()->update(x, y, w, h);
507 void GuiWorkArea::doGreyOut(QLPainter & pain)
510 pain.fillRectangle(0, 0, width(), height(),
513 //if (!lyxrc.show_banner)
515 lyxerr << "show banner: " << lyxrc.show_banner << endl;
516 /// The text to be written on top of the pixmap
517 string const text = lyx_version ? lyx_version : "unknown";
518 string const file = support::libFileSearch("images", "banner", "ppm");
522 QPixmap pm(toqstr(file));
524 lyxerr << "could not load splash screen: '" << file << "'" << endl;
529 // The font used to display the version info
530 font.setStyleHint(QFont::SansSerif);
531 font.setWeight(QFont::Bold);
532 font.setPointSize(LyXFont::SIZE_NORMAL);
534 int const w = pm.width();
535 int const h = pm.height();
537 int x = (width() - w) / 2;
538 int y = (height() - h) / 2;
540 pain.drawPixmap(x, y, pm);
545 pain.setPen(QColor(255, 255, 0));
547 pain.drawText(x, y, toqstr(text));
551 void GuiWorkArea::paintEvent(QPaintEvent * ev)
554 lyxerr[Debug::GUI] << BOOST_CURRENT_FUNCTION
555 << "\n QWidget width\t" << this->width()
556 << "\n QWidget height\t" << this->height()
557 << "\n viewport width\t" << viewport()->width()
558 << "\n viewport height\t" << viewport()->height()
559 << "\n QPaintEvent x\t" << e->rect().x()
560 << "\n QPaintEvent y\t" << e->rect().y()
561 << "\n QPaintEvent w\t" << e->rect().width()
562 << "\n QPaintEvent h\t" << e->rect().height()
566 QRect const rc = ev->rect();
567 //lyxerr << "paintEvent begin: x: " << rc.x()
568 // << " y: " << rc.y()
569 // << " w: " << rc.width()
570 // << " h: " << rc.height() << endl;
573 lyxerr << "no bufferview" << endl;
578 if (rc.width() == 3) { // FIXME HACK
579 // Assume splash screen drawing is requested when
581 lyxerr << "splash screen requested" << endl;
582 QLPainter pain(viewport());
587 if (!buffer_view_->buffer()) {
588 lyxerr << "no buffer: " << endl;
589 QLPainter pain(viewport());
595 //lyxerr << "real drawing" << endl;
596 QLPainter pain(viewport());
597 paintText(*buffer_view_, pain);
602 void GuiWorkArea::expose(int x, int y, int w, int h)
608 void GuiWorkArea::showCursor(int x, int y, int h, CursorShape shape)
610 cursor_->setGeometry(x, y, 2, h);
611 cursor_->shape_ = shape;
617 void GuiWorkArea::removeCursor()
619 if (!qApp->focusWidget())
625 void GuiWorkArea::inputMethodEvent(QInputMethodEvent * e)
627 QString const & text = e->commitString();
628 if (!text.isEmpty()) {
630 lyxerr[Debug::KEY] << BOOST_CURRENT_FUNCTION
631 << " preeditString =" << fromqstr(e->preeditString())
632 << " commitString =" << fromqstr(e->commitString())
636 // needed to make math superscript work on some systems
637 // ideally, such special coding should not be necessary
639 key = Qt::Key_AsciiCircum;
640 // FIXME: Needs for investigation, this key is not really used,
641 // the ctor below just check if key is different from 0.
642 QKeyEvent ev(QEvent::KeyPress, key, Qt::NoModifier, text);
648 } // namespace frontend
651 #include "GuiWorkArea_moc.cpp"