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"
15 #include "GuiWorkArea_Private.h"
17 #include "ColorCache.h"
18 #include "FontLoader.h"
19 #include "GuiApplication.h"
20 #include "GuiCompleter.h"
21 #include "GuiKeySymbol.h"
22 #include "GuiPainter.h"
25 #include "qt_helpers.h"
28 #include "BufferList.h"
29 #include "BufferParams.h"
30 #include "BufferView.h"
31 #include "CoordCache.h"
34 #include "FuncRequest.h"
35 #include "KeySymbol.h"
41 #include "TextMetrics.h"
45 #include "graphics/GraphicsImage.h"
46 #include "graphics/GraphicsLoader.h"
48 #include "support/convert.h"
49 #include "support/debug.h"
50 #include "support/lassert.h"
51 #include "support/TempFile.h"
53 #include "frontends/Application.h"
54 #include "frontends/FontMetrics.h"
55 #include "frontends/WorkAreaManager.h"
57 #include <QContextMenuEvent>
58 #if (QT_VERSION < 0x050000)
59 #include <QInputContext>
64 #include <QProxyStyle>
66 #include <QMainWindow>
72 #include <QStyleOption>
73 #include <QStylePainter>
75 #include <QToolButton>
82 int const TabIndicatorWidth = 3;
88 using namespace lyx::support;
93 /// return the LyX mouse button state from Qt's
94 static mouse_button::state q_button_state(Qt::MouseButton button)
96 mouse_button::state b = mouse_button::none;
99 b = mouse_button::button1;
102 b = mouse_button::button2;
104 case Qt::RightButton:
105 b = mouse_button::button3;
114 /// return the LyX mouse button state from Qt's
115 mouse_button::state q_motion_state(Qt::MouseButtons state)
117 mouse_button::state b = mouse_button::none;
118 if (state & Qt::LeftButton)
119 b |= mouse_button::button1;
120 if (state & Qt::MidButton)
121 b |= mouse_button::button2;
122 if (state & Qt::RightButton)
123 b |= mouse_button::button3;
132 CaretWidget() : rtl_(false), l_shape_(false), completable_(false),
133 x_(0), caret_width_(0)
136 void draw(QPainter & painter)
138 if (!rect_.isValid())
142 int l = x_ - rect_.left();
143 int r = rect_.right() - x_;
144 int bot = rect_.bottom();
146 // draw vertical line
147 painter.fillRect(x_, y, caret_width_, rect_.height(), color_);
149 // draw RTL/LTR indication
150 painter.setPen(color_);
153 painter.drawLine(x_, bot, x_ - l, bot);
155 painter.drawLine(x_, bot, x_ + caret_width_ + r, bot);
158 // draw completion triangle
160 int m = y + rect_.height() / 2;
161 int d = TabIndicatorWidth - 1;
163 painter.drawLine(x_ - 1, m - d, x_ - 1 - d, m);
164 painter.drawLine(x_ - 1, m + d, x_ - 1 - d, m);
166 painter.drawLine(x_ + caret_width_, m - d, x_ + caret_width_ + d, m);
167 painter.drawLine(x_ + caret_width_, m + d, x_ + caret_width_ + d, m);
172 void update(int x, int y, int h, bool l_shape,
173 bool rtl, bool completable)
175 color_ = guiApp->colorCache().get(Color_cursor);
178 completable_ = completable;
181 // extension to left and right
185 // RTL/LTR indication
193 // completion triangle
196 l = max(l, TabIndicatorWidth);
198 r = max(r, TabIndicatorWidth);
201 //FIXME: LyXRC::cursor_width should be caret_width
202 caret_width_ = lyxrc.cursor_width
204 : 1 + int((lyxrc.currentZoom + 50) / 200.0);
206 // compute overall rectangle
207 rect_ = QRect(x - l, y, caret_width_ + r + l, h);
210 QRect const & rect() { return rect_; }
213 /// caret is in RTL or LTR text
215 /// indication for RTL or LTR
217 /// triangle to show that a completion is available
221 /// rectangle, possibly with l_shape and completion triangle
223 /// x position (were the vertical line is drawn)
225 /// the width of the vertical blinking bar
230 // This is a 'heartbeat' generating synthetic mouse move events when the
231 // cursor is at the top or bottom edge of the viewport. One scroll per 0.2 s
232 SyntheticMouseEvent::SyntheticMouseEvent()
233 : timeout(200), restart_timeout(true)
237 GuiWorkArea::Private::Private(GuiWorkArea * parent)
238 : p(parent), buffer_view_(0), lyx_view_(0),
239 caret_(0), caret_visible_(false),
240 need_resize_(false), preedit_lines_(1),
241 last_pixel_ratio_(1.0),
242 completer_(new GuiCompleter(p, p)), dialog_mode_(false), shell_escape_(false),
243 read_only_(false), clean_(true), externally_modified_(false)
245 int const time = QApplication::cursorFlashTime() / 2;
247 caret_timeout_.setInterval(time);
248 caret_timeout_.start();
250 // let's initialize this just to be safe
251 caret_timeout_.setInterval(500);
256 GuiWorkArea::Private::~Private()
258 // If something is wrong with the buffer, we can ignore it safely
260 buffer_view_->buffer().workAreaManager().remove(p);
264 // Completer has a QObject parent and is thus automatically destroyed.
266 // delete completer_;
270 GuiWorkArea::GuiWorkArea(QWidget * /* w */)
271 : d(new Private(this))
273 new CompressorProxy(this); // not a leak
277 GuiWorkArea::GuiWorkArea(Buffer & buffer, GuiView & gv)
278 : d(new Private(this))
280 new CompressorProxy(this); // not a leak
282 buffer.params().display_pixel_ratio = theGuiApp()->pixelRatio();
288 double GuiWorkArea::pixelRatio() const
290 #if QT_VERSION >= 0x050000
291 return qt_scale_factor * devicePixelRatio();
298 void GuiWorkArea::init()
301 connect(&d->caret_timeout_, SIGNAL(timeout()),
302 this, SLOT(toggleCaret()));
304 // This connection is closed at the same time as this is destroyed.
305 d->synthetic_mouse_event_.timeout.timeout.connect([this](){
306 generateSyntheticMouseEvent();
310 // With Qt4.5 a mouse event will happen before the first paint event
311 // so make sure that the buffer view has an up to date metrics.
312 d->buffer_view_->resize(viewport()->width(), viewport()->height());
313 d->caret_ = new frontend::CaretWidget();
315 setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
316 setAcceptDrops(true);
317 setMouseTracking(true);
318 setMinimumSize(100, 70);
319 setFrameStyle(QFrame::NoFrame);
322 d->updateCursorShape();
324 // we paint our own background
325 viewport()->setAttribute(Qt::WA_OpaquePaintEvent);
327 setFocusPolicy(Qt::StrongFocus);
329 LYXERR(Debug::GUI, "viewport width: " << viewport()->width()
330 << " viewport height: " << viewport()->height());
332 // Enables input methods for asian languages.
333 // Must be set when creating custom text editing widgets.
334 setAttribute(Qt::WA_InputMethodEnabled, true);
338 GuiWorkArea::~GuiWorkArea()
344 void GuiWorkArea::Private::updateCursorShape()
346 bool const clickable = buffer_view_ && buffer_view_->clickableInset();
347 p->viewport()->setCursor(clickable ? Qt::PointingHandCursor
352 void GuiWorkArea::setGuiView(GuiView & gv)
358 void GuiWorkArea::setBuffer(Buffer & buffer)
360 delete d->buffer_view_;
361 d->buffer_view_ = new BufferView(buffer);
362 buffer.workAreaManager().add(this);
364 // HACK: Prevents an additional redraw when the scrollbar pops up
365 // which regularily happens on documents with more than one page.
366 // The policy should be set to "Qt::ScrollBarAsNeeded" soon.
367 // Since we have no geometry information yet, we assume that
368 // a document needs a scrollbar if there is more then four
369 // paragraph in the outermost text.
370 if (buffer.text().paragraphs().size() > 4)
371 setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOn);
372 QTimer::singleShot(50, this, SLOT(fixVerticalScrollBar()));
373 Q_EMIT bufferViewChanged();
377 void GuiWorkArea::fixVerticalScrollBar()
380 setVerticalScrollBarPolicy(Qt::ScrollBarAsNeeded);
384 void GuiWorkArea::close()
386 d->lyx_view_->removeWorkArea(this);
390 void GuiWorkArea::setFullScreen(bool full_screen)
392 d->buffer_view_->setFullScreen(full_screen);
393 setFrameStyle(QFrame::NoFrame);
395 setFrameStyle(QFrame::NoFrame);
396 if (lyxrc.full_screen_scrollbar)
397 setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
399 setVerticalScrollBarPolicy(Qt::ScrollBarAsNeeded);
403 BufferView & GuiWorkArea::bufferView()
405 return *d->buffer_view_;
409 BufferView const & GuiWorkArea::bufferView() const
411 return *d->buffer_view_;
415 void GuiWorkArea::stopBlinkingCaret()
417 d->caret_timeout_.stop();
422 void GuiWorkArea::startBlinkingCaret()
424 // do not show the cursor if the view is busy
430 d->buffer_view_->caretPosAndHeight(p, h);
431 // Don't start blinking if the cursor isn't on screen.
432 if (!d->buffer_view_->cursorInView(p, h))
437 //we're not supposed to cache this value.
438 int const time = QApplication::cursorFlashTime() / 2;
441 d->caret_timeout_.setInterval(time);
442 d->caret_timeout_.start();
446 void GuiWorkArea::toggleCaret()
448 if (d->caret_visible_)
455 void GuiWorkArea::scheduleRedraw(bool update_metrics)
458 // No need to redraw in this case.
461 // No need to do anything if this is the current view. The BufferView
462 // metrics are already up to date.
463 if (update_metrics || d->lyx_view_ != guiApp->currentView()
464 || d->lyx_view_->currentWorkArea() != this) {
465 // FIXME: it would be nice to optimize for the off-screen case.
466 d->buffer_view_->cursor().fixIfBroken();
467 d->buffer_view_->updateMetrics();
468 d->buffer_view_->cursor().fixIfBroken();
471 // update caret position, because otherwise it has to wait until
472 // the blinking interval is over
473 d->updateCaretGeometry();
475 LYXERR(Debug::WORKAREA, "WorkArea::redraw screen");
476 viewport()->update();
478 /// FIXME: is this still true now that paintEvent does the actual painting?
479 /// \warning: scrollbar updating *must* be done after the BufferView is drawn
480 /// because \c BufferView::updateScrollbar() is called in \c BufferView::draw().
481 d->updateScrollbar();
482 d->lyx_view_->updateStatusBar();
484 if (lyxerr.debugging(Debug::WORKAREA))
485 d->buffer_view_->coordCache().dump();
489 d->updateCursorShape();
493 // Keep in sync with GuiWorkArea::processKeySym below
494 bool GuiWorkArea::queryKeySym(KeySymbol const & key, KeyModifier mod) const
496 return guiApp->queryKeySym(key, mod);
500 // Keep in sync with GuiWorkArea::queryKeySym above
501 void GuiWorkArea::processKeySym(KeySymbol const & key, KeyModifier mod)
503 if (d->lyx_view_->isFullScreen() && d->lyx_view_->menuBar()->isVisible()
504 && lyxrc.full_screen_menubar) {
505 // FIXME HACK: we should not have to do this here. See related comment
506 // in GuiView::event() (QEvent::ShortcutOverride)
507 d->lyx_view_->menuBar()->hide();
510 // In order to avoid bad surprise in the middle of an operation,
511 // we better stop the blinking caret...
512 // the caret gets restarted in GuiView::restartCaret()
514 guiApp->processKeySym(key, mod);
518 void GuiWorkArea::Private::dispatch(FuncRequest const & cmd)
521 if (cmd.action() == LFUN_FILE_OPEN) {
523 lyx_view_->dispatch(cmd, dr);
527 bool const notJustMovingTheMouse =
528 cmd.action() != LFUN_MOUSE_MOTION || cmd.button() != mouse_button::none;
530 // In order to avoid bad surprise in the middle of an operation, we better stop
531 // the blinking caret.
532 if (notJustMovingTheMouse)
533 p->stopBlinkingCaret();
535 buffer_view_->mouseEventDispatch(cmd);
537 // Skip these when selecting
538 // FIXME: let GuiView take care of those.
539 if (cmd.action() != LFUN_MOUSE_MOTION) {
540 completer_->updateVisibility(false, false);
541 lyx_view_->updateDialogs();
542 lyx_view_->updateStatusBar();
545 // GUI tweaks except with mouse motion with no button pressed.
546 if (notJustMovingTheMouse) {
547 // Slight hack: this is only called currently when we
548 // clicked somewhere, so we force through the display
549 // of the new status here.
550 // FIXME: let GuiView take care of those.
551 lyx_view_->clearMessage();
553 // Show the caret immediately after any operation
554 p->startBlinkingCaret();
561 void GuiWorkArea::Private::resizeBufferView()
563 // WARNING: Please don't put any code that will trigger a repaint here!
564 // We are already inside a paint event.
565 p->stopBlinkingCaret();
566 // Warn our container (GuiView).
571 buffer_view_->caretPosAndHeight(point, h);
572 bool const caret_in_view = buffer_view_->cursorInView(point, h);
573 buffer_view_->resize(p->viewport()->width(), p->viewport()->height());
575 buffer_view_->scrollToCursor();
576 updateCaretGeometry();
578 // Update scrollbars which might have changed due different
579 // BufferView dimension. This is especially important when the
580 // BufferView goes from zero-size to the real-size for the first time,
581 // as the scrollbar paramters are then set for the first time.
584 need_resize_ = false;
586 // Eventually, restart the caret after the resize event.
587 // We might be resizing even if the focus is on another widget so we only
588 // restart the caret if we have the focus.
590 QTimer::singleShot(50, p, SLOT(startBlinkingCaret()));
594 void GuiWorkArea::Private::updateCaretGeometry()
598 buffer_view_->caretPosAndHeight(point, h);
599 if (!buffer_view_->cursorInView(point, h))
603 bool l_shape = false;
604 Font const & realfont = buffer_view_->cursor().real_current_font;
605 BufferParams const & bp = buffer_view_->buffer().params();
606 bool const samelang = realfont.language() == bp.language;
607 bool const isrtl = realfont.isVisibleRightToLeft();
609 if (!samelang || isrtl != bp.language->rightToLeft())
612 // The ERT language hack needs fixing up
613 if (realfont.language() == latex_language)
616 // show caret on screen
617 Cursor & cur = buffer_view_->cursor();
618 bool completable = cur.inset().showCompletionCursor()
619 && completer_->completionAvailable()
620 && !completer_->popupVisible()
621 && !completer_->inlineVisible();
622 caret_visible_ = true;
624 //int cur_x = buffer_view_->getPos(cur).x_;
625 // We may have decided to slide the cursor row so that caret
627 point.x_ -= buffer_view_->horizScrollOffset();
629 caret_->update(point.x_, point.y_, h, l_shape, isrtl, completable);
633 void GuiWorkArea::Private::showCaret()
638 updateCaretGeometry();
639 p->viewport()->update(caret_->rect());
643 void GuiWorkArea::Private::hideCaret()
648 caret_visible_ = false;
649 //if (!qApp->focusWidget())
650 p->viewport()->update(caret_->rect());
654 void GuiWorkArea::Private::updateScrollbar()
656 // Prevent setRange() and setSliderPosition from causing recursive calls via
657 // the signal valueChanged. (#10311)
658 QObject::disconnect(p->verticalScrollBar(), SIGNAL(valueChanged(int)),
659 p, SLOT(scrollTo(int)));
660 ScrollbarParameters const & scroll_ = buffer_view_->scrollbarParameters();
661 p->verticalScrollBar()->setRange(scroll_.min, scroll_.max);
662 p->verticalScrollBar()->setPageStep(scroll_.page_step);
663 p->verticalScrollBar()->setSingleStep(scroll_.single_step);
664 p->verticalScrollBar()->setSliderPosition(0);
665 // Connect to the vertical scroll bar
666 QObject::connect(p->verticalScrollBar(), SIGNAL(valueChanged(int)),
667 p, SLOT(scrollTo(int)));
671 void GuiWorkArea::scrollTo(int value)
674 d->buffer_view_->scrollDocView(value, true);
676 if (lyxrc.cursor_follows_scrollbar) {
677 d->buffer_view_->setCursorFromScrollbar();
678 // FIXME: let GuiView take care of those.
679 d->lyx_view_->updateLayoutList();
681 // Show the caret immediately after any operation.
682 startBlinkingCaret();
685 QApplication::syncX();
690 bool GuiWorkArea::event(QEvent * e)
693 case QEvent::ToolTip: {
694 QHelpEvent * helpEvent = static_cast<QHelpEvent *>(e);
695 if (lyxrc.use_tooltip) {
696 QPoint pos = helpEvent->pos();
697 if (pos.x() < viewport()->width()) {
698 QString s = toqstr(d->buffer_view_->toolTip(pos.x(), pos.y()));
699 QToolTip::showText(helpEvent->globalPos(), formatToolTip(s,35));
702 QToolTip::hideText();
704 // Don't forget to accept the event!
709 case QEvent::ShortcutOverride:
710 // keyPressEvent is ShortcutOverride-aware and only accepts the event in
712 keyPressEvent(static_cast<QKeyEvent *>(e));
713 return e->isAccepted();
715 case QEvent::KeyPress: {
716 // We catch this event in order to catch the Tab or Shift+Tab key press
717 // which are otherwise reserved to focus switching between controls
719 QKeyEvent * ke = static_cast<QKeyEvent*>(e);
720 if ((ke->key() == Qt::Key_Tab && ke->modifiers() == Qt::NoModifier)
721 || (ke->key() == Qt::Key_Backtab && (
722 ke->modifiers() == Qt::ShiftModifier
723 || ke->modifiers() == Qt::NoModifier))) {
727 return QAbstractScrollArea::event(e);
731 return QAbstractScrollArea::event(e);
737 void GuiWorkArea::contextMenuEvent(QContextMenuEvent * e)
740 if (e->reason() == QContextMenuEvent::Mouse)
741 // the menu name is set on mouse press
742 name = d->context_menu_name_;
744 QPoint pos = e->pos();
745 Cursor const & cur = d->buffer_view_->cursor();
746 if (e->reason() == QContextMenuEvent::Keyboard && cur.inTexted()) {
747 // Do not access the context menu of math right in front of before
748 // the cursor. This does not work when the cursor is in text.
749 Inset * inset = cur.paragraph().getInset(cur.pos());
750 if (inset && inset->asInsetMath())
752 else if (cur.pos() > 0) {
753 Inset * inset = cur.paragraph().getInset(cur.pos() - 1);
758 name = d->buffer_view_->contextMenu(pos.x(), pos.y());
765 // always show mnemonics when the keyboard is used to show the context menu
766 // FIXME: This should be fixed in Qt itself
767 bool const keyboard = (e->reason() == QContextMenuEvent::Keyboard);
768 QMenu * menu = guiApp->menus().menu(toqstr(name), *d->lyx_view_, keyboard);
773 // Position the menu to the right.
774 // FIXME: menu position should be different for RTL text.
775 menu->exec(e->globalPos());
780 void GuiWorkArea::focusInEvent(QFocusEvent * e)
782 LYXERR(Debug::DEBUG, "GuiWorkArea::focusInEvent(): " << this << endl);
783 if (d->lyx_view_->currentWorkArea() != this) {
784 d->lyx_view_->setCurrentWorkArea(this);
785 d->lyx_view_->currentWorkArea()->bufferView().buffer().updateBuffer();
788 startBlinkingCaret();
789 QAbstractScrollArea::focusInEvent(e);
793 void GuiWorkArea::focusOutEvent(QFocusEvent * e)
795 LYXERR(Debug::DEBUG, "GuiWorkArea::focusOutEvent(): " << this << endl);
797 QAbstractScrollArea::focusOutEvent(e);
801 void GuiWorkArea::mousePressEvent(QMouseEvent * e)
803 if (d->dc_event_.active && d->dc_event_ == *e) {
804 d->dc_event_.active = false;
805 FuncRequest cmd(LFUN_MOUSE_TRIPLE, e->x(), e->y(),
806 q_button_state(e->button()), q_key_state(e->modifiers()));
812 #if (QT_VERSION < 0x050000) && !defined(__HAIKU__)
813 inputContext()->reset();
816 FuncRequest const cmd(LFUN_MOUSE_PRESS, e->x(), e->y(),
817 q_button_state(e->button()), q_key_state(e->modifiers()));
820 // Save the context menu on mouse press, because also the mouse
821 // cursor is set on mouse press. Afterwards, we can either release
822 // the mousebutton somewhere else, or the cursor might have moved
823 // due to the DEPM. We need to do this after the mouse has been
824 // set in dispatch(), because the selection state might change.
825 if (e->button() == Qt::RightButton)
826 d->context_menu_name_ = d->buffer_view_->contextMenu(e->x(), e->y());
832 void GuiWorkArea::mouseReleaseEvent(QMouseEvent * e)
834 if (d->synthetic_mouse_event_.timeout.running())
835 d->synthetic_mouse_event_.timeout.stop();
837 FuncRequest const cmd(LFUN_MOUSE_RELEASE, e->x(), e->y(),
838 q_button_state(e->button()), q_key_state(e->modifiers()));
844 void GuiWorkArea::mouseMoveEvent(QMouseEvent * e)
846 // we kill the triple click if we move
847 doubleClickTimeout();
848 FuncRequest cmd(LFUN_MOUSE_MOTION, e->x(), e->y(),
849 q_motion_state(e->buttons()), q_key_state(e->modifiers()));
853 // If we're above or below the work area...
854 if ((e->y() <= 20 || e->y() >= viewport()->height() - 20)
855 && e->buttons() == mouse_button::button1) {
856 // Make sure only a synthetic event can cause a page scroll,
857 // so they come at a steady rate:
859 // _Force_ a scroll up:
860 cmd.set_y(e->y() - 21);
862 cmd.set_y(e->y() + 21);
863 // Store the event, to be handled when the timeout expires.
864 d->synthetic_mouse_event_.cmd = cmd;
866 if (d->synthetic_mouse_event_.timeout.running()) {
867 // Discard the event. Note that it _may_ be handled
868 // when the timeout expires if
869 // synthetic_mouse_event_.cmd has not been overwritten.
870 // Ie, when the timeout expires, we handle the
871 // most recent event but discard all others that
872 // occurred after the one used to start the timeout
873 // in the first place.
877 d->synthetic_mouse_event_.restart_timeout = true;
878 d->synthetic_mouse_event_.timeout.start();
879 // Fall through to handle this event...
881 } else if (d->synthetic_mouse_event_.timeout.running()) {
882 // Store the event, to be possibly handled when the timeout
884 // Once the timeout has expired, normal control is returned
885 // to mouseMoveEvent (restart_timeout = false).
886 // This results in a much smoother 'feel' when moving the
887 // mouse back into the work area.
888 d->synthetic_mouse_event_.cmd = cmd;
889 d->synthetic_mouse_event_.restart_timeout = false;
896 void GuiWorkArea::wheelEvent(QWheelEvent * ev)
898 // Wheel rotation by one notch results in a delta() of 120 (see
899 // documentation of QWheelEvent)
900 double const delta = ev->delta() / 120.0;
902 switch (lyxrc.scroll_wheel_zoom) {
903 case LyXRC::SCROLL_WHEEL_ZOOM_CTRL:
904 zoom = ev->modifiers() & Qt::ControlModifier;
905 zoom &= !(ev->modifiers() & (Qt::ShiftModifier | Qt::AltModifier));
907 case LyXRC::SCROLL_WHEEL_ZOOM_SHIFT:
908 zoom = ev->modifiers() & Qt::ShiftModifier;
909 zoom &= !(ev->modifiers() & (Qt::ControlModifier | Qt::AltModifier));
911 case LyXRC::SCROLL_WHEEL_ZOOM_ALT:
912 zoom = ev->modifiers() & Qt::AltModifier;
913 zoom &= !(ev->modifiers() & (Qt::ShiftModifier | Qt::ControlModifier));
915 case LyXRC::SCROLL_WHEEL_ZOOM_OFF:
919 docstring arg = convert<docstring>(int(5 * delta));
920 lyx::dispatch(FuncRequest(LFUN_BUFFER_ZOOM_IN, arg));
924 // Take into account the desktop wide settings.
925 int const lines = qApp->wheelScrollLines();
926 int const page_step = verticalScrollBar()->pageStep();
927 // Test if the wheel mouse is set to one screen at a time.
928 // This is according to
929 // https://doc.qt.io/qt-5/qapplication.html#wheelScrollLines-prop
931 min(lines * verticalScrollBar()->singleStep(), page_step);
933 // Take into account the rotation and the user preferences.
934 scroll_value = int(scroll_value * delta * lyxrc.mouse_wheel_speed);
935 LYXERR(Debug::SCROLLING, "wheelScrollLines = " << lines
936 << " delta = " << delta << " scroll_value = " << scroll_value
937 << " page_step = " << page_step);
939 verticalScrollBar()->setValue(verticalScrollBar()->value() - scroll_value);
945 void GuiWorkArea::generateSyntheticMouseEvent()
947 int const e_y = d->synthetic_mouse_event_.cmd.y();
948 int const wh = d->buffer_view_->workHeight();
949 bool const up = e_y < 0;
950 bool const down = e_y > wh;
952 // Set things off to generate the _next_ 'pseudo' event.
954 if (d->synthetic_mouse_event_.restart_timeout) {
955 // This is some magic formulae to determine the speed
956 // of scrolling related to the position of the mouse.
959 int dist = up ? -e_y : e_y - wh;
960 time = max(min(200, 250000 / (dist * dist)), 1) ;
963 step = 80000 / (time * time);
967 d->synthetic_mouse_event_.timeout.setTimeout(time);
968 d->synthetic_mouse_event_.timeout.start();
971 // Can we scroll further ?
972 int const value = verticalScrollBar()->value();
973 if (value == verticalScrollBar()->maximum()
974 || value == verticalScrollBar()->minimum()) {
975 d->synthetic_mouse_event_.timeout.stop();
980 if (step <= 2 * wh) {
981 d->buffer_view_->scroll(up ? -step : step);
982 d->buffer_view_->updateMetrics();
984 d->buffer_view_->scrollDocView(value + (up ? -step : step), false);
987 // In which paragraph do we have to set the cursor ?
988 Cursor & cur = d->buffer_view_->cursor();
989 // FIXME: we don't know how to handle math.
990 Text * text = cur.text();
993 TextMetrics const & tm = d->buffer_view_->textMetrics(text);
995 // Quit gracefully if there are no metrics, since otherwise next
996 // line would crash (bug #10324).
997 // This situation seems related to a (not yet understood) timing problem.
1001 pair<pit_type, const ParagraphMetrics *> pp = up ? tm.first() : tm.last();
1002 ParagraphMetrics const & pm = *pp.second;
1003 pit_type const pit = pp.first;
1005 if (pm.rows().empty())
1008 // Find the row at which we set the cursor.
1009 RowList::const_iterator rit = pm.rows().begin();
1010 RowList::const_iterator rlast = pm.rows().end();
1011 int yy = pm.position() - pm.ascent();
1012 for (--rlast; rit != rlast; ++rit) {
1013 int h = rit->height();
1014 if ((up && yy + h > 0)
1015 || (!up && yy + h > wh - defaultRowHeight()))
1020 // Find the position of the cursor
1022 int x = d->synthetic_mouse_event_.cmd.x();
1023 pos_type const pos = tm.getPosNearX(*rit, x, bound);
1028 cur.boundary(bound);
1030 d->buffer_view_->buffer().changed(false);
1035 // CompressorProxy adapted from Kuba Ober https://stackoverflow.com/a/21006207
1036 CompressorProxy::CompressorProxy(GuiWorkArea * wa) : QObject(wa), flag_(false)
1038 qRegisterMetaType<KeySymbol>("KeySymbol");
1039 qRegisterMetaType<KeyModifier>("KeyModifier");
1040 connect(wa, SIGNAL(compressKeySym(KeySymbol, KeyModifier, bool)),
1041 this, SLOT(slot(KeySymbol, KeyModifier, bool)),
1042 Qt::QueuedConnection);
1043 connect(this, SIGNAL(signal(KeySymbol, KeyModifier)),
1044 wa, SLOT(processKeySym(KeySymbol, KeyModifier)));
1048 bool CompressorProxy::emitCheck(bool isAutoRepeat)
1052 QCoreApplication::sendPostedEvents(this, QEvent::MetaCall); // recurse
1053 bool result = flag_;
1059 void CompressorProxy::slot(KeySymbol sym, KeyModifier mod, bool isAutoRepeat)
1061 if (emitCheck(isAutoRepeat))
1062 Q_EMIT signal(sym, mod);
1064 LYXERR(Debug::KEY, "system is busy: autoRepeat key event ignored");
1068 void GuiWorkArea::keyPressEvent(QKeyEvent * ev)
1070 // this is also called for ShortcutOverride events. In this case, one must
1071 // not act but simply accept the event explicitly.
1072 bool const act = (ev->type() != QEvent::ShortcutOverride);
1074 // Do not process here some keys if dialog_mode_ is set
1075 bool const for_dialog_mode = d->dialog_mode_
1076 && (ev->modifiers() == Qt::NoModifier
1077 || ev->modifiers() == Qt::ShiftModifier)
1078 && (ev->key() == Qt::Key_Escape
1079 || ev->key() == Qt::Key_Enter
1080 || ev->key() == Qt::Key_Return);
1081 // also do not use autoRepeat to input shortcuts
1082 bool const autoRepeat = ev->isAutoRepeat();
1084 if (for_dialog_mode || (!act && autoRepeat)) {
1089 // intercept some keys if completion popup is visible
1090 if (d->completer_->popupVisible()) {
1091 switch (ev->key()) {
1093 case Qt::Key_Return:
1095 d->completer_->activate();
1101 KeyModifier const m = q_key_state(ev->modifiers());
1103 if (act && lyxerr.debugging(Debug::KEY)) {
1105 if (m & ShiftModifier)
1107 if (m & ControlModifier)
1109 if (m & AltModifier)
1111 if (m & MetaModifier)
1113 LYXERR(Debug::KEY, " count: " << ev->count() << " text: " << ev->text()
1114 << " isAutoRepeat: " << ev->isAutoRepeat() << " key: " << ev->key()
1115 << " keyState: " << str);
1119 setKeySymbol(&sym, ev);
1122 Q_EMIT compressKeySym(sym, m, autoRepeat);
1125 // here, !autoRepeat, as determined at the beginning
1126 ev->setAccepted(queryKeySym(sym, m));
1133 void GuiWorkArea::doubleClickTimeout()
1135 d->dc_event_.active = false;
1139 void GuiWorkArea::mouseDoubleClickEvent(QMouseEvent * ev)
1141 d->dc_event_ = DoubleClick(ev);
1142 QTimer::singleShot(QApplication::doubleClickInterval(), this,
1143 SLOT(doubleClickTimeout()));
1144 FuncRequest cmd(LFUN_MOUSE_DOUBLE, ev->x(), ev->y(),
1145 q_button_state(ev->button()), q_key_state(ev->modifiers()));
1151 void GuiWorkArea::resizeEvent(QResizeEvent * ev)
1153 QAbstractScrollArea::resizeEvent(ev);
1154 d->need_resize_ = true;
1159 void GuiWorkArea::Private::paintPreeditText(GuiPainter & pain)
1161 if (preedit_string_.empty())
1164 // FIXME: shall we use real_current_font here? (see #10478)
1165 FontInfo const font = buffer_view_->cursor().getFont().fontInfo();
1166 FontMetrics const & fm = theFontMetrics(font);
1167 int const height = fm.maxHeight();
1168 int cur_x = caret_->rect().left();
1169 int cur_y = caret_->rect().bottom();
1171 // get attributes of input method cursor.
1172 // cursor_pos : cursor position in preedit string.
1173 size_t cursor_pos = 0;
1174 bool cursor_is_visible = false;
1175 for (auto const & attr : preedit_attr_) {
1176 if (attr.type == QInputMethodEvent::Cursor) {
1177 cursor_pos = attr.start;
1178 cursor_is_visible = attr.length != 0;
1183 size_t const preedit_length = preedit_string_.length();
1185 // get position of selection in input method.
1186 // FIXME: isn't there a way to do this simplier?
1187 // rStart : cursor position in selected string in IM.
1189 // rLength : selected string length in IM.
1191 if (cursor_pos < preedit_length) {
1192 for (auto const & attr : preedit_attr_) {
1193 if (attr.type == QInputMethodEvent::TextFormat) {
1194 if (attr.start <= int(cursor_pos)
1195 && int(cursor_pos) < attr.start + attr.length) {
1196 rStart = attr.start;
1197 rLength = attr.length;
1198 if (!cursor_is_visible)
1199 cursor_pos += rLength;
1206 rStart = cursor_pos;
1210 int const right_margin = buffer_view_->rightMargin();
1211 Painter::preedit_style ps;
1212 // Most often there would be only one line:
1214 for (size_t pos = 0; pos != preedit_length; ++pos) {
1215 char_type const typed_char = preedit_string_[pos];
1216 // reset preedit string style
1217 ps = Painter::preedit_default;
1219 // if we reached the right extremity of the screen, go to next line.
1220 if (cur_x + fm.width(typed_char) > p->viewport()->width() - right_margin) {
1221 cur_x = right_margin;
1222 cur_y += height + 1;
1225 // preedit strings are displayed with dashed underline
1226 // and partial strings are displayed white on black indicating
1227 // that we are in selecting mode in the input method.
1228 // FIXME: rLength == preedit_length is not a changing condition
1229 // FIXME: should be put out of the loop.
1231 && pos < rStart + rLength
1232 && !(cursor_pos < rLength && rLength == preedit_length))
1233 ps = Painter::preedit_selecting;
1235 if (pos == cursor_pos
1236 && (cursor_pos < rLength && rLength == preedit_length))
1237 ps = Painter::preedit_cursor;
1239 // draw one character and update cur_x.
1240 cur_x += pain.preeditText(cur_x, cur_y, typed_char, font, ps);
1245 void GuiWorkArea::paintEvent(QPaintEvent * ev)
1247 // LYXERR(Debug::PAINTING, "paintEvent begin: x: " << rc.x()
1248 // << " y: " << rc.y() << " w: " << rc.width() << " h: " << rc.height());
1250 if (d->need_resize_ || pixelRatio() != d->last_pixel_ratio_) {
1252 d->resizeBufferView();
1255 d->last_pixel_ratio_ = pixelRatio();
1257 GuiPainter pain(d->screenDevice(), pixelRatio());
1259 d->buffer_view_->draw(pain, d->caret_visible_);
1261 // The preedit text, if needed
1262 d->paintPreeditText(pain);
1265 if (d->caret_visible_)
1266 d->caret_->draw(pain);
1268 d->updateScreen(ev->rect());
1274 void GuiWorkArea::inputMethodEvent(QInputMethodEvent * e)
1276 LYXERR(Debug::KEY, "preeditString: " << e->preeditString()
1277 << " commitString: " << e->commitString());
1279 // insert the processed text in the document (handles undo)
1280 if (!e->commitString().isEmpty()) {
1281 d->buffer_view_->cursor().beginUndoGroup();
1282 d->buffer_view_->cursor().insert(qstring_to_ucs4(e->commitString()));
1283 d->buffer_view_->updateMetrics();
1284 d->buffer_view_->cursor().endUndoGroup();
1285 viewport()->update();
1288 // Hide the caret during the test transformation.
1289 if (e->preeditString().isEmpty())
1290 startBlinkingCaret();
1292 stopBlinkingCaret();
1294 if (d->preedit_string_.empty() && e->preeditString().isEmpty()) {
1300 // The preedit text and its attributes will be used in paintPreeditText
1301 d->preedit_string_ = qstring_to_ucs4(e->preeditString());
1302 d->preedit_attr_ = e->attributes();
1305 // redraw area of preedit string.
1306 int height = d->caret_->rect().height();
1307 int cur_y = d->caret_->rect().bottom();
1308 viewport()->update(0, cur_y - height, viewport()->width(),
1309 (height + 1) * d->preedit_lines_);
1311 if (d->preedit_string_.empty()) {
1312 d->preedit_lines_ = 1;
1317 // Don't forget to accept the event!
1322 QVariant GuiWorkArea::inputMethodQuery(Qt::InputMethodQuery query) const
1324 QRect cur_r(0, 0, 0, 0);
1326 // this is the CJK-specific composition window position and
1327 // the context menu position when the menu key is pressed.
1328 case Qt::ImMicroFocus:
1329 cur_r = d->caret_->rect();
1330 if (d->preedit_lines_ != 1)
1332 cur_r.moveBottom(cur_r.bottom()
1333 + cur_r.height() * (d->preedit_lines_ - 1));
1334 // return lower right of caret in LyX.
1337 return QWidget::inputMethodQuery(query);
1342 void GuiWorkArea::updateWindowTitle()
1344 Buffer const & buf = bufferView().buffer();
1345 if (buf.fileName() != d->file_name_
1346 || buf.params().shell_escape != d->shell_escape_
1347 || buf.hasReadonlyFlag() != d->read_only_
1348 || buf.lyxvc().vcstatus() != d->vc_status_
1349 || buf.isClean() != d->clean_
1350 || buf.notifiesExternalModification() != d->externally_modified_) {
1351 d->file_name_ = buf.fileName();
1352 d->shell_escape_ = buf.params().shell_escape;
1353 d->read_only_ = buf.hasReadonlyFlag();
1354 d->vc_status_ = buf.lyxvc().vcstatus();
1355 d->clean_ = buf.isClean();
1356 d->externally_modified_ = buf.notifiesExternalModification();
1357 Q_EMIT titleChanged(this);
1362 bool GuiWorkArea::isFullScreen() const
1364 return d->lyx_view_ && d->lyx_view_->isFullScreen();
1368 bool GuiWorkArea::inDialogMode() const
1370 return d->dialog_mode_;
1374 void GuiWorkArea::setDialogMode(bool mode)
1376 d->dialog_mode_ = mode;
1380 GuiCompleter & GuiWorkArea::completer()
1382 return *d->completer_;
1385 GuiView const & GuiWorkArea::view() const
1387 return *d->lyx_view_;
1391 GuiView & GuiWorkArea::view()
1393 return *d->lyx_view_;
1396 ////////////////////////////////////////////////////////////////////
1400 ////////////////////////////////////////////////////////////////////
1403 EmbeddedWorkArea::EmbeddedWorkArea(QWidget * w): GuiWorkArea(w)
1405 support::TempFile tempfile("embedded.internal");
1406 tempfile.setAutoRemove(false);
1407 buffer_ = theBufferList().newInternalBuffer(tempfile.name().absFileName());
1408 buffer_->setUnnamed(true);
1409 buffer_->setFullyLoaded(true);
1410 setBuffer(*buffer_);
1411 setDialogMode(true);
1415 EmbeddedWorkArea::~EmbeddedWorkArea()
1417 // No need to destroy buffer and bufferview here, because it is done
1418 // in theBufferList() destruction loop at application exit
1422 void EmbeddedWorkArea::closeEvent(QCloseEvent * ev)
1425 GuiWorkArea::closeEvent(ev);
1429 void EmbeddedWorkArea::hideEvent(QHideEvent * ev)
1432 GuiWorkArea::hideEvent(ev);
1436 QSize EmbeddedWorkArea::sizeHint () const
1439 // GuiWorkArea sets the size to the screen's viewport
1440 // by returning a value this gets overridden
1441 // EmbeddedWorkArea is now sized to fit in the layout
1442 // of the parent, and has a minimum size set in GuiWorkArea
1443 // which is what we return here
1444 return QSize(100, 70);
1448 void EmbeddedWorkArea::disable()
1450 stopBlinkingCaret();
1451 if (view().currentWorkArea() != this)
1453 // No problem if currentMainWorkArea() is 0 (setCurrentWorkArea()
1454 // tolerates it and shows the background logo), what happens if
1455 // an EmbeddedWorkArea is closed after closing all document WAs
1456 view().setCurrentWorkArea(view().currentMainWorkArea());
1459 ////////////////////////////////////////////////////////////////////
1463 ////////////////////////////////////////////////////////////////////
1466 class NoTabFrameMacStyle : public QProxyStyle {
1469 QRect subElementRect(SubElement element, const QStyleOption * option,
1470 const QWidget * widget = 0) const
1472 QRect rect = QProxyStyle::subElementRect(element, option, widget);
1473 bool noBar = static_cast<QTabWidget const *>(widget)->count() <= 1;
1475 // The Qt Mac style puts the contents into a 3 pixel wide box
1476 // which looks very ugly and not like other Mac applications.
1477 // Hence we remove this here, and moreover the 16 pixel round
1478 // frame above if the tab bar is hidden.
1479 if (element == QStyle::SE_TabWidgetTabContents) {
1480 rect.adjust(- rect.left(), 0, rect.left(), 0);
1489 NoTabFrameMacStyle noTabFrameMacStyle;
1493 TabWorkArea::TabWorkArea(QWidget * parent)
1494 : QTabWidget(parent), clicked_tab_(-1), midpressed_tab_(-1)
1497 setStyle(&noTabFrameMacStyle);
1500 QPalette pal = palette();
1501 pal.setColor(QPalette::Active, QPalette::Button,
1502 pal.color(QPalette::Active, QPalette::Window));
1503 pal.setColor(QPalette::Disabled, QPalette::Button,
1504 pal.color(QPalette::Disabled, QPalette::Window));
1505 pal.setColor(QPalette::Inactive, QPalette::Button,
1506 pal.color(QPalette::Inactive, QPalette::Window));
1508 QObject::connect(this, SIGNAL(currentChanged(int)),
1509 this, SLOT(on_currentTabChanged(int)));
1511 closeBufferButton = new QToolButton(this);
1512 closeBufferButton->setPalette(pal);
1513 // FIXME: rename the icon to closebuffer.png
1514 closeBufferButton->setIcon(QIcon(getPixmap("images/", "closetab", "svgz,png")));
1515 closeBufferButton->setText("Close File");
1516 closeBufferButton->setAutoRaise(true);
1517 closeBufferButton->setCursor(Qt::ArrowCursor);
1518 closeBufferButton->setToolTip(qt_("Close File"));
1519 closeBufferButton->setEnabled(true);
1520 QObject::connect(closeBufferButton, SIGNAL(clicked()),
1521 this, SLOT(closeCurrentBuffer()));
1522 setCornerWidget(closeBufferButton, Qt::TopRightCorner);
1524 // setup drag'n'drop
1525 QTabBar* tb = new DragTabBar;
1526 connect(tb, SIGNAL(tabMoveRequested(int, int)),
1527 this, SLOT(moveTab(int, int)));
1528 tb->setElideMode(Qt::ElideNone);
1531 // make us responsible for the context menu of the tabbar
1532 tb->setContextMenuPolicy(Qt::CustomContextMenu);
1533 connect(tb, SIGNAL(customContextMenuRequested(const QPoint &)),
1534 this, SLOT(showContextMenu(const QPoint &)));
1535 connect(tb, SIGNAL(tabCloseRequested(int)),
1536 this, SLOT(closeTab(int)));
1538 setUsesScrollButtons(true);
1542 void TabWorkArea::mousePressEvent(QMouseEvent *me)
1544 if (me->button() == Qt::MidButton)
1545 midpressed_tab_ = tabBar()->tabAt(me->pos());
1547 QTabWidget::mousePressEvent(me);
1551 void TabWorkArea::mouseReleaseEvent(QMouseEvent *me)
1553 if (me->button() == Qt::MidButton) {
1554 int const midreleased_tab = tabBar()->tabAt(me->pos());
1555 if (midpressed_tab_ == midreleased_tab && posIsTab(me->pos()))
1556 closeTab(midreleased_tab);
1558 QTabWidget::mouseReleaseEvent(me);
1562 void TabWorkArea::paintEvent(QPaintEvent * event)
1564 if (tabBar()->isVisible()) {
1565 QTabWidget::paintEvent(event);
1567 // Prevent the selected tab to influence the
1568 // painting of the frame of the tab widget.
1569 // This is needed for gtk style in Qt.
1570 QStylePainter p(this);
1571 #if QT_VERSION < 0x050000
1572 QStyleOptionTabWidgetFrameV2 opt;
1574 QStyleOptionTabWidgetFrame opt;
1576 initStyleOption(&opt);
1577 opt.rect = style()->subElementRect(QStyle::SE_TabWidgetTabPane,
1579 opt.selectedTabRect = QRect();
1580 p.drawPrimitive(QStyle::PE_FrameTabWidget, opt);
1585 bool TabWorkArea::posIsTab(QPoint position)
1587 // tabAt returns -1 if tab does not covers position
1588 return tabBar()->tabAt(position) > -1;
1592 void TabWorkArea::mouseDoubleClickEvent(QMouseEvent * event)
1594 if (event->button() != Qt::LeftButton)
1597 // this code chunk is unnecessary because it seems the event only makes
1598 // it this far if it is not on a tab. I'm not sure why this is (maybe
1599 // it is handled and ended in DragTabBar?), and thus I'm not sure if
1600 // this is true in all cases and if it will be true in the future so I
1601 // leave this code for now. (skostysh, 2016-07-21)
1603 // return early if double click on existing tabs
1604 if (posIsTab(event->pos()))
1607 dispatch(FuncRequest(LFUN_BUFFER_NEW));
1611 void TabWorkArea::setFullScreen(bool full_screen)
1613 for (int i = 0; i != count(); ++i) {
1614 if (GuiWorkArea * wa = workArea(i))
1615 wa->setFullScreen(full_screen);
1618 if (lyxrc.full_screen_tabbar)
1619 showBar(!full_screen && count() > 1);
1621 showBar(count() > 1);
1625 void TabWorkArea::showBar(bool show)
1627 tabBar()->setEnabled(show);
1628 tabBar()->setVisible(show);
1629 closeBufferButton->setVisible(show && lyxrc.single_close_tab_button);
1630 setTabsClosable(!lyxrc.single_close_tab_button);
1634 GuiWorkAreaContainer * TabWorkArea::widget(int index) const
1636 QWidget * w = QTabWidget::widget(index);
1639 GuiWorkAreaContainer * wac = dynamic_cast<GuiWorkAreaContainer *>(w);
1645 GuiWorkAreaContainer * TabWorkArea::currentWidget() const
1647 return widget(currentIndex());
1651 GuiWorkArea * TabWorkArea::workArea(int index) const
1653 GuiWorkAreaContainer * w = widget(index);
1656 return w->workArea();
1660 GuiWorkArea * TabWorkArea::currentWorkArea() const
1662 return workArea(currentIndex());
1666 GuiWorkArea * TabWorkArea::workArea(Buffer & buffer) const
1668 // FIXME: this method doesn't work if we have more than one work area
1669 // showing the same buffer.
1670 for (int i = 0; i != count(); ++i) {
1671 GuiWorkArea * wa = workArea(i);
1672 LASSERT(wa, return 0);
1673 if (&wa->bufferView().buffer() == &buffer)
1680 void TabWorkArea::closeAll()
1683 QWidget * wac = widget(0);
1684 LASSERT(wac, return);
1691 int TabWorkArea::indexOfWorkArea(GuiWorkArea * w) const
1693 for (int index = 0; index < count(); ++index)
1694 if (workArea(index) == w)
1700 bool TabWorkArea::setCurrentWorkArea(GuiWorkArea * work_area)
1702 LASSERT(work_area, return false);
1703 int index = indexOfWorkArea(work_area);
1707 if (index == currentIndex())
1708 // Make sure the work area is up to date.
1709 on_currentTabChanged(index);
1711 // Switch to the work area.
1712 setCurrentIndex(index);
1713 work_area->setFocus();
1719 GuiWorkArea * TabWorkArea::addWorkArea(Buffer & buffer, GuiView & view)
1721 GuiWorkArea * wa = new GuiWorkArea(buffer, view);
1722 GuiWorkAreaContainer * wac = new GuiWorkAreaContainer(wa);
1723 wa->setUpdatesEnabled(false);
1724 // Hide tabbar if there's no tab (avoid a resize and a flashing tabbar
1725 // when hiding it again below).
1726 if (!(currentWorkArea() && currentWorkArea()->isFullScreen()))
1727 showBar(count() > 0);
1728 addTab(wac, wa->windowTitle());
1729 QObject::connect(wa, SIGNAL(titleChanged(GuiWorkArea *)),
1730 this, SLOT(updateTabTexts()));
1731 if (currentWorkArea() && currentWorkArea()->isFullScreen())
1732 setFullScreen(true);
1734 // Hide tabbar if there's only one tab.
1735 showBar(count() > 1);
1743 bool TabWorkArea::removeWorkArea(GuiWorkArea * work_area)
1745 LASSERT(work_area, return false);
1746 int index = indexOfWorkArea(work_area);
1750 work_area->setUpdatesEnabled(false);
1751 QWidget * wac = widget(index);
1756 // make sure the next work area is enabled.
1757 currentWidget()->setUpdatesEnabled(true);
1758 if (currentWorkArea() && currentWorkArea()->isFullScreen())
1759 setFullScreen(true);
1761 // Show tabbar only if there's more than one tab.
1762 showBar(count() > 1);
1764 lastWorkAreaRemoved();
1772 void TabWorkArea::on_currentTabChanged(int i)
1774 // returns e.g. on application destruction
1777 GuiWorkArea * wa = workArea(i);
1778 LASSERT(wa, return);
1779 wa->setUpdatesEnabled(true);
1780 wa->scheduleRedraw(true);
1783 currentWorkAreaChanged(wa);
1785 LYXERR(Debug::GUI, "currentTabChanged " << i
1786 << " File: " << wa->bufferView().buffer().absFileName());
1790 void TabWorkArea::closeCurrentBuffer()
1793 if (clicked_tab_ == -1)
1794 wa = currentWorkArea();
1796 wa = workArea(clicked_tab_);
1797 LASSERT(wa, return);
1799 wa->view().closeWorkArea(wa);
1803 void TabWorkArea::hideCurrentTab()
1806 if (clicked_tab_ == -1)
1807 wa = currentWorkArea();
1809 wa = workArea(clicked_tab_);
1810 LASSERT(wa, return);
1812 wa->view().hideWorkArea(wa);
1816 void TabWorkArea::closeTab(int index)
1818 on_currentTabChanged(index);
1821 wa = currentWorkArea();
1823 wa = workArea(index);
1824 LASSERT(wa, return);
1826 wa->view().closeWorkArea(wa);
1833 /// make vector happy
1834 DisplayPath() : tab_(-1), dottedPrefix_(false) {}
1836 DisplayPath(int tab, FileName const & filename)
1839 filename_ = (filename.extension() == "lyx") ?
1840 toqstr(filename.onlyFileNameWithoutExt())
1841 : toqstr(filename.onlyFileName());
1842 postfix_ = toqstr(filename.absoluteFilePath()).
1843 split("/", QString::SkipEmptyParts);
1844 postfix_.pop_back();
1845 abs_ = toqstr(filename.absoluteFilePath());
1846 dottedPrefix_ = false;
1849 /// Absolute path for debugging.
1854 /// Add the first segment from the postfix or three dots to the prefix.
1855 /// Merge multiple dot tripples. In fact dots are added lazily, i.e. only
1856 /// when really needed.
1857 void shiftPathSegment(bool dotted)
1859 if (postfix_.count() <= 0)
1863 if (dottedPrefix_ && !prefix_.isEmpty())
1864 prefix_ += ellipsisSlash_;
1865 prefix_ += postfix_.front() + "/";
1867 dottedPrefix_ = dotted && !prefix_.isEmpty();
1868 postfix_.pop_front();
1871 QString displayString() const
1873 if (prefix_.isEmpty())
1876 bool dots = dottedPrefix_ || !postfix_.isEmpty();
1877 return prefix_ + (dots ? ellipsisSlash_ : "") + filename_;
1880 QString forecastPathString() const
1882 if (postfix_.count() == 0)
1883 return displayString();
1886 + (dottedPrefix_ ? ellipsisSlash_ : "")
1887 + postfix_.front() + "/";
1890 bool final() const { return postfix_.empty(); }
1892 int tab() const { return tab_; }
1896 static QString const ellipsisSlash_;
1900 QStringList postfix_;
1912 QString const DisplayPath::ellipsisSlash_ = QString(QChar(0x2026)) + "/";
1916 bool operator<(DisplayPath const & a, DisplayPath const & b)
1918 return a.displayString() < b.displayString();
1922 bool operator==(DisplayPath const & a, DisplayPath const & b)
1924 return a.displayString() == b.displayString();
1928 void TabWorkArea::updateTabTexts()
1933 std::list<DisplayPath> paths;
1934 typedef std::list<DisplayPath>::iterator It;
1936 // collect full names first: path into postfix, empty prefix and
1937 // filename without extension
1938 for (size_t i = 0; i < n; ++i) {
1939 GuiWorkArea * i_wa = workArea(i);
1940 FileName const fn = i_wa->bufferView().buffer().fileName();
1941 paths.push_back(DisplayPath(i, fn));
1944 // go through path segments and see if it helps to make the path more unique
1945 bool somethingChanged = true;
1946 bool allFinal = false;
1947 while (somethingChanged && !allFinal) {
1948 // adding path segments changes order
1951 LYXERR(Debug::GUI, "updateTabTexts() iteration start");
1952 somethingChanged = false;
1955 // find segments which are not unique (i.e. non-atomic)
1956 It it = paths.begin();
1958 QString segString = it->displayString();
1959 for (; it != paths.end(); ++it) {
1960 // look to the next item
1965 allFinal = allFinal && it->final();
1967 LYXERR(Debug::GUI, "it = " << it->abs()
1968 << " => " << it->displayString());
1970 // still the same segment?
1972 if ((next != paths.end()
1973 && (nextString = next->displayString()) == segString))
1975 LYXERR(Debug::GUI, "segment ended");
1977 // only a trivial one with one element?
1978 if (it == segStart) {
1979 // start new segment
1981 segString = nextString;
1985 // We found a non-atomic segment
1986 // We know that segStart <= it < next <= paths.end().
1987 // The assertion below tells coverity about it.
1988 LATTEST(segStart != paths.end());
1989 QString dspString = segStart->forecastPathString();
1990 LYXERR(Debug::GUI, "first forecast found for "
1991 << segStart->abs() << " => " << dspString);
1994 // Shift path segments and hope for the best
1995 // that it makes the path more unique.
1996 somethingChanged = true;
1997 bool moreUnique = false;
1998 for (; sit != next; ++sit) {
1999 if (sit->forecastPathString() != dspString) {
2000 LYXERR(Debug::GUI, "different forecast found for "
2001 << sit->abs() << " => " << sit->forecastPathString());
2005 LYXERR(Debug::GUI, "same forecast found for "
2006 << sit->abs() << " => " << dspString);
2009 // if the path segment helped, add it. Otherwise add dots
2010 bool dots = !moreUnique;
2011 LYXERR(Debug::GUI, "using dots = " << dots);
2012 for (sit = segStart; sit != next; ++sit) {
2013 sit->shiftPathSegment(dots);
2014 LYXERR(Debug::GUI, "shifting "
2015 << sit->abs() << " => " << sit->displayString());
2018 // start new segment
2020 segString = nextString;
2024 // set new tab titles
2025 for (It it = paths.begin(); it != paths.end(); ++it) {
2026 int const tab_index = it->tab();
2027 Buffer const & buf = workArea(tab_index)->bufferView().buffer();
2028 QString tab_text = it->displayString().replace("&", "&&");
2029 if (!buf.fileName().empty() && !buf.isClean())
2031 QString tab_tooltip = it->abs();
2032 if (buf.hasReadonlyFlag()) {
2033 setTabIcon(tab_index, QIcon(getPixmap("images/", "emblem-readonly", "svgz,png")));
2034 tab_tooltip = qt_("%1 (read only)").arg(tab_tooltip);
2036 setTabIcon(tab_index, QIcon());
2037 if (buf.notifiesExternalModification()) {
2038 QString const warn = qt_("%1 (modified externally)");
2039 tab_tooltip = warn.arg(tab_tooltip);
2040 tab_text += QChar(0x26a0);
2042 setTabText(tab_index, tab_text);
2043 setTabToolTip(tab_index, tab_tooltip);
2048 void TabWorkArea::showContextMenu(const QPoint & pos)
2051 clicked_tab_ = static_cast<DragTabBar *>(tabBar())->tabAt(pos);
2052 if (clicked_tab_ == -1)
2057 popup.addAction(QIcon(getPixmap("images/", "hidetab", "svgz,png")),
2058 qt_("Hide tab"), this, SLOT(hideCurrentTab()));
2059 popup.addAction(QIcon(getPixmap("images/", "closetab", "svgz,png")),
2060 qt_("Close tab"), this, SLOT(closeCurrentBuffer()));
2061 popup.exec(tabBar()->mapToGlobal(pos));
2067 void TabWorkArea::moveTab(int fromIndex, int toIndex)
2069 QWidget * w = widget(fromIndex);
2070 QIcon icon = tabIcon(fromIndex);
2071 QString text = tabText(fromIndex);
2073 setCurrentIndex(fromIndex);
2074 removeTab(fromIndex);
2075 insertTab(toIndex, w, icon, text);
2076 setCurrentIndex(toIndex);
2080 DragTabBar::DragTabBar(QWidget* parent)
2083 setAcceptDrops(true);
2084 setTabsClosable(!lyxrc.single_close_tab_button);
2088 void DragTabBar::mousePressEvent(QMouseEvent * event)
2090 if (event->button() == Qt::LeftButton)
2091 dragStartPos_ = event->pos();
2092 QTabBar::mousePressEvent(event);
2096 void DragTabBar::mouseMoveEvent(QMouseEvent * event)
2098 // If the left button isn't pressed anymore then return
2099 if (!(event->buttons() & Qt::LeftButton))
2102 // If the distance is too small then return
2103 if ((event->pos() - dragStartPos_).manhattanLength()
2104 < QApplication::startDragDistance())
2107 // did we hit something after all?
2108 int tab = tabAt(dragStartPos_);
2112 // simulate button release to remove highlight from button
2113 int i = currentIndex();
2114 QMouseEvent me(QEvent::MouseButtonRelease, dragStartPos_,
2115 event->button(), event->buttons(), 0);
2116 QTabBar::mouseReleaseEvent(&me);
2120 QDrag * drag = new QDrag(this);
2121 QMimeData * mimeData = new QMimeData;
2122 // a crude way to distinguish tab-reodering drops from other ones
2123 mimeData->setData("action", "tab-reordering") ;
2124 drag->setMimeData(mimeData);
2126 // get tab pixmap as cursor
2127 QRect r = tabRect(tab);
2128 QPixmap pixmap(r.size());
2129 render(&pixmap, - r.topLeft());
2130 drag->setPixmap(pixmap);
2135 void DragTabBar::dragEnterEvent(QDragEnterEvent * event)
2137 // Only accept if it's an tab-reordering request
2138 QMimeData const * m = event->mimeData();
2139 QStringList formats = m->formats();
2140 if (formats.contains("action")
2141 && m->data("action") == "tab-reordering")
2142 event->acceptProposedAction();
2146 void DragTabBar::dropEvent(QDropEvent * event)
2148 int fromIndex = tabAt(dragStartPos_);
2149 int toIndex = tabAt(event->pos());
2151 // Tell interested objects that
2152 if (fromIndex != toIndex)
2153 tabMoveRequested(fromIndex, toIndex);
2154 event->acceptProposedAction();
2158 GuiWorkAreaContainer::GuiWorkAreaContainer(GuiWorkArea * wa, QWidget * parent)
2159 : QWidget(parent), wa_(wa)
2161 LASSERT(wa, return);
2162 Ui::WorkAreaUi::setupUi(this);
2163 layout()->addWidget(wa);
2164 connect(wa, SIGNAL(titleChanged(GuiWorkArea *)),
2165 this, SLOT(updateDisplay()));
2166 connect(reloadPB, SIGNAL(clicked()), this, SLOT(reload()));
2167 connect(ignorePB, SIGNAL(clicked()), this, SLOT(ignore()));
2168 setMessageColour({notificationFrame}, {reloadPB, ignorePB});
2173 void GuiWorkAreaContainer::updateDisplay()
2175 Buffer const & buf = wa_->bufferView().buffer();
2176 notificationFrame->setHidden(!buf.notifiesExternalModification());
2177 QString const label = qt_("<b>The file %1 changed on disk.</b>")
2178 .arg(toqstr(buf.fileName().displayName()));
2179 externalModificationLabel->setText(label);
2183 void GuiWorkAreaContainer::dispatch(FuncRequest f) const
2185 lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
2186 wa_->bufferView().buffer().absFileName()));
2191 void GuiWorkAreaContainer::reload() const
2193 dispatch(FuncRequest(LFUN_BUFFER_RELOAD));
2197 void GuiWorkAreaContainer::ignore() const
2199 dispatch(FuncRequest(LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR));
2203 void GuiWorkAreaContainer::mouseDoubleClickEvent(QMouseEvent * event)
2205 // prevent TabWorkArea from opening a new buffer on double click
2210 } // namespace frontend
2213 #include "moc_GuiWorkArea.cpp"