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"
22 #include "BufferList.h"
23 #include "BufferParams.h"
24 #include "BufferView.h"
25 #include "CoordCache.h"
28 #include "FuncRequest.h"
29 #include "GuiApplication.h"
30 #include "GuiCompleter.h"
31 #include "GuiKeySymbol.h"
32 #include "GuiPainter.h"
34 #include "KeySymbol.h"
39 #include "qt_helpers.h"
41 #include "TextMetrics.h"
44 #include "graphics/GraphicsImage.h"
45 #include "graphics/GraphicsLoader.h"
47 #include "support/convert.h"
48 #include "support/debug.h"
49 #include "support/gettext.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>
71 #include <QPixmapCache>
73 #include <QStyleOption>
74 #include <QStylePainter>
76 #include <QToolButton>
80 #include "support/bind.h"
85 int const TabIndicatorWidth = 3;
91 using namespace lyx::support;
96 /// return the LyX mouse button state from Qt's
97 static mouse_button::state q_button_state(Qt::MouseButton button)
99 mouse_button::state b = mouse_button::none;
102 b = mouse_button::button1;
105 b = mouse_button::button2;
107 case Qt::RightButton:
108 b = mouse_button::button3;
117 /// return the LyX mouse button state from Qt's
118 mouse_button::state q_motion_state(Qt::MouseButtons state)
120 mouse_button::state b = mouse_button::none;
121 if (state & Qt::LeftButton)
122 b |= mouse_button::button1;
123 if (state & Qt::MidButton)
124 b |= mouse_button::button2;
125 if (state & Qt::RightButton)
126 b |= mouse_button::button3;
135 CursorWidget() : rtl_(false), l_shape_(false), completable_(false),
136 show_(false), x_(0), cursor_width_(0)
141 void draw(QPainter & painter)
143 if (!show_ || !rect_.isValid())
147 int l = x_ - rect_.left();
148 int r = rect_.right() - x_;
149 int bot = rect_.bottom();
151 // draw vertical line
152 painter.fillRect(x_, y, cursor_width_, rect_.height(), color_);
154 // draw RTL/LTR indication
155 painter.setPen(color_);
158 painter.drawLine(x_, bot, x_ - l, bot);
160 painter.drawLine(x_, bot, x_ + cursor_width_ + r, bot);
163 // draw completion triangle
165 int m = y + rect_.height() / 2;
166 int d = TabIndicatorWidth - 1;
168 painter.drawLine(x_ - 1, m - d, x_ - 1 - d, m);
169 painter.drawLine(x_ - 1, m + d, x_ - 1 - d, m);
171 painter.drawLine(x_ + cursor_width_, m - d, x_ + cursor_width_ + d, m);
172 painter.drawLine(x_ + cursor_width_, m + d, x_ + cursor_width_ + d, m);
177 void update(int x, int y, int h, bool l_shape,
178 bool rtl, bool completable)
180 color_ = guiApp->colorCache().get(Color_cursor);
183 completable_ = completable;
186 // extension to left and right
190 // RTL/LTR indication
198 // completion triangle
201 l = max(l, TabIndicatorWidth);
203 r = max(r, TabIndicatorWidth);
206 // compute overall rectangle
207 rect_ = QRect(x - l, y, cursor_width_ + r + l, h);
210 void show(bool set_show = true) { show_ = set_show; }
211 void hide() { show_ = false; }
212 int cursorWidth() const { return cursor_width_; }
213 void recomputeWidth() {
214 cursor_width_ = lyxrc.cursor_width
216 : 1 + int((lyxrc.currentZoom + 50) / 200.0);
219 QRect const & rect() { return rect_; }
222 /// cursor is in RTL or LTR text
224 /// indication for RTL or LTR
226 /// triangle to show that a completion is available
232 /// rectangle, possibly with l_shape and completion triangle
234 /// x position (were the vertical line is drawn)
241 // This is a 'heartbeat' generating synthetic mouse move events when the
242 // cursor is at the top or bottom edge of the viewport. One scroll per 0.2 s
243 SyntheticMouseEvent::SyntheticMouseEvent()
244 : timeout(200), restart_timeout(true)
248 GuiWorkArea::Private::Private(GuiWorkArea * parent)
249 : p(parent), screen_(0), buffer_view_(0), lyx_view_(0),
250 cursor_visible_(false), cursor_(0),
251 need_resize_(false), schedule_redraw_(false), preedit_lines_(1),
253 completer_(new GuiCompleter(p, p)), dialog_mode_(false), shell_escape_(false),
254 read_only_(false), clean_(true), externally_modified_(false)
259 GuiWorkArea::GuiWorkArea(QWidget * /* w */)
260 : d(new Private(this))
265 GuiWorkArea::GuiWorkArea(Buffer & buffer, GuiView & gv)
266 : d(new Private(this))
268 new CompressorProxy(this); // not a leak
270 buffer.params().display_pixel_ratio = theGuiApp()->pixelRatio();
276 double GuiWorkArea::pixelRatio() const
278 #if QT_VERSION >= 0x050000
279 return qt_scale_factor * devicePixelRatio();
286 void GuiWorkArea::init()
289 connect(&d->cursor_timeout_, SIGNAL(timeout()),
290 this, SLOT(toggleCursor()));
292 int const time = QApplication::cursorFlashTime() / 2;
294 d->cursor_timeout_.setInterval(time);
295 d->cursor_timeout_.start();
297 // let's initialize this just to be safe
298 d->cursor_timeout_.setInterval(500);
302 // With Qt4.5 a mouse event will happen before the first paint event
303 // so make sure that the buffer view has an up to date metrics.
304 d->buffer_view_->resize(viewport()->width(), viewport()->height());
305 d->cursor_ = new frontend::CursorWidget();
308 setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
309 setAcceptDrops(true);
310 setMouseTracking(true);
311 setMinimumSize(100, 70);
312 setFrameStyle(QFrame::NoFrame);
315 viewport()->setAutoFillBackground(false);
316 // We don't need double-buffering nor SystemBackground on
317 // the viewport because we have our own backing pixmap.
318 viewport()->setAttribute(Qt::WA_NoSystemBackground);
320 setFocusPolicy(Qt::StrongFocus);
322 d->setCursorShape(Qt::IBeamCursor);
324 // This connection is closed at the same time as this is destroyed.
325 d->synthetic_mouse_event_.timeout.timeout.connect([this](){
326 generateSyntheticMouseEvent();
329 LYXERR(Debug::GUI, "viewport width: " << viewport()->width()
330 << " viewport height: " << viewport()->height());
332 // Enables input methods for asian languages.
333 // Must be set when creating custom text editing widgets.
334 setAttribute(Qt::WA_InputMethodEnabled, true);
336 d->dialog_mode_ = false;
340 GuiWorkArea::~GuiWorkArea()
342 // If something is wrong with the buffer, we can ignore it safely
344 d->buffer_view_->buffer().workAreaManager().remove(this);
347 delete d->buffer_view_;
349 // Completer has a QObject parent and is thus automatically destroyed.
351 // delete completer_;
356 Qt::CursorShape GuiWorkArea::cursorShape() const
358 return viewport()->cursor().shape();
362 void GuiWorkArea::Private::setCursorShape(Qt::CursorShape shape)
364 p->viewport()->setCursor(shape);
368 void GuiWorkArea::Private::updateCursorShape()
370 setCursorShape(buffer_view_->clickableInset()
371 ? Qt::PointingHandCursor : Qt::IBeamCursor);
375 void GuiWorkArea::setGuiView(GuiView & gv)
381 void GuiWorkArea::setBuffer(Buffer & buffer)
383 delete d->buffer_view_;
384 d->buffer_view_ = new BufferView(buffer);
385 buffer.workAreaManager().add(this);
387 // HACK: Prevents an additional redraw when the scrollbar pops up
388 // which regularily happens on documents with more than one page.
389 // The policy should be set to "Qt::ScrollBarAsNeeded" soon.
390 // Since we have no geometry information yet, we assume that
391 // a document needs a scrollbar if there is more then four
392 // paragraph in the outermost text.
393 if (buffer.text().paragraphs().size() > 4)
394 setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOn);
395 QTimer::singleShot(50, this, SLOT(fixVerticalScrollBar()));
396 Q_EMIT bufferViewChanged();
400 void GuiWorkArea::fixVerticalScrollBar()
403 setVerticalScrollBarPolicy(Qt::ScrollBarAsNeeded);
407 void GuiWorkArea::close()
409 d->lyx_view_->removeWorkArea(this);
413 void GuiWorkArea::setFullScreen(bool full_screen)
415 d->buffer_view_->setFullScreen(full_screen);
416 setFrameStyle(QFrame::NoFrame);
418 setFrameStyle(QFrame::NoFrame);
419 if (lyxrc.full_screen_scrollbar)
420 setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
422 setVerticalScrollBarPolicy(Qt::ScrollBarAsNeeded);
426 BufferView & GuiWorkArea::bufferView()
428 return *d->buffer_view_;
432 BufferView const & GuiWorkArea::bufferView() const
434 return *d->buffer_view_;
438 void GuiWorkArea::stopBlinkingCursor()
440 d->cursor_timeout_.stop();
445 void GuiWorkArea::startBlinkingCursor()
447 // do not show the cursor if the view is busy
453 d->buffer_view_->cursorPosAndHeight(p, h);
454 // Don't start blinking if the cursor isn't on screen.
455 if (!d->buffer_view_->cursorInView(p, h))
460 //we're not supposed to cache this value.
461 int const time = QApplication::cursorFlashTime() / 2;
464 d->cursor_timeout_.setInterval(time);
465 d->cursor_timeout_.start();
469 void GuiWorkArea::redraw(bool update_metrics)
472 // No need to redraw in this case.
475 // No need to do anything if this is the current view. The BufferView
476 // metrics are already up to date.
477 if (update_metrics || d->lyx_view_ != guiApp->currentView()
478 || d->lyx_view_->currentWorkArea() != this) {
479 // FIXME: it would be nice to optimize for the off-screen case.
480 d->buffer_view_->cursor().fixIfBroken();
481 d->buffer_view_->updateMetrics();
482 d->buffer_view_->cursor().fixIfBroken();
485 // update cursor position, because otherwise it has to wait until
486 // the blinking interval is over
487 if (d->cursor_visible_) {
492 LYXERR(Debug::WORKAREA, "WorkArea::redraw screen");
494 update(0, 0, viewport()->width(), viewport()->height());
496 /// \warning: scrollbar updating *must* be done after the BufferView is drawn
497 /// because \c BufferView::updateScrollbar() is called in \c BufferView::draw().
498 d->updateScrollbar();
499 d->lyx_view_->updateStatusBar();
501 if (lyxerr.debugging(Debug::WORKAREA))
502 d->buffer_view_->coordCache().dump();
506 d->updateCursorShape();
510 // Keep in sync with GuiWorkArea::processKeySym below
511 bool GuiWorkArea::queryKeySym(KeySymbol const & key, KeyModifier mod) const
513 return guiApp->queryKeySym(key, mod);
517 // Keep in sync with GuiWorkArea::queryKeySym above
518 void GuiWorkArea::processKeySym(KeySymbol const & key, KeyModifier mod)
520 if (d->lyx_view_->isFullScreen() && d->lyx_view_->menuBar()->isVisible()
521 && lyxrc.full_screen_menubar) {
522 // FIXME HACK: we should not have to do this here. See related comment
523 // in GuiView::event() (QEvent::ShortcutOverride)
524 d->lyx_view_->menuBar()->hide();
527 // In order to avoid bad surprise in the middle of an operation,
528 // we better stop the blinking cursor...
529 // the cursor gets restarted in GuiView::restartCursor()
530 stopBlinkingCursor();
531 guiApp->processKeySym(key, mod);
535 void GuiWorkArea::Private::dispatch(FuncRequest const & cmd)
538 if (cmd.action() == LFUN_FILE_OPEN) {
540 lyx_view_->dispatch(cmd, dr);
544 bool const notJustMovingTheMouse =
545 cmd.action() != LFUN_MOUSE_MOTION || cmd.button() != mouse_button::none;
547 // In order to avoid bad surprise in the middle of an operation, we better stop
548 // the blinking cursor.
549 if (notJustMovingTheMouse)
550 p->stopBlinkingCursor();
552 buffer_view_->mouseEventDispatch(cmd);
554 // Skip these when selecting
555 // FIXME: let GuiView take care of those.
556 if (cmd.action() != LFUN_MOUSE_MOTION) {
557 completer_->updateVisibility(false, false);
558 lyx_view_->updateDialogs();
559 lyx_view_->updateStatusBar();
562 // GUI tweaks except with mouse motion with no button pressed.
563 if (notJustMovingTheMouse) {
564 // Slight hack: this is only called currently when we
565 // clicked somewhere, so we force through the display
566 // of the new status here.
567 // FIXME: let GuiView take care of those.
568 lyx_view_->clearMessage();
570 // Show the cursor immediately after any operation
571 p->startBlinkingCursor();
578 void GuiWorkArea::Private::resizeBufferView()
580 // WARNING: Please don't put any code that will trigger a repaint here!
581 // We are already inside a paint event.
582 p->stopBlinkingCursor();
583 // Warn our container (GuiView).
588 buffer_view_->cursorPosAndHeight(point, h);
589 bool const cursor_in_view = buffer_view_->cursorInView(point, h);
590 buffer_view_->resize(p->viewport()->width(), p->viewport()->height());
592 buffer_view_->scrollToCursor();
595 // Update scrollbars which might have changed due different
596 // BufferView dimension. This is especially important when the
597 // BufferView goes from zero-size to the real-size for the first time,
598 // as the scrollbar paramters are then set for the first time.
601 need_resize_ = false;
603 // Eventually, restart the cursor after the resize event.
604 // We might be resizing even if the focus is on another widget so we only
605 // restart the cursor if we have the focus.
607 QTimer::singleShot(50, p, SLOT(startBlinkingCursor()));
611 void GuiWorkArea::Private::showCursor()
618 buffer_view_->cursorPosAndHeight(p, h);
619 if (!buffer_view_->cursorInView(p, h))
623 bool l_shape = false;
624 Font const & realfont = buffer_view_->cursor().real_current_font;
625 BufferParams const & bp = buffer_view_->buffer().params();
626 bool const samelang = realfont.language() == bp.language;
627 bool const isrtl = realfont.isVisibleRightToLeft();
629 if (!samelang || isrtl != bp.language->rightToLeft())
632 // The ERT language hack needs fixing up
633 if (realfont.language() == latex_language)
636 // show cursor on screen
637 Cursor & cur = buffer_view_->cursor();
638 bool completable = cur.inset().showCompletionCursor()
639 && completer_->completionAvailable()
640 && !completer_->popupVisible()
641 && !completer_->inlineVisible();
642 cursor_visible_ = true;
643 cursor_->recomputeWidth();
645 //int cur_x = buffer_view_->getPos(cur).x_;
646 // We may have decided to slide the cursor row so that cursor
648 p.x_ -= buffer_view_->horizScrollOffset();
650 showCursor(p.x_, p.y_, h, l_shape, isrtl, completable);
654 void GuiWorkArea::Private::hideCursor()
656 if (!cursor_visible_)
659 cursor_visible_ = false;
664 void GuiWorkArea::toggleCursor()
666 if (d->cursor_visible_)
673 void GuiWorkArea::Private::updateScrollbar()
675 // Prevent setRange() and setSliderPosition from causing recursive calls via
676 // the signal valueChanged. (#10311)
677 QObject::disconnect(p->verticalScrollBar(), SIGNAL(valueChanged(int)),
678 p, SLOT(scrollTo(int)));
679 ScrollbarParameters const & scroll_ = buffer_view_->scrollbarParameters();
680 p->verticalScrollBar()->setRange(scroll_.min, scroll_.max);
681 p->verticalScrollBar()->setPageStep(scroll_.page_step);
682 p->verticalScrollBar()->setSingleStep(scroll_.single_step);
683 p->verticalScrollBar()->setSliderPosition(0);
684 // Connect to the vertical scroll bar
685 QObject::connect(p->verticalScrollBar(), SIGNAL(valueChanged(int)),
686 p, SLOT(scrollTo(int)));
690 void GuiWorkArea::scrollTo(int value)
692 stopBlinkingCursor();
693 d->buffer_view_->scrollDocView(value, true);
695 if (lyxrc.cursor_follows_scrollbar) {
696 d->buffer_view_->setCursorFromScrollbar();
697 // FIXME: let GuiView take care of those.
698 d->lyx_view_->updateLayoutList();
700 // Show the cursor immediately after any operation.
701 startBlinkingCursor();
704 QApplication::syncX();
709 bool GuiWorkArea::event(QEvent * e)
712 case QEvent::ToolTip: {
713 QHelpEvent * helpEvent = static_cast<QHelpEvent *>(e);
714 if (lyxrc.use_tooltip) {
715 QPoint pos = helpEvent->pos();
716 if (pos.x() < viewport()->width()) {
717 QString s = toqstr(d->buffer_view_->toolTip(pos.x(), pos.y()));
718 QToolTip::showText(helpEvent->globalPos(), formatToolTip(s,35));
721 QToolTip::hideText();
723 // Don't forget to accept the event!
728 case QEvent::ShortcutOverride:
729 // keyPressEvent is ShortcutOverride-aware and only accepts the event in
731 keyPressEvent(static_cast<QKeyEvent *>(e));
732 return e->isAccepted();
734 case QEvent::KeyPress: {
735 // We catch this event in order to catch the Tab or Shift+Tab key press
736 // which are otherwise reserved to focus switching between controls
738 QKeyEvent * ke = static_cast<QKeyEvent*>(e);
739 if ((ke->key() == Qt::Key_Tab && ke->modifiers() == Qt::NoModifier)
740 || (ke->key() == Qt::Key_Backtab && (
741 ke->modifiers() == Qt::ShiftModifier
742 || ke->modifiers() == Qt::NoModifier))) {
746 return QAbstractScrollArea::event(e);
750 return QAbstractScrollArea::event(e);
756 void GuiWorkArea::contextMenuEvent(QContextMenuEvent * e)
759 if (e->reason() == QContextMenuEvent::Mouse)
760 // the menu name is set on mouse press
761 name = d->context_menu_name_;
763 QPoint pos = e->pos();
764 Cursor const & cur = d->buffer_view_->cursor();
765 if (e->reason() == QContextMenuEvent::Keyboard && cur.inTexted()) {
766 // Do not access the context menu of math right in front of before
767 // the cursor. This does not work when the cursor is in text.
768 Inset * inset = cur.paragraph().getInset(cur.pos());
769 if (inset && inset->asInsetMath())
771 else if (cur.pos() > 0) {
772 Inset * inset = cur.paragraph().getInset(cur.pos() - 1);
777 name = d->buffer_view_->contextMenu(pos.x(), pos.y());
784 // always show mnemonics when the keyboard is used to show the context menu
785 // FIXME: This should be fixed in Qt itself
786 bool const keyboard = (e->reason() == QContextMenuEvent::Keyboard);
787 QMenu * menu = guiApp->menus().menu(toqstr(name), *d->lyx_view_, keyboard);
792 // Position the menu to the right.
793 // FIXME: menu position should be different for RTL text.
794 menu->exec(e->globalPos());
799 void GuiWorkArea::focusInEvent(QFocusEvent * e)
801 LYXERR(Debug::DEBUG, "GuiWorkArea::focusInEvent(): " << this << endl);
802 if (d->lyx_view_->currentWorkArea() != this) {
803 d->lyx_view_->setCurrentWorkArea(this);
804 d->lyx_view_->currentWorkArea()->bufferView().buffer().updateBuffer();
807 startBlinkingCursor();
808 QAbstractScrollArea::focusInEvent(e);
812 void GuiWorkArea::focusOutEvent(QFocusEvent * e)
814 LYXERR(Debug::DEBUG, "GuiWorkArea::focusOutEvent(): " << this << endl);
815 stopBlinkingCursor();
816 QAbstractScrollArea::focusOutEvent(e);
820 void GuiWorkArea::mousePressEvent(QMouseEvent * e)
822 if (d->dc_event_.active && d->dc_event_ == *e) {
823 d->dc_event_.active = false;
824 FuncRequest cmd(LFUN_MOUSE_TRIPLE, e->x(), e->y(),
825 q_button_state(e->button()), q_key_state(e->modifiers()));
831 #if (QT_VERSION < 0x050000) && !defined(__HAIKU__)
832 inputContext()->reset();
835 FuncRequest const cmd(LFUN_MOUSE_PRESS, e->x(), e->y(),
836 q_button_state(e->button()), q_key_state(e->modifiers()));
839 // Save the context menu on mouse press, because also the mouse
840 // cursor is set on mouse press. Afterwards, we can either release
841 // the mousebutton somewhere else, or the cursor might have moved
842 // due to the DEPM. We need to do this after the mouse has been
843 // set in dispatch(), because the selection state might change.
844 if (e->button() == Qt::RightButton)
845 d->context_menu_name_ = d->buffer_view_->contextMenu(e->x(), e->y());
851 void GuiWorkArea::mouseReleaseEvent(QMouseEvent * e)
853 if (d->synthetic_mouse_event_.timeout.running())
854 d->synthetic_mouse_event_.timeout.stop();
856 FuncRequest const cmd(LFUN_MOUSE_RELEASE, e->x(), e->y(),
857 q_button_state(e->button()), q_key_state(e->modifiers()));
863 void GuiWorkArea::mouseMoveEvent(QMouseEvent * e)
865 // we kill the triple click if we move
866 doubleClickTimeout();
867 FuncRequest cmd(LFUN_MOUSE_MOTION, e->x(), e->y(),
868 q_motion_state(e->buttons()), q_key_state(e->modifiers()));
872 // If we're above or below the work area...
873 if ((e->y() <= 20 || e->y() >= viewport()->height() - 20)
874 && e->buttons() == mouse_button::button1) {
875 // Make sure only a synthetic event can cause a page scroll,
876 // so they come at a steady rate:
878 // _Force_ a scroll up:
879 cmd.set_y(e->y() - 21);
881 cmd.set_y(e->y() + 21);
882 // Store the event, to be handled when the timeout expires.
883 d->synthetic_mouse_event_.cmd = cmd;
885 if (d->synthetic_mouse_event_.timeout.running()) {
886 // Discard the event. Note that it _may_ be handled
887 // when the timeout expires if
888 // synthetic_mouse_event_.cmd has not been overwritten.
889 // Ie, when the timeout expires, we handle the
890 // most recent event but discard all others that
891 // occurred after the one used to start the timeout
892 // in the first place.
896 d->synthetic_mouse_event_.restart_timeout = true;
897 d->synthetic_mouse_event_.timeout.start();
898 // Fall through to handle this event...
900 } else if (d->synthetic_mouse_event_.timeout.running()) {
901 // Store the event, to be possibly handled when the timeout
903 // Once the timeout has expired, normal control is returned
904 // to mouseMoveEvent (restart_timeout = false).
905 // This results in a much smoother 'feel' when moving the
906 // mouse back into the work area.
907 d->synthetic_mouse_event_.cmd = cmd;
908 d->synthetic_mouse_event_.restart_timeout = false;
915 void GuiWorkArea::wheelEvent(QWheelEvent * ev)
917 // Wheel rotation by one notch results in a delta() of 120 (see
918 // documentation of QWheelEvent)
919 double const delta = ev->delta() / 120.0;
921 switch (lyxrc.scroll_wheel_zoom) {
922 case LyXRC::SCROLL_WHEEL_ZOOM_CTRL:
923 zoom = ev->modifiers() & Qt::ControlModifier;
924 zoom &= !(ev->modifiers() & (Qt::ShiftModifier | Qt::AltModifier));
926 case LyXRC::SCROLL_WHEEL_ZOOM_SHIFT:
927 zoom = ev->modifiers() & Qt::ShiftModifier;
928 zoom &= !(ev->modifiers() & (Qt::ControlModifier | Qt::AltModifier));
930 case LyXRC::SCROLL_WHEEL_ZOOM_ALT:
931 zoom = ev->modifiers() & Qt::AltModifier;
932 zoom &= !(ev->modifiers() & (Qt::ShiftModifier | Qt::ControlModifier));
934 case LyXRC::SCROLL_WHEEL_ZOOM_OFF:
938 docstring arg = convert<docstring>(int(5 * delta));
939 lyx::dispatch(FuncRequest(LFUN_BUFFER_ZOOM_IN, arg));
943 // Take into account the desktop wide settings.
944 int const lines = qApp->wheelScrollLines();
945 int const page_step = verticalScrollBar()->pageStep();
946 // Test if the wheel mouse is set to one screen at a time.
947 // This is according to
948 // https://doc.qt.io/qt-5/qapplication.html#wheelScrollLines-prop
950 min(lines * verticalScrollBar()->singleStep(), page_step);
952 // Take into account the rotation and the user preferences.
953 scroll_value = int(scroll_value * delta * lyxrc.mouse_wheel_speed);
954 LYXERR(Debug::SCROLLING, "wheelScrollLines = " << lines
955 << " delta = " << delta << " scroll_value = " << scroll_value
956 << " page_step = " << page_step);
958 verticalScrollBar()->setValue(verticalScrollBar()->value() - scroll_value);
964 void GuiWorkArea::generateSyntheticMouseEvent()
966 int const e_y = d->synthetic_mouse_event_.cmd.y();
967 int const wh = d->buffer_view_->workHeight();
968 bool const up = e_y < 0;
969 bool const down = e_y > wh;
971 // Set things off to generate the _next_ 'pseudo' event.
973 if (d->synthetic_mouse_event_.restart_timeout) {
974 // This is some magic formulae to determine the speed
975 // of scrolling related to the position of the mouse.
978 int dist = up ? -e_y : e_y - wh;
979 time = max(min(200, 250000 / (dist * dist)), 1) ;
982 step = 80000 / (time * time);
986 d->synthetic_mouse_event_.timeout.setTimeout(time);
987 d->synthetic_mouse_event_.timeout.start();
990 // Can we scroll further ?
991 int const value = verticalScrollBar()->value();
992 if (value == verticalScrollBar()->maximum()
993 || value == verticalScrollBar()->minimum()) {
994 d->synthetic_mouse_event_.timeout.stop();
999 if (step <= 2 * wh) {
1000 d->buffer_view_->scroll(up ? -step : step);
1001 d->buffer_view_->updateMetrics();
1003 d->buffer_view_->scrollDocView(value + (up ? -step : step), false);
1006 // In which paragraph do we have to set the cursor ?
1007 Cursor & cur = d->buffer_view_->cursor();
1008 // FIXME: we don't know how to handle math.
1009 Text * text = cur.text();
1012 TextMetrics const & tm = d->buffer_view_->textMetrics(text);
1014 // Quit gracefully if there are no metrics, since otherwise next
1015 // line would crash (bug #10324).
1016 // This situation seems related to a (not yet understood) timing problem.
1020 pair<pit_type, const ParagraphMetrics *> pp = up ? tm.first() : tm.last();
1021 ParagraphMetrics const & pm = *pp.second;
1022 pit_type const pit = pp.first;
1024 if (pm.rows().empty())
1027 // Find the row at which we set the cursor.
1028 RowList::const_iterator rit = pm.rows().begin();
1029 RowList::const_iterator rlast = pm.rows().end();
1030 int yy = pm.position() - pm.ascent();
1031 for (--rlast; rit != rlast; ++rit) {
1032 int h = rit->height();
1033 if ((up && yy + h > 0)
1034 || (!up && yy + h > wh - defaultRowHeight()))
1039 // Find the position of the cursor
1041 int x = d->synthetic_mouse_event_.cmd.x();
1042 pos_type const pos = tm.getPosNearX(*rit, x, bound);
1047 cur.boundary(bound);
1049 d->buffer_view_->buffer().changed(false);
1054 // CompressorProxy adapted from Kuba Ober https://stackoverflow.com/a/21006207
1055 CompressorProxy::CompressorProxy(GuiWorkArea * wa) : QObject(wa)
1057 qRegisterMetaType<KeySymbol>("KeySymbol");
1058 qRegisterMetaType<KeyModifier>("KeyModifier");
1059 connect(wa, &GuiWorkArea::compressKeySym, this, &CompressorProxy::slot,
1060 Qt::QueuedConnection);
1061 connect(this, &CompressorProxy::signal, wa, &GuiWorkArea::processKeySym);
1065 bool CompressorProxy::emitCheck(bool isAutoRepeat)
1069 QCoreApplication::sendPostedEvents(this, QEvent::MetaCall); // recurse
1070 bool result = flag_;
1076 void CompressorProxy::slot(KeySymbol sym, KeyModifier mod, bool isAutoRepeat)
1078 if (emitCheck(isAutoRepeat))
1079 Q_EMIT signal(sym, mod);
1081 LYXERR(Debug::KEY, "system is busy: autoRepeat key event ignored");
1085 void GuiWorkArea::keyPressEvent(QKeyEvent * ev)
1087 // this is also called for ShortcutOverride events. In this case, one must
1088 // not act but simply accept the event explicitly.
1089 bool const act = (ev->type() != QEvent::ShortcutOverride);
1091 // Do not process here some keys if dialog_mode_ is set
1092 bool const for_dialog_mode = d->dialog_mode_
1093 && (ev->modifiers() == Qt::NoModifier
1094 || ev->modifiers() == Qt::ShiftModifier)
1095 && (ev->key() == Qt::Key_Escape
1096 || ev->key() == Qt::Key_Enter
1097 || ev->key() == Qt::Key_Return);
1098 // also do not use autoRepeat to input shortcuts
1099 bool const autoRepeat = ev->isAutoRepeat();
1101 if (for_dialog_mode || (!act && autoRepeat)) {
1106 // intercept some keys if completion popup is visible
1107 if (d->completer_->popupVisible()) {
1108 switch (ev->key()) {
1110 case Qt::Key_Return:
1112 d->completer_->activate();
1118 KeyModifier const m = q_key_state(ev->modifiers());
1120 if (act && lyxerr.debugging(Debug::KEY)) {
1122 if (m & ShiftModifier)
1124 if (m & ControlModifier)
1126 if (m & AltModifier)
1128 if (m & MetaModifier)
1130 LYXERR(Debug::KEY, " count: " << ev->count() << " text: " << ev->text()
1131 << " isAutoRepeat: " << ev->isAutoRepeat() << " key: " << ev->key()
1132 << " keyState: " << str);
1136 setKeySymbol(&sym, ev);
1139 Q_EMIT compressKeySym(sym, m, autoRepeat);
1142 // here, !autoRepeat, as determined at the beginning
1143 ev->setAccepted(queryKeySym(sym, m));
1150 void GuiWorkArea::doubleClickTimeout()
1152 d->dc_event_.active = false;
1156 void GuiWorkArea::mouseDoubleClickEvent(QMouseEvent * ev)
1158 d->dc_event_ = DoubleClick(ev);
1159 QTimer::singleShot(QApplication::doubleClickInterval(), this,
1160 SLOT(doubleClickTimeout()));
1161 FuncRequest cmd(LFUN_MOUSE_DOUBLE, ev->x(), ev->y(),
1162 q_button_state(ev->button()), q_key_state(ev->modifiers()));
1168 void GuiWorkArea::resizeEvent(QResizeEvent * ev)
1170 QAbstractScrollArea::resizeEvent(ev);
1171 d->need_resize_ = true;
1176 void GuiWorkArea::Private::update(int x, int y, int w, int h)
1178 p->viewport()->update(x, y, w, h);
1182 void GuiWorkArea::paintEvent(QPaintEvent * ev)
1184 QRectF const rc = ev->rect();
1185 // LYXERR(Debug::PAINTING, "paintEvent begin: x: " << rc.x()
1186 // << " y: " << rc.y() << " w: " << rc.width() << " h: " << rc.height());
1188 if (d->needResize()) {
1190 d->resizeBufferView();
1191 if (d->cursor_visible_) {
1197 QPainter pain(viewport());
1198 double const pr = pixelRatio();
1199 QRectF const rcs = QRectF(rc.x() * pr, rc.y() * pr, rc.width() * pr, rc.height() * pr);
1201 if (lyxrc.use_qimage) {
1202 QImage const & image = static_cast<QImage const &>(*d->screen_);
1203 pain.drawImage(rc, image, rcs);
1205 QPixmap const & pixmap = static_cast<QPixmap const &>(*d->screen_);
1206 pain.drawPixmap(rc, pixmap, rcs);
1208 d->cursor_->draw(pain);
1213 void GuiWorkArea::Private::updateScreen()
1215 GuiPainter pain(screen_, p->pixelRatio());
1216 buffer_view_->draw(pain);
1220 void GuiWorkArea::Private::showCursor(int x, int y, int h,
1221 bool l_shape, bool rtl, bool completable)
1223 if (schedule_redraw_) {
1224 // This happens when a graphic conversion is finished. As we don't know
1225 // the size of the new graphics, it's better the update everything.
1226 // We can't use redraw() here because this would trigger a infinite
1227 // recursive loop with showCursor().
1228 buffer_view_->resize(p->viewport()->width(), p->viewport()->height());
1231 p->viewport()->update(QRect(0, 0, p->viewport()->width(), p->viewport()->height()));
1232 schedule_redraw_ = false;
1233 // Show the cursor immediately after the update.
1239 cursor_->update(x, y, h, l_shape, rtl, completable);
1241 p->viewport()->update(cursor_->rect());
1245 void GuiWorkArea::Private::removeCursor()
1248 //if (!qApp->focusWidget())
1249 p->viewport()->update(cursor_->rect());
1253 void GuiWorkArea::inputMethodEvent(QInputMethodEvent * e)
1255 QString const & commit_string = e->commitString();
1256 docstring const & preedit_string
1257 = qstring_to_ucs4(e->preeditString());
1259 if (!commit_string.isEmpty()) {
1261 LYXERR(Debug::KEY, "preeditString: " << e->preeditString()
1262 << " commitString: " << e->commitString());
1266 // FIXME Iwami 04/01/07: we should take care also of UTF16 surrogates here.
1267 for (int i = 0; i != commit_string.size(); ++i) {
1268 QKeyEvent ev(QEvent::KeyPress, key, Qt::NoModifier, commit_string[i]);
1273 // Hide the cursor during the kana-kanji transformation.
1274 if (preedit_string.empty())
1275 startBlinkingCursor();
1277 stopBlinkingCursor();
1279 // last_width : for checking if last preedit string was/wasn't empty.
1280 // FIXME THREAD && FIXME
1281 // We could have more than one work area, right?
1282 static bool last_width = false;
1283 if (!last_width && preedit_string.empty()) {
1284 // if last_width is last length of preedit string.
1289 GuiPainter pain(d->screen_, pixelRatio());
1290 d->buffer_view_->updateMetrics();
1291 d->buffer_view_->draw(pain);
1292 // FIXME: shall we use real_current_font here? (see #10478)
1293 FontInfo font = d->buffer_view_->cursor().getFont().fontInfo();
1294 FontMetrics const & fm = theFontMetrics(font);
1295 int height = fm.maxHeight();
1296 int cur_x = d->cursor_->rect().left();
1297 int cur_y = d->cursor_->rect().bottom();
1299 // redraw area of preedit string.
1300 update(0, cur_y - height, viewport()->width(),
1301 (height + 1) * d->preedit_lines_);
1303 if (preedit_string.empty()) {
1305 d->preedit_lines_ = 1;
1311 // att : stores an IM attribute.
1312 QList<QInputMethodEvent::Attribute> const & att = e->attributes();
1314 // get attributes of input method cursor.
1315 // cursor_pos : cursor position in preedit string.
1316 size_t cursor_pos = 0;
1317 bool cursor_is_visible = false;
1318 for (int i = 0; i != att.size(); ++i) {
1319 if (att.at(i).type == QInputMethodEvent::Cursor) {
1320 cursor_pos = att.at(i).start;
1321 cursor_is_visible = att.at(i).length != 0;
1326 size_t preedit_length = preedit_string.length();
1328 // get position of selection in input method.
1329 // FIXME: isn't there a way to do this simplier?
1330 // rStart : cursor position in selected string in IM.
1332 // rLength : selected string length in IM.
1334 if (cursor_pos < preedit_length) {
1335 for (int i = 0; i != att.size(); ++i) {
1336 if (att.at(i).type == QInputMethodEvent::TextFormat) {
1337 if (att.at(i).start <= int(cursor_pos)
1338 && int(cursor_pos) < att.at(i).start + att.at(i).length) {
1339 rStart = att.at(i).start;
1340 rLength = att.at(i).length;
1341 if (!cursor_is_visible)
1342 cursor_pos += rLength;
1349 rStart = cursor_pos;
1353 int const right_margin = d->buffer_view_->rightMargin();
1354 Painter::preedit_style ps;
1355 // Most often there would be only one line:
1356 d->preedit_lines_ = 1;
1357 for (size_t pos = 0; pos != preedit_length; ++pos) {
1358 char_type const typed_char = preedit_string[pos];
1359 // reset preedit string style
1360 ps = Painter::preedit_default;
1362 // if we reached the right extremity of the screen, go to next line.
1363 if (cur_x + fm.width(typed_char) > viewport()->width() - right_margin) {
1364 cur_x = right_margin;
1365 cur_y += height + 1;
1366 ++d->preedit_lines_;
1368 // preedit strings are displayed with dashed underline
1369 // and partial strings are displayed white on black indicating
1370 // that we are in selecting mode in the input method.
1371 // FIXME: rLength == preedit_length is not a changing condition
1372 // FIXME: should be put out of the loop.
1374 && pos < rStart + rLength
1375 && !(cursor_pos < rLength && rLength == preedit_length))
1376 ps = Painter::preedit_selecting;
1378 if (pos == cursor_pos
1379 && (cursor_pos < rLength && rLength == preedit_length))
1380 ps = Painter::preedit_cursor;
1382 // draw one character and update cur_x.
1383 cur_x += pain.preeditText(cur_x, cur_y, typed_char, font, ps);
1386 // update the preedit string screen area.
1387 update(0, cur_y - d->preedit_lines_*height, viewport()->width(),
1388 (height + 1) * d->preedit_lines_);
1390 // Don't forget to accept the event!
1395 QVariant GuiWorkArea::inputMethodQuery(Qt::InputMethodQuery query) const
1397 QRect cur_r(0, 0, 0, 0);
1399 // this is the CJK-specific composition window position and
1400 // the context menu position when the menu key is pressed.
1401 case Qt::ImMicroFocus:
1402 cur_r = d->cursor_->rect();
1403 if (d->preedit_lines_ != 1)
1405 cur_r.moveBottom(cur_r.bottom()
1406 + cur_r.height() * (d->preedit_lines_ - 1));
1407 // return lower right of cursor in LyX.
1410 return QWidget::inputMethodQuery(query);
1415 void GuiWorkArea::updateWindowTitle()
1417 Buffer const & buf = bufferView().buffer();
1418 if (buf.fileName() != d->file_name_
1419 || buf.params().shell_escape != d->shell_escape_
1420 || buf.hasReadonlyFlag() != d->read_only_
1421 || buf.lyxvc().vcstatus() != d->vc_status_
1422 || buf.isClean() != d->clean_
1423 || buf.notifiesExternalModification() != d->externally_modified_) {
1424 d->file_name_ = buf.fileName();
1425 d->shell_escape_ = buf.params().shell_escape;
1426 d->read_only_ = buf.hasReadonlyFlag();
1427 d->vc_status_ = buf.lyxvc().vcstatus();
1428 d->clean_ = buf.isClean();
1429 d->externally_modified_ = buf.notifiesExternalModification();
1430 Q_EMIT titleChanged(this);
1435 bool GuiWorkArea::isFullScreen() const
1437 return d->lyx_view_ && d->lyx_view_->isFullScreen();
1441 void GuiWorkArea::scheduleRedraw()
1443 d->schedule_redraw_ = true;
1447 bool GuiWorkArea::inDialogMode() const
1449 return d->dialog_mode_;
1453 void GuiWorkArea::setDialogMode(bool mode)
1455 d->dialog_mode_ = mode;
1459 GuiCompleter & GuiWorkArea::completer()
1461 return *d->completer_;
1464 GuiView const & GuiWorkArea::view() const
1466 return *d->lyx_view_;
1470 GuiView & GuiWorkArea::view()
1472 return *d->lyx_view_;
1475 ////////////////////////////////////////////////////////////////////
1479 ////////////////////////////////////////////////////////////////////
1482 EmbeddedWorkArea::EmbeddedWorkArea(QWidget * w): GuiWorkArea(w)
1484 support::TempFile tempfile("embedded.internal");
1485 tempfile.setAutoRemove(false);
1486 buffer_ = theBufferList().newInternalBuffer(tempfile.name().absFileName());
1487 buffer_->setUnnamed(true);
1488 buffer_->setFullyLoaded(true);
1489 setBuffer(*buffer_);
1490 setDialogMode(true);
1494 EmbeddedWorkArea::~EmbeddedWorkArea()
1496 // No need to destroy buffer and bufferview here, because it is done
1497 // in theBufferList() destruction loop at application exit
1501 void EmbeddedWorkArea::closeEvent(QCloseEvent * ev)
1504 GuiWorkArea::closeEvent(ev);
1508 void EmbeddedWorkArea::hideEvent(QHideEvent * ev)
1511 GuiWorkArea::hideEvent(ev);
1515 QSize EmbeddedWorkArea::sizeHint () const
1518 // GuiWorkArea sets the size to the screen's viewport
1519 // by returning a value this gets overridden
1520 // EmbeddedWorkArea is now sized to fit in the layout
1521 // of the parent, and has a minimum size set in GuiWorkArea
1522 // which is what we return here
1523 return QSize(100, 70);
1527 void EmbeddedWorkArea::disable()
1529 stopBlinkingCursor();
1530 if (view().currentWorkArea() != this)
1532 // No problem if currentMainWorkArea() is 0 (setCurrentWorkArea()
1533 // tolerates it and shows the background logo), what happens if
1534 // an EmbeddedWorkArea is closed after closing all document WAs
1535 view().setCurrentWorkArea(view().currentMainWorkArea());
1538 ////////////////////////////////////////////////////////////////////
1542 ////////////////////////////////////////////////////////////////////
1545 class NoTabFrameMacStyle : public QProxyStyle {
1548 QRect subElementRect(SubElement element, const QStyleOption * option,
1549 const QWidget * widget = 0) const
1551 QRect rect = QProxyStyle::subElementRect(element, option, widget);
1552 bool noBar = static_cast<QTabWidget const *>(widget)->count() <= 1;
1554 // The Qt Mac style puts the contents into a 3 pixel wide box
1555 // which looks very ugly and not like other Mac applications.
1556 // Hence we remove this here, and moreover the 16 pixel round
1557 // frame above if the tab bar is hidden.
1558 if (element == QStyle::SE_TabWidgetTabContents) {
1559 rect.adjust(- rect.left(), 0, rect.left(), 0);
1568 NoTabFrameMacStyle noTabFrameMacStyle;
1572 TabWorkArea::TabWorkArea(QWidget * parent)
1573 : QTabWidget(parent), clicked_tab_(-1), midpressed_tab_(-1)
1576 setStyle(&noTabFrameMacStyle);
1579 QPalette pal = palette();
1580 pal.setColor(QPalette::Active, QPalette::Button,
1581 pal.color(QPalette::Active, QPalette::Window));
1582 pal.setColor(QPalette::Disabled, QPalette::Button,
1583 pal.color(QPalette::Disabled, QPalette::Window));
1584 pal.setColor(QPalette::Inactive, QPalette::Button,
1585 pal.color(QPalette::Inactive, QPalette::Window));
1587 QObject::connect(this, SIGNAL(currentChanged(int)),
1588 this, SLOT(on_currentTabChanged(int)));
1590 closeBufferButton = new QToolButton(this);
1591 closeBufferButton->setPalette(pal);
1592 // FIXME: rename the icon to closebuffer.png
1593 closeBufferButton->setIcon(QIcon(getPixmap("images/", "closetab", "svgz,png")));
1594 closeBufferButton->setText("Close File");
1595 closeBufferButton->setAutoRaise(true);
1596 closeBufferButton->setCursor(Qt::ArrowCursor);
1597 closeBufferButton->setToolTip(qt_("Close File"));
1598 closeBufferButton->setEnabled(true);
1599 QObject::connect(closeBufferButton, SIGNAL(clicked()),
1600 this, SLOT(closeCurrentBuffer()));
1601 setCornerWidget(closeBufferButton, Qt::TopRightCorner);
1603 // setup drag'n'drop
1604 QTabBar* tb = new DragTabBar;
1605 connect(tb, SIGNAL(tabMoveRequested(int, int)),
1606 this, SLOT(moveTab(int, int)));
1607 tb->setElideMode(Qt::ElideNone);
1610 // make us responsible for the context menu of the tabbar
1611 tb->setContextMenuPolicy(Qt::CustomContextMenu);
1612 connect(tb, SIGNAL(customContextMenuRequested(const QPoint &)),
1613 this, SLOT(showContextMenu(const QPoint &)));
1614 connect(tb, SIGNAL(tabCloseRequested(int)),
1615 this, SLOT(closeTab(int)));
1617 setUsesScrollButtons(true);
1621 void TabWorkArea::mousePressEvent(QMouseEvent *me)
1623 if (me->button() == Qt::MidButton)
1624 midpressed_tab_ = tabBar()->tabAt(me->pos());
1626 QTabWidget::mousePressEvent(me);
1630 void TabWorkArea::mouseReleaseEvent(QMouseEvent *me)
1632 if (me->button() == Qt::MidButton) {
1633 int const midreleased_tab = tabBar()->tabAt(me->pos());
1634 if (midpressed_tab_ == midreleased_tab && posIsTab(me->pos()))
1635 closeTab(midreleased_tab);
1637 QTabWidget::mouseReleaseEvent(me);
1641 void TabWorkArea::paintEvent(QPaintEvent * event)
1643 if (tabBar()->isVisible()) {
1644 QTabWidget::paintEvent(event);
1646 // Prevent the selected tab to influence the
1647 // painting of the frame of the tab widget.
1648 // This is needed for gtk style in Qt.
1649 QStylePainter p(this);
1650 #if QT_VERSION < 0x050000
1651 QStyleOptionTabWidgetFrameV2 opt;
1653 QStyleOptionTabWidgetFrame opt;
1655 initStyleOption(&opt);
1656 opt.rect = style()->subElementRect(QStyle::SE_TabWidgetTabPane,
1658 opt.selectedTabRect = QRect();
1659 p.drawPrimitive(QStyle::PE_FrameTabWidget, opt);
1664 bool TabWorkArea::posIsTab(QPoint position)
1666 // tabAt returns -1 if tab does not covers position
1667 return tabBar()->tabAt(position) > -1;
1671 void TabWorkArea::mouseDoubleClickEvent(QMouseEvent * event)
1673 if (event->button() != Qt::LeftButton)
1676 // this code chunk is unnecessary because it seems the event only makes
1677 // it this far if it is not on a tab. I'm not sure why this is (maybe
1678 // it is handled and ended in DragTabBar?), and thus I'm not sure if
1679 // this is true in all cases and if it will be true in the future so I
1680 // leave this code for now. (skostysh, 2016-07-21)
1682 // return early if double click on existing tabs
1683 if (posIsTab(event->pos()))
1686 dispatch(FuncRequest(LFUN_BUFFER_NEW));
1690 void TabWorkArea::setFullScreen(bool full_screen)
1692 for (int i = 0; i != count(); ++i) {
1693 if (GuiWorkArea * wa = workArea(i))
1694 wa->setFullScreen(full_screen);
1697 if (lyxrc.full_screen_tabbar)
1698 showBar(!full_screen && count() > 1);
1700 showBar(count() > 1);
1704 void TabWorkArea::showBar(bool show)
1706 tabBar()->setEnabled(show);
1707 tabBar()->setVisible(show);
1708 closeBufferButton->setVisible(show && lyxrc.single_close_tab_button);
1709 setTabsClosable(!lyxrc.single_close_tab_button);
1713 GuiWorkAreaContainer * TabWorkArea::widget(int index) const
1715 QWidget * w = QTabWidget::widget(index);
1718 GuiWorkAreaContainer * wac = dynamic_cast<GuiWorkAreaContainer *>(w);
1724 GuiWorkAreaContainer * TabWorkArea::currentWidget() const
1726 return widget(currentIndex());
1730 GuiWorkArea * TabWorkArea::workArea(int index) const
1732 GuiWorkAreaContainer * w = widget(index);
1735 return w->workArea();
1739 GuiWorkArea * TabWorkArea::currentWorkArea() const
1741 return workArea(currentIndex());
1745 GuiWorkArea * TabWorkArea::workArea(Buffer & buffer) const
1747 // FIXME: this method doesn't work if we have more than one work area
1748 // showing the same buffer.
1749 for (int i = 0; i != count(); ++i) {
1750 GuiWorkArea * wa = workArea(i);
1751 LASSERT(wa, return 0);
1752 if (&wa->bufferView().buffer() == &buffer)
1759 void TabWorkArea::closeAll()
1762 QWidget * wac = widget(0);
1763 LASSERT(wac, return);
1770 int TabWorkArea::indexOfWorkArea(GuiWorkArea * w) const
1772 for (int index = 0; index < count(); ++index)
1773 if (workArea(index) == w)
1779 bool TabWorkArea::setCurrentWorkArea(GuiWorkArea * work_area)
1781 LASSERT(work_area, return false);
1782 int index = indexOfWorkArea(work_area);
1786 if (index == currentIndex())
1787 // Make sure the work area is up to date.
1788 on_currentTabChanged(index);
1790 // Switch to the work area.
1791 setCurrentIndex(index);
1792 work_area->setFocus();
1798 GuiWorkArea * TabWorkArea::addWorkArea(Buffer & buffer, GuiView & view)
1800 GuiWorkArea * wa = new GuiWorkArea(buffer, view);
1801 GuiWorkAreaContainer * wac = new GuiWorkAreaContainer(wa);
1802 wa->setUpdatesEnabled(false);
1803 // Hide tabbar if there's no tab (avoid a resize and a flashing tabbar
1804 // when hiding it again below).
1805 if (!(currentWorkArea() && currentWorkArea()->isFullScreen()))
1806 showBar(count() > 0);
1807 addTab(wac, wa->windowTitle());
1808 QObject::connect(wa, SIGNAL(titleChanged(GuiWorkArea *)),
1809 this, SLOT(updateTabTexts()));
1810 if (currentWorkArea() && currentWorkArea()->isFullScreen())
1811 setFullScreen(true);
1813 // Hide tabbar if there's only one tab.
1814 showBar(count() > 1);
1822 bool TabWorkArea::removeWorkArea(GuiWorkArea * work_area)
1824 LASSERT(work_area, return false);
1825 int index = indexOfWorkArea(work_area);
1829 work_area->setUpdatesEnabled(false);
1830 QWidget * wac = widget(index);
1835 // make sure the next work area is enabled.
1836 currentWidget()->setUpdatesEnabled(true);
1837 if (currentWorkArea() && currentWorkArea()->isFullScreen())
1838 setFullScreen(true);
1840 // Show tabbar only if there's more than one tab.
1841 showBar(count() > 1);
1843 lastWorkAreaRemoved();
1851 void TabWorkArea::on_currentTabChanged(int i)
1853 // returns e.g. on application destruction
1856 GuiWorkArea * wa = workArea(i);
1857 LASSERT(wa, return);
1858 wa->setUpdatesEnabled(true);
1862 currentWorkAreaChanged(wa);
1864 LYXERR(Debug::GUI, "currentTabChanged " << i
1865 << " File: " << wa->bufferView().buffer().absFileName());
1869 void TabWorkArea::closeCurrentBuffer()
1872 if (clicked_tab_ == -1)
1873 wa = currentWorkArea();
1875 wa = workArea(clicked_tab_);
1876 LASSERT(wa, return);
1878 wa->view().closeWorkArea(wa);
1882 void TabWorkArea::hideCurrentTab()
1885 if (clicked_tab_ == -1)
1886 wa = currentWorkArea();
1888 wa = workArea(clicked_tab_);
1889 LASSERT(wa, return);
1891 wa->view().hideWorkArea(wa);
1895 void TabWorkArea::closeTab(int index)
1897 on_currentTabChanged(index);
1900 wa = currentWorkArea();
1902 wa = workArea(index);
1903 LASSERT(wa, return);
1905 wa->view().closeWorkArea(wa);
1912 /// make vector happy
1913 DisplayPath() : tab_(-1), dottedPrefix_(false) {}
1915 DisplayPath(int tab, FileName const & filename)
1918 filename_ = (filename.extension() == "lyx") ?
1919 toqstr(filename.onlyFileNameWithoutExt())
1920 : toqstr(filename.onlyFileName());
1921 postfix_ = toqstr(filename.absoluteFilePath()).
1922 split("/", QString::SkipEmptyParts);
1923 postfix_.pop_back();
1924 abs_ = toqstr(filename.absoluteFilePath());
1925 dottedPrefix_ = false;
1928 /// Absolute path for debugging.
1933 /// Add the first segment from the postfix or three dots to the prefix.
1934 /// Merge multiple dot tripples. In fact dots are added lazily, i.e. only
1935 /// when really needed.
1936 void shiftPathSegment(bool dotted)
1938 if (postfix_.count() <= 0)
1942 if (dottedPrefix_ && !prefix_.isEmpty())
1943 prefix_ += ellipsisSlash_;
1944 prefix_ += postfix_.front() + "/";
1946 dottedPrefix_ = dotted && !prefix_.isEmpty();
1947 postfix_.pop_front();
1950 QString displayString() const
1952 if (prefix_.isEmpty())
1955 bool dots = dottedPrefix_ || !postfix_.isEmpty();
1956 return prefix_ + (dots ? ellipsisSlash_ : "") + filename_;
1959 QString forecastPathString() const
1961 if (postfix_.count() == 0)
1962 return displayString();
1965 + (dottedPrefix_ ? ellipsisSlash_ : "")
1966 + postfix_.front() + "/";
1969 bool final() const { return postfix_.empty(); }
1971 int tab() const { return tab_; }
1975 static QString const ellipsisSlash_;
1979 QStringList postfix_;
1991 QString const DisplayPath::ellipsisSlash_ = QString(QChar(0x2026)) + "/";
1995 bool operator<(DisplayPath const & a, DisplayPath const & b)
1997 return a.displayString() < b.displayString();
2001 bool operator==(DisplayPath const & a, DisplayPath const & b)
2003 return a.displayString() == b.displayString();
2007 void TabWorkArea::updateTabTexts()
2012 std::list<DisplayPath> paths;
2013 typedef std::list<DisplayPath>::iterator It;
2015 // collect full names first: path into postfix, empty prefix and
2016 // filename without extension
2017 for (size_t i = 0; i < n; ++i) {
2018 GuiWorkArea * i_wa = workArea(i);
2019 FileName const fn = i_wa->bufferView().buffer().fileName();
2020 paths.push_back(DisplayPath(i, fn));
2023 // go through path segments and see if it helps to make the path more unique
2024 bool somethingChanged = true;
2025 bool allFinal = false;
2026 while (somethingChanged && !allFinal) {
2027 // adding path segments changes order
2030 LYXERR(Debug::GUI, "updateTabTexts() iteration start");
2031 somethingChanged = false;
2034 // find segments which are not unique (i.e. non-atomic)
2035 It it = paths.begin();
2037 QString segString = it->displayString();
2038 for (; it != paths.end(); ++it) {
2039 // look to the next item
2044 allFinal = allFinal && it->final();
2046 LYXERR(Debug::GUI, "it = " << it->abs()
2047 << " => " << it->displayString());
2049 // still the same segment?
2051 if ((next != paths.end()
2052 && (nextString = next->displayString()) == segString))
2054 LYXERR(Debug::GUI, "segment ended");
2056 // only a trivial one with one element?
2057 if (it == segStart) {
2058 // start new segment
2060 segString = nextString;
2064 // We found a non-atomic segment
2065 // We know that segStart <= it < next <= paths.end().
2066 // The assertion below tells coverity about it.
2067 LATTEST(segStart != paths.end());
2068 QString dspString = segStart->forecastPathString();
2069 LYXERR(Debug::GUI, "first forecast found for "
2070 << segStart->abs() << " => " << dspString);
2073 // Shift path segments and hope for the best
2074 // that it makes the path more unique.
2075 somethingChanged = true;
2076 bool moreUnique = false;
2077 for (; sit != next; ++sit) {
2078 if (sit->forecastPathString() != dspString) {
2079 LYXERR(Debug::GUI, "different forecast found for "
2080 << sit->abs() << " => " << sit->forecastPathString());
2084 LYXERR(Debug::GUI, "same forecast found for "
2085 << sit->abs() << " => " << dspString);
2088 // if the path segment helped, add it. Otherwise add dots
2089 bool dots = !moreUnique;
2090 LYXERR(Debug::GUI, "using dots = " << dots);
2091 for (sit = segStart; sit != next; ++sit) {
2092 sit->shiftPathSegment(dots);
2093 LYXERR(Debug::GUI, "shifting "
2094 << sit->abs() << " => " << sit->displayString());
2097 // start new segment
2099 segString = nextString;
2103 // set new tab titles
2104 for (It it = paths.begin(); it != paths.end(); ++it) {
2105 int const tab_index = it->tab();
2106 Buffer const & buf = workArea(tab_index)->bufferView().buffer();
2107 QString tab_text = it->displayString().replace("&", "&&");
2108 if (!buf.fileName().empty() && !buf.isClean())
2110 QString tab_tooltip = it->abs();
2111 if (buf.hasReadonlyFlag()) {
2112 setTabIcon(tab_index, QIcon(getPixmap("images/", "emblem-readonly", "svgz,png")));
2113 tab_tooltip = qt_("%1 (read only)").arg(tab_tooltip);
2115 setTabIcon(tab_index, QIcon());
2116 if (buf.notifiesExternalModification()) {
2117 QString const warn = qt_("%1 (modified externally)");
2118 tab_tooltip = warn.arg(tab_tooltip);
2119 tab_text += QChar(0x26a0);
2121 setTabText(tab_index, tab_text);
2122 setTabToolTip(tab_index, tab_tooltip);
2127 void TabWorkArea::showContextMenu(const QPoint & pos)
2130 clicked_tab_ = static_cast<DragTabBar *>(tabBar())->tabAt(pos);
2131 if (clicked_tab_ == -1)
2136 popup.addAction(QIcon(getPixmap("images/", "hidetab", "svgz,png")),
2137 qt_("Hide tab"), this, SLOT(hideCurrentTab()));
2138 popup.addAction(QIcon(getPixmap("images/", "closetab", "svgz,png")),
2139 qt_("Close tab"), this, SLOT(closeCurrentBuffer()));
2140 popup.exec(tabBar()->mapToGlobal(pos));
2146 void TabWorkArea::moveTab(int fromIndex, int toIndex)
2148 QWidget * w = widget(fromIndex);
2149 QIcon icon = tabIcon(fromIndex);
2150 QString text = tabText(fromIndex);
2152 setCurrentIndex(fromIndex);
2153 removeTab(fromIndex);
2154 insertTab(toIndex, w, icon, text);
2155 setCurrentIndex(toIndex);
2159 DragTabBar::DragTabBar(QWidget* parent)
2162 setAcceptDrops(true);
2163 setTabsClosable(!lyxrc.single_close_tab_button);
2167 void DragTabBar::mousePressEvent(QMouseEvent * event)
2169 if (event->button() == Qt::LeftButton)
2170 dragStartPos_ = event->pos();
2171 QTabBar::mousePressEvent(event);
2175 void DragTabBar::mouseMoveEvent(QMouseEvent * event)
2177 // If the left button isn't pressed anymore then return
2178 if (!(event->buttons() & Qt::LeftButton))
2181 // If the distance is too small then return
2182 if ((event->pos() - dragStartPos_).manhattanLength()
2183 < QApplication::startDragDistance())
2186 // did we hit something after all?
2187 int tab = tabAt(dragStartPos_);
2191 // simulate button release to remove highlight from button
2192 int i = currentIndex();
2193 QMouseEvent me(QEvent::MouseButtonRelease, dragStartPos_,
2194 event->button(), event->buttons(), 0);
2195 QTabBar::mouseReleaseEvent(&me);
2199 QDrag * drag = new QDrag(this);
2200 QMimeData * mimeData = new QMimeData;
2201 // a crude way to distinguish tab-reodering drops from other ones
2202 mimeData->setData("action", "tab-reordering") ;
2203 drag->setMimeData(mimeData);
2205 // get tab pixmap as cursor
2206 QRect r = tabRect(tab);
2207 QPixmap pixmap(r.size());
2208 render(&pixmap, - r.topLeft());
2209 drag->setPixmap(pixmap);
2214 void DragTabBar::dragEnterEvent(QDragEnterEvent * event)
2216 // Only accept if it's an tab-reordering request
2217 QMimeData const * m = event->mimeData();
2218 QStringList formats = m->formats();
2219 if (formats.contains("action")
2220 && m->data("action") == "tab-reordering")
2221 event->acceptProposedAction();
2225 void DragTabBar::dropEvent(QDropEvent * event)
2227 int fromIndex = tabAt(dragStartPos_);
2228 int toIndex = tabAt(event->pos());
2230 // Tell interested objects that
2231 if (fromIndex != toIndex)
2232 tabMoveRequested(fromIndex, toIndex);
2233 event->acceptProposedAction();
2237 GuiWorkAreaContainer::GuiWorkAreaContainer(GuiWorkArea * wa, QWidget * parent)
2238 : QWidget(parent), wa_(wa)
2240 LASSERT(wa, return);
2241 Ui::WorkAreaUi::setupUi(this);
2242 layout()->addWidget(wa);
2243 connect(wa, SIGNAL(titleChanged(GuiWorkArea *)),
2244 this, SLOT(updateDisplay()));
2245 connect(reloadPB, SIGNAL(clicked()), this, SLOT(reload()));
2246 connect(ignorePB, SIGNAL(clicked()), this, SLOT(ignore()));
2247 setMessageColour({notificationFrame}, {reloadPB, ignorePB});
2252 void GuiWorkAreaContainer::updateDisplay()
2254 Buffer const & buf = wa_->bufferView().buffer();
2255 notificationFrame->setHidden(!buf.notifiesExternalModification());
2256 QString const label = qt_("<b>The file %1 changed on disk.</b>")
2257 .arg(toqstr(buf.fileName().displayName()));
2258 externalModificationLabel->setText(label);
2262 void GuiWorkAreaContainer::dispatch(FuncRequest f) const
2264 lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
2265 wa_->bufferView().buffer().absFileName()));
2270 void GuiWorkAreaContainer::reload() const
2272 dispatch(FuncRequest(LFUN_BUFFER_RELOAD));
2276 void GuiWorkAreaContainer::ignore() const
2278 dispatch(FuncRequest(LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR));
2282 void GuiWorkAreaContainer::mouseDoubleClickEvent(QMouseEvent * event)
2284 // prevent TabWorkArea from opening a new buffer on double click
2289 } // namespace frontend
2292 #include "moc_GuiWorkArea.cpp"