2 * \file GuiWorkArea.cpp
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 "GuiPainter.h"
18 #include "GuiKeySymbol.h"
19 #include "qt_helpers.h"
21 #include "frontends/LyXView.h"
23 #include "BufferView.h"
26 #include "FuncRequest.h"
30 #include "support/filetools.h" // LibFileSearch
32 #include "graphics/GraphicsImage.h"
33 #include "graphics/GraphicsLoader.h"
35 #include <QInputContext>
37 #include <QMainWindow>
42 #include <boost/bind.hpp>
43 #include <boost/current_function.hpp>
47 extern "C" int XEventsQueued(Display *display, int mode);
51 int const CursorWidth = 2;
53 int const CursorWidth = 1;
64 using support::FileName;
66 /// return the LyX mouse button state from Qt's
67 static mouse_button::state q_button_state(Qt::MouseButton button)
69 mouse_button::state b = mouse_button::none;
72 b = mouse_button::button1;
75 b = mouse_button::button2;
78 b = mouse_button::button3;
87 /// return the LyX mouse button state from Qt's
88 mouse_button::state q_motion_state(Qt::MouseButtons state)
90 mouse_button::state b = mouse_button::none;
91 if (state & Qt::LeftButton)
92 b |= mouse_button::button1;
93 if (state & Qt::MidButton)
94 b |= mouse_button::button2;
95 if (state & Qt::RightButton)
96 b |= mouse_button::button3;
107 void draw(QPainter & painter)
109 if (show_ && rect_.isValid()) {
112 painter.fillRect(rect_.x(), rect_.y(), CursorWidth, rect_.height(), color_);
113 painter.setPen(color_);
114 painter.drawLine(rect_.bottomLeft().x() + CursorWidth, rect_.bottomLeft().y(),
115 rect_.bottomRight().x(), rect_.bottomLeft().y());
118 case REVERSED_L_SHAPE:
119 painter.fillRect(rect_.x() + rect_.height() / 3, rect_.y(), CursorWidth, rect_.height(), color_);
120 painter.setPen(color_);
121 painter.drawLine(rect_.bottomRight().x() - CursorWidth, rect_.bottomLeft().y(),
122 rect_.bottomLeft().x(), rect_.bottomLeft().y());
126 painter.fillRect(rect_, color_);
132 void update(int x, int y, int h, CursorShape shape)
134 color_ = guiApp->colorCache().get(Color::cursor);
138 rect_ = QRect(x, y, CursorWidth + h / 3, h);
140 case REVERSED_L_SHAPE:
141 rect_ = QRect(x - h / 3, y, CursorWidth + h / 3, h);
144 rect_ = QRect(x, y, CursorWidth, h);
149 void show(bool set_show = true) { show_ = set_show; }
150 void hide() { show_ = false; }
152 QRect const & rect() { return rect_; }
166 // This is a 'heartbeat' generating synthetic mouse move events when the
167 // cursor is at the top or bottom edge of the viewport. One scroll per 0.2 s
168 SyntheticMouseEvent::SyntheticMouseEvent()
169 : timeout(200), restart_timeout(true),
170 x_old(-1), y_old(-1), scrollbar_value_old(-1.0)
174 GuiWorkArea::GuiWorkArea(Buffer & buf, LyXView & lv)
175 : WorkArea(buf, lv), need_resize_(false), schedule_redraw_(false),
178 screen_ = QPixmap(viewport()->width(), viewport()->height());
179 cursor_ = new frontend::CursorWidget();
182 setVerticalScrollBarPolicy(Qt::ScrollBarAsNeeded);
183 setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
184 setAcceptDrops(true);
185 setMouseTracking(true);
186 setMinimumSize(100, 70);
188 viewport()->setAutoFillBackground(false);
189 // We don't need double-buffering nor SystemBackground on
190 // the viewport because we have our own backing pixmap.
191 viewport()->setAttribute(Qt::WA_NoSystemBackground);
193 setFocusPolicy(Qt::WheelFocus);
195 viewport()->setCursor(Qt::IBeamCursor);
197 synthetic_mouse_event_.timeout.timeout.connect(
198 boost::bind(&GuiWorkArea::generateSyntheticMouseEvent,
201 // Initialize the vertical Scroll Bar
202 QObject::connect(verticalScrollBar(), SIGNAL(actionTriggered(int)),
203 this, SLOT(adjustViewWithScrollBar(int)));
205 // disable context menu for the scrollbar
206 verticalScrollBar()->setContextMenuPolicy(Qt::NoContextMenu);
208 // PageStep only depends on the viewport height.
209 verticalScrollBar()->setPageStep(viewport()->height());
211 LYXERR(Debug::GUI) << BOOST_CURRENT_FUNCTION
212 << "\n Area width\t" << width()
213 << "\n Area height\t" << height()
214 << "\n viewport width\t" << viewport()->width()
215 << "\n viewport height\t" << viewport()->height()
218 // Enables input methods for asian languages.
219 // Must be set when creating custom text editing widgets.
220 setAttribute(Qt::WA_InputMethodEnabled, true);
224 void GuiWorkArea::setScrollbarParams(int h, int scroll_pos, int scroll_line_step)
226 if (verticalScrollBarPolicy() != Qt::ScrollBarAlwaysOn)
227 setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOn);
229 verticalScrollBar()->setTracking(false);
231 // do what cursor movement does (some grey)
233 int scroll_max_ = std::max(0, h - height());
235 verticalScrollBar()->setRange(0, scroll_max_);
236 verticalScrollBar()->setSliderPosition(scroll_pos);
237 verticalScrollBar()->setSingleStep(scroll_line_step);
238 verticalScrollBar()->setValue(scroll_pos);
240 verticalScrollBar()->setTracking(true);
244 void GuiWorkArea::adjustViewWithScrollBar(int)
246 scrollBufferView(verticalScrollBar()->sliderPosition());
247 QApplication::syncX();
251 void GuiWorkArea::focusInEvent(QFocusEvent * /*event*/)
253 // No need to do anything if we didn't change views...
254 // if (theApp() == 0 || &lyx_view_ == theApp()->currentView())
257 theApp()->setCurrentView(*lyx_view_);
259 // Repaint the whole screen.
260 // Note: this is different from redraw() as only the backing pixmap
261 // will be redrawn, which is cheap.
262 viewport()->repaint();
264 startBlinkingCursor();
268 void GuiWorkArea::focusOutEvent(QFocusEvent * /*event*/)
270 stopBlinkingCursor();
274 void GuiWorkArea::mousePressEvent(QMouseEvent * e)
276 if (dc_event_.active && dc_event_ == *e) {
277 dc_event_.active = false;
278 FuncRequest cmd(LFUN_MOUSE_TRIPLE,
280 q_button_state(e->button()));
285 inputContext()->reset();
287 FuncRequest const cmd(LFUN_MOUSE_PRESS, e->x(), e->y(),
288 q_button_state(e->button()));
289 dispatch(cmd, q_key_state(e->modifiers()));
293 void GuiWorkArea::mouseReleaseEvent(QMouseEvent * e)
295 if (synthetic_mouse_event_.timeout.running())
296 synthetic_mouse_event_.timeout.stop();
298 FuncRequest const cmd(LFUN_MOUSE_RELEASE, e->x(), e->y(),
299 q_button_state(e->button()));
304 void GuiWorkArea::mouseMoveEvent(QMouseEvent * e)
306 // we kill the triple click if we move
307 doubleClickTimeout();
308 FuncRequest cmd(LFUN_MOUSE_MOTION, e->x(), e->y(),
309 q_motion_state(e->buttons()));
311 // If we're above or below the work area...
312 if (e->y() <= 20 || e->y() >= viewport()->height() - 20) {
313 // Make sure only a synthetic event can cause a page scroll,
314 // so they come at a steady rate:
316 // _Force_ a scroll up:
319 cmd.y = viewport()->height();
320 // Store the event, to be handled when the timeout expires.
321 synthetic_mouse_event_.cmd = cmd;
323 if (synthetic_mouse_event_.timeout.running())
324 // Discard the event. Note that it _may_ be handled
325 // when the timeout expires if
326 // synthetic_mouse_event_.cmd has not been overwritten.
327 // Ie, when the timeout expires, we handle the
328 // most recent event but discard all others that
329 // occurred after the one used to start the timeout
330 // in the first place.
333 synthetic_mouse_event_.restart_timeout = true;
334 synthetic_mouse_event_.timeout.start();
335 // Fall through to handle this event...
338 } else if (synthetic_mouse_event_.timeout.running()) {
339 // Store the event, to be possibly handled when the timeout
341 // Once the timeout has expired, normal control is returned
342 // to mouseMoveEvent (restart_timeout = false).
343 // This results in a much smoother 'feel' when moving the
344 // mouse back into the work area.
345 synthetic_mouse_event_.cmd = cmd;
346 synthetic_mouse_event_.restart_timeout = false;
350 // Has anything changed on-screen since the last QMouseEvent
352 double const scrollbar_value = verticalScrollBar()->value();
353 if (e->x() != synthetic_mouse_event_.x_old ||
354 e->y() != synthetic_mouse_event_.y_old ||
355 scrollbar_value != synthetic_mouse_event_.scrollbar_value_old) {
356 // Yes it has. Store the params used to check this.
357 synthetic_mouse_event_.x_old = e->x();
358 synthetic_mouse_event_.y_old = e->y();
359 synthetic_mouse_event_.scrollbar_value_old = scrollbar_value;
361 // ... and dispatch the event to the LyX core.
367 void GuiWorkArea::wheelEvent(QWheelEvent * e)
369 // Wheel rotation by one notch results in a delta() of 120 (see
370 // documentation of QWheelEvent)
371 int const lines = qApp->wheelScrollLines() * e->delta() / 120;
372 verticalScrollBar()->setValue(verticalScrollBar()->value() -
373 lines * verticalScrollBar()->singleStep());
374 adjustViewWithScrollBar();
378 void GuiWorkArea::generateSyntheticMouseEvent()
380 // Set things off to generate the _next_ 'pseudo' event.
381 if (synthetic_mouse_event_.restart_timeout)
382 synthetic_mouse_event_.timeout.start();
384 // Has anything changed on-screen since the last timeout signal
386 double const scrollbar_value = verticalScrollBar()->value();
387 if (scrollbar_value != synthetic_mouse_event_.scrollbar_value_old) {
388 // Yes it has. Store the params used to check this.
389 synthetic_mouse_event_.scrollbar_value_old = scrollbar_value;
391 // ... and dispatch the event to the LyX core.
392 dispatch(synthetic_mouse_event_.cmd);
397 void GuiWorkArea::keyPressEvent(QKeyEvent * e)
399 // do nothing if there are other events
400 // (the auto repeated events come too fast)
401 // \todo FIXME: remove hard coded Qt keys, process the key binding
403 if (XEventsQueued(QX11Info::display(), 0) > 1 && e->isAutoRepeat()
404 && (Qt::Key_PageDown || Qt::Key_PageUp)) {
406 << BOOST_CURRENT_FUNCTION << endl
407 << "system is busy: scroll key event ignored" << endl;
413 LYXERR(Debug::KEY) << BOOST_CURRENT_FUNCTION
414 << " count=" << e->count()
415 << " text=" << fromqstr(e->text())
416 << " isAutoRepeat=" << e->isAutoRepeat()
417 << " key=" << e->key()
420 boost::shared_ptr<GuiKeySymbol> sym(new GuiKeySymbol);
422 processKeySym(sym, q_key_state(e->modifiers()));
426 void GuiWorkArea::doubleClickTimeout()
428 dc_event_.active = false;
432 void GuiWorkArea::mouseDoubleClickEvent(QMouseEvent * e)
434 dc_event_ = double_click(e);
435 QTimer::singleShot(QApplication::doubleClickInterval(), this,
436 SLOT(doubleClickTimeout()));
437 FuncRequest cmd(LFUN_MOUSE_DOUBLE,
439 q_button_state(e->button()));
444 void GuiWorkArea::resizeEvent(QResizeEvent * ev)
446 QAbstractScrollArea::resizeEvent(ev);
451 void GuiWorkArea::update(int x, int y, int w, int h)
453 viewport()->repaint(x, y, w, h);
457 void GuiWorkArea::paintEvent(QPaintEvent * ev)
459 QRect const rc = ev->rect();
461 LYXERR(Debug::PAINTING) << "paintEvent begin: x: " << rc.x()
463 << " w: " << rc.width()
464 << " h: " << rc.height() << endl;
468 verticalScrollBar()->setPageStep(viewport()->height());
469 screen_ = QPixmap(viewport()->width(), viewport()->height());
472 WorkArea::hideCursor();
473 WorkArea::showCursor();
474 need_resize_ = false;
477 QPainter pain(viewport());
478 pain.drawPixmap(rc, screen_, rc);
483 void GuiWorkArea::expose(int x, int y, int w, int h)
490 void GuiWorkArea::updateScreen()
492 GuiPainter pain(&screen_);
493 verticalScrollBar()->show();
494 buffer_view_->draw(pain);
498 void GuiWorkArea::showCursor(int x, int y, int h, CursorShape shape)
500 if (schedule_redraw_) {
501 buffer_view_->update(Update::Force);
503 viewport()->update(QRect(0, 0, viewport()->width(), viewport()->height()));
504 schedule_redraw_ = false;
505 // Show the cursor immediately after the update.
511 cursor_->update(x, y, h, shape);
513 viewport()->update(cursor_->rect());
517 void GuiWorkArea::removeCursor()
520 //if (!qApp->focusWidget())
521 viewport()->update(cursor_->rect());
525 void GuiWorkArea::inputMethodEvent(QInputMethodEvent * e)
527 QString const & commit_string = e->commitString();
528 docstring const & preedit_string
529 = qstring_to_ucs4(e->preeditString());
531 if (!commit_string.isEmpty()) {
533 LYXERR(Debug::KEY) << BOOST_CURRENT_FUNCTION
534 << " preeditString =" << fromqstr(e->preeditString())
535 << " commitString =" << fromqstr(e->commitString())
540 // FIXME Iwami 04/01/07: we should take care also of UTF16 surrogates here.
541 for (int i = 0; i < commit_string.size(); ++i) {
542 QKeyEvent ev(QEvent::KeyPress, key, Qt::NoModifier, commit_string[i]);
547 // Hide the cursor during the kana-kanji transformation.
548 if (preedit_string.empty())
549 startBlinkingCursor();
551 stopBlinkingCursor();
553 // last_width : for checking if last preedit string was/wasn't empty.
554 static bool last_width = false;
555 if (!last_width && preedit_string.empty()) {
556 // if last_width is last length of preedit string.
561 GuiPainter pain(&screen_);
562 buffer_view_->updateMetrics(false);
563 buffer_view_->draw(pain);
564 Font font = buffer_view_->cursor().getFont();
565 FontMetrics const & fm = theFontMetrics(font);
566 int height = fm.maxHeight();
567 int cur_x = cursor_->rect().left();
568 int cur_y = cursor_->rect().bottom();
570 // redraw area of preedit string.
571 update(0, cur_y - height, GuiWorkArea::width(),
572 (height + 1) * preedit_lines_);
574 if (preedit_string.empty()) {
582 // att : stores an IM attribute.
583 QList<QInputMethodEvent::Attribute> const & att = e->attributes();
585 // get attributes of input method cursor.
586 // cursor_pos : cursor position in preedit string.
587 size_t cursor_pos = 0;
588 bool cursor_is_visible = false;
589 for (int i = 0; i < att.size(); ++i) {
590 if (att.at(i).type == QInputMethodEvent::Cursor) {
591 cursor_pos = att.at(i).start;
592 cursor_is_visible = att.at(i).length != 0;
597 size_t preedit_length = preedit_string.length();
599 // get position of selection in input method.
600 // FIXME: isn't there a way to do this simplier?
601 // rStart : cursor position in selected string in IM.
603 // rLength : selected string length in IM.
605 if (cursor_pos < preedit_length) {
606 for (int i = 0; i < att.size(); ++i) {
607 if (att.at(i).type == QInputMethodEvent::TextFormat) {
608 if (att.at(i).start <= int(cursor_pos)
609 && int(cursor_pos) < att.at(i).start + att.at(i).length) {
610 rStart = att.at(i).start;
611 rLength = att.at(i).length;
612 if (!cursor_is_visible)
613 cursor_pos += rLength;
624 int const right_margin = rightMargin();
625 Painter::preedit_style ps;
626 // Most often there would be only one line:
628 for (size_t pos = 0; pos != preedit_length; ++pos) {
629 char_type const typed_char = preedit_string[pos];
630 // reset preedit string style
631 ps = Painter::preedit_default;
633 // if we reached the right extremity of the screen, go to next line.
634 if (cur_x + fm.width(typed_char) > GuiWorkArea::width() - right_margin) {
635 cur_x = right_margin;
639 // preedit strings are displayed with dashed underline
640 // and partial strings are displayed white on black indicating
641 // that we are in selecting mode in the input method.
642 // FIXME: rLength == preedit_length is not a changing condition
643 // FIXME: should be put out of the loop.
645 && pos < rStart + rLength
646 && !(cursor_pos < rLength && rLength == preedit_length))
647 ps = Painter::preedit_selecting;
649 if (pos == cursor_pos
650 && (cursor_pos < rLength && rLength == preedit_length))
651 ps = Painter::preedit_cursor;
653 // draw one character and update cur_x.
654 cur_x += pain.preeditText(cur_x, cur_y, typed_char, font, ps);
657 // update the preedit string screen area.
658 update(0, cur_y - preedit_lines_*height, GuiWorkArea::width(),
659 (height + 1) * preedit_lines_);
661 // Don't forget to accept the event!
666 QVariant GuiWorkArea::inputMethodQuery(Qt::InputMethodQuery query) const
668 QRect cur_r(0,0,0,0);
670 // this is the CJK-specific composition window position.
671 case Qt::ImMicroFocus:
672 cur_r = cursor_->rect();
673 if (preedit_lines_ != 1)
675 cur_r.moveBottom(cur_r.bottom() + cur_r.height() * preedit_lines_);
676 // return lower right of cursor in LyX.
679 return QWidget::inputMethodQuery(query);
683 } // namespace frontend
686 #include "GuiWorkArea_moc.cpp"