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))
276 GuiWorkArea::GuiWorkArea(Buffer & buffer, GuiView & gv)
277 : d(new Private(this))
280 buffer.params().display_pixel_ratio = theGuiApp()->pixelRatio();
286 double GuiWorkArea::pixelRatio() const
288 #if QT_VERSION >= 0x050000
289 return qt_scale_factor * devicePixelRatio();
296 void GuiWorkArea::init()
299 connect(&d->caret_timeout_, SIGNAL(timeout()),
300 this, SLOT(toggleCaret()));
302 // This connection is closed at the same time as this is destroyed.
303 d->synthetic_mouse_event_.timeout.timeout.connect([this](){
304 generateSyntheticMouseEvent();
307 // With Qt4.5 a mouse event will happen before the first paint event
308 // so make sure that the buffer view has an up to date metrics.
309 d->buffer_view_->resize(viewport()->width(), viewport()->height());
310 d->caret_ = new frontend::CaretWidget();
312 setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
313 setAcceptDrops(true);
314 setMouseTracking(true);
315 setMinimumSize(100, 70);
316 setFrameStyle(QFrame::NoFrame);
319 d->updateCursorShape();
321 // we paint our own background
322 viewport()->setAttribute(Qt::WA_OpaquePaintEvent);
324 setFocusPolicy(Qt::StrongFocus);
326 LYXERR(Debug::GUI, "viewport width: " << viewport()->width()
327 << " viewport height: " << viewport()->height());
329 // Enables input methods for asian languages.
330 // Must be set when creating custom text editing widgets.
331 setAttribute(Qt::WA_InputMethodEnabled, true);
335 GuiWorkArea::~GuiWorkArea()
341 void GuiWorkArea::Private::updateCursorShape()
343 bool const clickable = buffer_view_ && buffer_view_->clickableInset();
344 p->viewport()->setCursor(clickable ? Qt::PointingHandCursor
349 void GuiWorkArea::setGuiView(GuiView & gv)
355 void GuiWorkArea::setBuffer(Buffer & buffer)
357 delete d->buffer_view_;
358 d->buffer_view_ = new BufferView(buffer);
359 buffer.workAreaManager().add(this);
361 // HACK: Prevents an additional redraw when the scrollbar pops up
362 // which regularily happens on documents with more than one page.
363 // The policy should be set to "Qt::ScrollBarAsNeeded" soon.
364 // Since we have no geometry information yet, we assume that
365 // a document needs a scrollbar if there is more then four
366 // paragraph in the outermost text.
367 if (buffer.text().paragraphs().size() > 4)
368 setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOn);
369 QTimer::singleShot(50, this, SLOT(fixVerticalScrollBar()));
370 Q_EMIT bufferViewChanged();
374 void GuiWorkArea::fixVerticalScrollBar()
377 setVerticalScrollBarPolicy(Qt::ScrollBarAsNeeded);
381 void GuiWorkArea::close()
383 d->lyx_view_->removeWorkArea(this);
387 void GuiWorkArea::setFullScreen(bool full_screen)
389 d->buffer_view_->setFullScreen(full_screen);
390 setFrameStyle(QFrame::NoFrame);
392 setFrameStyle(QFrame::NoFrame);
393 if (lyxrc.full_screen_scrollbar)
394 setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
396 setVerticalScrollBarPolicy(Qt::ScrollBarAsNeeded);
400 BufferView & GuiWorkArea::bufferView()
402 return *d->buffer_view_;
406 BufferView const & GuiWorkArea::bufferView() const
408 return *d->buffer_view_;
412 void GuiWorkArea::stopBlinkingCaret()
414 d->caret_timeout_.stop();
419 void GuiWorkArea::startBlinkingCaret()
421 // do not show the cursor if the view is busy
427 d->buffer_view_->caretPosAndHeight(p, h);
428 // Don't start blinking if the cursor isn't on screen.
429 if (!d->buffer_view_->cursorInView(p, h))
434 //we're not supposed to cache this value.
435 int const time = QApplication::cursorFlashTime() / 2;
438 d->caret_timeout_.setInterval(time);
439 d->caret_timeout_.start();
443 void GuiWorkArea::toggleCaret()
445 if (d->caret_visible_)
452 void GuiWorkArea::scheduleRedraw(bool update_metrics)
455 // No need to redraw in this case.
458 // No need to do anything if this is the current view. The BufferView
459 // metrics are already up to date.
460 if (update_metrics || d->lyx_view_ != guiApp->currentView()
461 || d->lyx_view_->currentWorkArea() != this) {
462 // FIXME: it would be nice to optimize for the off-screen case.
463 d->buffer_view_->cursor().fixIfBroken();
464 d->buffer_view_->updateMetrics();
465 d->buffer_view_->cursor().fixIfBroken();
468 // update caret position, because otherwise it has to wait until
469 // the blinking interval is over
470 if (d->caret_visible_) {
475 LYXERR(Debug::WORKAREA, "WorkArea::redraw screen");
476 viewport()->update();
478 /// \warning: scrollbar updating *must* be done after the BufferView is drawn
479 /// because \c BufferView::updateScrollbar() is called in \c BufferView::draw().
480 d->updateScrollbar();
481 d->lyx_view_->updateStatusBar();
483 if (lyxerr.debugging(Debug::WORKAREA))
484 d->buffer_view_->coordCache().dump();
488 d->updateCursorShape();
492 // Keep in sync with GuiWorkArea::processKeySym below
493 bool GuiWorkArea::queryKeySym(KeySymbol const & key, KeyModifier mod) const
495 return guiApp->queryKeySym(key, mod);
499 // Keep in sync with GuiWorkArea::queryKeySym above
500 void GuiWorkArea::processKeySym(KeySymbol const & key, KeyModifier mod)
502 if (d->lyx_view_->isFullScreen() && d->lyx_view_->menuBar()->isVisible()
503 && lyxrc.full_screen_menubar) {
504 // FIXME HACK: we should not have to do this here. See related comment
505 // in GuiView::event() (QEvent::ShortcutOverride)
506 d->lyx_view_->menuBar()->hide();
509 // In order to avoid bad surprise in the middle of an operation,
510 // we better stop the blinking caret...
511 // the caret gets restarted in GuiView::restartCaret()
513 guiApp->processKeySym(key, mod);
517 void GuiWorkArea::Private::dispatch(FuncRequest const & cmd)
520 if (cmd.action() == LFUN_FILE_OPEN) {
522 lyx_view_->dispatch(cmd, dr);
526 bool const notJustMovingTheMouse =
527 cmd.action() != LFUN_MOUSE_MOTION || cmd.button() != mouse_button::none;
529 // In order to avoid bad surprise in the middle of an operation, we better stop
530 // the blinking caret.
531 if (notJustMovingTheMouse)
532 p->stopBlinkingCaret();
534 buffer_view_->mouseEventDispatch(cmd);
536 // Skip these when selecting
537 // FIXME: let GuiView take care of those.
538 if (cmd.action() != LFUN_MOUSE_MOTION) {
539 completer_->updateVisibility(false, false);
540 lyx_view_->updateDialogs();
541 lyx_view_->updateStatusBar();
544 // GUI tweaks except with mouse motion with no button pressed.
545 if (notJustMovingTheMouse) {
546 // Slight hack: this is only called currently when we
547 // clicked somewhere, so we force through the display
548 // of the new status here.
549 // FIXME: let GuiView take care of those.
550 lyx_view_->clearMessage();
552 // Show the caret immediately after any operation
553 p->startBlinkingCaret();
560 void GuiWorkArea::Private::resizeBufferView()
562 // WARNING: Please don't put any code that will trigger a repaint here!
563 // We are already inside a paint event.
564 p->stopBlinkingCaret();
565 // Warn our container (GuiView).
570 buffer_view_->caretPosAndHeight(point, h);
571 bool const caret_in_view = buffer_view_->cursorInView(point, h);
572 buffer_view_->resize(p->viewport()->width(), p->viewport()->height());
574 buffer_view_->scrollToCursor();
575 p->viewport()->update();
577 // Update scrollbars which might have changed due different
578 // BufferView dimension. This is especially important when the
579 // BufferView goes from zero-size to the real-size for the first time,
580 // as the scrollbar paramters are then set for the first time.
583 need_resize_ = false;
585 // Eventually, restart the caret after the resize event.
586 // We might be resizing even if the focus is on another widget so we only
587 // restart the caret if we have the focus.
589 QTimer::singleShot(50, p, SLOT(startBlinkingCaret()));
593 void GuiWorkArea::Private::showCaret()
600 buffer_view_->caretPosAndHeight(point, h);
601 if (!buffer_view_->cursorInView(point, h))
605 bool l_shape = false;
606 Font const & realfont = buffer_view_->cursor().real_current_font;
607 BufferParams const & bp = buffer_view_->buffer().params();
608 bool const samelang = realfont.language() == bp.language;
609 bool const isrtl = realfont.isVisibleRightToLeft();
611 if (!samelang || isrtl != bp.language->rightToLeft())
614 // The ERT language hack needs fixing up
615 if (realfont.language() == latex_language)
618 // show caret on screen
619 Cursor & cur = buffer_view_->cursor();
620 bool completable = cur.inset().showCompletionCursor()
621 && completer_->completionAvailable()
622 && !completer_->popupVisible()
623 && !completer_->inlineVisible();
624 caret_visible_ = true;
626 //int cur_x = buffer_view_->getPos(cur).x_;
627 // We may have decided to slide the cursor row so that caret
629 point.x_ -= buffer_view_->horizScrollOffset();
631 caret_->update(point.x_, point.y_, h, l_shape, isrtl, completable);
633 p->viewport()->update(caret_->rect());
637 void GuiWorkArea::Private::hideCaret()
642 caret_visible_ = false;
643 //if (!qApp->focusWidget())
644 p->viewport()->update(caret_->rect());
648 void GuiWorkArea::Private::updateScrollbar()
650 // Prevent setRange() and setSliderPosition from causing recursive calls via
651 // the signal valueChanged. (#10311)
652 QObject::disconnect(p->verticalScrollBar(), SIGNAL(valueChanged(int)),
653 p, SLOT(scrollTo(int)));
654 ScrollbarParameters const & scroll_ = buffer_view_->scrollbarParameters();
655 p->verticalScrollBar()->setRange(scroll_.min, scroll_.max);
656 p->verticalScrollBar()->setPageStep(scroll_.page_step);
657 p->verticalScrollBar()->setSingleStep(scroll_.single_step);
658 p->verticalScrollBar()->setSliderPosition(0);
659 // Connect to the vertical scroll bar
660 QObject::connect(p->verticalScrollBar(), SIGNAL(valueChanged(int)),
661 p, SLOT(scrollTo(int)));
665 void GuiWorkArea::scrollTo(int value)
668 d->buffer_view_->scrollDocView(value, true);
670 if (lyxrc.cursor_follows_scrollbar) {
671 d->buffer_view_->setCursorFromScrollbar();
672 // FIXME: let GuiView take care of those.
673 d->lyx_view_->updateLayoutList();
675 // Show the caret immediately after any operation.
676 startBlinkingCaret();
679 QApplication::syncX();
684 bool GuiWorkArea::event(QEvent * e)
687 case QEvent::ToolTip: {
688 QHelpEvent * helpEvent = static_cast<QHelpEvent *>(e);
689 if (lyxrc.use_tooltip) {
690 QPoint pos = helpEvent->pos();
691 if (pos.x() < viewport()->width()) {
692 QString s = toqstr(d->buffer_view_->toolTip(pos.x(), pos.y()));
693 QToolTip::showText(helpEvent->globalPos(), formatToolTip(s,35));
696 QToolTip::hideText();
698 // Don't forget to accept the event!
703 case QEvent::ShortcutOverride:
704 // keyPressEvent is ShortcutOverride-aware and only accepts the event in
706 keyPressEvent(static_cast<QKeyEvent *>(e));
707 return e->isAccepted();
709 case QEvent::KeyPress: {
710 // We catch this event in order to catch the Tab or Shift+Tab key press
711 // which are otherwise reserved to focus switching between controls
713 QKeyEvent * ke = static_cast<QKeyEvent*>(e);
714 if ((ke->key() == Qt::Key_Tab && ke->modifiers() == Qt::NoModifier)
715 || (ke->key() == Qt::Key_Backtab && (
716 ke->modifiers() == Qt::ShiftModifier
717 || ke->modifiers() == Qt::NoModifier))) {
721 return QAbstractScrollArea::event(e);
725 return QAbstractScrollArea::event(e);
731 void GuiWorkArea::contextMenuEvent(QContextMenuEvent * e)
734 if (e->reason() == QContextMenuEvent::Mouse)
735 // the menu name is set on mouse press
736 name = d->context_menu_name_;
738 QPoint pos = e->pos();
739 Cursor const & cur = d->buffer_view_->cursor();
740 if (e->reason() == QContextMenuEvent::Keyboard && cur.inTexted()) {
741 // Do not access the context menu of math right in front of before
742 // the cursor. This does not work when the cursor is in text.
743 Inset * inset = cur.paragraph().getInset(cur.pos());
744 if (inset && inset->asInsetMath())
746 else if (cur.pos() > 0) {
747 Inset * inset = cur.paragraph().getInset(cur.pos() - 1);
752 name = d->buffer_view_->contextMenu(pos.x(), pos.y());
759 // always show mnemonics when the keyboard is used to show the context menu
760 // FIXME: This should be fixed in Qt itself
761 bool const keyboard = (e->reason() == QContextMenuEvent::Keyboard);
762 QMenu * menu = guiApp->menus().menu(toqstr(name), *d->lyx_view_, keyboard);
767 // Position the menu to the right.
768 // FIXME: menu position should be different for RTL text.
769 menu->exec(e->globalPos());
774 void GuiWorkArea::focusInEvent(QFocusEvent * e)
776 LYXERR(Debug::DEBUG, "GuiWorkArea::focusInEvent(): " << this << endl);
777 if (d->lyx_view_->currentWorkArea() != this) {
778 d->lyx_view_->setCurrentWorkArea(this);
779 d->lyx_view_->currentWorkArea()->bufferView().buffer().updateBuffer();
782 startBlinkingCaret();
783 QAbstractScrollArea::focusInEvent(e);
787 void GuiWorkArea::focusOutEvent(QFocusEvent * e)
789 LYXERR(Debug::DEBUG, "GuiWorkArea::focusOutEvent(): " << this << endl);
791 QAbstractScrollArea::focusOutEvent(e);
795 void GuiWorkArea::mousePressEvent(QMouseEvent * e)
797 if (d->dc_event_.active && d->dc_event_ == *e) {
798 d->dc_event_.active = false;
799 FuncRequest cmd(LFUN_MOUSE_TRIPLE, e->x(), e->y(),
800 q_button_state(e->button()), q_key_state(e->modifiers()));
806 #if (QT_VERSION < 0x050000) && !defined(__HAIKU__)
807 inputContext()->reset();
810 FuncRequest const cmd(LFUN_MOUSE_PRESS, e->x(), e->y(),
811 q_button_state(e->button()), q_key_state(e->modifiers()));
814 // Save the context menu on mouse press, because also the mouse
815 // cursor is set on mouse press. Afterwards, we can either release
816 // the mousebutton somewhere else, or the cursor might have moved
817 // due to the DEPM. We need to do this after the mouse has been
818 // set in dispatch(), because the selection state might change.
819 if (e->button() == Qt::RightButton)
820 d->context_menu_name_ = d->buffer_view_->contextMenu(e->x(), e->y());
826 void GuiWorkArea::mouseReleaseEvent(QMouseEvent * e)
828 if (d->synthetic_mouse_event_.timeout.running())
829 d->synthetic_mouse_event_.timeout.stop();
831 FuncRequest const cmd(LFUN_MOUSE_RELEASE, e->x(), e->y(),
832 q_button_state(e->button()), q_key_state(e->modifiers()));
838 void GuiWorkArea::mouseMoveEvent(QMouseEvent * e)
840 // we kill the triple click if we move
841 doubleClickTimeout();
842 FuncRequest cmd(LFUN_MOUSE_MOTION, e->x(), e->y(),
843 q_motion_state(e->buttons()), q_key_state(e->modifiers()));
847 // If we're above or below the work area...
848 if ((e->y() <= 20 || e->y() >= viewport()->height() - 20)
849 && e->buttons() == mouse_button::button1) {
850 // Make sure only a synthetic event can cause a page scroll,
851 // so they come at a steady rate:
853 // _Force_ a scroll up:
854 cmd.set_y(e->y() - 21);
856 cmd.set_y(e->y() + 21);
857 // Store the event, to be handled when the timeout expires.
858 d->synthetic_mouse_event_.cmd = cmd;
860 if (d->synthetic_mouse_event_.timeout.running()) {
861 // Discard the event. Note that it _may_ be handled
862 // when the timeout expires if
863 // synthetic_mouse_event_.cmd has not been overwritten.
864 // Ie, when the timeout expires, we handle the
865 // most recent event but discard all others that
866 // occurred after the one used to start the timeout
867 // in the first place.
871 d->synthetic_mouse_event_.restart_timeout = true;
872 d->synthetic_mouse_event_.timeout.start();
873 // Fall through to handle this event...
875 } else if (d->synthetic_mouse_event_.timeout.running()) {
876 // Store the event, to be possibly handled when the timeout
878 // Once the timeout has expired, normal control is returned
879 // to mouseMoveEvent (restart_timeout = false).
880 // This results in a much smoother 'feel' when moving the
881 // mouse back into the work area.
882 d->synthetic_mouse_event_.cmd = cmd;
883 d->synthetic_mouse_event_.restart_timeout = false;
890 void GuiWorkArea::wheelEvent(QWheelEvent * ev)
892 // Wheel rotation by one notch results in a delta() of 120 (see
893 // documentation of QWheelEvent)
894 double const delta = ev->delta() / 120.0;
896 switch (lyxrc.scroll_wheel_zoom) {
897 case LyXRC::SCROLL_WHEEL_ZOOM_CTRL:
898 zoom = ev->modifiers() & Qt::ControlModifier;
899 zoom &= !(ev->modifiers() & (Qt::ShiftModifier | Qt::AltModifier));
901 case LyXRC::SCROLL_WHEEL_ZOOM_SHIFT:
902 zoom = ev->modifiers() & Qt::ShiftModifier;
903 zoom &= !(ev->modifiers() & (Qt::ControlModifier | Qt::AltModifier));
905 case LyXRC::SCROLL_WHEEL_ZOOM_ALT:
906 zoom = ev->modifiers() & Qt::AltModifier;
907 zoom &= !(ev->modifiers() & (Qt::ShiftModifier | Qt::ControlModifier));
909 case LyXRC::SCROLL_WHEEL_ZOOM_OFF:
913 docstring arg = convert<docstring>(int(5 * delta));
914 lyx::dispatch(FuncRequest(LFUN_BUFFER_ZOOM_IN, arg));
918 // Take into account the desktop wide settings.
919 int const lines = qApp->wheelScrollLines();
920 int const page_step = verticalScrollBar()->pageStep();
921 // Test if the wheel mouse is set to one screen at a time.
922 // This is according to
923 // https://doc.qt.io/qt-5/qapplication.html#wheelScrollLines-prop
925 min(lines * verticalScrollBar()->singleStep(), page_step);
927 // Take into account the rotation and the user preferences.
928 scroll_value = int(scroll_value * delta * lyxrc.mouse_wheel_speed);
929 LYXERR(Debug::SCROLLING, "wheelScrollLines = " << lines
930 << " delta = " << delta << " scroll_value = " << scroll_value
931 << " page_step = " << page_step);
933 verticalScrollBar()->setValue(verticalScrollBar()->value() - scroll_value);
939 void GuiWorkArea::generateSyntheticMouseEvent()
941 int const e_y = d->synthetic_mouse_event_.cmd.y();
942 int const wh = d->buffer_view_->workHeight();
943 bool const up = e_y < 0;
944 bool const down = e_y > wh;
946 // Set things off to generate the _next_ 'pseudo' event.
948 if (d->synthetic_mouse_event_.restart_timeout) {
949 // This is some magic formulae to determine the speed
950 // of scrolling related to the position of the mouse.
953 int dist = up ? -e_y : e_y - wh;
954 time = max(min(200, 250000 / (dist * dist)), 1) ;
957 step = 80000 / (time * time);
961 d->synthetic_mouse_event_.timeout.setTimeout(time);
962 d->synthetic_mouse_event_.timeout.start();
965 // Can we scroll further ?
966 int const value = verticalScrollBar()->value();
967 if (value == verticalScrollBar()->maximum()
968 || value == verticalScrollBar()->minimum()) {
969 d->synthetic_mouse_event_.timeout.stop();
974 if (step <= 2 * wh) {
975 d->buffer_view_->scroll(up ? -step : step);
976 d->buffer_view_->updateMetrics();
978 d->buffer_view_->scrollDocView(value + (up ? -step : step), false);
981 // In which paragraph do we have to set the cursor ?
982 Cursor & cur = d->buffer_view_->cursor();
983 // FIXME: we don't know how to handle math.
984 Text * text = cur.text();
987 TextMetrics const & tm = d->buffer_view_->textMetrics(text);
989 // Quit gracefully if there are no metrics, since otherwise next
990 // line would crash (bug #10324).
991 // This situation seems related to a (not yet understood) timing problem.
995 pair<pit_type, const ParagraphMetrics *> pp = up ? tm.first() : tm.last();
996 ParagraphMetrics const & pm = *pp.second;
997 pit_type const pit = pp.first;
999 if (pm.rows().empty())
1002 // Find the row at which we set the cursor.
1003 RowList::const_iterator rit = pm.rows().begin();
1004 RowList::const_iterator rlast = pm.rows().end();
1005 int yy = pm.position() - pm.ascent();
1006 for (--rlast; rit != rlast; ++rit) {
1007 int h = rit->height();
1008 if ((up && yy + h > 0)
1009 || (!up && yy + h > wh - defaultRowHeight()))
1014 // Find the position of the cursor
1016 int x = d->synthetic_mouse_event_.cmd.x();
1017 pos_type const pos = tm.getPosNearX(*rit, x, bound);
1022 cur.boundary(bound);
1024 d->buffer_view_->buffer().changed(false);
1029 void GuiWorkArea::keyPressEvent(QKeyEvent * ev)
1031 // this is also called for ShortcutOverride events. In this case, one must
1032 // not act but simply accept the event explicitly.
1033 bool const act = (ev->type() != QEvent::ShortcutOverride);
1035 // Do not process here some keys if dialog_mode_ is set
1037 && (ev->modifiers() == Qt::NoModifier
1038 || ev->modifiers() == Qt::ShiftModifier)
1039 && (ev->key() == Qt::Key_Escape
1040 || ev->key() == Qt::Key_Enter
1041 || ev->key() == Qt::Key_Return)
1047 // intercept some keys if completion popup is visible
1048 if (d->completer_->popupVisible()) {
1049 switch (ev->key()) {
1051 case Qt::Key_Return:
1053 d->completer_->activate();
1059 // do nothing if there are other events
1060 // (the auto repeated events come too fast)
1061 // it looks like this is only needed on X11
1062 #if defined(Q_WS_X11) || defined(QPA_XCB)
1063 // FIXME: this is a weird way to implement event compression. Also, this is
1064 // broken with IBus.
1065 if (act && qApp->hasPendingEvents() && ev->isAutoRepeat()) {
1066 switch (ev->key()) {
1067 case Qt::Key_PageDown:
1068 case Qt::Key_PageUp:
1073 LYXERR(Debug::KEY, "system is busy: scroll key event ignored");
1080 KeyModifier const m = q_key_state(ev->modifiers());
1083 if (m & ShiftModifier)
1085 if (m & ControlModifier)
1087 if (m & AltModifier)
1089 if (m & MetaModifier)
1093 LYXERR(Debug::KEY, " count: " << ev->count() << " text: " << ev->text()
1094 << " isAutoRepeat: " << ev->isAutoRepeat() << " key: " << ev->key()
1095 << " keyState: " << str);
1098 setKeySymbol(&sym, ev);
1101 processKeySym(sym, m);
1104 ev->setAccepted(queryKeySym(sym, m));
1111 void GuiWorkArea::doubleClickTimeout()
1113 d->dc_event_.active = false;
1117 void GuiWorkArea::mouseDoubleClickEvent(QMouseEvent * ev)
1119 d->dc_event_ = DoubleClick(ev);
1120 QTimer::singleShot(QApplication::doubleClickInterval(), this,
1121 SLOT(doubleClickTimeout()));
1122 FuncRequest cmd(LFUN_MOUSE_DOUBLE, ev->x(), ev->y(),
1123 q_button_state(ev->button()), q_key_state(ev->modifiers()));
1129 void GuiWorkArea::resizeEvent(QResizeEvent * ev)
1131 QAbstractScrollArea::resizeEvent(ev);
1132 d->need_resize_ = true;
1137 void GuiWorkArea::Private::paintPreeditText(GuiPainter & pain)
1139 if (preedit_string_.empty())
1142 // FIXME: shall we use real_current_font here? (see #10478)
1143 FontInfo const font = buffer_view_->cursor().getFont().fontInfo();
1144 FontMetrics const & fm = theFontMetrics(font);
1145 int const height = fm.maxHeight();
1146 int cur_x = caret_->rect().left();
1147 int cur_y = caret_->rect().bottom();
1149 // get attributes of input method cursor.
1150 // cursor_pos : cursor position in preedit string.
1151 size_t cursor_pos = 0;
1152 bool cursor_is_visible = false;
1153 for (auto const & attr : preedit_attr_) {
1154 if (attr.type == QInputMethodEvent::Cursor) {
1155 cursor_pos = attr.start;
1156 cursor_is_visible = attr.length != 0;
1161 size_t const preedit_length = preedit_string_.length();
1163 // get position of selection in input method.
1164 // FIXME: isn't there a way to do this simplier?
1165 // rStart : cursor position in selected string in IM.
1167 // rLength : selected string length in IM.
1169 if (cursor_pos < preedit_length) {
1170 for (auto const & attr : preedit_attr_) {
1171 if (attr.type == QInputMethodEvent::TextFormat) {
1172 if (attr.start <= int(cursor_pos)
1173 && int(cursor_pos) < attr.start + attr.length) {
1174 rStart = attr.start;
1175 rLength = attr.length;
1176 if (!cursor_is_visible)
1177 cursor_pos += rLength;
1184 rStart = cursor_pos;
1188 int const right_margin = buffer_view_->rightMargin();
1189 Painter::preedit_style ps;
1190 // Most often there would be only one line:
1192 for (size_t pos = 0; pos != preedit_length; ++pos) {
1193 char_type const typed_char = preedit_string_[pos];
1194 // reset preedit string style
1195 ps = Painter::preedit_default;
1197 // if we reached the right extremity of the screen, go to next line.
1198 if (cur_x + fm.width(typed_char) > p->viewport()->width() - right_margin) {
1199 cur_x = right_margin;
1200 cur_y += height + 1;
1203 // preedit strings are displayed with dashed underline
1204 // and partial strings are displayed white on black indicating
1205 // that we are in selecting mode in the input method.
1206 // FIXME: rLength == preedit_length is not a changing condition
1207 // FIXME: should be put out of the loop.
1209 && pos < rStart + rLength
1210 && !(cursor_pos < rLength && rLength == preedit_length))
1211 ps = Painter::preedit_selecting;
1213 if (pos == cursor_pos
1214 && (cursor_pos < rLength && rLength == preedit_length))
1215 ps = Painter::preedit_cursor;
1217 // draw one character and update cur_x.
1218 cur_x += pain.preeditText(cur_x, cur_y, typed_char, font, ps);
1223 void GuiWorkArea::paintEvent(QPaintEvent * ev)
1225 // LYXERR(Debug::PAINTING, "paintEvent begin: x: " << rc.x()
1226 // << " y: " << rc.y() << " w: " << rc.width() << " h: " << rc.height());
1228 if (d->need_resize_ || pixelRatio() != d->last_pixel_ratio_) {
1229 d->resizeBufferView();
1230 if (d->caret_visible_) {
1236 d->last_pixel_ratio_ = pixelRatio();
1238 GuiPainter pain(viewport(), pixelRatio());
1239 d->buffer_view_->draw(pain, d->caret_visible_);
1241 // The preedit text, if needed
1242 d->paintPreeditText(pain);
1245 if (d->caret_visible_)
1246 d->caret_->draw(pain);
1251 void GuiWorkArea::inputMethodEvent(QInputMethodEvent * e)
1253 LYXERR(Debug::KEY, "preeditString: " << e->preeditString()
1254 << " commitString: " << e->commitString());
1256 // insert the processed text in the document (handles undo)
1257 if (!e->commitString().isEmpty()) {
1258 d->buffer_view_->cursor().beginUndoGroup();
1259 d->buffer_view_->cursor().insert(qstring_to_ucs4(e->commitString()));
1260 d->buffer_view_->updateMetrics();
1261 d->buffer_view_->cursor().endUndoGroup();
1262 viewport()->update();
1265 // Hide the caret during the test transformation.
1266 if (e->preeditString().isEmpty())
1267 startBlinkingCaret();
1269 stopBlinkingCaret();
1271 if (d->preedit_string_.empty() && e->preeditString().isEmpty()) {
1277 // The preedit text and its attributes will be used in paintPreeditText
1278 d->preedit_string_ = qstring_to_ucs4(e->preeditString());
1279 d->preedit_attr_ = e->attributes();
1282 // redraw area of preedit string.
1283 int height = d->caret_->rect().height();
1284 int cur_y = d->caret_->rect().bottom();
1285 viewport()->update(0, cur_y - height, viewport()->width(),
1286 (height + 1) * d->preedit_lines_);
1288 if (d->preedit_string_.empty()) {
1289 d->preedit_lines_ = 1;
1294 // Don't forget to accept the event!
1299 QVariant GuiWorkArea::inputMethodQuery(Qt::InputMethodQuery query) const
1301 QRect cur_r(0, 0, 0, 0);
1303 // this is the CJK-specific composition window position and
1304 // the context menu position when the menu key is pressed.
1305 case Qt::ImMicroFocus:
1306 cur_r = d->caret_->rect();
1307 if (d->preedit_lines_ != 1)
1309 cur_r.moveBottom(cur_r.bottom()
1310 + cur_r.height() * (d->preedit_lines_ - 1));
1311 // return lower right of caret in LyX.
1314 return QWidget::inputMethodQuery(query);
1319 void GuiWorkArea::updateWindowTitle()
1321 Buffer const & buf = bufferView().buffer();
1322 if (buf.fileName() != d->file_name_
1323 || buf.params().shell_escape != d->shell_escape_
1324 || buf.hasReadonlyFlag() != d->read_only_
1325 || buf.lyxvc().vcstatus() != d->vc_status_
1326 || buf.isClean() != d->clean_
1327 || buf.notifiesExternalModification() != d->externally_modified_) {
1328 d->file_name_ = buf.fileName();
1329 d->shell_escape_ = buf.params().shell_escape;
1330 d->read_only_ = buf.hasReadonlyFlag();
1331 d->vc_status_ = buf.lyxvc().vcstatus();
1332 d->clean_ = buf.isClean();
1333 d->externally_modified_ = buf.notifiesExternalModification();
1334 Q_EMIT titleChanged(this);
1339 bool GuiWorkArea::isFullScreen() const
1341 return d->lyx_view_ && d->lyx_view_->isFullScreen();
1345 bool GuiWorkArea::inDialogMode() const
1347 return d->dialog_mode_;
1351 void GuiWorkArea::setDialogMode(bool mode)
1353 d->dialog_mode_ = mode;
1357 GuiCompleter & GuiWorkArea::completer()
1359 return *d->completer_;
1362 GuiView const & GuiWorkArea::view() const
1364 return *d->lyx_view_;
1368 GuiView & GuiWorkArea::view()
1370 return *d->lyx_view_;
1373 ////////////////////////////////////////////////////////////////////
1377 ////////////////////////////////////////////////////////////////////
1380 EmbeddedWorkArea::EmbeddedWorkArea(QWidget * w): GuiWorkArea(w)
1382 support::TempFile tempfile("embedded.internal");
1383 tempfile.setAutoRemove(false);
1384 buffer_ = theBufferList().newInternalBuffer(tempfile.name().absFileName());
1385 buffer_->setUnnamed(true);
1386 buffer_->setFullyLoaded(true);
1387 setBuffer(*buffer_);
1388 setDialogMode(true);
1392 EmbeddedWorkArea::~EmbeddedWorkArea()
1394 // No need to destroy buffer and bufferview here, because it is done
1395 // in theBufferList() destruction loop at application exit
1399 void EmbeddedWorkArea::closeEvent(QCloseEvent * ev)
1402 GuiWorkArea::closeEvent(ev);
1406 void EmbeddedWorkArea::hideEvent(QHideEvent * ev)
1409 GuiWorkArea::hideEvent(ev);
1413 QSize EmbeddedWorkArea::sizeHint () const
1416 // GuiWorkArea sets the size to the screen's viewport
1417 // by returning a value this gets overridden
1418 // EmbeddedWorkArea is now sized to fit in the layout
1419 // of the parent, and has a minimum size set in GuiWorkArea
1420 // which is what we return here
1421 return QSize(100, 70);
1425 void EmbeddedWorkArea::disable()
1427 stopBlinkingCaret();
1428 if (view().currentWorkArea() != this)
1430 // No problem if currentMainWorkArea() is 0 (setCurrentWorkArea()
1431 // tolerates it and shows the background logo), what happens if
1432 // an EmbeddedWorkArea is closed after closing all document WAs
1433 view().setCurrentWorkArea(view().currentMainWorkArea());
1436 ////////////////////////////////////////////////////////////////////
1440 ////////////////////////////////////////////////////////////////////
1443 class NoTabFrameMacStyle : public QProxyStyle {
1446 QRect subElementRect(SubElement element, const QStyleOption * option,
1447 const QWidget * widget = 0) const
1449 QRect rect = QProxyStyle::subElementRect(element, option, widget);
1450 bool noBar = static_cast<QTabWidget const *>(widget)->count() <= 1;
1452 // The Qt Mac style puts the contents into a 3 pixel wide box
1453 // which looks very ugly and not like other Mac applications.
1454 // Hence we remove this here, and moreover the 16 pixel round
1455 // frame above if the tab bar is hidden.
1456 if (element == QStyle::SE_TabWidgetTabContents) {
1457 rect.adjust(- rect.left(), 0, rect.left(), 0);
1466 NoTabFrameMacStyle noTabFrameMacStyle;
1470 TabWorkArea::TabWorkArea(QWidget * parent)
1471 : QTabWidget(parent), clicked_tab_(-1), midpressed_tab_(-1)
1474 setStyle(&noTabFrameMacStyle);
1477 QPalette pal = palette();
1478 pal.setColor(QPalette::Active, QPalette::Button,
1479 pal.color(QPalette::Active, QPalette::Window));
1480 pal.setColor(QPalette::Disabled, QPalette::Button,
1481 pal.color(QPalette::Disabled, QPalette::Window));
1482 pal.setColor(QPalette::Inactive, QPalette::Button,
1483 pal.color(QPalette::Inactive, QPalette::Window));
1485 QObject::connect(this, SIGNAL(currentChanged(int)),
1486 this, SLOT(on_currentTabChanged(int)));
1488 closeBufferButton = new QToolButton(this);
1489 closeBufferButton->setPalette(pal);
1490 // FIXME: rename the icon to closebuffer.png
1491 closeBufferButton->setIcon(QIcon(getPixmap("images/", "closetab", "svgz,png")));
1492 closeBufferButton->setText("Close File");
1493 closeBufferButton->setAutoRaise(true);
1494 closeBufferButton->setCursor(Qt::ArrowCursor);
1495 closeBufferButton->setToolTip(qt_("Close File"));
1496 closeBufferButton->setEnabled(true);
1497 QObject::connect(closeBufferButton, SIGNAL(clicked()),
1498 this, SLOT(closeCurrentBuffer()));
1499 setCornerWidget(closeBufferButton, Qt::TopRightCorner);
1501 // setup drag'n'drop
1502 QTabBar* tb = new DragTabBar;
1503 connect(tb, SIGNAL(tabMoveRequested(int, int)),
1504 this, SLOT(moveTab(int, int)));
1505 tb->setElideMode(Qt::ElideNone);
1508 // make us responsible for the context menu of the tabbar
1509 tb->setContextMenuPolicy(Qt::CustomContextMenu);
1510 connect(tb, SIGNAL(customContextMenuRequested(const QPoint &)),
1511 this, SLOT(showContextMenu(const QPoint &)));
1512 connect(tb, SIGNAL(tabCloseRequested(int)),
1513 this, SLOT(closeTab(int)));
1515 setUsesScrollButtons(true);
1519 void TabWorkArea::mousePressEvent(QMouseEvent *me)
1521 if (me->button() == Qt::MidButton)
1522 midpressed_tab_ = tabBar()->tabAt(me->pos());
1524 QTabWidget::mousePressEvent(me);
1528 void TabWorkArea::mouseReleaseEvent(QMouseEvent *me)
1530 if (me->button() == Qt::MidButton) {
1531 int const midreleased_tab = tabBar()->tabAt(me->pos());
1532 if (midpressed_tab_ == midreleased_tab && posIsTab(me->pos()))
1533 closeTab(midreleased_tab);
1535 QTabWidget::mouseReleaseEvent(me);
1539 void TabWorkArea::paintEvent(QPaintEvent * event)
1541 if (tabBar()->isVisible()) {
1542 QTabWidget::paintEvent(event);
1544 // Prevent the selected tab to influence the
1545 // painting of the frame of the tab widget.
1546 // This is needed for gtk style in Qt.
1547 QStylePainter p(this);
1548 #if QT_VERSION < 0x050000
1549 QStyleOptionTabWidgetFrameV2 opt;
1551 QStyleOptionTabWidgetFrame opt;
1553 initStyleOption(&opt);
1554 opt.rect = style()->subElementRect(QStyle::SE_TabWidgetTabPane,
1556 opt.selectedTabRect = QRect();
1557 p.drawPrimitive(QStyle::PE_FrameTabWidget, opt);
1562 bool TabWorkArea::posIsTab(QPoint position)
1564 // tabAt returns -1 if tab does not covers position
1565 return tabBar()->tabAt(position) > -1;
1569 void TabWorkArea::mouseDoubleClickEvent(QMouseEvent * event)
1571 if (event->button() != Qt::LeftButton)
1574 // this code chunk is unnecessary because it seems the event only makes
1575 // it this far if it is not on a tab. I'm not sure why this is (maybe
1576 // it is handled and ended in DragTabBar?), and thus I'm not sure if
1577 // this is true in all cases and if it will be true in the future so I
1578 // leave this code for now. (skostysh, 2016-07-21)
1580 // return early if double click on existing tabs
1581 if (posIsTab(event->pos()))
1584 dispatch(FuncRequest(LFUN_BUFFER_NEW));
1588 void TabWorkArea::setFullScreen(bool full_screen)
1590 for (int i = 0; i != count(); ++i) {
1591 if (GuiWorkArea * wa = workArea(i))
1592 wa->setFullScreen(full_screen);
1595 if (lyxrc.full_screen_tabbar)
1596 showBar(!full_screen && count() > 1);
1598 showBar(count() > 1);
1602 void TabWorkArea::showBar(bool show)
1604 tabBar()->setEnabled(show);
1605 tabBar()->setVisible(show);
1606 closeBufferButton->setVisible(show && lyxrc.single_close_tab_button);
1607 setTabsClosable(!lyxrc.single_close_tab_button);
1611 GuiWorkAreaContainer * TabWorkArea::widget(int index) const
1613 QWidget * w = QTabWidget::widget(index);
1616 GuiWorkAreaContainer * wac = dynamic_cast<GuiWorkAreaContainer *>(w);
1622 GuiWorkAreaContainer * TabWorkArea::currentWidget() const
1624 return widget(currentIndex());
1628 GuiWorkArea * TabWorkArea::workArea(int index) const
1630 GuiWorkAreaContainer * w = widget(index);
1633 return w->workArea();
1637 GuiWorkArea * TabWorkArea::currentWorkArea() const
1639 return workArea(currentIndex());
1643 GuiWorkArea * TabWorkArea::workArea(Buffer & buffer) const
1645 // FIXME: this method doesn't work if we have more than one work area
1646 // showing the same buffer.
1647 for (int i = 0; i != count(); ++i) {
1648 GuiWorkArea * wa = workArea(i);
1649 LASSERT(wa, return 0);
1650 if (&wa->bufferView().buffer() == &buffer)
1657 void TabWorkArea::closeAll()
1660 QWidget * wac = widget(0);
1661 LASSERT(wac, return);
1668 int TabWorkArea::indexOfWorkArea(GuiWorkArea * w) const
1670 for (int index = 0; index < count(); ++index)
1671 if (workArea(index) == w)
1677 bool TabWorkArea::setCurrentWorkArea(GuiWorkArea * work_area)
1679 LASSERT(work_area, return false);
1680 int index = indexOfWorkArea(work_area);
1684 if (index == currentIndex())
1685 // Make sure the work area is up to date.
1686 on_currentTabChanged(index);
1688 // Switch to the work area.
1689 setCurrentIndex(index);
1690 work_area->setFocus();
1696 GuiWorkArea * TabWorkArea::addWorkArea(Buffer & buffer, GuiView & view)
1698 GuiWorkArea * wa = new GuiWorkArea(buffer, view);
1699 GuiWorkAreaContainer * wac = new GuiWorkAreaContainer(wa);
1700 wa->setUpdatesEnabled(false);
1701 // Hide tabbar if there's no tab (avoid a resize and a flashing tabbar
1702 // when hiding it again below).
1703 if (!(currentWorkArea() && currentWorkArea()->isFullScreen()))
1704 showBar(count() > 0);
1705 addTab(wac, wa->windowTitle());
1706 QObject::connect(wa, SIGNAL(titleChanged(GuiWorkArea *)),
1707 this, SLOT(updateTabTexts()));
1708 if (currentWorkArea() && currentWorkArea()->isFullScreen())
1709 setFullScreen(true);
1711 // Hide tabbar if there's only one tab.
1712 showBar(count() > 1);
1720 bool TabWorkArea::removeWorkArea(GuiWorkArea * work_area)
1722 LASSERT(work_area, return false);
1723 int index = indexOfWorkArea(work_area);
1727 work_area->setUpdatesEnabled(false);
1728 QWidget * wac = widget(index);
1733 // make sure the next work area is enabled.
1734 currentWidget()->setUpdatesEnabled(true);
1735 if (currentWorkArea() && currentWorkArea()->isFullScreen())
1736 setFullScreen(true);
1738 // Show tabbar only if there's more than one tab.
1739 showBar(count() > 1);
1741 lastWorkAreaRemoved();
1749 void TabWorkArea::on_currentTabChanged(int i)
1751 // returns e.g. on application destruction
1754 GuiWorkArea * wa = workArea(i);
1755 LASSERT(wa, return);
1756 wa->setUpdatesEnabled(true);
1757 wa->scheduleRedraw(true);
1760 currentWorkAreaChanged(wa);
1762 LYXERR(Debug::GUI, "currentTabChanged " << i
1763 << " File: " << wa->bufferView().buffer().absFileName());
1767 void TabWorkArea::closeCurrentBuffer()
1770 if (clicked_tab_ == -1)
1771 wa = currentWorkArea();
1773 wa = workArea(clicked_tab_);
1774 LASSERT(wa, return);
1776 wa->view().closeWorkArea(wa);
1780 void TabWorkArea::hideCurrentTab()
1783 if (clicked_tab_ == -1)
1784 wa = currentWorkArea();
1786 wa = workArea(clicked_tab_);
1787 LASSERT(wa, return);
1789 wa->view().hideWorkArea(wa);
1793 void TabWorkArea::closeTab(int index)
1795 on_currentTabChanged(index);
1798 wa = currentWorkArea();
1800 wa = workArea(index);
1801 LASSERT(wa, return);
1803 wa->view().closeWorkArea(wa);
1810 /// make vector happy
1811 DisplayPath() : tab_(-1), dottedPrefix_(false) {}
1813 DisplayPath(int tab, FileName const & filename)
1816 filename_ = (filename.extension() == "lyx") ?
1817 toqstr(filename.onlyFileNameWithoutExt())
1818 : toqstr(filename.onlyFileName());
1819 postfix_ = toqstr(filename.absoluteFilePath()).
1820 split("/", QString::SkipEmptyParts);
1821 postfix_.pop_back();
1822 abs_ = toqstr(filename.absoluteFilePath());
1823 dottedPrefix_ = false;
1826 /// Absolute path for debugging.
1831 /// Add the first segment from the postfix or three dots to the prefix.
1832 /// Merge multiple dot tripples. In fact dots are added lazily, i.e. only
1833 /// when really needed.
1834 void shiftPathSegment(bool dotted)
1836 if (postfix_.count() <= 0)
1840 if (dottedPrefix_ && !prefix_.isEmpty())
1841 prefix_ += ellipsisSlash_;
1842 prefix_ += postfix_.front() + "/";
1844 dottedPrefix_ = dotted && !prefix_.isEmpty();
1845 postfix_.pop_front();
1848 QString displayString() const
1850 if (prefix_.isEmpty())
1853 bool dots = dottedPrefix_ || !postfix_.isEmpty();
1854 return prefix_ + (dots ? ellipsisSlash_ : "") + filename_;
1857 QString forecastPathString() const
1859 if (postfix_.count() == 0)
1860 return displayString();
1863 + (dottedPrefix_ ? ellipsisSlash_ : "")
1864 + postfix_.front() + "/";
1867 bool final() const { return postfix_.empty(); }
1869 int tab() const { return tab_; }
1873 static QString const ellipsisSlash_;
1877 QStringList postfix_;
1889 QString const DisplayPath::ellipsisSlash_ = QString(QChar(0x2026)) + "/";
1893 bool operator<(DisplayPath const & a, DisplayPath const & b)
1895 return a.displayString() < b.displayString();
1899 bool operator==(DisplayPath const & a, DisplayPath const & b)
1901 return a.displayString() == b.displayString();
1905 void TabWorkArea::updateTabTexts()
1910 std::list<DisplayPath> paths;
1911 typedef std::list<DisplayPath>::iterator It;
1913 // collect full names first: path into postfix, empty prefix and
1914 // filename without extension
1915 for (size_t i = 0; i < n; ++i) {
1916 GuiWorkArea * i_wa = workArea(i);
1917 FileName const fn = i_wa->bufferView().buffer().fileName();
1918 paths.push_back(DisplayPath(i, fn));
1921 // go through path segments and see if it helps to make the path more unique
1922 bool somethingChanged = true;
1923 bool allFinal = false;
1924 while (somethingChanged && !allFinal) {
1925 // adding path segments changes order
1928 LYXERR(Debug::GUI, "updateTabTexts() iteration start");
1929 somethingChanged = false;
1932 // find segments which are not unique (i.e. non-atomic)
1933 It it = paths.begin();
1935 QString segString = it->displayString();
1936 for (; it != paths.end(); ++it) {
1937 // look to the next item
1942 allFinal = allFinal && it->final();
1944 LYXERR(Debug::GUI, "it = " << it->abs()
1945 << " => " << it->displayString());
1947 // still the same segment?
1949 if ((next != paths.end()
1950 && (nextString = next->displayString()) == segString))
1952 LYXERR(Debug::GUI, "segment ended");
1954 // only a trivial one with one element?
1955 if (it == segStart) {
1956 // start new segment
1958 segString = nextString;
1962 // We found a non-atomic segment
1963 // We know that segStart <= it < next <= paths.end().
1964 // The assertion below tells coverity about it.
1965 LATTEST(segStart != paths.end());
1966 QString dspString = segStart->forecastPathString();
1967 LYXERR(Debug::GUI, "first forecast found for "
1968 << segStart->abs() << " => " << dspString);
1971 // Shift path segments and hope for the best
1972 // that it makes the path more unique.
1973 somethingChanged = true;
1974 bool moreUnique = false;
1975 for (; sit != next; ++sit) {
1976 if (sit->forecastPathString() != dspString) {
1977 LYXERR(Debug::GUI, "different forecast found for "
1978 << sit->abs() << " => " << sit->forecastPathString());
1982 LYXERR(Debug::GUI, "same forecast found for "
1983 << sit->abs() << " => " << dspString);
1986 // if the path segment helped, add it. Otherwise add dots
1987 bool dots = !moreUnique;
1988 LYXERR(Debug::GUI, "using dots = " << dots);
1989 for (sit = segStart; sit != next; ++sit) {
1990 sit->shiftPathSegment(dots);
1991 LYXERR(Debug::GUI, "shifting "
1992 << sit->abs() << " => " << sit->displayString());
1995 // start new segment
1997 segString = nextString;
2001 // set new tab titles
2002 for (It it = paths.begin(); it != paths.end(); ++it) {
2003 int const tab_index = it->tab();
2004 Buffer const & buf = workArea(tab_index)->bufferView().buffer();
2005 QString tab_text = it->displayString().replace("&", "&&");
2006 if (!buf.fileName().empty() && !buf.isClean())
2008 QString tab_tooltip = it->abs();
2009 if (buf.hasReadonlyFlag()) {
2010 setTabIcon(tab_index, QIcon(getPixmap("images/", "emblem-readonly", "svgz,png")));
2011 tab_tooltip = qt_("%1 (read only)").arg(tab_tooltip);
2013 setTabIcon(tab_index, QIcon());
2014 if (buf.notifiesExternalModification()) {
2015 QString const warn = qt_("%1 (modified externally)");
2016 tab_tooltip = warn.arg(tab_tooltip);
2017 tab_text += QChar(0x26a0);
2019 setTabText(tab_index, tab_text);
2020 setTabToolTip(tab_index, tab_tooltip);
2025 void TabWorkArea::showContextMenu(const QPoint & pos)
2028 clicked_tab_ = static_cast<DragTabBar *>(tabBar())->tabAt(pos);
2029 if (clicked_tab_ == -1)
2034 popup.addAction(QIcon(getPixmap("images/", "hidetab", "svgz,png")),
2035 qt_("Hide tab"), this, SLOT(hideCurrentTab()));
2036 popup.addAction(QIcon(getPixmap("images/", "closetab", "svgz,png")),
2037 qt_("Close tab"), this, SLOT(closeCurrentBuffer()));
2038 popup.exec(tabBar()->mapToGlobal(pos));
2044 void TabWorkArea::moveTab(int fromIndex, int toIndex)
2046 QWidget * w = widget(fromIndex);
2047 QIcon icon = tabIcon(fromIndex);
2048 QString text = tabText(fromIndex);
2050 setCurrentIndex(fromIndex);
2051 removeTab(fromIndex);
2052 insertTab(toIndex, w, icon, text);
2053 setCurrentIndex(toIndex);
2057 DragTabBar::DragTabBar(QWidget* parent)
2060 setAcceptDrops(true);
2061 setTabsClosable(!lyxrc.single_close_tab_button);
2065 void DragTabBar::mousePressEvent(QMouseEvent * event)
2067 if (event->button() == Qt::LeftButton)
2068 dragStartPos_ = event->pos();
2069 QTabBar::mousePressEvent(event);
2073 void DragTabBar::mouseMoveEvent(QMouseEvent * event)
2075 // If the left button isn't pressed anymore then return
2076 if (!(event->buttons() & Qt::LeftButton))
2079 // If the distance is too small then return
2080 if ((event->pos() - dragStartPos_).manhattanLength()
2081 < QApplication::startDragDistance())
2084 // did we hit something after all?
2085 int tab = tabAt(dragStartPos_);
2089 // simulate button release to remove highlight from button
2090 int i = currentIndex();
2091 QMouseEvent me(QEvent::MouseButtonRelease, dragStartPos_,
2092 event->button(), event->buttons(), 0);
2093 QTabBar::mouseReleaseEvent(&me);
2097 QDrag * drag = new QDrag(this);
2098 QMimeData * mimeData = new QMimeData;
2099 // a crude way to distinguish tab-reodering drops from other ones
2100 mimeData->setData("action", "tab-reordering") ;
2101 drag->setMimeData(mimeData);
2103 // get tab pixmap as cursor
2104 QRect r = tabRect(tab);
2105 QPixmap pixmap(r.size());
2106 render(&pixmap, - r.topLeft());
2107 drag->setPixmap(pixmap);
2112 void DragTabBar::dragEnterEvent(QDragEnterEvent * event)
2114 // Only accept if it's an tab-reordering request
2115 QMimeData const * m = event->mimeData();
2116 QStringList formats = m->formats();
2117 if (formats.contains("action")
2118 && m->data("action") == "tab-reordering")
2119 event->acceptProposedAction();
2123 void DragTabBar::dropEvent(QDropEvent * event)
2125 int fromIndex = tabAt(dragStartPos_);
2126 int toIndex = tabAt(event->pos());
2128 // Tell interested objects that
2129 if (fromIndex != toIndex)
2130 tabMoveRequested(fromIndex, toIndex);
2131 event->acceptProposedAction();
2135 GuiWorkAreaContainer::GuiWorkAreaContainer(GuiWorkArea * wa, QWidget * parent)
2136 : QWidget(parent), wa_(wa)
2138 LASSERT(wa, return);
2139 Ui::WorkAreaUi::setupUi(this);
2140 layout()->addWidget(wa);
2141 connect(wa, SIGNAL(titleChanged(GuiWorkArea *)),
2142 this, SLOT(updateDisplay()));
2143 connect(reloadPB, SIGNAL(clicked()), this, SLOT(reload()));
2144 connect(ignorePB, SIGNAL(clicked()), this, SLOT(ignore()));
2145 setMessageColour({notificationFrame}, {reloadPB, ignorePB});
2150 void GuiWorkAreaContainer::updateDisplay()
2152 Buffer const & buf = wa_->bufferView().buffer();
2153 notificationFrame->setHidden(!buf.notifiesExternalModification());
2154 QString const label = qt_("<b>The file %1 changed on disk.</b>")
2155 .arg(toqstr(buf.fileName().displayName()));
2156 externalModificationLabel->setText(label);
2160 void GuiWorkAreaContainer::dispatch(FuncRequest f) const
2162 lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
2163 wa_->bufferView().buffer().absFileName()));
2168 void GuiWorkAreaContainer::reload() const
2170 dispatch(FuncRequest(LFUN_BUFFER_RELOAD));
2174 void GuiWorkAreaContainer::ignore() const
2176 dispatch(FuncRequest(LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR));
2180 void GuiWorkAreaContainer::mouseDoubleClickEvent(QMouseEvent * event)
2182 // prevent TabWorkArea from opening a new buffer on double click
2187 } // namespace frontend
2190 #include "moc_GuiWorkArea.cpp"