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), schedule_redraw_(false), preedit_lines_(1),
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::redraw(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 if (schedule_redraw_) {
634 // This happens when a graphic conversion is finished. As we don't know
635 // the size of the new graphics, it's better the update everything.
636 // We can't use redraw() here because this would trigger a infinite
637 // recursive loop with showCaret().
638 buffer_view_->resize(p->viewport()->width(), p->viewport()->height());
639 p->viewport()->update();
641 schedule_redraw_ = false;
645 p->viewport()->update(caret_->rect());
649 void GuiWorkArea::Private::hideCaret()
654 caret_visible_ = false;
655 //if (!qApp->focusWidget())
656 p->viewport()->update(caret_->rect());
660 void GuiWorkArea::Private::updateScrollbar()
662 // Prevent setRange() and setSliderPosition from causing recursive calls via
663 // the signal valueChanged. (#10311)
664 QObject::disconnect(p->verticalScrollBar(), SIGNAL(valueChanged(int)),
665 p, SLOT(scrollTo(int)));
666 ScrollbarParameters const & scroll_ = buffer_view_->scrollbarParameters();
667 p->verticalScrollBar()->setRange(scroll_.min, scroll_.max);
668 p->verticalScrollBar()->setPageStep(scroll_.page_step);
669 p->verticalScrollBar()->setSingleStep(scroll_.single_step);
670 p->verticalScrollBar()->setSliderPosition(0);
671 // Connect to the vertical scroll bar
672 QObject::connect(p->verticalScrollBar(), SIGNAL(valueChanged(int)),
673 p, SLOT(scrollTo(int)));
677 void GuiWorkArea::scrollTo(int value)
680 d->buffer_view_->scrollDocView(value, true);
682 if (lyxrc.cursor_follows_scrollbar) {
683 d->buffer_view_->setCursorFromScrollbar();
684 // FIXME: let GuiView take care of those.
685 d->lyx_view_->updateLayoutList();
687 // Show the caret immediately after any operation.
688 startBlinkingCaret();
691 QApplication::syncX();
696 bool GuiWorkArea::event(QEvent * e)
699 case QEvent::ToolTip: {
700 QHelpEvent * helpEvent = static_cast<QHelpEvent *>(e);
701 if (lyxrc.use_tooltip) {
702 QPoint pos = helpEvent->pos();
703 if (pos.x() < viewport()->width()) {
704 QString s = toqstr(d->buffer_view_->toolTip(pos.x(), pos.y()));
705 QToolTip::showText(helpEvent->globalPos(), formatToolTip(s,35));
708 QToolTip::hideText();
710 // Don't forget to accept the event!
715 case QEvent::ShortcutOverride:
716 // keyPressEvent is ShortcutOverride-aware and only accepts the event in
718 keyPressEvent(static_cast<QKeyEvent *>(e));
719 return e->isAccepted();
721 case QEvent::KeyPress: {
722 // We catch this event in order to catch the Tab or Shift+Tab key press
723 // which are otherwise reserved to focus switching between controls
725 QKeyEvent * ke = static_cast<QKeyEvent*>(e);
726 if ((ke->key() == Qt::Key_Tab && ke->modifiers() == Qt::NoModifier)
727 || (ke->key() == Qt::Key_Backtab && (
728 ke->modifiers() == Qt::ShiftModifier
729 || ke->modifiers() == Qt::NoModifier))) {
733 return QAbstractScrollArea::event(e);
737 return QAbstractScrollArea::event(e);
743 void GuiWorkArea::contextMenuEvent(QContextMenuEvent * e)
746 if (e->reason() == QContextMenuEvent::Mouse)
747 // the menu name is set on mouse press
748 name = d->context_menu_name_;
750 QPoint pos = e->pos();
751 Cursor const & cur = d->buffer_view_->cursor();
752 if (e->reason() == QContextMenuEvent::Keyboard && cur.inTexted()) {
753 // Do not access the context menu of math right in front of before
754 // the cursor. This does not work when the cursor is in text.
755 Inset * inset = cur.paragraph().getInset(cur.pos());
756 if (inset && inset->asInsetMath())
758 else if (cur.pos() > 0) {
759 Inset * inset = cur.paragraph().getInset(cur.pos() - 1);
764 name = d->buffer_view_->contextMenu(pos.x(), pos.y());
771 // always show mnemonics when the keyboard is used to show the context menu
772 // FIXME: This should be fixed in Qt itself
773 bool const keyboard = (e->reason() == QContextMenuEvent::Keyboard);
774 QMenu * menu = guiApp->menus().menu(toqstr(name), *d->lyx_view_, keyboard);
779 // Position the menu to the right.
780 // FIXME: menu position should be different for RTL text.
781 menu->exec(e->globalPos());
786 void GuiWorkArea::focusInEvent(QFocusEvent * e)
788 LYXERR(Debug::DEBUG, "GuiWorkArea::focusInEvent(): " << this << endl);
789 if (d->lyx_view_->currentWorkArea() != this) {
790 d->lyx_view_->setCurrentWorkArea(this);
791 d->lyx_view_->currentWorkArea()->bufferView().buffer().updateBuffer();
794 startBlinkingCaret();
795 QAbstractScrollArea::focusInEvent(e);
799 void GuiWorkArea::focusOutEvent(QFocusEvent * e)
801 LYXERR(Debug::DEBUG, "GuiWorkArea::focusOutEvent(): " << this << endl);
803 QAbstractScrollArea::focusOutEvent(e);
807 void GuiWorkArea::mousePressEvent(QMouseEvent * e)
809 if (d->dc_event_.active && d->dc_event_ == *e) {
810 d->dc_event_.active = false;
811 FuncRequest cmd(LFUN_MOUSE_TRIPLE, e->x(), e->y(),
812 q_button_state(e->button()), q_key_state(e->modifiers()));
818 #if (QT_VERSION < 0x050000) && !defined(__HAIKU__)
819 inputContext()->reset();
822 FuncRequest const cmd(LFUN_MOUSE_PRESS, e->x(), e->y(),
823 q_button_state(e->button()), q_key_state(e->modifiers()));
826 // Save the context menu on mouse press, because also the mouse
827 // cursor is set on mouse press. Afterwards, we can either release
828 // the mousebutton somewhere else, or the cursor might have moved
829 // due to the DEPM. We need to do this after the mouse has been
830 // set in dispatch(), because the selection state might change.
831 if (e->button() == Qt::RightButton)
832 d->context_menu_name_ = d->buffer_view_->contextMenu(e->x(), e->y());
838 void GuiWorkArea::mouseReleaseEvent(QMouseEvent * e)
840 if (d->synthetic_mouse_event_.timeout.running())
841 d->synthetic_mouse_event_.timeout.stop();
843 FuncRequest const cmd(LFUN_MOUSE_RELEASE, e->x(), e->y(),
844 q_button_state(e->button()), q_key_state(e->modifiers()));
850 void GuiWorkArea::mouseMoveEvent(QMouseEvent * e)
852 // we kill the triple click if we move
853 doubleClickTimeout();
854 FuncRequest cmd(LFUN_MOUSE_MOTION, e->x(), e->y(),
855 q_motion_state(e->buttons()), q_key_state(e->modifiers()));
859 // If we're above or below the work area...
860 if ((e->y() <= 20 || e->y() >= viewport()->height() - 20)
861 && e->buttons() == mouse_button::button1) {
862 // Make sure only a synthetic event can cause a page scroll,
863 // so they come at a steady rate:
865 // _Force_ a scroll up:
866 cmd.set_y(e->y() - 21);
868 cmd.set_y(e->y() + 21);
869 // Store the event, to be handled when the timeout expires.
870 d->synthetic_mouse_event_.cmd = cmd;
872 if (d->synthetic_mouse_event_.timeout.running()) {
873 // Discard the event. Note that it _may_ be handled
874 // when the timeout expires if
875 // synthetic_mouse_event_.cmd has not been overwritten.
876 // Ie, when the timeout expires, we handle the
877 // most recent event but discard all others that
878 // occurred after the one used to start the timeout
879 // in the first place.
883 d->synthetic_mouse_event_.restart_timeout = true;
884 d->synthetic_mouse_event_.timeout.start();
885 // Fall through to handle this event...
887 } else if (d->synthetic_mouse_event_.timeout.running()) {
888 // Store the event, to be possibly handled when the timeout
890 // Once the timeout has expired, normal control is returned
891 // to mouseMoveEvent (restart_timeout = false).
892 // This results in a much smoother 'feel' when moving the
893 // mouse back into the work area.
894 d->synthetic_mouse_event_.cmd = cmd;
895 d->synthetic_mouse_event_.restart_timeout = false;
902 void GuiWorkArea::wheelEvent(QWheelEvent * ev)
904 // Wheel rotation by one notch results in a delta() of 120 (see
905 // documentation of QWheelEvent)
906 double const delta = ev->delta() / 120.0;
908 switch (lyxrc.scroll_wheel_zoom) {
909 case LyXRC::SCROLL_WHEEL_ZOOM_CTRL:
910 zoom = ev->modifiers() & Qt::ControlModifier;
911 zoom &= !(ev->modifiers() & (Qt::ShiftModifier | Qt::AltModifier));
913 case LyXRC::SCROLL_WHEEL_ZOOM_SHIFT:
914 zoom = ev->modifiers() & Qt::ShiftModifier;
915 zoom &= !(ev->modifiers() & (Qt::ControlModifier | Qt::AltModifier));
917 case LyXRC::SCROLL_WHEEL_ZOOM_ALT:
918 zoom = ev->modifiers() & Qt::AltModifier;
919 zoom &= !(ev->modifiers() & (Qt::ShiftModifier | Qt::ControlModifier));
921 case LyXRC::SCROLL_WHEEL_ZOOM_OFF:
925 docstring arg = convert<docstring>(int(5 * delta));
926 lyx::dispatch(FuncRequest(LFUN_BUFFER_ZOOM_IN, arg));
930 // Take into account the desktop wide settings.
931 int const lines = qApp->wheelScrollLines();
932 int const page_step = verticalScrollBar()->pageStep();
933 // Test if the wheel mouse is set to one screen at a time.
934 // This is according to
935 // https://doc.qt.io/qt-5/qapplication.html#wheelScrollLines-prop
937 min(lines * verticalScrollBar()->singleStep(), page_step);
939 // Take into account the rotation and the user preferences.
940 scroll_value = int(scroll_value * delta * lyxrc.mouse_wheel_speed);
941 LYXERR(Debug::SCROLLING, "wheelScrollLines = " << lines
942 << " delta = " << delta << " scroll_value = " << scroll_value
943 << " page_step = " << page_step);
945 verticalScrollBar()->setValue(verticalScrollBar()->value() - scroll_value);
951 void GuiWorkArea::generateSyntheticMouseEvent()
953 int const e_y = d->synthetic_mouse_event_.cmd.y();
954 int const wh = d->buffer_view_->workHeight();
955 bool const up = e_y < 0;
956 bool const down = e_y > wh;
958 // Set things off to generate the _next_ 'pseudo' event.
960 if (d->synthetic_mouse_event_.restart_timeout) {
961 // This is some magic formulae to determine the speed
962 // of scrolling related to the position of the mouse.
965 int dist = up ? -e_y : e_y - wh;
966 time = max(min(200, 250000 / (dist * dist)), 1) ;
969 step = 80000 / (time * time);
973 d->synthetic_mouse_event_.timeout.setTimeout(time);
974 d->synthetic_mouse_event_.timeout.start();
977 // Can we scroll further ?
978 int const value = verticalScrollBar()->value();
979 if (value == verticalScrollBar()->maximum()
980 || value == verticalScrollBar()->minimum()) {
981 d->synthetic_mouse_event_.timeout.stop();
986 if (step <= 2 * wh) {
987 d->buffer_view_->scroll(up ? -step : step);
988 d->buffer_view_->updateMetrics();
990 d->buffer_view_->scrollDocView(value + (up ? -step : step), false);
993 // In which paragraph do we have to set the cursor ?
994 Cursor & cur = d->buffer_view_->cursor();
995 // FIXME: we don't know how to handle math.
996 Text * text = cur.text();
999 TextMetrics const & tm = d->buffer_view_->textMetrics(text);
1001 // Quit gracefully if there are no metrics, since otherwise next
1002 // line would crash (bug #10324).
1003 // This situation seems related to a (not yet understood) timing problem.
1007 pair<pit_type, const ParagraphMetrics *> pp = up ? tm.first() : tm.last();
1008 ParagraphMetrics const & pm = *pp.second;
1009 pit_type const pit = pp.first;
1011 if (pm.rows().empty())
1014 // Find the row at which we set the cursor.
1015 RowList::const_iterator rit = pm.rows().begin();
1016 RowList::const_iterator rlast = pm.rows().end();
1017 int yy = pm.position() - pm.ascent();
1018 for (--rlast; rit != rlast; ++rit) {
1019 int h = rit->height();
1020 if ((up && yy + h > 0)
1021 || (!up && yy + h > wh - defaultRowHeight()))
1026 // Find the position of the cursor
1028 int x = d->synthetic_mouse_event_.cmd.x();
1029 pos_type const pos = tm.getPosNearX(*rit, x, bound);
1034 cur.boundary(bound);
1036 d->buffer_view_->buffer().changed(false);
1041 void GuiWorkArea::keyPressEvent(QKeyEvent * ev)
1043 // this is also called for ShortcutOverride events. In this case, one must
1044 // not act but simply accept the event explicitly.
1045 bool const act = (ev->type() != QEvent::ShortcutOverride);
1047 // Do not process here some keys if dialog_mode_ is set
1049 && (ev->modifiers() == Qt::NoModifier
1050 || ev->modifiers() == Qt::ShiftModifier)
1051 && (ev->key() == Qt::Key_Escape
1052 || ev->key() == Qt::Key_Enter
1053 || ev->key() == Qt::Key_Return)
1059 // intercept some keys if completion popup is visible
1060 if (d->completer_->popupVisible()) {
1061 switch (ev->key()) {
1063 case Qt::Key_Return:
1065 d->completer_->activate();
1071 // do nothing if there are other events
1072 // (the auto repeated events come too fast)
1073 // it looks like this is only needed on X11
1074 #if defined(Q_WS_X11) || defined(QPA_XCB)
1075 // FIXME: this is a weird way to implement event compression. Also, this is
1076 // broken with IBus.
1077 if (act && qApp->hasPendingEvents() && ev->isAutoRepeat()) {
1078 switch (ev->key()) {
1079 case Qt::Key_PageDown:
1080 case Qt::Key_PageUp:
1085 LYXERR(Debug::KEY, "system is busy: scroll key event ignored");
1092 KeyModifier const m = q_key_state(ev->modifiers());
1095 if (m & ShiftModifier)
1097 if (m & ControlModifier)
1099 if (m & AltModifier)
1101 if (m & MetaModifier)
1105 LYXERR(Debug::KEY, " count: " << ev->count() << " text: " << ev->text()
1106 << " isAutoRepeat: " << ev->isAutoRepeat() << " key: " << ev->key()
1107 << " keyState: " << str);
1110 setKeySymbol(&sym, ev);
1113 processKeySym(sym, m);
1116 ev->setAccepted(queryKeySym(sym, m));
1123 void GuiWorkArea::doubleClickTimeout()
1125 d->dc_event_.active = false;
1129 void GuiWorkArea::mouseDoubleClickEvent(QMouseEvent * ev)
1131 d->dc_event_ = DoubleClick(ev);
1132 QTimer::singleShot(QApplication::doubleClickInterval(), this,
1133 SLOT(doubleClickTimeout()));
1134 FuncRequest cmd(LFUN_MOUSE_DOUBLE, ev->x(), ev->y(),
1135 q_button_state(ev->button()), q_key_state(ev->modifiers()));
1141 void GuiWorkArea::resizeEvent(QResizeEvent * ev)
1143 QAbstractScrollArea::resizeEvent(ev);
1144 d->need_resize_ = true;
1149 void GuiWorkArea::Private::paintPreeditText(GuiPainter & pain)
1151 if (preedit_string_.empty())
1154 // FIXME: shall we use real_current_font here? (see #10478)
1155 FontInfo const font = buffer_view_->cursor().getFont().fontInfo();
1156 FontMetrics const & fm = theFontMetrics(font);
1157 int const height = fm.maxHeight();
1158 int cur_x = caret_->rect().left();
1159 int cur_y = caret_->rect().bottom();
1161 // get attributes of input method cursor.
1162 // cursor_pos : cursor position in preedit string.
1163 size_t cursor_pos = 0;
1164 bool cursor_is_visible = false;
1165 for (auto const & attr : preedit_attr_) {
1166 if (attr.type == QInputMethodEvent::Cursor) {
1167 cursor_pos = attr.start;
1168 cursor_is_visible = attr.length != 0;
1173 size_t const preedit_length = preedit_string_.length();
1175 // get position of selection in input method.
1176 // FIXME: isn't there a way to do this simplier?
1177 // rStart : cursor position in selected string in IM.
1179 // rLength : selected string length in IM.
1181 if (cursor_pos < preedit_length) {
1182 for (auto const & attr : preedit_attr_) {
1183 if (attr.type == QInputMethodEvent::TextFormat) {
1184 if (attr.start <= int(cursor_pos)
1185 && int(cursor_pos) < attr.start + attr.length) {
1186 rStart = attr.start;
1187 rLength = attr.length;
1188 if (!cursor_is_visible)
1189 cursor_pos += rLength;
1196 rStart = cursor_pos;
1200 int const right_margin = buffer_view_->rightMargin();
1201 Painter::preedit_style ps;
1202 // Most often there would be only one line:
1204 for (size_t pos = 0; pos != preedit_length; ++pos) {
1205 char_type const typed_char = preedit_string_[pos];
1206 // reset preedit string style
1207 ps = Painter::preedit_default;
1209 // if we reached the right extremity of the screen, go to next line.
1210 if (cur_x + fm.width(typed_char) > p->viewport()->width() - right_margin) {
1211 cur_x = right_margin;
1212 cur_y += height + 1;
1215 // preedit strings are displayed with dashed underline
1216 // and partial strings are displayed white on black indicating
1217 // that we are in selecting mode in the input method.
1218 // FIXME: rLength == preedit_length is not a changing condition
1219 // FIXME: should be put out of the loop.
1221 && pos < rStart + rLength
1222 && !(cursor_pos < rLength && rLength == preedit_length))
1223 ps = Painter::preedit_selecting;
1225 if (pos == cursor_pos
1226 && (cursor_pos < rLength && rLength == preedit_length))
1227 ps = Painter::preedit_cursor;
1229 // draw one character and update cur_x.
1230 cur_x += pain.preeditText(cur_x, cur_y, typed_char, font, ps);
1235 void GuiWorkArea::paintEvent(QPaintEvent * ev)
1237 // LYXERR(Debug::PAINTING, "paintEvent begin: x: " << rc.x()
1238 // << " y: " << rc.y() << " w: " << rc.width() << " h: " << rc.height());
1240 if (d->needResize()) {
1241 d->resizeBufferView();
1242 if (d->caret_visible_) {
1248 GuiPainter pain(viewport(), pixelRatio());
1249 d->buffer_view_->draw(pain, d->caret_visible_);
1251 // The preedit text, if needed
1252 d->paintPreeditText(pain);
1255 if (d->caret_visible_)
1256 d->caret_->draw(pain);
1261 void GuiWorkArea::inputMethodEvent(QInputMethodEvent * e)
1263 LYXERR(Debug::KEY, "preeditString: " << e->preeditString()
1264 << " commitString: " << e->commitString());
1266 // insert the processed text in the document (handles undo)
1267 if (!e->commitString().isEmpty()) {
1268 d->buffer_view_->cursor().beginUndoGroup();
1269 d->buffer_view_->cursor().insert(qstring_to_ucs4(e->commitString()));
1270 d->buffer_view_->updateMetrics();
1271 d->buffer_view_->cursor().endUndoGroup();
1272 viewport()->update();
1275 // Hide the caret during the test transformation.
1276 if (e->preeditString().isEmpty())
1277 startBlinkingCaret();
1279 stopBlinkingCaret();
1281 if (d->preedit_string_.empty() && e->preeditString().isEmpty()) {
1287 // The preedit text and its attributes will be used in paintPreeditText
1288 d->preedit_string_ = qstring_to_ucs4(e->preeditString());
1289 d->preedit_attr_ = e->attributes();
1292 // redraw area of preedit string.
1293 int height = d->caret_->rect().height();
1294 int cur_y = d->caret_->rect().bottom();
1295 viewport()->update(0, cur_y - height, viewport()->width(),
1296 (height + 1) * d->preedit_lines_);
1298 if (d->preedit_string_.empty()) {
1299 d->preedit_lines_ = 1;
1304 // Don't forget to accept the event!
1309 QVariant GuiWorkArea::inputMethodQuery(Qt::InputMethodQuery query) const
1311 QRect cur_r(0, 0, 0, 0);
1313 // this is the CJK-specific composition window position and
1314 // the context menu position when the menu key is pressed.
1315 case Qt::ImMicroFocus:
1316 cur_r = d->caret_->rect();
1317 if (d->preedit_lines_ != 1)
1319 cur_r.moveBottom(cur_r.bottom()
1320 + cur_r.height() * (d->preedit_lines_ - 1));
1321 // return lower right of caret in LyX.
1324 return QWidget::inputMethodQuery(query);
1329 void GuiWorkArea::updateWindowTitle()
1331 Buffer const & buf = bufferView().buffer();
1332 if (buf.fileName() != d->file_name_
1333 || buf.params().shell_escape != d->shell_escape_
1334 || buf.hasReadonlyFlag() != d->read_only_
1335 || buf.lyxvc().vcstatus() != d->vc_status_
1336 || buf.isClean() != d->clean_
1337 || buf.notifiesExternalModification() != d->externally_modified_) {
1338 d->file_name_ = buf.fileName();
1339 d->shell_escape_ = buf.params().shell_escape;
1340 d->read_only_ = buf.hasReadonlyFlag();
1341 d->vc_status_ = buf.lyxvc().vcstatus();
1342 d->clean_ = buf.isClean();
1343 d->externally_modified_ = buf.notifiesExternalModification();
1344 Q_EMIT titleChanged(this);
1349 bool GuiWorkArea::isFullScreen() const
1351 return d->lyx_view_ && d->lyx_view_->isFullScreen();
1355 void GuiWorkArea::scheduleRedraw()
1357 d->schedule_redraw_ = true;
1361 bool GuiWorkArea::inDialogMode() const
1363 return d->dialog_mode_;
1367 void GuiWorkArea::setDialogMode(bool mode)
1369 d->dialog_mode_ = mode;
1373 GuiCompleter & GuiWorkArea::completer()
1375 return *d->completer_;
1378 GuiView const & GuiWorkArea::view() const
1380 return *d->lyx_view_;
1384 GuiView & GuiWorkArea::view()
1386 return *d->lyx_view_;
1389 ////////////////////////////////////////////////////////////////////
1393 ////////////////////////////////////////////////////////////////////
1396 EmbeddedWorkArea::EmbeddedWorkArea(QWidget * w): GuiWorkArea(w)
1398 support::TempFile tempfile("embedded.internal");
1399 tempfile.setAutoRemove(false);
1400 buffer_ = theBufferList().newInternalBuffer(tempfile.name().absFileName());
1401 buffer_->setUnnamed(true);
1402 buffer_->setFullyLoaded(true);
1403 setBuffer(*buffer_);
1404 setDialogMode(true);
1408 EmbeddedWorkArea::~EmbeddedWorkArea()
1410 // No need to destroy buffer and bufferview here, because it is done
1411 // in theBufferList() destruction loop at application exit
1415 void EmbeddedWorkArea::closeEvent(QCloseEvent * ev)
1418 GuiWorkArea::closeEvent(ev);
1422 void EmbeddedWorkArea::hideEvent(QHideEvent * ev)
1425 GuiWorkArea::hideEvent(ev);
1429 QSize EmbeddedWorkArea::sizeHint () const
1432 // GuiWorkArea sets the size to the screen's viewport
1433 // by returning a value this gets overridden
1434 // EmbeddedWorkArea is now sized to fit in the layout
1435 // of the parent, and has a minimum size set in GuiWorkArea
1436 // which is what we return here
1437 return QSize(100, 70);
1441 void EmbeddedWorkArea::disable()
1443 stopBlinkingCaret();
1444 if (view().currentWorkArea() != this)
1446 // No problem if currentMainWorkArea() is 0 (setCurrentWorkArea()
1447 // tolerates it and shows the background logo), what happens if
1448 // an EmbeddedWorkArea is closed after closing all document WAs
1449 view().setCurrentWorkArea(view().currentMainWorkArea());
1452 ////////////////////////////////////////////////////////////////////
1456 ////////////////////////////////////////////////////////////////////
1459 class NoTabFrameMacStyle : public QProxyStyle {
1462 QRect subElementRect(SubElement element, const QStyleOption * option,
1463 const QWidget * widget = 0) const
1465 QRect rect = QProxyStyle::subElementRect(element, option, widget);
1466 bool noBar = static_cast<QTabWidget const *>(widget)->count() <= 1;
1468 // The Qt Mac style puts the contents into a 3 pixel wide box
1469 // which looks very ugly and not like other Mac applications.
1470 // Hence we remove this here, and moreover the 16 pixel round
1471 // frame above if the tab bar is hidden.
1472 if (element == QStyle::SE_TabWidgetTabContents) {
1473 rect.adjust(- rect.left(), 0, rect.left(), 0);
1482 NoTabFrameMacStyle noTabFrameMacStyle;
1486 TabWorkArea::TabWorkArea(QWidget * parent)
1487 : QTabWidget(parent), clicked_tab_(-1), midpressed_tab_(-1)
1490 setStyle(&noTabFrameMacStyle);
1493 QPalette pal = palette();
1494 pal.setColor(QPalette::Active, QPalette::Button,
1495 pal.color(QPalette::Active, QPalette::Window));
1496 pal.setColor(QPalette::Disabled, QPalette::Button,
1497 pal.color(QPalette::Disabled, QPalette::Window));
1498 pal.setColor(QPalette::Inactive, QPalette::Button,
1499 pal.color(QPalette::Inactive, QPalette::Window));
1501 QObject::connect(this, SIGNAL(currentChanged(int)),
1502 this, SLOT(on_currentTabChanged(int)));
1504 closeBufferButton = new QToolButton(this);
1505 closeBufferButton->setPalette(pal);
1506 // FIXME: rename the icon to closebuffer.png
1507 closeBufferButton->setIcon(QIcon(getPixmap("images/", "closetab", "svgz,png")));
1508 closeBufferButton->setText("Close File");
1509 closeBufferButton->setAutoRaise(true);
1510 closeBufferButton->setCursor(Qt::ArrowCursor);
1511 closeBufferButton->setToolTip(qt_("Close File"));
1512 closeBufferButton->setEnabled(true);
1513 QObject::connect(closeBufferButton, SIGNAL(clicked()),
1514 this, SLOT(closeCurrentBuffer()));
1515 setCornerWidget(closeBufferButton, Qt::TopRightCorner);
1517 // setup drag'n'drop
1518 QTabBar* tb = new DragTabBar;
1519 connect(tb, SIGNAL(tabMoveRequested(int, int)),
1520 this, SLOT(moveTab(int, int)));
1521 tb->setElideMode(Qt::ElideNone);
1524 // make us responsible for the context menu of the tabbar
1525 tb->setContextMenuPolicy(Qt::CustomContextMenu);
1526 connect(tb, SIGNAL(customContextMenuRequested(const QPoint &)),
1527 this, SLOT(showContextMenu(const QPoint &)));
1528 connect(tb, SIGNAL(tabCloseRequested(int)),
1529 this, SLOT(closeTab(int)));
1531 setUsesScrollButtons(true);
1535 void TabWorkArea::mousePressEvent(QMouseEvent *me)
1537 if (me->button() == Qt::MidButton)
1538 midpressed_tab_ = tabBar()->tabAt(me->pos());
1540 QTabWidget::mousePressEvent(me);
1544 void TabWorkArea::mouseReleaseEvent(QMouseEvent *me)
1546 if (me->button() == Qt::MidButton) {
1547 int const midreleased_tab = tabBar()->tabAt(me->pos());
1548 if (midpressed_tab_ == midreleased_tab && posIsTab(me->pos()))
1549 closeTab(midreleased_tab);
1551 QTabWidget::mouseReleaseEvent(me);
1555 void TabWorkArea::paintEvent(QPaintEvent * event)
1557 if (tabBar()->isVisible()) {
1558 QTabWidget::paintEvent(event);
1560 // Prevent the selected tab to influence the
1561 // painting of the frame of the tab widget.
1562 // This is needed for gtk style in Qt.
1563 QStylePainter p(this);
1564 #if QT_VERSION < 0x050000
1565 QStyleOptionTabWidgetFrameV2 opt;
1567 QStyleOptionTabWidgetFrame opt;
1569 initStyleOption(&opt);
1570 opt.rect = style()->subElementRect(QStyle::SE_TabWidgetTabPane,
1572 opt.selectedTabRect = QRect();
1573 p.drawPrimitive(QStyle::PE_FrameTabWidget, opt);
1578 bool TabWorkArea::posIsTab(QPoint position)
1580 // tabAt returns -1 if tab does not covers position
1581 return tabBar()->tabAt(position) > -1;
1585 void TabWorkArea::mouseDoubleClickEvent(QMouseEvent * event)
1587 if (event->button() != Qt::LeftButton)
1590 // this code chunk is unnecessary because it seems the event only makes
1591 // it this far if it is not on a tab. I'm not sure why this is (maybe
1592 // it is handled and ended in DragTabBar?), and thus I'm not sure if
1593 // this is true in all cases and if it will be true in the future so I
1594 // leave this code for now. (skostysh, 2016-07-21)
1596 // return early if double click on existing tabs
1597 if (posIsTab(event->pos()))
1600 dispatch(FuncRequest(LFUN_BUFFER_NEW));
1604 void TabWorkArea::setFullScreen(bool full_screen)
1606 for (int i = 0; i != count(); ++i) {
1607 if (GuiWorkArea * wa = workArea(i))
1608 wa->setFullScreen(full_screen);
1611 if (lyxrc.full_screen_tabbar)
1612 showBar(!full_screen && count() > 1);
1614 showBar(count() > 1);
1618 void TabWorkArea::showBar(bool show)
1620 tabBar()->setEnabled(show);
1621 tabBar()->setVisible(show);
1622 closeBufferButton->setVisible(show && lyxrc.single_close_tab_button);
1623 setTabsClosable(!lyxrc.single_close_tab_button);
1627 GuiWorkAreaContainer * TabWorkArea::widget(int index) const
1629 QWidget * w = QTabWidget::widget(index);
1632 GuiWorkAreaContainer * wac = dynamic_cast<GuiWorkAreaContainer *>(w);
1638 GuiWorkAreaContainer * TabWorkArea::currentWidget() const
1640 return widget(currentIndex());
1644 GuiWorkArea * TabWorkArea::workArea(int index) const
1646 GuiWorkAreaContainer * w = widget(index);
1649 return w->workArea();
1653 GuiWorkArea * TabWorkArea::currentWorkArea() const
1655 return workArea(currentIndex());
1659 GuiWorkArea * TabWorkArea::workArea(Buffer & buffer) const
1661 // FIXME: this method doesn't work if we have more than one work area
1662 // showing the same buffer.
1663 for (int i = 0; i != count(); ++i) {
1664 GuiWorkArea * wa = workArea(i);
1665 LASSERT(wa, return 0);
1666 if (&wa->bufferView().buffer() == &buffer)
1673 void TabWorkArea::closeAll()
1676 QWidget * wac = widget(0);
1677 LASSERT(wac, return);
1684 int TabWorkArea::indexOfWorkArea(GuiWorkArea * w) const
1686 for (int index = 0; index < count(); ++index)
1687 if (workArea(index) == w)
1693 bool TabWorkArea::setCurrentWorkArea(GuiWorkArea * work_area)
1695 LASSERT(work_area, return false);
1696 int index = indexOfWorkArea(work_area);
1700 if (index == currentIndex())
1701 // Make sure the work area is up to date.
1702 on_currentTabChanged(index);
1704 // Switch to the work area.
1705 setCurrentIndex(index);
1706 work_area->setFocus();
1712 GuiWorkArea * TabWorkArea::addWorkArea(Buffer & buffer, GuiView & view)
1714 GuiWorkArea * wa = new GuiWorkArea(buffer, view);
1715 GuiWorkAreaContainer * wac = new GuiWorkAreaContainer(wa);
1716 wa->setUpdatesEnabled(false);
1717 // Hide tabbar if there's no tab (avoid a resize and a flashing tabbar
1718 // when hiding it again below).
1719 if (!(currentWorkArea() && currentWorkArea()->isFullScreen()))
1720 showBar(count() > 0);
1721 addTab(wac, wa->windowTitle());
1722 QObject::connect(wa, SIGNAL(titleChanged(GuiWorkArea *)),
1723 this, SLOT(updateTabTexts()));
1724 if (currentWorkArea() && currentWorkArea()->isFullScreen())
1725 setFullScreen(true);
1727 // Hide tabbar if there's only one tab.
1728 showBar(count() > 1);
1736 bool TabWorkArea::removeWorkArea(GuiWorkArea * work_area)
1738 LASSERT(work_area, return false);
1739 int index = indexOfWorkArea(work_area);
1743 work_area->setUpdatesEnabled(false);
1744 QWidget * wac = widget(index);
1749 // make sure the next work area is enabled.
1750 currentWidget()->setUpdatesEnabled(true);
1751 if (currentWorkArea() && currentWorkArea()->isFullScreen())
1752 setFullScreen(true);
1754 // Show tabbar only if there's more than one tab.
1755 showBar(count() > 1);
1757 lastWorkAreaRemoved();
1765 void TabWorkArea::on_currentTabChanged(int i)
1767 // returns e.g. on application destruction
1770 GuiWorkArea * wa = workArea(i);
1771 LASSERT(wa, return);
1772 wa->setUpdatesEnabled(true);
1776 currentWorkAreaChanged(wa);
1778 LYXERR(Debug::GUI, "currentTabChanged " << i
1779 << " File: " << wa->bufferView().buffer().absFileName());
1783 void TabWorkArea::closeCurrentBuffer()
1786 if (clicked_tab_ == -1)
1787 wa = currentWorkArea();
1789 wa = workArea(clicked_tab_);
1790 LASSERT(wa, return);
1792 wa->view().closeWorkArea(wa);
1796 void TabWorkArea::hideCurrentTab()
1799 if (clicked_tab_ == -1)
1800 wa = currentWorkArea();
1802 wa = workArea(clicked_tab_);
1803 LASSERT(wa, return);
1805 wa->view().hideWorkArea(wa);
1809 void TabWorkArea::closeTab(int index)
1811 on_currentTabChanged(index);
1814 wa = currentWorkArea();
1816 wa = workArea(index);
1817 LASSERT(wa, return);
1819 wa->view().closeWorkArea(wa);
1826 /// make vector happy
1827 DisplayPath() : tab_(-1), dottedPrefix_(false) {}
1829 DisplayPath(int tab, FileName const & filename)
1832 filename_ = (filename.extension() == "lyx") ?
1833 toqstr(filename.onlyFileNameWithoutExt())
1834 : toqstr(filename.onlyFileName());
1835 postfix_ = toqstr(filename.absoluteFilePath()).
1836 split("/", QString::SkipEmptyParts);
1837 postfix_.pop_back();
1838 abs_ = toqstr(filename.absoluteFilePath());
1839 dottedPrefix_ = false;
1842 /// Absolute path for debugging.
1847 /// Add the first segment from the postfix or three dots to the prefix.
1848 /// Merge multiple dot tripples. In fact dots are added lazily, i.e. only
1849 /// when really needed.
1850 void shiftPathSegment(bool dotted)
1852 if (postfix_.count() <= 0)
1856 if (dottedPrefix_ && !prefix_.isEmpty())
1857 prefix_ += ellipsisSlash_;
1858 prefix_ += postfix_.front() + "/";
1860 dottedPrefix_ = dotted && !prefix_.isEmpty();
1861 postfix_.pop_front();
1864 QString displayString() const
1866 if (prefix_.isEmpty())
1869 bool dots = dottedPrefix_ || !postfix_.isEmpty();
1870 return prefix_ + (dots ? ellipsisSlash_ : "") + filename_;
1873 QString forecastPathString() const
1875 if (postfix_.count() == 0)
1876 return displayString();
1879 + (dottedPrefix_ ? ellipsisSlash_ : "")
1880 + postfix_.front() + "/";
1883 bool final() const { return postfix_.empty(); }
1885 int tab() const { return tab_; }
1889 static QString const ellipsisSlash_;
1893 QStringList postfix_;
1905 QString const DisplayPath::ellipsisSlash_ = QString(QChar(0x2026)) + "/";
1909 bool operator<(DisplayPath const & a, DisplayPath const & b)
1911 return a.displayString() < b.displayString();
1915 bool operator==(DisplayPath const & a, DisplayPath const & b)
1917 return a.displayString() == b.displayString();
1921 void TabWorkArea::updateTabTexts()
1926 std::list<DisplayPath> paths;
1927 typedef std::list<DisplayPath>::iterator It;
1929 // collect full names first: path into postfix, empty prefix and
1930 // filename without extension
1931 for (size_t i = 0; i < n; ++i) {
1932 GuiWorkArea * i_wa = workArea(i);
1933 FileName const fn = i_wa->bufferView().buffer().fileName();
1934 paths.push_back(DisplayPath(i, fn));
1937 // go through path segments and see if it helps to make the path more unique
1938 bool somethingChanged = true;
1939 bool allFinal = false;
1940 while (somethingChanged && !allFinal) {
1941 // adding path segments changes order
1944 LYXERR(Debug::GUI, "updateTabTexts() iteration start");
1945 somethingChanged = false;
1948 // find segments which are not unique (i.e. non-atomic)
1949 It it = paths.begin();
1951 QString segString = it->displayString();
1952 for (; it != paths.end(); ++it) {
1953 // look to the next item
1958 allFinal = allFinal && it->final();
1960 LYXERR(Debug::GUI, "it = " << it->abs()
1961 << " => " << it->displayString());
1963 // still the same segment?
1965 if ((next != paths.end()
1966 && (nextString = next->displayString()) == segString))
1968 LYXERR(Debug::GUI, "segment ended");
1970 // only a trivial one with one element?
1971 if (it == segStart) {
1972 // start new segment
1974 segString = nextString;
1978 // We found a non-atomic segment
1979 // We know that segStart <= it < next <= paths.end().
1980 // The assertion below tells coverity about it.
1981 LATTEST(segStart != paths.end());
1982 QString dspString = segStart->forecastPathString();
1983 LYXERR(Debug::GUI, "first forecast found for "
1984 << segStart->abs() << " => " << dspString);
1987 // Shift path segments and hope for the best
1988 // that it makes the path more unique.
1989 somethingChanged = true;
1990 bool moreUnique = false;
1991 for (; sit != next; ++sit) {
1992 if (sit->forecastPathString() != dspString) {
1993 LYXERR(Debug::GUI, "different forecast found for "
1994 << sit->abs() << " => " << sit->forecastPathString());
1998 LYXERR(Debug::GUI, "same forecast found for "
1999 << sit->abs() << " => " << dspString);
2002 // if the path segment helped, add it. Otherwise add dots
2003 bool dots = !moreUnique;
2004 LYXERR(Debug::GUI, "using dots = " << dots);
2005 for (sit = segStart; sit != next; ++sit) {
2006 sit->shiftPathSegment(dots);
2007 LYXERR(Debug::GUI, "shifting "
2008 << sit->abs() << " => " << sit->displayString());
2011 // start new segment
2013 segString = nextString;
2017 // set new tab titles
2018 for (It it = paths.begin(); it != paths.end(); ++it) {
2019 int const tab_index = it->tab();
2020 Buffer const & buf = workArea(tab_index)->bufferView().buffer();
2021 QString tab_text = it->displayString().replace("&", "&&");
2022 if (!buf.fileName().empty() && !buf.isClean())
2024 QString tab_tooltip = it->abs();
2025 if (buf.hasReadonlyFlag()) {
2026 setTabIcon(tab_index, QIcon(getPixmap("images/", "emblem-readonly", "svgz,png")));
2027 tab_tooltip = qt_("%1 (read only)").arg(tab_tooltip);
2029 setTabIcon(tab_index, QIcon());
2030 if (buf.notifiesExternalModification()) {
2031 QString const warn = qt_("%1 (modified externally)");
2032 tab_tooltip = warn.arg(tab_tooltip);
2033 tab_text += QChar(0x26a0);
2035 setTabText(tab_index, tab_text);
2036 setTabToolTip(tab_index, tab_tooltip);
2041 void TabWorkArea::showContextMenu(const QPoint & pos)
2044 clicked_tab_ = static_cast<DragTabBar *>(tabBar())->tabAt(pos);
2045 if (clicked_tab_ == -1)
2050 popup.addAction(QIcon(getPixmap("images/", "hidetab", "svgz,png")),
2051 qt_("Hide tab"), this, SLOT(hideCurrentTab()));
2052 popup.addAction(QIcon(getPixmap("images/", "closetab", "svgz,png")),
2053 qt_("Close tab"), this, SLOT(closeCurrentBuffer()));
2054 popup.exec(tabBar()->mapToGlobal(pos));
2060 void TabWorkArea::moveTab(int fromIndex, int toIndex)
2062 QWidget * w = widget(fromIndex);
2063 QIcon icon = tabIcon(fromIndex);
2064 QString text = tabText(fromIndex);
2066 setCurrentIndex(fromIndex);
2067 removeTab(fromIndex);
2068 insertTab(toIndex, w, icon, text);
2069 setCurrentIndex(toIndex);
2073 DragTabBar::DragTabBar(QWidget* parent)
2076 setAcceptDrops(true);
2077 setTabsClosable(!lyxrc.single_close_tab_button);
2081 void DragTabBar::mousePressEvent(QMouseEvent * event)
2083 if (event->button() == Qt::LeftButton)
2084 dragStartPos_ = event->pos();
2085 QTabBar::mousePressEvent(event);
2089 void DragTabBar::mouseMoveEvent(QMouseEvent * event)
2091 // If the left button isn't pressed anymore then return
2092 if (!(event->buttons() & Qt::LeftButton))
2095 // If the distance is too small then return
2096 if ((event->pos() - dragStartPos_).manhattanLength()
2097 < QApplication::startDragDistance())
2100 // did we hit something after all?
2101 int tab = tabAt(dragStartPos_);
2105 // simulate button release to remove highlight from button
2106 int i = currentIndex();
2107 QMouseEvent me(QEvent::MouseButtonRelease, dragStartPos_,
2108 event->button(), event->buttons(), 0);
2109 QTabBar::mouseReleaseEvent(&me);
2113 QDrag * drag = new QDrag(this);
2114 QMimeData * mimeData = new QMimeData;
2115 // a crude way to distinguish tab-reodering drops from other ones
2116 mimeData->setData("action", "tab-reordering") ;
2117 drag->setMimeData(mimeData);
2119 // get tab pixmap as cursor
2120 QRect r = tabRect(tab);
2121 QPixmap pixmap(r.size());
2122 render(&pixmap, - r.topLeft());
2123 drag->setPixmap(pixmap);
2128 void DragTabBar::dragEnterEvent(QDragEnterEvent * event)
2130 // Only accept if it's an tab-reordering request
2131 QMimeData const * m = event->mimeData();
2132 QStringList formats = m->formats();
2133 if (formats.contains("action")
2134 && m->data("action") == "tab-reordering")
2135 event->acceptProposedAction();
2139 void DragTabBar::dropEvent(QDropEvent * event)
2141 int fromIndex = tabAt(dragStartPos_);
2142 int toIndex = tabAt(event->pos());
2144 // Tell interested objects that
2145 if (fromIndex != toIndex)
2146 tabMoveRequested(fromIndex, toIndex);
2147 event->acceptProposedAction();
2151 GuiWorkAreaContainer::GuiWorkAreaContainer(GuiWorkArea * wa, QWidget * parent)
2152 : QWidget(parent), wa_(wa)
2154 LASSERT(wa, return);
2155 Ui::WorkAreaUi::setupUi(this);
2156 layout()->addWidget(wa);
2157 connect(wa, SIGNAL(titleChanged(GuiWorkArea *)),
2158 this, SLOT(updateDisplay()));
2159 connect(reloadPB, SIGNAL(clicked()), this, SLOT(reload()));
2160 connect(ignorePB, SIGNAL(clicked()), this, SLOT(ignore()));
2161 setMessageColour({notificationFrame}, {reloadPB, ignorePB});
2166 void GuiWorkAreaContainer::updateDisplay()
2168 Buffer const & buf = wa_->bufferView().buffer();
2169 notificationFrame->setHidden(!buf.notifiesExternalModification());
2170 QString const label = qt_("<b>The file %1 changed on disk.</b>")
2171 .arg(toqstr(buf.fileName().displayName()));
2172 externalModificationLabel->setText(label);
2176 void GuiWorkAreaContainer::dispatch(FuncRequest f) const
2178 lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
2179 wa_->bufferView().buffer().absFileName()));
2184 void GuiWorkAreaContainer::reload() const
2186 dispatch(FuncRequest(LFUN_BUFFER_RELOAD));
2190 void GuiWorkAreaContainer::ignore() const
2192 dispatch(FuncRequest(LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR));
2196 void GuiWorkAreaContainer::mouseDoubleClickEvent(QMouseEvent * event)
2198 // prevent TabWorkArea from opening a new buffer on double click
2203 } // namespace frontend
2206 #include "moc_GuiWorkArea.cpp"