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"
27 #include "BufferList.h"
28 #include "BufferParams.h"
29 #include "BufferView.h"
30 #include "CoordCache.h"
33 #include "FuncRequest.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), 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))
262 new CompressorProxy(this); // not a leak
266 GuiWorkArea::GuiWorkArea(Buffer & buffer, GuiView & gv)
267 : d(new Private(this))
269 new CompressorProxy(this); // not a leak
271 buffer.params().display_pixel_ratio = theGuiApp()->pixelRatio();
277 double GuiWorkArea::pixelRatio() const
279 #if QT_VERSION >= 0x050000
280 return qt_scale_factor * devicePixelRatio();
287 void GuiWorkArea::init()
290 connect(&d->cursor_timeout_, SIGNAL(timeout()),
291 this, SLOT(toggleCursor()));
293 int const time = QApplication::cursorFlashTime() / 2;
295 d->cursor_timeout_.setInterval(time);
296 d->cursor_timeout_.start();
298 // let's initialize this just to be safe
299 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);
319 viewport()->setAttribute(Qt::WA_OpaquePaintEvent);
321 setFocusPolicy(Qt::StrongFocus);
323 d->setCursorShape(Qt::IBeamCursor);
325 // This connection is closed at the same time as this is destroyed.
326 d->synthetic_mouse_event_.timeout.timeout.connect([this](){
327 generateSyntheticMouseEvent();
330 LYXERR(Debug::GUI, "viewport width: " << viewport()->width()
331 << " viewport height: " << viewport()->height());
333 // Enables input methods for asian languages.
334 // Must be set when creating custom text editing widgets.
335 setAttribute(Qt::WA_InputMethodEnabled, true);
337 d->dialog_mode_ = false;
341 GuiWorkArea::~GuiWorkArea()
343 // If something is wrong with the buffer, we can ignore it safely
345 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");
493 viewport()->update();
495 /// \warning: scrollbar updating *must* be done after the BufferView is drawn
496 /// because \c BufferView::updateScrollbar() is called in \c BufferView::draw().
497 d->updateScrollbar();
498 d->lyx_view_->updateStatusBar();
500 if (lyxerr.debugging(Debug::WORKAREA))
501 d->buffer_view_->coordCache().dump();
505 d->updateCursorShape();
509 // Keep in sync with GuiWorkArea::processKeySym below
510 bool GuiWorkArea::queryKeySym(KeySymbol const & key, KeyModifier mod) const
512 return guiApp->queryKeySym(key, mod);
516 // Keep in sync with GuiWorkArea::queryKeySym above
517 void GuiWorkArea::processKeySym(KeySymbol const & key, KeyModifier mod)
519 if (d->lyx_view_->isFullScreen() && d->lyx_view_->menuBar()->isVisible()
520 && lyxrc.full_screen_menubar) {
521 // FIXME HACK: we should not have to do this here. See related comment
522 // in GuiView::event() (QEvent::ShortcutOverride)
523 d->lyx_view_->menuBar()->hide();
526 // In order to avoid bad surprise in the middle of an operation,
527 // we better stop the blinking cursor...
528 // the cursor gets restarted in GuiView::restartCursor()
529 stopBlinkingCursor();
530 guiApp->processKeySym(key, mod);
534 void GuiWorkArea::Private::dispatch(FuncRequest const & cmd)
537 if (cmd.action() == LFUN_FILE_OPEN) {
539 lyx_view_->dispatch(cmd, dr);
543 bool const notJustMovingTheMouse =
544 cmd.action() != LFUN_MOUSE_MOTION || cmd.button() != mouse_button::none;
546 // In order to avoid bad surprise in the middle of an operation, we better stop
547 // the blinking cursor.
548 if (notJustMovingTheMouse)
549 p->stopBlinkingCursor();
551 buffer_view_->mouseEventDispatch(cmd);
553 // Skip these when selecting
554 // FIXME: let GuiView take care of those.
555 if (cmd.action() != LFUN_MOUSE_MOTION) {
556 completer_->updateVisibility(false, false);
557 lyx_view_->updateDialogs();
558 lyx_view_->updateStatusBar();
561 // GUI tweaks except with mouse motion with no button pressed.
562 if (notJustMovingTheMouse) {
563 // Slight hack: this is only called currently when we
564 // clicked somewhere, so we force through the display
565 // of the new status here.
566 // FIXME: let GuiView take care of those.
567 lyx_view_->clearMessage();
569 // Show the cursor immediately after any operation
570 p->startBlinkingCursor();
577 void GuiWorkArea::Private::resizeBufferView()
579 // WARNING: Please don't put any code that will trigger a repaint here!
580 // We are already inside a paint event.
581 p->stopBlinkingCursor();
582 // Warn our container (GuiView).
587 buffer_view_->cursorPosAndHeight(point, h);
588 bool const cursor_in_view = buffer_view_->cursorInView(point, h);
589 buffer_view_->resize(p->viewport()->width(), p->viewport()->height());
591 buffer_view_->scrollToCursor();
592 p->viewport()->update();
594 // Update scrollbars which might have changed due different
595 // BufferView dimension. This is especially important when the
596 // BufferView goes from zero-size to the real-size for the first time,
597 // as the scrollbar paramters are then set for the first time.
600 need_resize_ = false;
602 // Eventually, restart the cursor after the resize event.
603 // We might be resizing even if the focus is on another widget so we only
604 // restart the cursor if we have the focus.
606 QTimer::singleShot(50, p, SLOT(startBlinkingCursor()));
610 void GuiWorkArea::Private::showCursor()
617 buffer_view_->cursorPosAndHeight(p, h);
618 if (!buffer_view_->cursorInView(p, h))
622 bool l_shape = false;
623 Font const & realfont = buffer_view_->cursor().real_current_font;
624 BufferParams const & bp = buffer_view_->buffer().params();
625 bool const samelang = realfont.language() == bp.language;
626 bool const isrtl = realfont.isVisibleRightToLeft();
628 if (!samelang || isrtl != bp.language->rightToLeft())
631 // The ERT language hack needs fixing up
632 if (realfont.language() == latex_language)
635 // show cursor on screen
636 Cursor & cur = buffer_view_->cursor();
637 bool completable = cur.inset().showCompletionCursor()
638 && completer_->completionAvailable()
639 && !completer_->popupVisible()
640 && !completer_->inlineVisible();
641 cursor_visible_ = true;
642 cursor_->recomputeWidth();
644 //int cur_x = buffer_view_->getPos(cur).x_;
645 // We may have decided to slide the cursor row so that cursor
647 p.x_ -= buffer_view_->horizScrollOffset();
649 showCursor(p.x_, p.y_, h, l_shape, isrtl, completable);
653 void GuiWorkArea::Private::hideCursor()
655 if (!cursor_visible_)
658 cursor_visible_ = false;
663 void GuiWorkArea::toggleCursor()
665 if (d->cursor_visible_)
672 void GuiWorkArea::Private::updateScrollbar()
674 // Prevent setRange() and setSliderPosition from causing recursive calls via
675 // the signal valueChanged. (#10311)
676 QObject::disconnect(p->verticalScrollBar(), SIGNAL(valueChanged(int)),
677 p, SLOT(scrollTo(int)));
678 ScrollbarParameters const & scroll_ = buffer_view_->scrollbarParameters();
679 p->verticalScrollBar()->setRange(scroll_.min, scroll_.max);
680 p->verticalScrollBar()->setPageStep(scroll_.page_step);
681 p->verticalScrollBar()->setSingleStep(scroll_.single_step);
682 p->verticalScrollBar()->setSliderPosition(0);
683 // Connect to the vertical scroll bar
684 QObject::connect(p->verticalScrollBar(), SIGNAL(valueChanged(int)),
685 p, SLOT(scrollTo(int)));
689 void GuiWorkArea::scrollTo(int value)
691 stopBlinkingCursor();
692 d->buffer_view_->scrollDocView(value, true);
694 if (lyxrc.cursor_follows_scrollbar) {
695 d->buffer_view_->setCursorFromScrollbar();
696 // FIXME: let GuiView take care of those.
697 d->lyx_view_->updateLayoutList();
699 // Show the cursor immediately after any operation.
700 startBlinkingCursor();
703 QApplication::syncX();
708 bool GuiWorkArea::event(QEvent * e)
711 case QEvent::ToolTip: {
712 QHelpEvent * helpEvent = static_cast<QHelpEvent *>(e);
713 if (lyxrc.use_tooltip) {
714 QPoint pos = helpEvent->pos();
715 if (pos.x() < viewport()->width()) {
716 QString s = toqstr(d->buffer_view_->toolTip(pos.x(), pos.y()));
717 QToolTip::showText(helpEvent->globalPos(), formatToolTip(s,35));
720 QToolTip::hideText();
722 // Don't forget to accept the event!
727 case QEvent::ShortcutOverride:
728 // keyPressEvent is ShortcutOverride-aware and only accepts the event in
730 keyPressEvent(static_cast<QKeyEvent *>(e));
731 return e->isAccepted();
733 case QEvent::KeyPress: {
734 // We catch this event in order to catch the Tab or Shift+Tab key press
735 // which are otherwise reserved to focus switching between controls
737 QKeyEvent * ke = static_cast<QKeyEvent*>(e);
738 if ((ke->key() == Qt::Key_Tab && ke->modifiers() == Qt::NoModifier)
739 || (ke->key() == Qt::Key_Backtab && (
740 ke->modifiers() == Qt::ShiftModifier
741 || ke->modifiers() == Qt::NoModifier))) {
745 return QAbstractScrollArea::event(e);
749 return QAbstractScrollArea::event(e);
755 void GuiWorkArea::contextMenuEvent(QContextMenuEvent * e)
758 if (e->reason() == QContextMenuEvent::Mouse)
759 // the menu name is set on mouse press
760 name = d->context_menu_name_;
762 QPoint pos = e->pos();
763 Cursor const & cur = d->buffer_view_->cursor();
764 if (e->reason() == QContextMenuEvent::Keyboard && cur.inTexted()) {
765 // Do not access the context menu of math right in front of before
766 // the cursor. This does not work when the cursor is in text.
767 Inset * inset = cur.paragraph().getInset(cur.pos());
768 if (inset && inset->asInsetMath())
770 else if (cur.pos() > 0) {
771 Inset * inset = cur.paragraph().getInset(cur.pos() - 1);
776 name = d->buffer_view_->contextMenu(pos.x(), pos.y());
783 // always show mnemonics when the keyboard is used to show the context menu
784 // FIXME: This should be fixed in Qt itself
785 bool const keyboard = (e->reason() == QContextMenuEvent::Keyboard);
786 QMenu * menu = guiApp->menus().menu(toqstr(name), *d->lyx_view_, keyboard);
791 // Position the menu to the right.
792 // FIXME: menu position should be different for RTL text.
793 menu->exec(e->globalPos());
798 void GuiWorkArea::focusInEvent(QFocusEvent * e)
800 LYXERR(Debug::DEBUG, "GuiWorkArea::focusInEvent(): " << this << endl);
801 if (d->lyx_view_->currentWorkArea() != this) {
802 d->lyx_view_->setCurrentWorkArea(this);
803 d->lyx_view_->currentWorkArea()->bufferView().buffer().updateBuffer();
806 startBlinkingCursor();
807 QAbstractScrollArea::focusInEvent(e);
811 void GuiWorkArea::focusOutEvent(QFocusEvent * e)
813 LYXERR(Debug::DEBUG, "GuiWorkArea::focusOutEvent(): " << this << endl);
814 stopBlinkingCursor();
815 QAbstractScrollArea::focusOutEvent(e);
819 void GuiWorkArea::mousePressEvent(QMouseEvent * e)
821 if (d->dc_event_.active && d->dc_event_ == *e) {
822 d->dc_event_.active = false;
823 FuncRequest cmd(LFUN_MOUSE_TRIPLE, e->x(), e->y(),
824 q_button_state(e->button()), q_key_state(e->modifiers()));
830 #if (QT_VERSION < 0x050000) && !defined(__HAIKU__)
831 inputContext()->reset();
834 FuncRequest const cmd(LFUN_MOUSE_PRESS, e->x(), e->y(),
835 q_button_state(e->button()), q_key_state(e->modifiers()));
838 // Save the context menu on mouse press, because also the mouse
839 // cursor is set on mouse press. Afterwards, we can either release
840 // the mousebutton somewhere else, or the cursor might have moved
841 // due to the DEPM. We need to do this after the mouse has been
842 // set in dispatch(), because the selection state might change.
843 if (e->button() == Qt::RightButton)
844 d->context_menu_name_ = d->buffer_view_->contextMenu(e->x(), e->y());
850 void GuiWorkArea::mouseReleaseEvent(QMouseEvent * e)
852 if (d->synthetic_mouse_event_.timeout.running())
853 d->synthetic_mouse_event_.timeout.stop();
855 FuncRequest const cmd(LFUN_MOUSE_RELEASE, e->x(), e->y(),
856 q_button_state(e->button()), q_key_state(e->modifiers()));
862 void GuiWorkArea::mouseMoveEvent(QMouseEvent * e)
864 // we kill the triple click if we move
865 doubleClickTimeout();
866 FuncRequest cmd(LFUN_MOUSE_MOTION, e->x(), e->y(),
867 q_motion_state(e->buttons()), q_key_state(e->modifiers()));
871 // If we're above or below the work area...
872 if ((e->y() <= 20 || e->y() >= viewport()->height() - 20)
873 && e->buttons() == mouse_button::button1) {
874 // Make sure only a synthetic event can cause a page scroll,
875 // so they come at a steady rate:
877 // _Force_ a scroll up:
878 cmd.set_y(e->y() - 21);
880 cmd.set_y(e->y() + 21);
881 // Store the event, to be handled when the timeout expires.
882 d->synthetic_mouse_event_.cmd = cmd;
884 if (d->synthetic_mouse_event_.timeout.running()) {
885 // Discard the event. Note that it _may_ be handled
886 // when the timeout expires if
887 // synthetic_mouse_event_.cmd has not been overwritten.
888 // Ie, when the timeout expires, we handle the
889 // most recent event but discard all others that
890 // occurred after the one used to start the timeout
891 // in the first place.
895 d->synthetic_mouse_event_.restart_timeout = true;
896 d->synthetic_mouse_event_.timeout.start();
897 // Fall through to handle this event...
899 } else if (d->synthetic_mouse_event_.timeout.running()) {
900 // Store the event, to be possibly handled when the timeout
902 // Once the timeout has expired, normal control is returned
903 // to mouseMoveEvent (restart_timeout = false).
904 // This results in a much smoother 'feel' when moving the
905 // mouse back into the work area.
906 d->synthetic_mouse_event_.cmd = cmd;
907 d->synthetic_mouse_event_.restart_timeout = false;
914 void GuiWorkArea::wheelEvent(QWheelEvent * ev)
916 // Wheel rotation by one notch results in a delta() of 120 (see
917 // documentation of QWheelEvent)
918 double const delta = ev->delta() / 120.0;
920 switch (lyxrc.scroll_wheel_zoom) {
921 case LyXRC::SCROLL_WHEEL_ZOOM_CTRL:
922 zoom = ev->modifiers() & Qt::ControlModifier;
923 zoom &= !(ev->modifiers() & (Qt::ShiftModifier | Qt::AltModifier));
925 case LyXRC::SCROLL_WHEEL_ZOOM_SHIFT:
926 zoom = ev->modifiers() & Qt::ShiftModifier;
927 zoom &= !(ev->modifiers() & (Qt::ControlModifier | Qt::AltModifier));
929 case LyXRC::SCROLL_WHEEL_ZOOM_ALT:
930 zoom = ev->modifiers() & Qt::AltModifier;
931 zoom &= !(ev->modifiers() & (Qt::ShiftModifier | Qt::ControlModifier));
933 case LyXRC::SCROLL_WHEEL_ZOOM_OFF:
937 docstring arg = convert<docstring>(int(5 * delta));
938 lyx::dispatch(FuncRequest(LFUN_BUFFER_ZOOM_IN, arg));
942 // Take into account the desktop wide settings.
943 int const lines = qApp->wheelScrollLines();
944 int const page_step = verticalScrollBar()->pageStep();
945 // Test if the wheel mouse is set to one screen at a time.
946 // This is according to
947 // https://doc.qt.io/qt-5/qapplication.html#wheelScrollLines-prop
949 min(lines * verticalScrollBar()->singleStep(), page_step);
951 // Take into account the rotation and the user preferences.
952 scroll_value = int(scroll_value * delta * lyxrc.mouse_wheel_speed);
953 LYXERR(Debug::SCROLLING, "wheelScrollLines = " << lines
954 << " delta = " << delta << " scroll_value = " << scroll_value
955 << " page_step = " << page_step);
957 verticalScrollBar()->setValue(verticalScrollBar()->value() - scroll_value);
963 void GuiWorkArea::generateSyntheticMouseEvent()
965 int const e_y = d->synthetic_mouse_event_.cmd.y();
966 int const wh = d->buffer_view_->workHeight();
967 bool const up = e_y < 0;
968 bool const down = e_y > wh;
970 // Set things off to generate the _next_ 'pseudo' event.
972 if (d->synthetic_mouse_event_.restart_timeout) {
973 // This is some magic formulae to determine the speed
974 // of scrolling related to the position of the mouse.
977 int dist = up ? -e_y : e_y - wh;
978 time = max(min(200, 250000 / (dist * dist)), 1) ;
981 step = 80000 / (time * time);
985 d->synthetic_mouse_event_.timeout.setTimeout(time);
986 d->synthetic_mouse_event_.timeout.start();
989 // Can we scroll further ?
990 int const value = verticalScrollBar()->value();
991 if (value == verticalScrollBar()->maximum()
992 || value == verticalScrollBar()->minimum()) {
993 d->synthetic_mouse_event_.timeout.stop();
998 if (step <= 2 * wh) {
999 d->buffer_view_->scroll(up ? -step : step);
1000 d->buffer_view_->updateMetrics();
1002 d->buffer_view_->scrollDocView(value + (up ? -step : step), false);
1005 // In which paragraph do we have to set the cursor ?
1006 Cursor & cur = d->buffer_view_->cursor();
1007 // FIXME: we don't know how to handle math.
1008 Text * text = cur.text();
1011 TextMetrics const & tm = d->buffer_view_->textMetrics(text);
1013 // Quit gracefully if there are no metrics, since otherwise next
1014 // line would crash (bug #10324).
1015 // This situation seems related to a (not yet understood) timing problem.
1019 pair<pit_type, const ParagraphMetrics *> pp = up ? tm.first() : tm.last();
1020 ParagraphMetrics const & pm = *pp.second;
1021 pit_type const pit = pp.first;
1023 if (pm.rows().empty())
1026 // Find the row at which we set the cursor.
1027 RowList::const_iterator rit = pm.rows().begin();
1028 RowList::const_iterator rlast = pm.rows().end();
1029 int yy = pm.position() - pm.ascent();
1030 for (--rlast; rit != rlast; ++rit) {
1031 int h = rit->height();
1032 if ((up && yy + h > 0)
1033 || (!up && yy + h > wh - defaultRowHeight()))
1038 // Find the position of the cursor
1040 int x = d->synthetic_mouse_event_.cmd.x();
1041 pos_type const pos = tm.getPosNearX(*rit, x, bound);
1046 cur.boundary(bound);
1048 d->buffer_view_->buffer().changed(false);
1053 // CompressorProxy adapted from Kuba Ober https://stackoverflow.com/a/21006207
1054 CompressorProxy::CompressorProxy(GuiWorkArea * wa) : QObject(wa), flag_(false)
1056 qRegisterMetaType<KeySymbol>("KeySymbol");
1057 qRegisterMetaType<KeyModifier>("KeyModifier");
1058 connect(wa, SIGNAL(compressKeySym(KeySymbol, KeyModifier, bool)),
1059 this, SLOT(slot(KeySymbol, KeyModifier, bool)),
1060 Qt::QueuedConnection);
1061 connect(this, SIGNAL(signal(KeySymbol, KeyModifier)),
1062 wa, SLOT(processKeySym(KeySymbol, KeyModifier)));
1066 bool CompressorProxy::emitCheck(bool isAutoRepeat)
1070 QCoreApplication::sendPostedEvents(this, QEvent::MetaCall); // recurse
1071 bool result = flag_;
1077 void CompressorProxy::slot(KeySymbol sym, KeyModifier mod, bool isAutoRepeat)
1079 if (emitCheck(isAutoRepeat))
1080 Q_EMIT signal(sym, mod);
1082 LYXERR(Debug::KEY, "system is busy: autoRepeat key event ignored");
1086 void GuiWorkArea::keyPressEvent(QKeyEvent * ev)
1088 // this is also called for ShortcutOverride events. In this case, one must
1089 // not act but simply accept the event explicitly.
1090 bool const act = (ev->type() != QEvent::ShortcutOverride);
1092 // Do not process here some keys if dialog_mode_ is set
1093 bool const for_dialog_mode = d->dialog_mode_
1094 && (ev->modifiers() == Qt::NoModifier
1095 || ev->modifiers() == Qt::ShiftModifier)
1096 && (ev->key() == Qt::Key_Escape
1097 || ev->key() == Qt::Key_Enter
1098 || ev->key() == Qt::Key_Return);
1099 // also do not use autoRepeat to input shortcuts
1100 bool const autoRepeat = ev->isAutoRepeat();
1102 if (for_dialog_mode || (!act && autoRepeat)) {
1107 // intercept some keys if completion popup is visible
1108 if (d->completer_->popupVisible()) {
1109 switch (ev->key()) {
1111 case Qt::Key_Return:
1113 d->completer_->activate();
1119 KeyModifier const m = q_key_state(ev->modifiers());
1121 if (act && lyxerr.debugging(Debug::KEY)) {
1123 if (m & ShiftModifier)
1125 if (m & ControlModifier)
1127 if (m & AltModifier)
1129 if (m & MetaModifier)
1131 LYXERR(Debug::KEY, " count: " << ev->count() << " text: " << ev->text()
1132 << " isAutoRepeat: " << ev->isAutoRepeat() << " key: " << ev->key()
1133 << " keyState: " << str);
1137 setKeySymbol(&sym, ev);
1140 Q_EMIT compressKeySym(sym, m, autoRepeat);
1143 // here, !autoRepeat, as determined at the beginning
1144 ev->setAccepted(queryKeySym(sym, m));
1151 void GuiWorkArea::doubleClickTimeout()
1153 d->dc_event_.active = false;
1157 void GuiWorkArea::mouseDoubleClickEvent(QMouseEvent * ev)
1159 d->dc_event_ = DoubleClick(ev);
1160 QTimer::singleShot(QApplication::doubleClickInterval(), this,
1161 SLOT(doubleClickTimeout()));
1162 FuncRequest cmd(LFUN_MOUSE_DOUBLE, ev->x(), ev->y(),
1163 q_button_state(ev->button()), q_key_state(ev->modifiers()));
1169 void GuiWorkArea::resizeEvent(QResizeEvent * ev)
1171 QAbstractScrollArea::resizeEvent(ev);
1172 d->need_resize_ = true;
1177 void GuiWorkArea::paintEvent(QPaintEvent * ev)
1179 // LYXERR(Debug::PAINTING, "paintEvent begin: x: " << rc.x()
1180 // << " y: " << rc.y() << " w: " << rc.width() << " h: " << rc.height());
1182 if (d->needResize()) {
1183 d->resizeBufferView();
1184 if (d->cursor_visible_) {
1190 GuiPainter pain(viewport(), pixelRatio());
1191 d->buffer_view_->draw(pain);
1193 d->cursor_->draw(pain);
1198 void GuiWorkArea::Private::showCursor(int x, int y, int h,
1199 bool l_shape, bool rtl, bool completable)
1201 if (schedule_redraw_) {
1202 // This happens when a graphic conversion is finished. As we don't know
1203 // the size of the new graphics, it's better the update everything.
1204 // We can't use redraw() here because this would trigger a infinite
1205 // recursive loop with showCursor().
1206 buffer_view_->resize(p->viewport()->width(), p->viewport()->height());
1207 p->viewport()->update();
1209 schedule_redraw_ = false;
1210 // Show the cursor immediately after the update.
1216 cursor_->update(x, y, h, l_shape, rtl, completable);
1218 p->viewport()->update(cursor_->rect());
1222 void GuiWorkArea::Private::removeCursor()
1225 //if (!qApp->focusWidget())
1226 p->viewport()->update(cursor_->rect());
1230 void GuiWorkArea::inputMethodEvent(QInputMethodEvent * e)
1232 //FIXME Broken Feature !!
1233 // I do not think that we are supposed to paint inside this event. Shall we
1234 // just let TextMetrics::breakRow add this to the relevant Row object?
1236 QString const & commit_string = e->commitString();
1237 docstring const & preedit_string
1238 = qstring_to_ucs4(e->preeditString());
1240 if (!commit_string.isEmpty()) {
1242 LYXERR(Debug::KEY, "preeditString: " << e->preeditString()
1243 << " commitString: " << e->commitString());
1247 // FIXME Iwami 04/01/07: we should take care also of UTF16 surrogates here.
1248 for (int i = 0; i != commit_string.size(); ++i) {
1249 QKeyEvent ev(QEvent::KeyPress, key, Qt::NoModifier, commit_string[i]);
1254 // Hide the cursor during the kana-kanji transformation.
1255 if (preedit_string.empty())
1256 startBlinkingCursor();
1258 stopBlinkingCursor();
1260 // last_width : for checking if last preedit string was/wasn't empty.
1261 // FIXME THREAD && FIXME
1262 // We could have more than one work area, right?
1263 static bool last_width = false;
1264 if (!last_width && preedit_string.empty()) {
1265 // if last_width is last length of preedit string.
1270 d->buffer_view_->updateMetrics();
1271 viewport()->update();
1272 // FIXME: shall we use real_current_font here? (see #10478)
1273 FontInfo font = d->buffer_view_->cursor().getFont().fontInfo();
1274 FontMetrics const & fm = theFontMetrics(font);
1275 int height = fm.maxHeight();
1276 int cur_x = d->cursor_->rect().left();
1277 int cur_y = d->cursor_->rect().bottom();
1279 // redraw area of preedit string.
1280 viewport()->update(0, cur_y - height, viewport()->width(),
1281 (height + 1) * d->preedit_lines_);
1283 if (preedit_string.empty()) {
1285 d->preedit_lines_ = 1;
1291 // att : stores an IM attribute.
1292 QList<QInputMethodEvent::Attribute> const & att = e->attributes();
1294 // get attributes of input method cursor.
1295 // cursor_pos : cursor position in preedit string.
1296 size_t cursor_pos = 0;
1297 bool cursor_is_visible = false;
1298 for (int i = 0; i != att.size(); ++i) {
1299 if (att.at(i).type == QInputMethodEvent::Cursor) {
1300 cursor_pos = att.at(i).start;
1301 cursor_is_visible = att.at(i).length != 0;
1306 size_t preedit_length = preedit_string.length();
1308 // get position of selection in input method.
1309 // FIXME: isn't there a way to do this simplier?
1310 // rStart : cursor position in selected string in IM.
1312 // rLength : selected string length in IM.
1314 if (cursor_pos < preedit_length) {
1315 for (int i = 0; i != att.size(); ++i) {
1316 if (att.at(i).type == QInputMethodEvent::TextFormat) {
1317 if (att.at(i).start <= int(cursor_pos)
1318 && int(cursor_pos) < att.at(i).start + att.at(i).length) {
1319 rStart = att.at(i).start;
1320 rLength = att.at(i).length;
1321 if (!cursor_is_visible)
1322 cursor_pos += rLength;
1329 rStart = cursor_pos;
1333 int const right_margin = d->buffer_view_->rightMargin();
1334 Painter::preedit_style ps;
1335 // Most often there would be only one line:
1336 d->preedit_lines_ = 1;
1337 for (size_t pos = 0; pos != preedit_length; ++pos) {
1338 char_type const typed_char = preedit_string[pos];
1339 // reset preedit string style
1340 ps = Painter::preedit_default;
1342 // if we reached the right extremity of the screen, go to next line.
1343 if (cur_x + fm.width(typed_char) > viewport()->width() - right_margin) {
1344 cur_x = right_margin;
1345 cur_y += height + 1;
1346 ++d->preedit_lines_;
1348 // preedit strings are displayed with dashed underline
1349 // and partial strings are displayed white on black indicating
1350 // that we are in selecting mode in the input method.
1351 // FIXME: rLength == preedit_length is not a changing condition
1352 // FIXME: should be put out of the loop.
1354 && pos < rStart + rLength
1355 && !(cursor_pos < rLength && rLength == preedit_length))
1356 ps = Painter::preedit_selecting;
1358 if (pos == cursor_pos
1359 && (cursor_pos < rLength && rLength == preedit_length))
1360 ps = Painter::preedit_cursor;
1362 // draw one character and update cur_x.
1363 GuiPainter pain(d->screen_, pixelRatio());
1364 cur_x += pain.preeditText(cur_x, cur_y, typed_char, font, ps);
1367 // update the preedit string screen area.
1368 viewport()->update(0, cur_y - d->preedit_lines_*height, viewport()->width(),
1369 (height + 1) * d->preedit_lines_);
1372 // Don't forget to accept the event!
1377 QVariant GuiWorkArea::inputMethodQuery(Qt::InputMethodQuery query) const
1379 QRect cur_r(0, 0, 0, 0);
1381 // this is the CJK-specific composition window position and
1382 // the context menu position when the menu key is pressed.
1383 case Qt::ImMicroFocus:
1384 cur_r = d->cursor_->rect();
1385 if (d->preedit_lines_ != 1)
1387 cur_r.moveBottom(cur_r.bottom()
1388 + cur_r.height() * (d->preedit_lines_ - 1));
1389 // return lower right of cursor in LyX.
1392 return QWidget::inputMethodQuery(query);
1397 void GuiWorkArea::updateWindowTitle()
1399 Buffer const & buf = bufferView().buffer();
1400 if (buf.fileName() != d->file_name_
1401 || buf.params().shell_escape != d->shell_escape_
1402 || buf.hasReadonlyFlag() != d->read_only_
1403 || buf.lyxvc().vcstatus() != d->vc_status_
1404 || buf.isClean() != d->clean_
1405 || buf.notifiesExternalModification() != d->externally_modified_) {
1406 d->file_name_ = buf.fileName();
1407 d->shell_escape_ = buf.params().shell_escape;
1408 d->read_only_ = buf.hasReadonlyFlag();
1409 d->vc_status_ = buf.lyxvc().vcstatus();
1410 d->clean_ = buf.isClean();
1411 d->externally_modified_ = buf.notifiesExternalModification();
1412 Q_EMIT titleChanged(this);
1417 bool GuiWorkArea::isFullScreen() const
1419 return d->lyx_view_ && d->lyx_view_->isFullScreen();
1423 void GuiWorkArea::scheduleRedraw()
1425 d->schedule_redraw_ = true;
1429 bool GuiWorkArea::inDialogMode() const
1431 return d->dialog_mode_;
1435 void GuiWorkArea::setDialogMode(bool mode)
1437 d->dialog_mode_ = mode;
1441 GuiCompleter & GuiWorkArea::completer()
1443 return *d->completer_;
1446 GuiView const & GuiWorkArea::view() const
1448 return *d->lyx_view_;
1452 GuiView & GuiWorkArea::view()
1454 return *d->lyx_view_;
1457 ////////////////////////////////////////////////////////////////////
1461 ////////////////////////////////////////////////////////////////////
1464 EmbeddedWorkArea::EmbeddedWorkArea(QWidget * w): GuiWorkArea(w)
1466 support::TempFile tempfile("embedded.internal");
1467 tempfile.setAutoRemove(false);
1468 buffer_ = theBufferList().newInternalBuffer(tempfile.name().absFileName());
1469 buffer_->setUnnamed(true);
1470 buffer_->setFullyLoaded(true);
1471 setBuffer(*buffer_);
1472 setDialogMode(true);
1476 EmbeddedWorkArea::~EmbeddedWorkArea()
1478 // No need to destroy buffer and bufferview here, because it is done
1479 // in theBufferList() destruction loop at application exit
1483 void EmbeddedWorkArea::closeEvent(QCloseEvent * ev)
1486 GuiWorkArea::closeEvent(ev);
1490 void EmbeddedWorkArea::hideEvent(QHideEvent * ev)
1493 GuiWorkArea::hideEvent(ev);
1497 QSize EmbeddedWorkArea::sizeHint () const
1500 // GuiWorkArea sets the size to the screen's viewport
1501 // by returning a value this gets overridden
1502 // EmbeddedWorkArea is now sized to fit in the layout
1503 // of the parent, and has a minimum size set in GuiWorkArea
1504 // which is what we return here
1505 return QSize(100, 70);
1509 void EmbeddedWorkArea::disable()
1511 stopBlinkingCursor();
1512 if (view().currentWorkArea() != this)
1514 // No problem if currentMainWorkArea() is 0 (setCurrentWorkArea()
1515 // tolerates it and shows the background logo), what happens if
1516 // an EmbeddedWorkArea is closed after closing all document WAs
1517 view().setCurrentWorkArea(view().currentMainWorkArea());
1520 ////////////////////////////////////////////////////////////////////
1524 ////////////////////////////////////////////////////////////////////
1527 class NoTabFrameMacStyle : public QProxyStyle {
1530 QRect subElementRect(SubElement element, const QStyleOption * option,
1531 const QWidget * widget = 0) const
1533 QRect rect = QProxyStyle::subElementRect(element, option, widget);
1534 bool noBar = static_cast<QTabWidget const *>(widget)->count() <= 1;
1536 // The Qt Mac style puts the contents into a 3 pixel wide box
1537 // which looks very ugly and not like other Mac applications.
1538 // Hence we remove this here, and moreover the 16 pixel round
1539 // frame above if the tab bar is hidden.
1540 if (element == QStyle::SE_TabWidgetTabContents) {
1541 rect.adjust(- rect.left(), 0, rect.left(), 0);
1550 NoTabFrameMacStyle noTabFrameMacStyle;
1554 TabWorkArea::TabWorkArea(QWidget * parent)
1555 : QTabWidget(parent), clicked_tab_(-1), midpressed_tab_(-1)
1558 setStyle(&noTabFrameMacStyle);
1561 QPalette pal = palette();
1562 pal.setColor(QPalette::Active, QPalette::Button,
1563 pal.color(QPalette::Active, QPalette::Window));
1564 pal.setColor(QPalette::Disabled, QPalette::Button,
1565 pal.color(QPalette::Disabled, QPalette::Window));
1566 pal.setColor(QPalette::Inactive, QPalette::Button,
1567 pal.color(QPalette::Inactive, QPalette::Window));
1569 QObject::connect(this, SIGNAL(currentChanged(int)),
1570 this, SLOT(on_currentTabChanged(int)));
1572 closeBufferButton = new QToolButton(this);
1573 closeBufferButton->setPalette(pal);
1574 // FIXME: rename the icon to closebuffer.png
1575 closeBufferButton->setIcon(QIcon(getPixmap("images/", "closetab", "svgz,png")));
1576 closeBufferButton->setText("Close File");
1577 closeBufferButton->setAutoRaise(true);
1578 closeBufferButton->setCursor(Qt::ArrowCursor);
1579 closeBufferButton->setToolTip(qt_("Close File"));
1580 closeBufferButton->setEnabled(true);
1581 QObject::connect(closeBufferButton, SIGNAL(clicked()),
1582 this, SLOT(closeCurrentBuffer()));
1583 setCornerWidget(closeBufferButton, Qt::TopRightCorner);
1585 // setup drag'n'drop
1586 QTabBar* tb = new DragTabBar;
1587 connect(tb, SIGNAL(tabMoveRequested(int, int)),
1588 this, SLOT(moveTab(int, int)));
1589 tb->setElideMode(Qt::ElideNone);
1592 // make us responsible for the context menu of the tabbar
1593 tb->setContextMenuPolicy(Qt::CustomContextMenu);
1594 connect(tb, SIGNAL(customContextMenuRequested(const QPoint &)),
1595 this, SLOT(showContextMenu(const QPoint &)));
1596 connect(tb, SIGNAL(tabCloseRequested(int)),
1597 this, SLOT(closeTab(int)));
1599 setUsesScrollButtons(true);
1603 void TabWorkArea::mousePressEvent(QMouseEvent *me)
1605 if (me->button() == Qt::MidButton)
1606 midpressed_tab_ = tabBar()->tabAt(me->pos());
1608 QTabWidget::mousePressEvent(me);
1612 void TabWorkArea::mouseReleaseEvent(QMouseEvent *me)
1614 if (me->button() == Qt::MidButton) {
1615 int const midreleased_tab = tabBar()->tabAt(me->pos());
1616 if (midpressed_tab_ == midreleased_tab && posIsTab(me->pos()))
1617 closeTab(midreleased_tab);
1619 QTabWidget::mouseReleaseEvent(me);
1623 void TabWorkArea::paintEvent(QPaintEvent * event)
1625 if (tabBar()->isVisible()) {
1626 QTabWidget::paintEvent(event);
1628 // Prevent the selected tab to influence the
1629 // painting of the frame of the tab widget.
1630 // This is needed for gtk style in Qt.
1631 QStylePainter p(this);
1632 #if QT_VERSION < 0x050000
1633 QStyleOptionTabWidgetFrameV2 opt;
1635 QStyleOptionTabWidgetFrame opt;
1637 initStyleOption(&opt);
1638 opt.rect = style()->subElementRect(QStyle::SE_TabWidgetTabPane,
1640 opt.selectedTabRect = QRect();
1641 p.drawPrimitive(QStyle::PE_FrameTabWidget, opt);
1646 bool TabWorkArea::posIsTab(QPoint position)
1648 // tabAt returns -1 if tab does not covers position
1649 return tabBar()->tabAt(position) > -1;
1653 void TabWorkArea::mouseDoubleClickEvent(QMouseEvent * event)
1655 if (event->button() != Qt::LeftButton)
1658 // this code chunk is unnecessary because it seems the event only makes
1659 // it this far if it is not on a tab. I'm not sure why this is (maybe
1660 // it is handled and ended in DragTabBar?), and thus I'm not sure if
1661 // this is true in all cases and if it will be true in the future so I
1662 // leave this code for now. (skostysh, 2016-07-21)
1664 // return early if double click on existing tabs
1665 if (posIsTab(event->pos()))
1668 dispatch(FuncRequest(LFUN_BUFFER_NEW));
1672 void TabWorkArea::setFullScreen(bool full_screen)
1674 for (int i = 0; i != count(); ++i) {
1675 if (GuiWorkArea * wa = workArea(i))
1676 wa->setFullScreen(full_screen);
1679 if (lyxrc.full_screen_tabbar)
1680 showBar(!full_screen && count() > 1);
1682 showBar(count() > 1);
1686 void TabWorkArea::showBar(bool show)
1688 tabBar()->setEnabled(show);
1689 tabBar()->setVisible(show);
1690 closeBufferButton->setVisible(show && lyxrc.single_close_tab_button);
1691 setTabsClosable(!lyxrc.single_close_tab_button);
1695 GuiWorkAreaContainer * TabWorkArea::widget(int index) const
1697 QWidget * w = QTabWidget::widget(index);
1700 GuiWorkAreaContainer * wac = dynamic_cast<GuiWorkAreaContainer *>(w);
1706 GuiWorkAreaContainer * TabWorkArea::currentWidget() const
1708 return widget(currentIndex());
1712 GuiWorkArea * TabWorkArea::workArea(int index) const
1714 GuiWorkAreaContainer * w = widget(index);
1717 return w->workArea();
1721 GuiWorkArea * TabWorkArea::currentWorkArea() const
1723 return workArea(currentIndex());
1727 GuiWorkArea * TabWorkArea::workArea(Buffer & buffer) const
1729 // FIXME: this method doesn't work if we have more than one work area
1730 // showing the same buffer.
1731 for (int i = 0; i != count(); ++i) {
1732 GuiWorkArea * wa = workArea(i);
1733 LASSERT(wa, return 0);
1734 if (&wa->bufferView().buffer() == &buffer)
1741 void TabWorkArea::closeAll()
1744 QWidget * wac = widget(0);
1745 LASSERT(wac, return);
1752 int TabWorkArea::indexOfWorkArea(GuiWorkArea * w) const
1754 for (int index = 0; index < count(); ++index)
1755 if (workArea(index) == w)
1761 bool TabWorkArea::setCurrentWorkArea(GuiWorkArea * work_area)
1763 LASSERT(work_area, return false);
1764 int index = indexOfWorkArea(work_area);
1768 if (index == currentIndex())
1769 // Make sure the work area is up to date.
1770 on_currentTabChanged(index);
1772 // Switch to the work area.
1773 setCurrentIndex(index);
1774 work_area->setFocus();
1780 GuiWorkArea * TabWorkArea::addWorkArea(Buffer & buffer, GuiView & view)
1782 GuiWorkArea * wa = new GuiWorkArea(buffer, view);
1783 GuiWorkAreaContainer * wac = new GuiWorkAreaContainer(wa);
1784 wa->setUpdatesEnabled(false);
1785 // Hide tabbar if there's no tab (avoid a resize and a flashing tabbar
1786 // when hiding it again below).
1787 if (!(currentWorkArea() && currentWorkArea()->isFullScreen()))
1788 showBar(count() > 0);
1789 addTab(wac, wa->windowTitle());
1790 QObject::connect(wa, SIGNAL(titleChanged(GuiWorkArea *)),
1791 this, SLOT(updateTabTexts()));
1792 if (currentWorkArea() && currentWorkArea()->isFullScreen())
1793 setFullScreen(true);
1795 // Hide tabbar if there's only one tab.
1796 showBar(count() > 1);
1804 bool TabWorkArea::removeWorkArea(GuiWorkArea * work_area)
1806 LASSERT(work_area, return false);
1807 int index = indexOfWorkArea(work_area);
1811 work_area->setUpdatesEnabled(false);
1812 QWidget * wac = widget(index);
1817 // make sure the next work area is enabled.
1818 currentWidget()->setUpdatesEnabled(true);
1819 if (currentWorkArea() && currentWorkArea()->isFullScreen())
1820 setFullScreen(true);
1822 // Show tabbar only if there's more than one tab.
1823 showBar(count() > 1);
1825 lastWorkAreaRemoved();
1833 void TabWorkArea::on_currentTabChanged(int i)
1835 // returns e.g. on application destruction
1838 GuiWorkArea * wa = workArea(i);
1839 LASSERT(wa, return);
1840 wa->setUpdatesEnabled(true);
1844 currentWorkAreaChanged(wa);
1846 LYXERR(Debug::GUI, "currentTabChanged " << i
1847 << " File: " << wa->bufferView().buffer().absFileName());
1851 void TabWorkArea::closeCurrentBuffer()
1854 if (clicked_tab_ == -1)
1855 wa = currentWorkArea();
1857 wa = workArea(clicked_tab_);
1858 LASSERT(wa, return);
1860 wa->view().closeWorkArea(wa);
1864 void TabWorkArea::hideCurrentTab()
1867 if (clicked_tab_ == -1)
1868 wa = currentWorkArea();
1870 wa = workArea(clicked_tab_);
1871 LASSERT(wa, return);
1873 wa->view().hideWorkArea(wa);
1877 void TabWorkArea::closeTab(int index)
1879 on_currentTabChanged(index);
1882 wa = currentWorkArea();
1884 wa = workArea(index);
1885 LASSERT(wa, return);
1887 wa->view().closeWorkArea(wa);
1894 /// make vector happy
1895 DisplayPath() : tab_(-1), dottedPrefix_(false) {}
1897 DisplayPath(int tab, FileName const & filename)
1900 filename_ = (filename.extension() == "lyx") ?
1901 toqstr(filename.onlyFileNameWithoutExt())
1902 : toqstr(filename.onlyFileName());
1903 postfix_ = toqstr(filename.absoluteFilePath()).
1904 split("/", QString::SkipEmptyParts);
1905 postfix_.pop_back();
1906 abs_ = toqstr(filename.absoluteFilePath());
1907 dottedPrefix_ = false;
1910 /// Absolute path for debugging.
1915 /// Add the first segment from the postfix or three dots to the prefix.
1916 /// Merge multiple dot tripples. In fact dots are added lazily, i.e. only
1917 /// when really needed.
1918 void shiftPathSegment(bool dotted)
1920 if (postfix_.count() <= 0)
1924 if (dottedPrefix_ && !prefix_.isEmpty())
1925 prefix_ += ellipsisSlash_;
1926 prefix_ += postfix_.front() + "/";
1928 dottedPrefix_ = dotted && !prefix_.isEmpty();
1929 postfix_.pop_front();
1932 QString displayString() const
1934 if (prefix_.isEmpty())
1937 bool dots = dottedPrefix_ || !postfix_.isEmpty();
1938 return prefix_ + (dots ? ellipsisSlash_ : "") + filename_;
1941 QString forecastPathString() const
1943 if (postfix_.count() == 0)
1944 return displayString();
1947 + (dottedPrefix_ ? ellipsisSlash_ : "")
1948 + postfix_.front() + "/";
1951 bool final() const { return postfix_.empty(); }
1953 int tab() const { return tab_; }
1957 static QString const ellipsisSlash_;
1961 QStringList postfix_;
1973 QString const DisplayPath::ellipsisSlash_ = QString(QChar(0x2026)) + "/";
1977 bool operator<(DisplayPath const & a, DisplayPath const & b)
1979 return a.displayString() < b.displayString();
1983 bool operator==(DisplayPath const & a, DisplayPath const & b)
1985 return a.displayString() == b.displayString();
1989 void TabWorkArea::updateTabTexts()
1994 std::list<DisplayPath> paths;
1995 typedef std::list<DisplayPath>::iterator It;
1997 // collect full names first: path into postfix, empty prefix and
1998 // filename without extension
1999 for (size_t i = 0; i < n; ++i) {
2000 GuiWorkArea * i_wa = workArea(i);
2001 FileName const fn = i_wa->bufferView().buffer().fileName();
2002 paths.push_back(DisplayPath(i, fn));
2005 // go through path segments and see if it helps to make the path more unique
2006 bool somethingChanged = true;
2007 bool allFinal = false;
2008 while (somethingChanged && !allFinal) {
2009 // adding path segments changes order
2012 LYXERR(Debug::GUI, "updateTabTexts() iteration start");
2013 somethingChanged = false;
2016 // find segments which are not unique (i.e. non-atomic)
2017 It it = paths.begin();
2019 QString segString = it->displayString();
2020 for (; it != paths.end(); ++it) {
2021 // look to the next item
2026 allFinal = allFinal && it->final();
2028 LYXERR(Debug::GUI, "it = " << it->abs()
2029 << " => " << it->displayString());
2031 // still the same segment?
2033 if ((next != paths.end()
2034 && (nextString = next->displayString()) == segString))
2036 LYXERR(Debug::GUI, "segment ended");
2038 // only a trivial one with one element?
2039 if (it == segStart) {
2040 // start new segment
2042 segString = nextString;
2046 // We found a non-atomic segment
2047 // We know that segStart <= it < next <= paths.end().
2048 // The assertion below tells coverity about it.
2049 LATTEST(segStart != paths.end());
2050 QString dspString = segStart->forecastPathString();
2051 LYXERR(Debug::GUI, "first forecast found for "
2052 << segStart->abs() << " => " << dspString);
2055 // Shift path segments and hope for the best
2056 // that it makes the path more unique.
2057 somethingChanged = true;
2058 bool moreUnique = false;
2059 for (; sit != next; ++sit) {
2060 if (sit->forecastPathString() != dspString) {
2061 LYXERR(Debug::GUI, "different forecast found for "
2062 << sit->abs() << " => " << sit->forecastPathString());
2066 LYXERR(Debug::GUI, "same forecast found for "
2067 << sit->abs() << " => " << dspString);
2070 // if the path segment helped, add it. Otherwise add dots
2071 bool dots = !moreUnique;
2072 LYXERR(Debug::GUI, "using dots = " << dots);
2073 for (sit = segStart; sit != next; ++sit) {
2074 sit->shiftPathSegment(dots);
2075 LYXERR(Debug::GUI, "shifting "
2076 << sit->abs() << " => " << sit->displayString());
2079 // start new segment
2081 segString = nextString;
2085 // set new tab titles
2086 for (It it = paths.begin(); it != paths.end(); ++it) {
2087 int const tab_index = it->tab();
2088 Buffer const & buf = workArea(tab_index)->bufferView().buffer();
2089 QString tab_text = it->displayString().replace("&", "&&");
2090 if (!buf.fileName().empty() && !buf.isClean())
2092 QString tab_tooltip = it->abs();
2093 if (buf.hasReadonlyFlag()) {
2094 setTabIcon(tab_index, QIcon(getPixmap("images/", "emblem-readonly", "svgz,png")));
2095 tab_tooltip = qt_("%1 (read only)").arg(tab_tooltip);
2097 setTabIcon(tab_index, QIcon());
2098 if (buf.notifiesExternalModification()) {
2099 QString const warn = qt_("%1 (modified externally)");
2100 tab_tooltip = warn.arg(tab_tooltip);
2101 tab_text += QChar(0x26a0);
2103 setTabText(tab_index, tab_text);
2104 setTabToolTip(tab_index, tab_tooltip);
2109 void TabWorkArea::showContextMenu(const QPoint & pos)
2112 clicked_tab_ = static_cast<DragTabBar *>(tabBar())->tabAt(pos);
2113 if (clicked_tab_ == -1)
2118 popup.addAction(QIcon(getPixmap("images/", "hidetab", "svgz,png")),
2119 qt_("Hide tab"), this, SLOT(hideCurrentTab()));
2120 popup.addAction(QIcon(getPixmap("images/", "closetab", "svgz,png")),
2121 qt_("Close tab"), this, SLOT(closeCurrentBuffer()));
2122 popup.exec(tabBar()->mapToGlobal(pos));
2128 void TabWorkArea::moveTab(int fromIndex, int toIndex)
2130 QWidget * w = widget(fromIndex);
2131 QIcon icon = tabIcon(fromIndex);
2132 QString text = tabText(fromIndex);
2134 setCurrentIndex(fromIndex);
2135 removeTab(fromIndex);
2136 insertTab(toIndex, w, icon, text);
2137 setCurrentIndex(toIndex);
2141 DragTabBar::DragTabBar(QWidget* parent)
2144 setAcceptDrops(true);
2145 setTabsClosable(!lyxrc.single_close_tab_button);
2149 void DragTabBar::mousePressEvent(QMouseEvent * event)
2151 if (event->button() == Qt::LeftButton)
2152 dragStartPos_ = event->pos();
2153 QTabBar::mousePressEvent(event);
2157 void DragTabBar::mouseMoveEvent(QMouseEvent * event)
2159 // If the left button isn't pressed anymore then return
2160 if (!(event->buttons() & Qt::LeftButton))
2163 // If the distance is too small then return
2164 if ((event->pos() - dragStartPos_).manhattanLength()
2165 < QApplication::startDragDistance())
2168 // did we hit something after all?
2169 int tab = tabAt(dragStartPos_);
2173 // simulate button release to remove highlight from button
2174 int i = currentIndex();
2175 QMouseEvent me(QEvent::MouseButtonRelease, dragStartPos_,
2176 event->button(), event->buttons(), 0);
2177 QTabBar::mouseReleaseEvent(&me);
2181 QDrag * drag = new QDrag(this);
2182 QMimeData * mimeData = new QMimeData;
2183 // a crude way to distinguish tab-reodering drops from other ones
2184 mimeData->setData("action", "tab-reordering") ;
2185 drag->setMimeData(mimeData);
2187 // get tab pixmap as cursor
2188 QRect r = tabRect(tab);
2189 QPixmap pixmap(r.size());
2190 render(&pixmap, - r.topLeft());
2191 drag->setPixmap(pixmap);
2196 void DragTabBar::dragEnterEvent(QDragEnterEvent * event)
2198 // Only accept if it's an tab-reordering request
2199 QMimeData const * m = event->mimeData();
2200 QStringList formats = m->formats();
2201 if (formats.contains("action")
2202 && m->data("action") == "tab-reordering")
2203 event->acceptProposedAction();
2207 void DragTabBar::dropEvent(QDropEvent * event)
2209 int fromIndex = tabAt(dragStartPos_);
2210 int toIndex = tabAt(event->pos());
2212 // Tell interested objects that
2213 if (fromIndex != toIndex)
2214 tabMoveRequested(fromIndex, toIndex);
2215 event->acceptProposedAction();
2219 GuiWorkAreaContainer::GuiWorkAreaContainer(GuiWorkArea * wa, QWidget * parent)
2220 : QWidget(parent), wa_(wa)
2222 LASSERT(wa, return);
2223 Ui::WorkAreaUi::setupUi(this);
2224 layout()->addWidget(wa);
2225 connect(wa, SIGNAL(titleChanged(GuiWorkArea *)),
2226 this, SLOT(updateDisplay()));
2227 connect(reloadPB, SIGNAL(clicked()), this, SLOT(reload()));
2228 connect(ignorePB, SIGNAL(clicked()), this, SLOT(ignore()));
2229 setMessageColour({notificationFrame}, {reloadPB, ignorePB});
2234 void GuiWorkAreaContainer::updateDisplay()
2236 Buffer const & buf = wa_->bufferView().buffer();
2237 notificationFrame->setHidden(!buf.notifiesExternalModification());
2238 QString const label = qt_("<b>The file %1 changed on disk.</b>")
2239 .arg(toqstr(buf.fileName().displayName()));
2240 externalModificationLabel->setText(label);
2244 void GuiWorkAreaContainer::dispatch(FuncRequest f) const
2246 lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
2247 wa_->bufferView().buffer().absFileName()));
2252 void GuiWorkAreaContainer::reload() const
2254 dispatch(FuncRequest(LFUN_BUFFER_RELOAD));
2258 void GuiWorkAreaContainer::ignore() const
2260 dispatch(FuncRequest(LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR));
2264 void GuiWorkAreaContainer::mouseDoubleClickEvent(QMouseEvent * event)
2266 // prevent TabWorkArea from opening a new buffer on double click
2271 } // namespace frontend
2274 #include "moc_GuiWorkArea.cpp"