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 /* Draw the caret. Parameter \c horiz_offset is not 0 when there
137 * has been horizontal scrolling in current row
139 void draw(QPainter & painter, int horiz_offset)
141 if (!rect_.isValid())
144 int const x = x_ - horiz_offset;
145 int const y = rect_.top();
146 int const l = x_ - rect_.left();
147 int const r = rect_.right() - x_;
148 int const bot = rect_.bottom();
150 // draw vertical line
151 painter.fillRect(x, y, caret_width_, rect_.height(), color_);
153 // draw RTL/LTR indication
154 painter.setPen(color_);
157 painter.drawLine(x, bot, x - l + 1, bot);
159 painter.drawLine(x, bot, x + caret_width_ + r - 1, bot);
162 // draw completion triangle
164 int m = y + rect_.height() / 2;
165 int d = TabIndicatorWidth - 1;
167 painter.drawLine(x - 1, m - d, x - 1 - d, m);
168 painter.drawLine(x - 1, m + d, x - 1 - d, m);
170 painter.drawLine(x + caret_width_, m - d, x + caret_width_ + d, m);
171 painter.drawLine(x + caret_width_, m + d, x + caret_width_ + d, m);
176 void update(int x, int y, int h, bool l_shape,
177 bool rtl, bool completable)
179 color_ = guiApp->colorCache().get(Color_cursor);
182 completable_ = completable;
185 // extension to left and right
189 // RTL/LTR indication
197 // completion triangle
200 l = max(l, TabIndicatorWidth);
202 r = max(r, TabIndicatorWidth);
205 //FIXME: LyXRC::cursor_width should be caret_width
206 caret_width_ = lyxrc.cursor_width
208 : 1 + int((lyxrc.currentZoom + 50) / 200.0);
210 // compute overall rectangle
211 rect_ = QRect(x - l, y, caret_width_ + r + l, h);
214 QRect const & rect() { return rect_; }
217 /// caret is in RTL or LTR text
219 /// indication for RTL or LTR
221 /// triangle to show that a completion is available
225 /// rectangle, possibly with l_shape and completion triangle
227 /// x position (were the vertical line is drawn)
229 /// the width of the vertical blinking bar
234 // This is a 'heartbeat' generating synthetic mouse move events when the
235 // cursor is at the top or bottom edge of the viewport. One scroll per 0.2 s
236 SyntheticMouseEvent::SyntheticMouseEvent()
237 : timeout(200), restart_timeout(true)
241 GuiWorkArea::Private::Private(GuiWorkArea * parent)
242 : p(parent), buffer_view_(0), lyx_view_(0), caret_(0),
243 caret_visible_(false), need_resize_(false), preedit_lines_(1),
244 last_pixel_ratio_(1.0), completer_(new GuiCompleter(p, p)),
245 dialog_mode_(false), shell_escape_(false), read_only_(false),
246 clean_(true), externally_modified_(false)
248 /* Qt on macOS and Wayland does not respect the
249 * Qt::WA_OpaquePaintEvent attribute and resets the widget backing
250 * store at each update. Therefore, we use our own backing store in
251 * these two cases. */
252 #if QT_VERSION >= 0x050000
253 use_backingstore_ = guiApp->platformName() == "cocoa"
254 || guiApp->platformName().contains("wayland");
257 use_backingstore_ = true;
259 use_backingstore_ = false;
263 int const time = QApplication::cursorFlashTime() / 2;
265 caret_timeout_.setInterval(time);
266 caret_timeout_.start();
268 // let's initialize this just to be safe
269 caret_timeout_.setInterval(500);
274 GuiWorkArea::Private::~Private()
276 // If something is wrong with the buffer, we can ignore it safely
278 buffer_view_->buffer().workAreaManager().remove(p);
282 // Completer has a QObject parent and is thus automatically destroyed.
284 // delete completer_;
288 GuiWorkArea::GuiWorkArea(QWidget * /* w */)
289 : d(new Private(this))
291 new CompressorProxy(this); // not a leak
295 GuiWorkArea::GuiWorkArea(Buffer & buffer, GuiView & gv)
296 : d(new Private(this))
298 new CompressorProxy(this); // not a leak
300 buffer.params().display_pixel_ratio = theGuiApp()->pixelRatio();
306 double GuiWorkArea::pixelRatio() const
308 #if QT_VERSION >= 0x050000
309 return qt_scale_factor * devicePixelRatio();
316 void GuiWorkArea::init()
319 connect(&d->caret_timeout_, SIGNAL(timeout()),
320 this, SLOT(toggleCaret()));
322 // This connection is closed at the same time as this is destroyed.
323 d->synthetic_mouse_event_.timeout.timeout.connect([this](){
324 generateSyntheticMouseEvent();
328 // With Qt4.5 a mouse event will happen before the first paint event
329 // so make sure that the buffer view has an up to date metrics.
330 d->buffer_view_->resize(viewport()->width(), viewport()->height());
331 d->caret_ = new frontend::CaretWidget();
333 setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
334 setAcceptDrops(true);
335 setMouseTracking(true);
336 setMinimumSize(100, 70);
337 setFrameStyle(QFrame::NoFrame);
340 d->updateCursorShape();
342 // we paint our own background
343 viewport()->setAttribute(Qt::WA_OpaquePaintEvent);
345 setFocusPolicy(Qt::StrongFocus);
347 LYXERR(Debug::GUI, "viewport width: " << viewport()->width()
348 << " viewport height: " << viewport()->height());
350 // Enables input methods for asian languages.
351 // Must be set when creating custom text editing widgets.
352 setAttribute(Qt::WA_InputMethodEnabled, true);
356 GuiWorkArea::~GuiWorkArea()
362 void GuiWorkArea::Private::updateCursorShape()
364 bool const clickable = buffer_view_ && buffer_view_->clickableInset();
365 p->viewport()->setCursor(clickable ? Qt::PointingHandCursor
370 void GuiWorkArea::setGuiView(GuiView & gv)
376 void GuiWorkArea::setBuffer(Buffer & buffer)
378 delete d->buffer_view_;
379 d->buffer_view_ = new BufferView(buffer);
380 buffer.workAreaManager().add(this);
382 // HACK: Prevents an additional redraw when the scrollbar pops up
383 // which regularily happens on documents with more than one page.
384 // The policy should be set to "Qt::ScrollBarAsNeeded" soon.
385 // Since we have no geometry information yet, we assume that
386 // a document needs a scrollbar if there is more then four
387 // paragraph in the outermost text.
388 if (buffer.text().paragraphs().size() > 4)
389 setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOn);
390 QTimer::singleShot(50, this, SLOT(fixVerticalScrollBar()));
391 Q_EMIT bufferViewChanged();
395 void GuiWorkArea::fixVerticalScrollBar()
398 setVerticalScrollBarPolicy(Qt::ScrollBarAsNeeded);
402 void GuiWorkArea::close()
404 d->lyx_view_->removeWorkArea(this);
408 void GuiWorkArea::setFullScreen(bool full_screen)
410 d->buffer_view_->setFullScreen(full_screen);
411 setFrameStyle(QFrame::NoFrame);
413 setFrameStyle(QFrame::NoFrame);
414 if (lyxrc.full_screen_scrollbar)
415 setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
417 setVerticalScrollBarPolicy(Qt::ScrollBarAsNeeded);
421 BufferView & GuiWorkArea::bufferView()
423 return *d->buffer_view_;
427 BufferView const & GuiWorkArea::bufferView() const
429 return *d->buffer_view_;
433 void GuiWorkArea::stopBlinkingCaret()
435 d->caret_timeout_.stop();
440 void GuiWorkArea::startBlinkingCaret()
442 // do not show the cursor if the view is busy
446 // Don't start blinking if the cursor isn't on screen.
447 if (!d->buffer_view_->caretInView())
452 // Avoid blinking when debugging PAINTING, since it creates too much noise
453 if (!lyxerr.debugging(Debug::PAINTING)) {
454 // we are not supposed to cache this value.
455 int const time = QApplication::cursorFlashTime() / 2;
458 d->caret_timeout_.setInterval(time);
459 d->caret_timeout_.start();
464 void GuiWorkArea::toggleCaret()
466 if (d->caret_visible_)
473 void GuiWorkArea::scheduleRedraw(bool update_metrics)
476 // No need to redraw in this case.
479 // No need to do anything if this is the current view. The BufferView
480 // metrics are already up to date.
481 if (update_metrics || d->lyx_view_ != guiApp->currentView()
482 || d->lyx_view_->currentWorkArea() != this) {
483 // FIXME: it would be nice to optimize for the off-screen case.
484 d->buffer_view_->cursor().fixIfBroken();
485 d->buffer_view_->updateMetrics();
486 d->buffer_view_->cursor().fixIfBroken();
489 // update caret position, because otherwise it has to wait until
490 // the blinking interval is over
491 d->updateCaretGeometry();
493 LYXERR(Debug::WORKAREA, "WorkArea::redraw screen");
494 viewport()->update();
496 /// FIXME: is this still true now that paintEvent does the actual painting?
497 /// \warning: scrollbar updating *must* be done after the BufferView is drawn
498 /// because \c BufferView::updateScrollbar() is called in \c BufferView::draw().
499 d->updateScrollbar();
500 d->lyx_view_->updateStatusBar();
502 if (lyxerr.debugging(Debug::WORKAREA))
503 d->buffer_view_->coordCache().dump();
507 d->updateCursorShape();
511 // Keep in sync with GuiWorkArea::processKeySym below
512 bool GuiWorkArea::queryKeySym(KeySymbol const & key, KeyModifier mod) const
514 return guiApp->queryKeySym(key, mod);
518 // Keep in sync with GuiWorkArea::queryKeySym above
519 void GuiWorkArea::processKeySym(KeySymbol const & key, KeyModifier mod)
521 if (d->lyx_view_->isFullScreen() && d->lyx_view_->menuBar()->isVisible()
522 && lyxrc.full_screen_menubar) {
523 // FIXME HACK: we should not have to do this here. See related comment
524 // in GuiView::event() (QEvent::ShortcutOverride)
525 d->lyx_view_->menuBar()->hide();
528 // In order to avoid bad surprise in the middle of an operation,
529 // we better stop the blinking caret...
530 // the caret gets restarted in GuiView::restartCaret()
532 guiApp->processKeySym(key, mod);
536 void GuiWorkArea::Private::dispatch(FuncRequest const & cmd)
539 if (cmd.action() == LFUN_FILE_OPEN) {
541 lyx_view_->dispatch(cmd, dr);
545 bool const notJustMovingTheMouse =
546 cmd.action() != LFUN_MOUSE_MOTION || cmd.button() != mouse_button::none;
548 // In order to avoid bad surprise in the middle of an operation, we better stop
549 // the blinking caret.
550 if (notJustMovingTheMouse)
551 p->stopBlinkingCaret();
553 buffer_view_->mouseEventDispatch(cmd);
555 // Skip these when selecting
556 // FIXME: let GuiView take care of those.
557 if (cmd.action() != LFUN_MOUSE_MOTION) {
558 completer_->updateVisibility(false, false);
559 lyx_view_->updateDialogs();
560 lyx_view_->updateStatusBar();
563 // GUI tweaks except with mouse motion with no button pressed.
564 if (notJustMovingTheMouse) {
565 // Slight hack: this is only called currently when we
566 // clicked somewhere, so we force through the display
567 // of the new status here.
568 // FIXME: let GuiView take care of those.
569 lyx_view_->clearMessage();
571 // Show the caret immediately after any operation
572 p->startBlinkingCaret();
579 void GuiWorkArea::Private::resizeBufferView()
581 // WARNING: Please don't put any code that will trigger a repaint here!
582 // We are already inside a paint event.
583 p->stopBlinkingCaret();
584 // Warn our container (GuiView).
587 bool const caret_in_view = buffer_view_->caretInView();
588 buffer_view_->resize(p->viewport()->width(), p->viewport()->height());
590 buffer_view_->scrollToCursor();
591 updateCaretGeometry();
593 // Update scrollbars which might have changed due different
594 // BufferView dimension. This is especially important when the
595 // BufferView goes from zero-size to the real-size for the first time,
596 // as the scrollbar paramters are then set for the first time.
599 need_resize_ = false;
601 // Eventually, restart the caret after the resize event.
602 // We might be resizing even if the focus is on another widget so we only
603 // restart the caret if we have the focus.
605 QTimer::singleShot(50, p, SLOT(startBlinkingCaret()));
609 void GuiWorkArea::Private::updateCaretGeometry()
611 if (!buffer_view_->caretInView())
616 buffer_view_->caretPosAndHeight(point, h);
619 bool l_shape = false;
620 Font const & realfont = buffer_view_->cursor().real_current_font;
621 BufferParams const & bp = buffer_view_->buffer().params();
622 bool const samelang = realfont.language() == bp.language;
623 bool const isrtl = realfont.isVisibleRightToLeft();
625 if (!samelang || isrtl != bp.language->rightToLeft())
628 // The ERT language hack needs fixing up
629 if (realfont.language() == latex_language)
632 // show caret on screen
633 Cursor & cur = buffer_view_->cursor();
634 bool completable = cur.inset().showCompletionCursor()
635 && completer_->completionAvailable()
636 && !completer_->popupVisible()
637 && !completer_->inlineVisible();
638 caret_visible_ = true;
640 caret_->update(point.x_, point.y_, h, l_shape, isrtl, completable);
644 void GuiWorkArea::Private::showCaret()
649 updateCaretGeometry();
650 p->viewport()->update();
654 void GuiWorkArea::Private::hideCaret()
659 caret_visible_ = false;
660 //if (!qApp->focusWidget())
661 p->viewport()->update();
665 void GuiWorkArea::Private::updateScrollbar()
667 // Prevent setRange() and setSliderPosition from causing recursive calls via
668 // the signal valueChanged. (#10311)
669 QObject::disconnect(p->verticalScrollBar(), SIGNAL(valueChanged(int)),
670 p, SLOT(scrollTo(int)));
671 ScrollbarParameters const & scroll = buffer_view_->scrollbarParameters();
672 p->verticalScrollBar()->setRange(scroll.min, scroll.max);
673 p->verticalScrollBar()->setPageStep(scroll.page_step);
674 p->verticalScrollBar()->setSingleStep(scroll.single_step);
675 p->verticalScrollBar()->setSliderPosition(0);
676 // Connect to the vertical scroll bar
677 QObject::connect(p->verticalScrollBar(), SIGNAL(valueChanged(int)),
678 p, SLOT(scrollTo(int)));
682 void GuiWorkArea::scrollTo(int value)
685 d->buffer_view_->scrollDocView(value, true);
687 if (lyxrc.cursor_follows_scrollbar) {
688 d->buffer_view_->setCursorFromScrollbar();
689 // FIXME: let GuiView take care of those.
690 d->lyx_view_->updateLayoutList();
692 // Show the caret immediately after any operation.
693 startBlinkingCaret();
696 QApplication::syncX();
701 bool GuiWorkArea::event(QEvent * e)
704 case QEvent::ToolTip: {
705 QHelpEvent * helpEvent = static_cast<QHelpEvent *>(e);
706 if (lyxrc.use_tooltip) {
707 QPoint pos = helpEvent->pos();
708 if (pos.x() < viewport()->width()) {
709 QString s = toqstr(d->buffer_view_->toolTip(pos.x(), pos.y()));
710 QToolTip::showText(helpEvent->globalPos(), formatToolTip(s,35));
713 QToolTip::hideText();
715 // Don't forget to accept the event!
720 case QEvent::ShortcutOverride:
721 // keyPressEvent is ShortcutOverride-aware and only accepts the event in
723 keyPressEvent(static_cast<QKeyEvent *>(e));
724 return e->isAccepted();
726 case QEvent::KeyPress: {
727 // We catch this event in order to catch the Tab or Shift+Tab key press
728 // which are otherwise reserved to focus switching between controls
730 QKeyEvent * ke = static_cast<QKeyEvent*>(e);
731 if ((ke->key() == Qt::Key_Tab && ke->modifiers() == Qt::NoModifier)
732 || (ke->key() == Qt::Key_Backtab && (
733 ke->modifiers() == Qt::ShiftModifier
734 || ke->modifiers() == Qt::NoModifier))) {
738 return QAbstractScrollArea::event(e);
742 return QAbstractScrollArea::event(e);
748 void GuiWorkArea::contextMenuEvent(QContextMenuEvent * e)
751 if (e->reason() == QContextMenuEvent::Mouse)
752 // the menu name is set on mouse press
753 name = d->context_menu_name_;
755 QPoint pos = e->pos();
756 Cursor const & cur = d->buffer_view_->cursor();
757 if (e->reason() == QContextMenuEvent::Keyboard && cur.inTexted()) {
758 // Do not access the context menu of math right in front of before
759 // the cursor. This does not work when the cursor is in text.
760 Inset * inset = cur.paragraph().getInset(cur.pos());
761 if (inset && inset->asInsetMath())
763 else if (cur.pos() > 0) {
764 inset = cur.paragraph().getInset(cur.pos() - 1);
769 name = d->buffer_view_->contextMenu(pos.x(), pos.y());
776 // always show mnemonics when the keyboard is used to show the context menu
777 // FIXME: This should be fixed in Qt itself
778 bool const keyboard = (e->reason() == QContextMenuEvent::Keyboard);
779 QMenu * menu = guiApp->menus().menu(toqstr(name), *d->lyx_view_, keyboard);
784 // Position the menu to the right.
785 // FIXME: menu position should be different for RTL text.
786 menu->exec(e->globalPos());
791 void GuiWorkArea::focusInEvent(QFocusEvent * e)
793 LYXERR(Debug::DEBUG, "GuiWorkArea::focusInEvent(): " << this << endl);
794 if (d->lyx_view_->currentWorkArea() != this) {
795 d->lyx_view_->setCurrentWorkArea(this);
796 d->lyx_view_->currentWorkArea()->bufferView().buffer().updateBuffer();
799 startBlinkingCaret();
800 QAbstractScrollArea::focusInEvent(e);
804 void GuiWorkArea::focusOutEvent(QFocusEvent * e)
806 LYXERR(Debug::DEBUG, "GuiWorkArea::focusOutEvent(): " << this << endl);
808 QAbstractScrollArea::focusOutEvent(e);
812 void GuiWorkArea::mousePressEvent(QMouseEvent * e)
814 if (d->dc_event_.active && d->dc_event_ == *e) {
815 d->dc_event_.active = false;
816 FuncRequest cmd(LFUN_MOUSE_TRIPLE, e->x(), e->y(),
817 q_button_state(e->button()), q_key_state(e->modifiers()));
823 #if (QT_VERSION < 0x050000) && !defined(__HAIKU__)
824 inputContext()->reset();
827 FuncRequest const cmd(LFUN_MOUSE_PRESS, e->x(), e->y(),
828 q_button_state(e->button()), q_key_state(e->modifiers()));
831 // Save the context menu on mouse press, because also the mouse
832 // cursor is set on mouse press. Afterwards, we can either release
833 // the mousebutton somewhere else, or the cursor might have moved
834 // due to the DEPM. We need to do this after the mouse has been
835 // set in dispatch(), because the selection state might change.
836 if (e->button() == Qt::RightButton)
837 d->context_menu_name_ = d->buffer_view_->contextMenu(e->x(), e->y());
843 void GuiWorkArea::mouseReleaseEvent(QMouseEvent * e)
845 if (d->synthetic_mouse_event_.timeout.running())
846 d->synthetic_mouse_event_.timeout.stop();
848 FuncRequest const cmd(LFUN_MOUSE_RELEASE, e->x(), e->y(),
849 q_button_state(e->button()), q_key_state(e->modifiers()));
855 void GuiWorkArea::mouseMoveEvent(QMouseEvent * e)
857 // we kill the triple click if we move
858 doubleClickTimeout();
859 FuncRequest cmd(LFUN_MOUSE_MOTION, e->x(), e->y(),
860 q_motion_state(e->buttons()), q_key_state(e->modifiers()));
864 // If we're above or below the work area...
865 if ((e->y() <= 20 || e->y() >= viewport()->height() - 20)
866 && e->buttons() == mouse_button::button1) {
867 // Make sure only a synthetic event can cause a page scroll,
868 // so they come at a steady rate:
870 // _Force_ a scroll up:
871 cmd.set_y(e->y() - 21);
873 cmd.set_y(e->y() + 21);
874 // Store the event, to be handled when the timeout expires.
875 d->synthetic_mouse_event_.cmd = cmd;
877 if (d->synthetic_mouse_event_.timeout.running()) {
878 // Discard the event. Note that it _may_ be handled
879 // when the timeout expires if
880 // synthetic_mouse_event_.cmd has not been overwritten.
881 // Ie, when the timeout expires, we handle the
882 // most recent event but discard all others that
883 // occurred after the one used to start the timeout
884 // in the first place.
888 d->synthetic_mouse_event_.restart_timeout = true;
889 d->synthetic_mouse_event_.timeout.start();
890 // Fall through to handle this event...
892 } else if (d->synthetic_mouse_event_.timeout.running()) {
893 // Store the event, to be possibly handled when the timeout
895 // Once the timeout has expired, normal control is returned
896 // to mouseMoveEvent (restart_timeout = false).
897 // This results in a much smoother 'feel' when moving the
898 // mouse back into the work area.
899 d->synthetic_mouse_event_.cmd = cmd;
900 d->synthetic_mouse_event_.restart_timeout = false;
907 void GuiWorkArea::wheelEvent(QWheelEvent * ev)
909 // Wheel rotation by one notch results in a delta() of 120 (see
910 // documentation of QWheelEvent)
911 // But first we have to ignore horizontal scroll events.
912 #if QT_VERSION < 0x050000
913 if (ev->orientation() == Qt::Horizontal) {
917 double const delta = ev->delta() / 120.0;
919 QPoint const aDelta = ev->angleDelta();
920 // skip horizontal wheel event
921 if (abs(aDelta.x()) > abs(aDelta.y())) {
925 double const delta = aDelta.y() / 120.0;
929 switch (lyxrc.scroll_wheel_zoom) {
930 case LyXRC::SCROLL_WHEEL_ZOOM_CTRL:
931 zoom = ev->modifiers() & Qt::ControlModifier;
932 zoom &= !(ev->modifiers() & (Qt::ShiftModifier | Qt::AltModifier));
934 case LyXRC::SCROLL_WHEEL_ZOOM_SHIFT:
935 zoom = ev->modifiers() & Qt::ShiftModifier;
936 zoom &= !(ev->modifiers() & (Qt::ControlModifier | Qt::AltModifier));
938 case LyXRC::SCROLL_WHEEL_ZOOM_ALT:
939 zoom = ev->modifiers() & Qt::AltModifier;
940 zoom &= !(ev->modifiers() & (Qt::ShiftModifier | Qt::ControlModifier));
942 case LyXRC::SCROLL_WHEEL_ZOOM_OFF:
946 docstring arg = convert<docstring>(int(5 * delta));
947 lyx::dispatch(FuncRequest(LFUN_BUFFER_ZOOM_IN, arg));
951 // Take into account the desktop wide settings.
952 int const lines = qApp->wheelScrollLines();
953 int const page_step = verticalScrollBar()->pageStep();
954 // Test if the wheel mouse is set to one screen at a time.
955 // This is according to
956 // https://doc.qt.io/qt-5/qapplication.html#wheelScrollLines-prop
958 min(lines * verticalScrollBar()->singleStep(), page_step);
960 // Take into account the rotation and the user preferences.
961 scroll_value = int(scroll_value * delta * lyxrc.mouse_wheel_speed);
962 LYXERR(Debug::SCROLLING, "wheelScrollLines = " << lines
963 << " delta = " << delta << " scroll_value = " << scroll_value
964 << " page_step = " << page_step);
966 verticalScrollBar()->setValue(verticalScrollBar()->value() - scroll_value);
972 void GuiWorkArea::generateSyntheticMouseEvent()
974 int const e_y = d->synthetic_mouse_event_.cmd.y();
975 int const wh = d->buffer_view_->workHeight();
976 bool const up = e_y < 0;
977 bool const down = e_y > wh;
979 // Set things off to generate the _next_ 'pseudo' event.
981 if (d->synthetic_mouse_event_.restart_timeout) {
982 // This is some magic formulae to determine the speed
983 // of scrolling related to the position of the mouse.
986 int dist = up ? -e_y : e_y - wh;
987 time = max(min(200, 250000 / (dist * dist)), 1) ;
990 step = 80000 / (time * time);
994 d->synthetic_mouse_event_.timeout.setTimeout(time);
995 d->synthetic_mouse_event_.timeout.start();
998 // Can we scroll further ?
999 int const value = verticalScrollBar()->value();
1000 if (value == verticalScrollBar()->maximum()
1001 || value == verticalScrollBar()->minimum()) {
1002 d->synthetic_mouse_event_.timeout.stop();
1007 if (step <= 2 * wh) {
1008 d->buffer_view_->scroll(up ? -step : step);
1009 d->buffer_view_->updateMetrics();
1011 d->buffer_view_->scrollDocView(value + (up ? -step : step), false);
1014 // In which paragraph do we have to set the cursor ?
1015 Cursor & cur = d->buffer_view_->cursor();
1016 // FIXME: we don't know how to handle math.
1017 Text * text = cur.text();
1020 TextMetrics const & tm = d->buffer_view_->textMetrics(text);
1022 // Quit gracefully if there are no metrics, since otherwise next
1023 // line would crash (bug #10324).
1024 // This situation seems related to a (not yet understood) timing problem.
1028 pair<pit_type, const ParagraphMetrics *> pp = up ? tm.first() : tm.last();
1029 ParagraphMetrics const & pm = *pp.second;
1030 pit_type const pit = pp.first;
1032 if (pm.rows().empty())
1035 // Find the row at which we set the cursor.
1036 RowList::const_iterator rit = pm.rows().begin();
1037 RowList::const_iterator rlast = pm.rows().end();
1038 int yy = pm.position() - pm.ascent();
1039 for (--rlast; rit != rlast; ++rit) {
1040 int h = rit->height();
1041 if ((up && yy + h > 0)
1042 || (!up && yy + h > wh - defaultRowHeight()))
1047 // Find the position of the cursor
1049 int x = d->synthetic_mouse_event_.cmd.x();
1050 pos_type const pos = tm.getPosNearX(*rit, x, bound);
1055 cur.boundary(bound);
1057 d->buffer_view_->buffer().changed(false);
1062 // CompressorProxy adapted from Kuba Ober https://stackoverflow.com/a/21006207
1063 CompressorProxy::CompressorProxy(GuiWorkArea * wa) : QObject(wa), flag_(false)
1065 qRegisterMetaType<KeySymbol>("KeySymbol");
1066 qRegisterMetaType<KeyModifier>("KeyModifier");
1067 connect(wa, SIGNAL(compressKeySym(KeySymbol, KeyModifier, bool)),
1068 this, SLOT(slot(KeySymbol, KeyModifier, bool)),
1069 Qt::QueuedConnection);
1070 connect(this, SIGNAL(signal(KeySymbol, KeyModifier)),
1071 wa, SLOT(processKeySym(KeySymbol, KeyModifier)));
1075 bool CompressorProxy::emitCheck(bool isAutoRepeat)
1079 QCoreApplication::sendPostedEvents(this, QEvent::MetaCall); // recurse
1080 bool result = flag_;
1086 void CompressorProxy::slot(KeySymbol sym, KeyModifier mod, bool isAutoRepeat)
1088 if (emitCheck(isAutoRepeat))
1089 Q_EMIT signal(sym, mod);
1091 LYXERR(Debug::KEY, "system is busy: autoRepeat key event ignored");
1095 void GuiWorkArea::keyPressEvent(QKeyEvent * ev)
1097 // this is also called for ShortcutOverride events. In this case, one must
1098 // not act but simply accept the event explicitly.
1099 bool const act = (ev->type() != QEvent::ShortcutOverride);
1101 // Do not process here some keys if dialog_mode_ is set
1102 bool const for_dialog_mode = d->dialog_mode_
1103 && (ev->modifiers() == Qt::NoModifier
1104 || ev->modifiers() == Qt::ShiftModifier)
1105 && (ev->key() == Qt::Key_Escape
1106 || ev->key() == Qt::Key_Enter
1107 || ev->key() == Qt::Key_Return);
1108 // also do not use autoRepeat to input shortcuts
1109 bool const autoRepeat = ev->isAutoRepeat();
1111 if (for_dialog_mode || (!act && autoRepeat)) {
1116 // intercept some keys if completion popup is visible
1117 if (d->completer_->popupVisible()) {
1118 switch (ev->key()) {
1120 case Qt::Key_Return:
1122 d->completer_->activate();
1128 KeyModifier const m = q_key_state(ev->modifiers());
1130 if (act && lyxerr.debugging(Debug::KEY)) {
1132 if (m & ShiftModifier)
1134 if (m & ControlModifier)
1136 if (m & AltModifier)
1138 if (m & MetaModifier)
1140 LYXERR(Debug::KEY, " count: " << ev->count() << " text: " << ev->text()
1141 << " isAutoRepeat: " << ev->isAutoRepeat() << " key: " << ev->key()
1142 << " keyState: " << str);
1146 setKeySymbol(&sym, ev);
1149 Q_EMIT compressKeySym(sym, m, autoRepeat);
1152 // here, !autoRepeat, as determined at the beginning
1153 ev->setAccepted(queryKeySym(sym, m));
1160 void GuiWorkArea::doubleClickTimeout()
1162 d->dc_event_.active = false;
1166 void GuiWorkArea::mouseDoubleClickEvent(QMouseEvent * ev)
1168 d->dc_event_ = DoubleClick(ev);
1169 QTimer::singleShot(QApplication::doubleClickInterval(), this,
1170 SLOT(doubleClickTimeout()));
1171 FuncRequest cmd(LFUN_MOUSE_DOUBLE, ev->x(), ev->y(),
1172 q_button_state(ev->button()), q_key_state(ev->modifiers()));
1178 void GuiWorkArea::resizeEvent(QResizeEvent * ev)
1180 QAbstractScrollArea::resizeEvent(ev);
1181 d->need_resize_ = true;
1186 void GuiWorkArea::Private::paintPreeditText(GuiPainter & pain)
1188 if (preedit_string_.empty())
1191 // FIXME: shall we use real_current_font here? (see #10478)
1192 FontInfo const font = buffer_view_->cursor().getFont().fontInfo();
1193 FontMetrics const & fm = theFontMetrics(font);
1194 int const height = fm.maxHeight();
1195 int cur_x = caret_->rect().left();
1196 int cur_y = caret_->rect().bottom();
1198 // get attributes of input method cursor.
1199 // cursor_pos : cursor position in preedit string.
1200 size_t cursor_pos = 0;
1201 bool cursor_is_visible = false;
1202 for (auto const & attr : preedit_attr_) {
1203 if (attr.type == QInputMethodEvent::Cursor) {
1204 cursor_pos = attr.start;
1205 cursor_is_visible = attr.length != 0;
1210 size_t const preedit_length = preedit_string_.length();
1212 // get position of selection in input method.
1213 // FIXME: isn't there a way to do this simplier?
1214 // rStart : cursor position in selected string in IM.
1216 // rLength : selected string length in IM.
1218 if (cursor_pos < preedit_length) {
1219 for (auto const & attr : preedit_attr_) {
1220 if (attr.type == QInputMethodEvent::TextFormat) {
1221 if (attr.start <= int(cursor_pos)
1222 && int(cursor_pos) < attr.start + attr.length) {
1223 rStart = attr.start;
1224 rLength = attr.length;
1225 if (!cursor_is_visible)
1226 cursor_pos += rLength;
1233 rStart = cursor_pos;
1237 int const right_margin = buffer_view_->rightMargin();
1238 Painter::preedit_style ps;
1239 // Most often there would be only one line:
1241 for (size_t pos = 0; pos != preedit_length; ++pos) {
1242 char_type const typed_char = preedit_string_[pos];
1243 // reset preedit string style
1244 ps = Painter::preedit_default;
1246 // if we reached the right extremity of the screen, go to next line.
1247 if (cur_x + fm.width(typed_char) > p->viewport()->width() - right_margin) {
1248 cur_x = right_margin;
1249 cur_y += height + 1;
1252 // preedit strings are displayed with dashed underline
1253 // and partial strings are displayed white on black indicating
1254 // that we are in selecting mode in the input method.
1255 // FIXME: rLength == preedit_length is not a changing condition
1256 // FIXME: should be put out of the loop.
1258 && pos < rStart + rLength
1259 && !(cursor_pos < rLength && rLength == preedit_length))
1260 ps = Painter::preedit_selecting;
1262 if (pos == cursor_pos
1263 && (cursor_pos < rLength && rLength == preedit_length))
1264 ps = Painter::preedit_cursor;
1266 // draw one character and update cur_x.
1267 cur_x += pain.preeditText(cur_x, cur_y, typed_char, font, ps);
1272 void GuiWorkArea::Private::resetScreen()
1274 if (use_backingstore_) {
1275 int const pr = p->pixelRatio();
1276 screen_ = QImage(static_cast<int>(pr * p->viewport()->width()),
1277 static_cast<int>(pr * p->viewport()->height()),
1278 QImage::Format_ARGB32_Premultiplied);
1279 # if QT_VERSION >= 0x050000
1280 screen_.setDevicePixelRatio(pr);
1286 QPaintDevice * GuiWorkArea::Private::screenDevice()
1288 if (use_backingstore_)
1291 return p->viewport();
1295 void GuiWorkArea::Private::updateScreen(QRectF const & rc)
1297 if (use_backingstore_) {
1298 QPainter qpain(p->viewport());
1299 double const pr = p->pixelRatio();
1300 QRectF const rcs = QRectF(rc.x() * pr, rc.y() * pr,
1301 rc.width() * pr, rc.height() * pr);
1302 qpain.drawImage(rc, screen_, rcs);
1307 void GuiWorkArea::paintEvent(QPaintEvent * ev)
1309 // Do not trigger the painting machinery if we are not ready (see
1310 // bug #10989). The second test triggers when in the middle of a
1311 // dispatch operation.
1312 if (view().busy() || d->buffer_view_->buffer().undo().activeUndoGroup()) {
1313 // Since macOS has turned the screen black at this point, our
1314 // backing store has to be copied to screen (this is a no-op
1315 // except on macOS).
1316 d->updateScreen(ev->rect());
1317 // Ignore this paint event, but request a new one for later.
1318 viewport()->update(ev->rect());
1323 // LYXERR(Debug::PAINTING, "paintEvent begin: x: " << rc.x()
1324 // << " y: " << rc.y() << " w: " << rc.width() << " h: " << rc.height());
1326 if (d->need_resize_ || pixelRatio() != d->last_pixel_ratio_) {
1328 d->resizeBufferView();
1331 d->last_pixel_ratio_ = pixelRatio();
1333 GuiPainter pain(d->screenDevice(), pixelRatio(), d->lyx_view_->develMode());
1335 d->buffer_view_->draw(pain, d->caret_visible_);
1337 // The preedit text, if needed
1338 d->paintPreeditText(pain);
1341 if (d->caret_visible_)
1342 d->caret_->draw(pain, d->buffer_view_->horizScrollOffset());
1344 d->updateScreen(ev->rect());
1350 void GuiWorkArea::inputMethodEvent(QInputMethodEvent * e)
1352 LYXERR(Debug::KEY, "preeditString: " << e->preeditString()
1353 << " commitString: " << e->commitString());
1355 // insert the processed text in the document (handles undo)
1356 if (!e->commitString().isEmpty()) {
1357 FuncRequest cmd(LFUN_SELF_INSERT,
1358 qstring_to_ucs4(e->commitString()),
1359 FuncRequest::KEYBOARD);
1361 // FIXME: this is supposed to remove traces from preedit
1362 // string. Can we avoid calling it explicitely?
1363 d->buffer_view_->updateMetrics();
1366 // Hide the caret during the test transformation.
1367 if (e->preeditString().isEmpty())
1368 startBlinkingCaret();
1370 stopBlinkingCaret();
1372 if (d->preedit_string_.empty() && e->preeditString().isEmpty()) {
1378 // The preedit text and its attributes will be used in paintPreeditText
1379 d->preedit_string_ = qstring_to_ucs4(e->preeditString());
1380 d->preedit_attr_ = e->attributes();
1383 // redraw area of preedit string.
1384 int height = d->caret_->rect().height();
1385 int cur_y = d->caret_->rect().bottom();
1386 viewport()->update(0, cur_y - height, viewport()->width(),
1387 (height + 1) * d->preedit_lines_);
1389 if (d->preedit_string_.empty()) {
1390 d->preedit_lines_ = 1;
1395 // Don't forget to accept the event!
1400 QVariant GuiWorkArea::inputMethodQuery(Qt::InputMethodQuery query) const
1402 QRect cur_r(0, 0, 0, 0);
1404 // this is the CJK-specific composition window position and
1405 // the context menu position when the menu key is pressed.
1406 case Qt::ImMicroFocus:
1407 cur_r = d->caret_->rect();
1408 if (d->preedit_lines_ != 1)
1410 cur_r.moveBottom(cur_r.bottom()
1411 + cur_r.height() * (d->preedit_lines_ - 1));
1412 // return lower right of caret in LyX.
1415 return QWidget::inputMethodQuery(query);
1420 void GuiWorkArea::updateWindowTitle()
1422 Buffer const & buf = bufferView().buffer();
1423 if (buf.fileName() != d->file_name_
1424 || buf.params().shell_escape != d->shell_escape_
1425 || buf.hasReadonlyFlag() != d->read_only_
1426 || buf.lyxvc().vcstatus() != d->vc_status_
1427 || buf.isClean() != d->clean_
1428 || buf.notifiesExternalModification() != d->externally_modified_) {
1429 d->file_name_ = buf.fileName();
1430 d->shell_escape_ = buf.params().shell_escape;
1431 d->read_only_ = buf.hasReadonlyFlag();
1432 d->vc_status_ = buf.lyxvc().vcstatus();
1433 d->clean_ = buf.isClean();
1434 d->externally_modified_ = buf.notifiesExternalModification();
1435 Q_EMIT titleChanged(this);
1440 bool GuiWorkArea::isFullScreen() const
1442 return d->lyx_view_ && d->lyx_view_->isFullScreen();
1446 bool GuiWorkArea::inDialogMode() const
1448 return d->dialog_mode_;
1452 void GuiWorkArea::setDialogMode(bool mode)
1454 d->dialog_mode_ = mode;
1458 GuiCompleter & GuiWorkArea::completer()
1460 return *d->completer_;
1463 GuiView const & GuiWorkArea::view() const
1465 return *d->lyx_view_;
1469 GuiView & GuiWorkArea::view()
1471 return *d->lyx_view_;
1474 ////////////////////////////////////////////////////////////////////
1478 ////////////////////////////////////////////////////////////////////
1481 EmbeddedWorkArea::EmbeddedWorkArea(QWidget * w): GuiWorkArea(w)
1483 support::TempFile tempfile("embedded.internal");
1484 tempfile.setAutoRemove(false);
1485 buffer_ = theBufferList().newInternalBuffer(tempfile.name().absFileName());
1486 buffer_->setUnnamed(true);
1487 buffer_->setFullyLoaded(true);
1488 setBuffer(*buffer_);
1489 setDialogMode(true);
1493 EmbeddedWorkArea::~EmbeddedWorkArea()
1495 // No need to destroy buffer and bufferview here, because it is done
1496 // in theBufferList() destruction loop at application exit
1500 void EmbeddedWorkArea::closeEvent(QCloseEvent * ev)
1503 GuiWorkArea::closeEvent(ev);
1507 void EmbeddedWorkArea::hideEvent(QHideEvent * ev)
1510 GuiWorkArea::hideEvent(ev);
1514 QSize EmbeddedWorkArea::sizeHint () const
1517 // GuiWorkArea sets the size to the screen's viewport
1518 // by returning a value this gets overridden
1519 // EmbeddedWorkArea is now sized to fit in the layout
1520 // of the parent, and has a minimum size set in GuiWorkArea
1521 // which is what we return here
1522 return QSize(100, 70);
1526 void EmbeddedWorkArea::disable()
1528 stopBlinkingCaret();
1529 if (view().currentWorkArea() != this)
1531 // No problem if currentMainWorkArea() is 0 (setCurrentWorkArea()
1532 // tolerates it and shows the background logo), what happens if
1533 // an EmbeddedWorkArea is closed after closing all document WAs
1534 view().setCurrentWorkArea(view().currentMainWorkArea());
1537 ////////////////////////////////////////////////////////////////////
1541 ////////////////////////////////////////////////////////////////////
1544 class NoTabFrameMacStyle : public QProxyStyle {
1547 QRect subElementRect(SubElement element, const QStyleOption * option,
1548 const QWidget * widget = 0) const
1550 QRect rect = QProxyStyle::subElementRect(element, option, widget);
1551 bool noBar = static_cast<QTabWidget const *>(widget)->count() <= 1;
1553 // The Qt Mac style puts the contents into a 3 pixel wide box
1554 // which looks very ugly and not like other Mac applications.
1555 // Hence we remove this here, and moreover the 16 pixel round
1556 // frame above if the tab bar is hidden.
1557 if (element == QStyle::SE_TabWidgetTabContents) {
1558 rect.adjust(- rect.left(), 0, rect.left(), 0);
1567 NoTabFrameMacStyle noTabFrameMacStyle;
1571 TabWorkArea::TabWorkArea(QWidget * parent)
1572 : QTabWidget(parent), clicked_tab_(-1), midpressed_tab_(-1)
1575 setStyle(&noTabFrameMacStyle);
1578 QPalette pal = palette();
1579 pal.setColor(QPalette::Active, QPalette::Button,
1580 pal.color(QPalette::Active, QPalette::Window));
1581 pal.setColor(QPalette::Disabled, QPalette::Button,
1582 pal.color(QPalette::Disabled, QPalette::Window));
1583 pal.setColor(QPalette::Inactive, QPalette::Button,
1584 pal.color(QPalette::Inactive, QPalette::Window));
1586 QObject::connect(this, SIGNAL(currentChanged(int)),
1587 this, SLOT(on_currentTabChanged(int)));
1589 closeBufferButton = new QToolButton(this);
1590 closeBufferButton->setPalette(pal);
1591 // FIXME: rename the icon to closebuffer.png
1592 closeBufferButton->setIcon(QIcon(getPixmap("images/", "closetab", "svgz,png")));
1593 closeBufferButton->setText("Close File");
1594 closeBufferButton->setAutoRaise(true);
1595 closeBufferButton->setCursor(Qt::ArrowCursor);
1596 closeBufferButton->setToolTip(qt_("Close File"));
1597 closeBufferButton->setEnabled(true);
1598 QObject::connect(closeBufferButton, SIGNAL(clicked()),
1599 this, SLOT(closeCurrentBuffer()));
1600 setCornerWidget(closeBufferButton, Qt::TopRightCorner);
1602 // set TabBar behaviour
1603 QTabBar * tb = tabBar();
1604 tb->setTabsClosable(!lyxrc.single_close_tab_button);
1605 tb->setSelectionBehaviorOnRemove(QTabBar::SelectPreviousTab);
1606 tb->setElideMode(Qt::ElideNone);
1607 // allow dragging tabs
1608 tb->setMovable(true);
1609 // make us responsible for the context menu of the tabbar
1610 tb->setContextMenuPolicy(Qt::CustomContextMenu);
1611 connect(tb, SIGNAL(customContextMenuRequested(const QPoint &)),
1612 this, SLOT(showContextMenu(const QPoint &)));
1613 connect(tb, SIGNAL(tabCloseRequested(int)),
1614 this, SLOT(closeTab(int)));
1616 setUsesScrollButtons(true);
1620 void TabWorkArea::mousePressEvent(QMouseEvent *me)
1622 if (me->button() == Qt::MidButton)
1623 midpressed_tab_ = tabBar()->tabAt(me->pos());
1625 QTabWidget::mousePressEvent(me);
1629 void TabWorkArea::mouseReleaseEvent(QMouseEvent *me)
1631 if (me->button() == Qt::MidButton) {
1632 int const midreleased_tab = tabBar()->tabAt(me->pos());
1633 if (midpressed_tab_ == midreleased_tab && posIsTab(me->pos()))
1634 closeTab(midreleased_tab);
1636 QTabWidget::mouseReleaseEvent(me);
1640 void TabWorkArea::paintEvent(QPaintEvent * event)
1642 if (tabBar()->isVisible()) {
1643 QTabWidget::paintEvent(event);
1645 // Prevent the selected tab to influence the
1646 // painting of the frame of the tab widget.
1647 // This is needed for gtk style in Qt.
1648 QStylePainter p(this);
1649 #if QT_VERSION < 0x050000
1650 QStyleOptionTabWidgetFrameV2 opt;
1652 QStyleOptionTabWidgetFrame opt;
1654 initStyleOption(&opt);
1655 opt.rect = style()->subElementRect(QStyle::SE_TabWidgetTabPane,
1657 opt.selectedTabRect = QRect();
1658 p.drawPrimitive(QStyle::PE_FrameTabWidget, opt);
1663 bool TabWorkArea::posIsTab(QPoint position)
1665 // tabAt returns -1 if tab does not covers position
1666 return tabBar()->tabAt(position) > -1;
1670 void TabWorkArea::mouseDoubleClickEvent(QMouseEvent * event)
1672 if (event->button() != Qt::LeftButton)
1675 // this code chunk is unnecessary because it seems the event only makes
1676 // it this far if it is not on a tab. I'm not sure why this is (maybe
1677 // it is handled and ended in DragTabBar?), and thus I'm not sure if
1678 // this is true in all cases and if it will be true in the future so I
1679 // leave this code for now. (skostysh, 2016-07-21)
1681 // return early if double click on existing tabs
1682 if (posIsTab(event->pos()))
1685 dispatch(FuncRequest(LFUN_BUFFER_NEW));
1689 void TabWorkArea::setFullScreen(bool full_screen)
1691 for (int i = 0; i != count(); ++i) {
1692 if (GuiWorkArea * wa = workArea(i))
1693 wa->setFullScreen(full_screen);
1696 if (lyxrc.full_screen_tabbar)
1697 showBar(!full_screen && count() > 1);
1699 showBar(count() > 1);
1703 void TabWorkArea::showBar(bool show)
1705 tabBar()->setEnabled(show);
1706 tabBar()->setVisible(show);
1707 closeBufferButton->setVisible(show && lyxrc.single_close_tab_button);
1708 setTabsClosable(!lyxrc.single_close_tab_button);
1712 GuiWorkAreaContainer * TabWorkArea::widget(int index) const
1714 QWidget * w = QTabWidget::widget(index);
1717 GuiWorkAreaContainer * wac = dynamic_cast<GuiWorkAreaContainer *>(w);
1723 GuiWorkAreaContainer * TabWorkArea::currentWidget() const
1725 return widget(currentIndex());
1729 GuiWorkArea * TabWorkArea::workArea(int index) const
1731 GuiWorkAreaContainer * w = widget(index);
1734 return w->workArea();
1738 GuiWorkArea * TabWorkArea::currentWorkArea() const
1740 return workArea(currentIndex());
1744 GuiWorkArea * TabWorkArea::workArea(Buffer & buffer) const
1746 // FIXME: this method doesn't work if we have more than one work area
1747 // showing the same buffer.
1748 for (int i = 0; i != count(); ++i) {
1749 GuiWorkArea * wa = workArea(i);
1750 LASSERT(wa, return 0);
1751 if (&wa->bufferView().buffer() == &buffer)
1758 void TabWorkArea::closeAll()
1761 QWidget * wac = widget(0);
1762 LASSERT(wac, return);
1769 int TabWorkArea::indexOfWorkArea(GuiWorkArea * w) const
1771 for (int index = 0; index < count(); ++index)
1772 if (workArea(index) == w)
1778 bool TabWorkArea::setCurrentWorkArea(GuiWorkArea * work_area)
1780 LASSERT(work_area, return false);
1781 int index = indexOfWorkArea(work_area);
1785 if (index == currentIndex())
1786 // Make sure the work area is up to date.
1787 on_currentTabChanged(index);
1789 // Switch to the work area.
1790 setCurrentIndex(index);
1791 work_area->setFocus();
1797 GuiWorkArea * TabWorkArea::addWorkArea(Buffer & buffer, GuiView & view)
1799 GuiWorkArea * wa = new GuiWorkArea(buffer, view);
1800 GuiWorkAreaContainer * wac = new GuiWorkAreaContainer(wa);
1801 wa->setUpdatesEnabled(false);
1802 // Hide tabbar if there's no tab (avoid a resize and a flashing tabbar
1803 // when hiding it again below).
1804 if (!(currentWorkArea() && currentWorkArea()->isFullScreen()))
1805 showBar(count() > 0);
1806 addTab(wac, wa->windowTitle());
1807 QObject::connect(wa, SIGNAL(titleChanged(GuiWorkArea *)),
1808 this, SLOT(updateTabTexts()));
1809 if (currentWorkArea() && currentWorkArea()->isFullScreen())
1810 setFullScreen(true);
1812 // Hide tabbar if there's only one tab.
1813 showBar(count() > 1);
1821 bool TabWorkArea::removeWorkArea(GuiWorkArea * work_area)
1823 LASSERT(work_area, return false);
1824 int index = indexOfWorkArea(work_area);
1828 work_area->setUpdatesEnabled(false);
1829 QWidget * wac = widget(index);
1834 // make sure the next work area is enabled.
1835 currentWidget()->setUpdatesEnabled(true);
1836 if (currentWorkArea() && currentWorkArea()->isFullScreen())
1837 setFullScreen(true);
1839 // Show tabbar only if there's more than one tab.
1840 showBar(count() > 1);
1842 lastWorkAreaRemoved();
1850 void TabWorkArea::on_currentTabChanged(int i)
1852 // returns e.g. on application destruction
1855 GuiWorkArea * wa = workArea(i);
1856 LASSERT(wa, return);
1857 wa->setUpdatesEnabled(true);
1858 wa->scheduleRedraw(true);
1861 currentWorkAreaChanged(wa);
1863 LYXERR(Debug::GUI, "currentTabChanged " << i
1864 << " File: " << wa->bufferView().buffer().absFileName());
1868 void TabWorkArea::closeCurrentBuffer()
1871 if (clicked_tab_ == -1)
1872 wa = currentWorkArea();
1874 wa = workArea(clicked_tab_);
1875 LASSERT(wa, return);
1877 wa->view().closeWorkArea(wa);
1881 void TabWorkArea::hideCurrentTab()
1884 if (clicked_tab_ == -1)
1885 wa = currentWorkArea();
1887 wa = workArea(clicked_tab_);
1888 LASSERT(wa, return);
1890 wa->view().hideWorkArea(wa);
1894 void TabWorkArea::closeTab(int index)
1896 on_currentTabChanged(index);
1899 wa = currentWorkArea();
1901 wa = workArea(index);
1902 LASSERT(wa, return);
1904 wa->view().closeWorkArea(wa);
1911 /// make vector happy
1912 DisplayPath() : tab_(-1), dottedPrefix_(false) {}
1914 DisplayPath(int tab, FileName const & filename)
1917 // Recode URL encoded chars via fromPercentEncoding()
1918 string const fn = (filename.extension() == "lyx")
1919 ? filename.onlyFileNameWithoutExt() : filename.onlyFileName();
1920 filename_ = QString::fromUtf8(QByteArray::fromPercentEncoding(fn.c_str()));
1921 postfix_ = toqstr(filename.absoluteFilePath()).
1922 split("/", QString::SkipEmptyParts);
1923 postfix_.pop_back();
1924 abs_ = toqstr(filename.absoluteFilePath());
1925 dottedPrefix_ = false;
1928 /// Absolute path for debugging.
1933 /// Add the first segment from the postfix or three dots to the prefix.
1934 /// Merge multiple dot tripples. In fact dots are added lazily, i.e. only
1935 /// when really needed.
1936 void shiftPathSegment(bool dotted)
1938 if (postfix_.count() <= 0)
1942 if (dottedPrefix_ && !prefix_.isEmpty())
1943 prefix_ += ellipsisSlash_;
1944 prefix_ += postfix_.front() + "/";
1946 dottedPrefix_ = dotted && !prefix_.isEmpty();
1947 postfix_.pop_front();
1950 QString displayString() const
1952 if (prefix_.isEmpty())
1955 bool dots = dottedPrefix_ || !postfix_.isEmpty();
1956 return prefix_ + (dots ? ellipsisSlash_ : "") + filename_;
1959 QString forecastPathString() const
1961 if (postfix_.count() == 0)
1962 return displayString();
1965 + (dottedPrefix_ ? ellipsisSlash_ : "")
1966 + postfix_.front() + "/";
1969 bool final() const { return postfix_.empty(); }
1971 int tab() const { return tab_; }
1975 static QString const ellipsisSlash_;
1979 QStringList postfix_;
1991 QString const DisplayPath::ellipsisSlash_ = QString(QChar(0x2026)) + "/";
1995 bool operator<(DisplayPath const & a, DisplayPath const & b)
1997 return a.displayString() < b.displayString();
2001 bool operator==(DisplayPath const & a, DisplayPath const & b)
2003 return a.displayString() == b.displayString();
2007 void TabWorkArea::updateTabTexts()
2012 std::list<DisplayPath> paths;
2013 typedef std::list<DisplayPath>::iterator It;
2015 // collect full names first: path into postfix, empty prefix and
2016 // filename without extension
2017 for (size_t i = 0; i < n; ++i) {
2018 GuiWorkArea * i_wa = workArea(i);
2019 FileName const fn = i_wa->bufferView().buffer().fileName();
2020 paths.push_back(DisplayPath(i, fn));
2023 // go through path segments and see if it helps to make the path more unique
2024 bool somethingChanged = true;
2025 bool allFinal = false;
2026 while (somethingChanged && !allFinal) {
2027 // adding path segments changes order
2030 LYXERR(Debug::GUI, "updateTabTexts() iteration start");
2031 somethingChanged = false;
2034 // find segments which are not unique (i.e. non-atomic)
2035 It it = paths.begin();
2037 QString segString = it->displayString();
2038 for (; it != paths.end(); ++it) {
2039 // look to the next item
2044 allFinal = allFinal && it->final();
2046 LYXERR(Debug::GUI, "it = " << it->abs()
2047 << " => " << it->displayString());
2049 // still the same segment?
2051 if ((next != paths.end()
2052 && (nextString = next->displayString()) == segString))
2054 LYXERR(Debug::GUI, "segment ended");
2056 // only a trivial one with one element?
2057 if (it == segStart) {
2058 // start new segment
2060 segString = nextString;
2064 // We found a non-atomic segment
2065 // We know that segStart <= it < next <= paths.end().
2066 // The assertion below tells coverity about it.
2067 LATTEST(segStart != paths.end());
2068 QString dspString = segStart->forecastPathString();
2069 LYXERR(Debug::GUI, "first forecast found for "
2070 << segStart->abs() << " => " << dspString);
2073 // Shift path segments and hope for the best
2074 // that it makes the path more unique.
2075 somethingChanged = true;
2076 bool moreUnique = false;
2077 for (; sit != next; ++sit) {
2078 if (sit->forecastPathString() != dspString) {
2079 LYXERR(Debug::GUI, "different forecast found for "
2080 << sit->abs() << " => " << sit->forecastPathString());
2084 LYXERR(Debug::GUI, "same forecast found for "
2085 << sit->abs() << " => " << dspString);
2088 // if the path segment helped, add it. Otherwise add dots
2089 bool dots = !moreUnique;
2090 LYXERR(Debug::GUI, "using dots = " << dots);
2091 for (sit = segStart; sit != next; ++sit) {
2092 sit->shiftPathSegment(dots);
2093 LYXERR(Debug::GUI, "shifting "
2094 << sit->abs() << " => " << sit->displayString());
2097 // start new segment
2099 segString = nextString;
2103 // set new tab titles
2104 for (It it = paths.begin(); it != paths.end(); ++it) {
2105 int const tab_index = it->tab();
2106 Buffer const & buf = workArea(tab_index)->bufferView().buffer();
2107 QString tab_text = it->displayString().replace("&", "&&");
2108 if (!buf.fileName().empty() && !buf.isClean())
2110 QString tab_tooltip = it->abs();
2111 if (buf.hasReadonlyFlag()) {
2112 setTabIcon(tab_index, QIcon(getPixmap("images/", "emblem-readonly", "svgz,png")));
2113 tab_tooltip = qt_("%1 (read only)").arg(tab_tooltip);
2115 setTabIcon(tab_index, QIcon());
2116 if (buf.notifiesExternalModification()) {
2117 QString const warn = qt_("%1 (modified externally)");
2118 tab_tooltip = warn.arg(tab_tooltip);
2119 tab_text += QChar(0x26a0);
2121 setTabText(tab_index, tab_text);
2122 setTabToolTip(tab_index, tab_tooltip);
2127 void TabWorkArea::showContextMenu(const QPoint & pos)
2130 clicked_tab_ = tabBar()->tabAt(pos);
2131 if (clicked_tab_ == -1)
2134 GuiWorkArea * wa = workArea(clicked_tab_);
2135 LASSERT(wa, return);
2139 popup.addAction(QIcon(getPixmap("images/", "hidetab", "svgz,png")),
2140 qt_("Hide tab"), this, SLOT(hideCurrentTab()));
2142 // we want to show the 'close' option only if this is not a child buffer.
2143 Buffer const & buf = wa->bufferView().buffer();
2145 popup.addAction(QIcon(getPixmap("images/", "closetab", "svgz,png")),
2146 qt_("Close tab"), this, SLOT(closeCurrentBuffer()));
2147 popup.exec(tabBar()->mapToGlobal(pos));
2153 void TabWorkArea::moveTab(int fromIndex, int toIndex)
2155 QWidget * w = widget(fromIndex);
2156 QIcon icon = tabIcon(fromIndex);
2157 QString text = tabText(fromIndex);
2159 setCurrentIndex(fromIndex);
2160 removeTab(fromIndex);
2161 insertTab(toIndex, w, icon, text);
2162 setCurrentIndex(toIndex);
2166 GuiWorkAreaContainer::GuiWorkAreaContainer(GuiWorkArea * wa, QWidget * parent)
2167 : QWidget(parent), wa_(wa)
2169 LASSERT(wa, return);
2170 Ui::WorkAreaUi::setupUi(this);
2171 layout()->addWidget(wa);
2172 connect(wa, SIGNAL(titleChanged(GuiWorkArea *)),
2173 this, SLOT(updateDisplay()));
2174 connect(reloadPB, SIGNAL(clicked()), this, SLOT(reload()));
2175 connect(ignorePB, SIGNAL(clicked()), this, SLOT(ignore()));
2176 setMessageColour({notificationFrame}, {reloadPB, ignorePB});
2181 void GuiWorkAreaContainer::updateDisplay()
2183 Buffer const & buf = wa_->bufferView().buffer();
2184 notificationFrame->setHidden(!buf.notifiesExternalModification());
2185 QString const label = qt_("<b>The file %1 changed on disk.</b>")
2186 .arg(toqstr(buf.fileName().displayName()));
2187 externalModificationLabel->setText(label);
2191 void GuiWorkAreaContainer::dispatch(FuncRequest f) const
2193 lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
2194 wa_->bufferView().buffer().absFileName()));
2199 void GuiWorkAreaContainer::reload() const
2201 dispatch(FuncRequest(LFUN_BUFFER_RELOAD));
2205 void GuiWorkAreaContainer::ignore() const
2207 dispatch(FuncRequest(LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR));
2211 void GuiWorkAreaContainer::mouseDoubleClickEvent(QMouseEvent * event)
2213 // prevent TabWorkArea from opening a new buffer on double click
2218 } // namespace frontend
2221 #include "moc_GuiWorkArea.cpp"