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 <boost/current_function.hpp>
16 #include "QWorkArea.h"
17 #include "QLPainter.h"
18 #include "QLyXKeySym.h"
20 #include "lcolorcache.h"
21 #include "qt_helpers.h"
22 #include "BufferView.h"
24 #include "funcrequest.h"
26 #include "support/os.h"
28 #include <QApplication>
31 #include <QMainWindow>
34 #include <QDragEnterEvent>
39 #include <boost/bind.hpp>
41 ///////////////////////////////////////////////////////////////
48 #include <Carbon/Carbon.h>
49 #include <support/lstrings.h>
50 using lyx::support::subst;
53 // You can find other qt-immodule, X11 and MACX specific stuff
54 // at the end of this file...
55 ///////////////////////////////////////////////////////////////
60 namespace os = lyx::support::os;
64 QWorkArea * wa_ptr = 0;
66 /// return the LyX key state from Qt's
67 key_modifier::state q_key_state(Qt::ButtonState state)
69 key_modifier::state k = key_modifier::none;
70 if (state & Qt::ControlModifier)
71 k |= key_modifier::ctrl;
72 if (state & Qt::ShiftModifier)
73 k |= key_modifier::shift;
74 if (state & Qt::AltModifier)
75 k |= key_modifier::alt;
80 /// return the LyX mouse button state from Qt's
81 mouse_button::state q_button_state(Qt::ButtonState button)
83 mouse_button::state b = mouse_button::none;
86 b = mouse_button::button1;
89 b = mouse_button::button2;
92 b = mouse_button::button3;
101 /// return the LyX mouse button state from Qt's
102 mouse_button::state q_motion_state(Qt::ButtonState state)
104 mouse_button::state b = mouse_button::none;
105 if (state & Qt::LeftButton)
106 b |= mouse_button::button1;
107 if (state & Qt::MidButton)
108 b |= mouse_button::button2;
109 if (state & Qt::RightButton)
110 b |= mouse_button::button3;
116 // This is a 'heartbeat' generating synthetic mouse move events when the
117 // cursor is at the top or bottom edge of the viewport. One scroll per 0.2 s
118 SyntheticMouseEvent::SyntheticMouseEvent()
119 : timeout(200), restart_timeout(true),
120 x_old(-1), y_old(-1), scrollbar_value_old(-1.0)
124 QWorkArea::QWorkArea(LyXView & owner, int w, int h)
125 : QAbstractScrollArea(qApp->mainWidget()), WorkArea(), view_(owner), painter_(this)
127 setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOn);
128 setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
130 (static_cast<QMainWindow*>(qApp->mainWidget()))->setCentralWidget(this);
132 setAcceptDrops(true);
134 setMinimumSize(100, 70);
136 viewport()->setAutoFillBackground(false);
137 viewport()->setAttribute(Qt::WA_OpaquePaintEvent);
139 viewport()->setFocusPolicy(Qt::WheelFocus);
140 viewport()->setFocus();
141 setFocusPolicy(Qt::WheelFocus);
143 viewport()->setCursor(Qt::IBeamCursor);
150 synthetic_mouse_event_.timeout.timeout.connect(
151 boost::bind(&QWorkArea::generateSyntheticMouseEvent,
154 // Initialize the vertical Scroll Bar
155 QObject::connect(verticalScrollBar(), SIGNAL(actionTriggered(int)),
156 this, SLOT(adjustViewWithScrollBar(int)));
158 // PageStep only depends on the viewport height.
159 verticalScrollBar()->setPageStep(workHeight_);
161 lyxerr[Debug::GUI] << BOOST_CURRENT_FUNCTION
162 << "\n Area width\t" << width()
163 << "\n Area height\t" << height()
164 << "\n viewport width\t" << viewport()->width()
165 << "\n viewport height\t" << viewport()->height()
169 // This is the keyboard buffering stuff...
170 // I don't see any need for this under windows. The keyboard is reactive
173 if ( !QObject::connect(&step_timer_, SIGNAL(timeout()),
174 this, SLOT(keyeventTimeout())) )
175 lyxerr[Debug::GUI] << "ERROR: keyeventTimeout cannot connect!" << endl;
177 // Start the timer, one-shot.
178 step_timer_.start(50, true);
181 ///////////////////////////////////////////////////////////////////////
182 // Specific stuff goes here...
184 #if USE_INPUT_METHODS
185 // to make qt-immodule work
186 setInputMethodEnabled(true);
190 // doubleClickInterval() is 400 ms on X11 witch is just too long.
191 // On Windows and Mac OS X, the operating system's value is used.
192 // On Microsoft Windows, calling this function sets the double
193 // click interval for all applications. So we don't!
194 QApplication::setDoubleClickInterval(300);
202 QWorkArea::~QWorkArea()
206 void QWorkArea::setScrollbarParams(int h, int scroll_pos, int scroll_line_step)
208 // do what cursor movement does (some grey)
210 int scroll_max_ = std::max(0, h - height());
212 verticalScrollBar()->setRange(0, scroll_max_);
213 verticalScrollBar()->setSliderPosition(scroll_pos);
214 verticalScrollBar()->setLineStep(scroll_line_step);
217 void QWorkArea::adjustViewWithScrollBar(int action)
220 lyxerr[Debug::GUI] << BOOST_CURRENT_FUNCTION
221 << " verticalScrollBar val=" << verticalScrollBar()->value()
222 << " verticalScrollBar pos=" << verticalScrollBar()->sliderPosition()
223 << " min=" << verticalScrollBar()->minimum()
224 << " max=" << verticalScrollBar()->maximum()
225 << " pagestep=" << verticalScrollBar()->pageStep()
226 << " linestep=" << verticalScrollBar()->lineStep()
229 view_.view()->scrollDocView(verticalScrollBar()->sliderPosition());
233 void QWorkArea::haveSelection(bool own) const
235 /// \todo ask X11 and MAC devels why this wa_ptr is useful.
236 wa_ptr = const_cast<QWorkArea*>(this);
238 if (!QApplication::clipboard()->supportsSelection())
242 QApplication::clipboard()->setText(QString(), QClipboard::Selection);
244 // We don't need to do anything if own = false, as this case is
249 string const QWorkArea::getClipboard() const
251 QString str = QApplication::clipboard()->text(QClipboard::Selection);
252 lyxerr[Debug::ACTION] << "getClipboard: " << (const char*) str << endl;
256 // The MAC clipboard uses \r for lineendings, and we use \n
257 return subst(fromqstr(str), '\r', '\n');
259 return fromqstr(str);
264 void QWorkArea::putClipboard(string const & str) const
267 // The MAC clipboard uses \r for lineendings, and we use \n
268 QApplication::clipboard()->setText(toqstr(subst(str, '\n', '\r')),
269 QClipboard::Selection);
271 QApplication::clipboard()->setText(toqstr(str), QClipboard::Selection);
273 lyxerr[Debug::ACTION] << "putClipboard: " << str << endl;
277 void QWorkArea::dragEnterEvent(QDragEnterEvent * event)
279 if (event->mimeData()->hasUrls())
281 /// \todo Ask lyx-devel is this is enough:
282 /// if (event->mimeData()->hasFormat("text/plain"))
283 /// event->acceptProposedAction();
288 void QWorkArea::dropEvent(QDropEvent* event)
290 QList<QUrl> files = event->mimeData()->urls();
294 lyxerr[Debug::GUI] << "QWorkArea::dropEvent: got URIs!" << endl;
295 for (int i = 0; i!=files.size(); ++i) {
296 string const file = os::internal_path(fromqstr(files.at(i).toString()));
298 view_.view()->workAreaDispatch(FuncRequest(LFUN_FILE_OPEN, file));
303 void QWorkArea::mousePressEvent(QMouseEvent * e)
305 if (dc_event_.active && dc_event_ == *e) {
306 dc_event_.active = false;
307 FuncRequest cmd(LFUN_MOUSE_TRIPLE,
308 dc_event_.x, dc_event_.y,
309 q_button_state(dc_event_.state));
310 view_.view()->workAreaDispatch(cmd);
314 FuncRequest const cmd(LFUN_MOUSE_PRESS, e->x(), e->y(),
315 q_button_state(e->button()));
316 view_.view()->workAreaDispatch(cmd);
320 void QWorkArea::mouseReleaseEvent(QMouseEvent * e)
322 if (synthetic_mouse_event_.timeout.running())
323 synthetic_mouse_event_.timeout.stop();
325 FuncRequest const cmd(LFUN_MOUSE_RELEASE, e->x(), e->y(),
326 q_button_state(e->button()));
327 view_.view()->workAreaDispatch(cmd);
331 void QWorkArea::mouseMoveEvent(QMouseEvent * e)
333 FuncRequest cmd(LFUN_MOUSE_MOTION, e->x(), e->y(),
334 q_motion_state(e->state()));
336 // If we're above or below the work area...
337 if (e->y() <= 20 || e->y() >= viewport()->height() - 20) {
338 // Make sure only a synthetic event can cause a page scroll,
339 // so they come at a steady rate:
341 // _Force_ a scroll up:
344 cmd.y = viewport()->height();
345 // Store the event, to be handled when the timeout expires.
346 synthetic_mouse_event_.cmd = cmd;
348 if (synthetic_mouse_event_.timeout.running())
349 // Discard the event. Note that it _may_ be handled
350 // when the timeout expires if
351 // synthetic_mouse_event_.cmd has not been overwritten.
352 // Ie, when the timeout expires, we handle the
353 // most recent event but discard all others that
354 // occurred after the one used to start the timeout
355 // in the first place.
358 synthetic_mouse_event_.restart_timeout = true;
359 synthetic_mouse_event_.timeout.start();
360 // Fall through to handle this event...
363 } else if (synthetic_mouse_event_.timeout.running()) {
364 // Store the event, to be possibly handled when the timeout
366 // Once the timeout has expired, normal control is returned
367 // to mouseMoveEvent (restart_timeout = false).
368 // This results in a much smoother 'feel' when moving the
369 // mouse back into the work area.
370 synthetic_mouse_event_.cmd = cmd;
371 synthetic_mouse_event_.restart_timeout = false;
375 // Has anything changed on-screen since the last QMouseEvent
377 double const scrollbar_value = verticalScrollBar()->value();
378 if (e->x() != synthetic_mouse_event_.x_old ||
379 e->y() != synthetic_mouse_event_.y_old ||
380 scrollbar_value != synthetic_mouse_event_.scrollbar_value_old) {
381 // Yes it has. Store the params used to check this.
382 synthetic_mouse_event_.x_old = e->x();
383 synthetic_mouse_event_.y_old = e->y();
384 synthetic_mouse_event_.scrollbar_value_old = scrollbar_value;
386 // ... and dispatch the event to the LyX core.
387 view_.view()->workAreaDispatch(cmd);
392 void QWorkArea::wheelEvent(QWheelEvent * e)
394 // Wheel rotation by one notch results in a delta() of 120 (see
395 // documentation of QWheelEvent)
396 int const lines = QApplication::wheelScrollLines() * e->delta() / 120;
397 verticalScrollBar()->setValue(verticalScrollBar()->value() -
398 lines * verticalScrollBar()->lineStep());
399 adjustViewWithScrollBar();
403 void QWorkArea::generateSyntheticMouseEvent()
405 // Set things off to generate the _next_ 'pseudo' event.
406 if (synthetic_mouse_event_.restart_timeout)
407 synthetic_mouse_event_.timeout.start();
409 // Has anything changed on-screen since the last timeout signal
411 double const scrollbar_value = verticalScrollBar()->value();
412 if (scrollbar_value != synthetic_mouse_event_.scrollbar_value_old) {
413 // Yes it has. Store the params used to check this.
414 synthetic_mouse_event_.scrollbar_value_old = scrollbar_value;
416 // ... and dispatch the event to the LyX core.
417 view_.view()->workAreaDispatch(synthetic_mouse_event_.cmd);
421 void QWorkArea::keyPressEvent(QKeyEvent * e)
423 lyxerr[Debug::KEY] << BOOST_CURRENT_FUNCTION
424 << " count=" << e->count()
425 << " text=" << (const char *) e->text()
426 << " isAutoRepeat=" << e->isAutoRepeat()
427 << " key=" << e->key()
430 // keyeventQueue_.push(boost::shared_ptr<QKeyEvent>(new QKeyEvent(*e)));
432 boost::shared_ptr<QLyXKeySym> sym(new QLyXKeySym);
434 view_.view()->workAreaKeyPress(sym, q_key_state(e->state()));
438 // This is not used for now...
439 void QWorkArea::keyeventTimeout()
441 bool handle_autos = true;
443 while (!keyeventQueue_.empty()) {
444 boost::shared_ptr<QKeyEvent> ev = keyeventQueue_.front();
446 // We never handle more than one auto repeated
447 // char in a list of queued up events.
448 if (!handle_autos && ev->isAutoRepeat()) {
449 keyeventQueue_.pop();
453 boost::shared_ptr<QLyXKeySym> sym(new QLyXKeySym);
456 lyxerr[Debug::GUI] << BOOST_CURRENT_FUNCTION
457 << " count=" << ev->count()
458 << " text=" << (const char *) ev->text()
459 << " isAutoRepeat=" << ev->isAutoRepeat()
460 << " key=" << ev->key()
463 view_.view()->workAreaKeyPress(sym, q_key_state(ev->state()));
464 keyeventQueue_.pop();
466 handle_autos = false;
469 // Restart the timer.
470 step_timer_.start(25, true);
474 void QWorkArea::mouseDoubleClickEvent(QMouseEvent * e)
476 dc_event_ = double_click(e);
478 if (!dc_event_.active)
481 dc_event_.active = false;
483 FuncRequest cmd(LFUN_MOUSE_DOUBLE,
484 dc_event_.x, dc_event_.y,
485 q_button_state(dc_event_.state));
486 view_.view()->workAreaDispatch(cmd);
490 void QWorkArea::resizeEvent(QResizeEvent * resizeEvent)
492 workWidth_ = viewport()->width();
493 workHeight_ = viewport()->height();
495 verticalScrollBar()->setPageStep(viewport()->height());
497 // screen_device_ = QPixmap(viewport()->width(), viewport()->height());
498 // paint_device_ = QImage(viewport()->width(), viewport()->height(), QImage::Format_RGB32);
499 paint_device_ = QPixmap(viewport()->width(), viewport()->height());
501 view_.view()->workAreaResize();
504 lyxerr[Debug::GUI] << BOOST_CURRENT_FUNCTION
505 << "\n QWidget width\t" << this->QWidget::width()
506 << "\n QWidget height\t" << this->QWidget::height()
507 << "\n viewport width\t" << viewport()->width()
508 << "\n viewport height\t" << viewport()->height()
509 << "\n QResizeEvent rect left\t" << rect().left()
510 << "\n QResizeEvent rect right\t" << rect().right()
515 void QWorkArea::update(int x, int y, int w, int h)
517 //screen_device_.fromImage(paint_device_);
518 //QPainter q(&screen_device_);
519 //q.drawImage(x, y, paint_device_.copy(x, y, w, h));
521 viewport()->update(x, y, w, h);
524 void QWorkArea::paintEvent(QPaintEvent * e)
527 lyxerr[Debug::GUI] << BOOST_CURRENT_FUNCTION
528 << "\n QWidget width\t" << this->width()
529 << "\n QWidget height\t" << this->height()
530 << "\n viewport width\t" << viewport()->width()
531 << "\n viewport height\t" << viewport()->height()
532 << "\n pixmap width\t" << pixmap_->width()
533 << "\n pixmap height\t" << pixmap_->height()
534 << "\n QPaintEvent x\t" << e->rect().x()
535 << "\n QPaintEvent y\t" << e->rect().y()
536 << "\n QPaintEvent w\t" << e->rect().width()
537 << "\n QPaintEvent h\t" << e->rect().height()
540 QPainter q(viewport());
541 q.drawPixmap(e->rect(), paint_device_, e->rect());
544 q.drawPixmap(cursor_x_, cursor_y_, vcursor_);
547 q.drawPixmap(cursor_x_, cursor_y_ + cursor_h_ - 1, hcursor_);
551 QPixmap QWorkArea::copyScreen(int x, int y, int w, int h) const
553 return paint_device_.copy(x, y, w, h);
556 void QWorkArea::drawScreen(int x, int y, QPixmap pixmap)
558 QPainter q(&paint_device_);
559 q.drawPixmap(x, y, pixmap);
560 viewport()->update(x, y, pixmap.width(), pixmap.height());
563 ///////////////////////////////////////////////////////////////
564 // LyXSreen overloaded methods:
566 WorkArea & QWorkArea::workarea()
568 // return static_cast<QWorkArea &> (*this);
573 void QWorkArea::expose(int x, int y, int w, int h)
575 // lyxerr[Debug::GUI] << "expose " << w << 'x' << h
576 // << '+' << x << '+' << y << std::endl;
582 void QWorkArea::showCursor(int x, int y, int h, Cursor_Shape shape)
584 if (!qApp->focusWidget())
587 show_vcursor_ = true;
589 QColor const & required_color = lcolorcache.get(LColor::cursor);
591 if (x==cursor_x_ && y==cursor_y_ && h==cursor_h_
592 && cursor_color_ == required_color
593 && cursor_shape_ == shape) {
594 show_hcursor_ = lshape_cursor_;
595 viewport()->update(cursor_x_, cursor_y_, cursor_w_, cursor_h_);
599 // Cache the dimensions of the cursor.
603 cursor_color_ = required_color;
604 cursor_shape_ = shape;
606 switch (cursor_shape_) {
608 // FIXME the cursor width shouldn't be hard-coded!
610 lshape_cursor_ = false;
613 cursor_w_ = cursor_h_ / 3;
614 lshape_cursor_ = true;
616 case REVERSED_L_SHAPE:
617 cursor_w_ = cursor_h_ / 3;
618 cursor_x_ -= cursor_w_ - 1;
619 lshape_cursor_ = true;
623 // We cache two pixmaps:
624 // 1 the vertical line of the cursor.
625 // 2 the horizontal line of the L-shaped cursor (if necessary).
627 // Draw the new (vertical) cursor.
628 vcursor_ = QPixmap(cursor_w_, cursor_h_);
629 vcursor_.fill(cursor_color_);
631 // Draw the new (horizontal) cursor if necessary.
632 if (lshape_cursor_) {
633 hcursor_ = QPixmap(cursor_w_, 1);
634 hcursor_.fill(cursor_color_);
635 show_hcursor_ = true;
638 viewport()->update(cursor_x_, cursor_y_, cursor_w_, cursor_h_);
642 void QWorkArea::removeCursor()
644 show_vcursor_ = false;
645 show_hcursor_ = false;
647 viewport()->update(cursor_x_, cursor_y_, cursor_w_, cursor_h_);
650 ///////////////////////////////////////////////////////////////
651 ///////////////////////////////////////////////////////////////
654 ////////////////////////////////////////////////////////////////////////
655 // qt-immodule specific stuff goes here...
657 #if USE_INPUT_METHODS
658 // to make qt-immodule work
660 void QWorkArea::inputMethodEvent(QInputMethodEvent * e)
662 QString const text = e->text();
663 if (!text.isEmpty()) {
665 // needed to make math superscript work on some systems
666 // ideally, such special coding should not be necessary
668 key = Qt::Key_AsciiCircum;
669 QKeyEvent ev(QEvent::KeyPress, key, *text.ascii(), 0, text);
677 ////////////////////////////////////////////////////////////////////////
678 // X11 specific stuff goes here...
681 bool lyxX11EventFilter(XEvent * xev)
684 case SelectionRequest:
685 lyxerr[Debug::GUI] << "X requested selection." << endl;
687 wa_ptr->view().view()->selectionRequested();
690 lyxerr[Debug::GUI] << "Lost selection." << endl;
692 wa_ptr->view().view()->selectionLost();
700 ////////////////////////////////////////////////////////////////////////
701 // Mac OSX specific stuff goes here...
705 OSErr checkAppleEventForMissingParams(const AppleEvent& theAppleEvent)
707 DescType returnedType;
709 OSErr err = AEGetAttributePtr(&theAppleEvent, keyMissedKeywordAttr,
710 typeWildCard, &returnedType, nil, 0,
713 case errAEDescNotFound:
716 return errAEEventNotHandled;
723 pascal OSErr handleOpenDocuments(const AppleEvent* inEvent,
724 AppleEvent* /*reply*/, long /*refCon*/)
727 AEDescList documentList;
728 OSErr err = AEGetParamDesc(inEvent, keyDirectObject, typeAEList,
733 err = checkAppleEventForMissingParams(*inEvent);
736 err = AECountItems(&documentList, &documentCount);
737 for (long documentIndex = 1;
738 err == noErr && documentIndex <= documentCount;
740 DescType returnedType;
745 err = AESizeOfNthItem(&documentList, documentIndex,
746 &returnedType, &actualSize);
748 err = AEGetNthPtr(&documentList, documentIndex,
750 &returnedType, (Ptr)&ref,
751 sizeof(FSRef), &actualSize);
753 FSRefMakePath(&ref, (UInt8*)qstr_buf,
755 s_arg=QString::fromUtf8(qstr_buf);
756 wa_ptr->view().view()->workAreaDispatch(
757 FuncRequest(LFUN_FILE_OPEN,
764 AEDisposeDesc(&documentList);
769 #include "QWorkArea_moc.cpp"