src/frontends/qt4/GuiWorkArea.C

   1 /**
   2  * \file GuiWorkArea.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author John Levon
   7  * \author Abdelrazak Younes
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "GuiWorkArea.h"
  15
  16 #include "GuiApplication.h"
  17 #include "QLPainter.h"
  18 #include "QLyXKeySym.h"
  19 #include "qt_helpers.h"
  20
  21 #include "LyXView.h"
  22
  23 #include "BufferView.h"
  24 #include "rowpainter.h"
  25 #include "debug.h"
  26 #include "funcrequest.h"
  27 #include "LColor.h"
  28 #include "version.h"
  29 #include "lyxrc.h"
  30
  31 #include "support/filetools.h" // LibFileSearch
  32 #include "support/os.h"
  33
  34 #include "graphics/GraphicsImage.h"
  35 #include "graphics/GraphicsLoader.h"
  36
  37 #include <QLayout>
  38 #include <QMainWindow>
  39 #include <QMimeData>
  40 #include <QUrl>
  41 #include <QDragEnterEvent>
  42 #include <QPixmap>
  43 #include <QPainter>
  44 #include <QScrollBar>
  45
  46 #include <boost/bind.hpp>
  47 #include <boost/current_function.hpp>
  48
  49 // Abdel (26/06/2006):
  50 // On windows-XP the UserGuide PageDown scroll test is faster without event pruning (16 s)
  51 // than with it (23 s).
  52 #ifdef Q_WS_WIN
  53  #define USE_EVENT_PRUNING 0
  54 #else
  55  #define USE_EVENT_PRUNING 0
  56 #endif
  57
  58
  59 using std::endl;
  60 using std::string;
  61
  62 namespace os = lyx::support::os;
  63
  64
  65 namespace lyx {
  66
  67 /// return the LyX key state from Qt's
  68 static key_modifier::state q_key_state(Qt::KeyboardModifiers state)
  69 {
  70         key_modifier::state k = key_modifier::none;
  71         if (state & Qt::ControlModifier)
  72                 k |= key_modifier::ctrl;
  73         if (state & Qt::ShiftModifier)
  74                 k |= key_modifier::shift;
  75         if (state & Qt::AltModifier || state & Qt::MetaModifier)
  76                 k |= key_modifier::alt;
  77         return k;
  78 }
  79
  80
  81 /// return the LyX mouse button state from Qt's
  82 static mouse_button::state q_button_state(Qt::MouseButton button)
  83 {
  84         mouse_button::state b = mouse_button::none;
  85         switch (button) {
  86                 case Qt::LeftButton:
  87                         b = mouse_button::button1;
  88                         break;
  89                 case Qt::MidButton:
  90                         b = mouse_button::button2;
  91                         break;
  92                 case Qt::RightButton:
  93                         b = mouse_button::button3;
  94                         break;
  95                 default:
  96                         break;
  97         }
  98         return b;
  99 }
 100
 101
 102 /// return the LyX mouse button state from Qt's
 103 mouse_button::state q_motion_state(Qt::MouseButton state)
 104 {
 105         mouse_button::state b = mouse_button::none;
 106         if (state & Qt::LeftButton)
 107                 b |= mouse_button::button1;
 108         if (state & Qt::MidButton)
 109                 b |= mouse_button::button2;
 110         if (state & Qt::RightButton)
 111                 b |= mouse_button::button3;
 112         return b;
 113 }
 114
 115
 116 namespace frontend {
 117
 118 class CursorWidget : public QWidget {
 119 public:
 120         CursorWidget(QWidget * parent)
 121                 : QWidget(parent)
 122         {
 123                 resize(2, 20);
 124         }
 125
 126         void paintEvent(QPaintEvent *)
 127         {
 128                 QColor const & col = guiApp->colorCache().get(LColor::cursor);
 129
 130 /*
 131                 int cursor_w_;
 132                 int cursor_h_;
 133
 134                 switch (cursor_shape_) {
 135                 case BAR_SHAPE:
 136                         // FIXME the cursor width shouldn't be hard-coded!
 137                         cursor_w_ = 2;
 138                         lshape_cursor_ = false;
 139                         break;
 140                 case L_SHAPE:
 141                         cursor_w_ = cursor_h_ / 3;
 142                         lshape_cursor_ = true;
 143                         break;
 144                 case REVERSED_L_SHAPE:
 145                         cursor_w_ = cursor_h_ / 3;
 146                         //cursor_x_ -= cursor_w_ - 1;
 147                         lshape_cursor_ = true;
 148                         break;
 149                 }
 150 */
 151
 152                 // We cache two pixmaps:
 153                 // 1 the vertical line of the cursor.
 154                 // 2 the horizontal line of the L-shaped cursor (if necessary).
 155
 156                 // Draw the new (vertical) cursor.
 157                 QPainter pain(this);
 158                 pain.fillRect(rect(), col);
 159 /*
 160                 // Draw the new (horizontal) cursor if necessary.
 161                 if (lshape_cursor_) {
 162                         hcursor_ = QPixmap(cursor_w_, 1);
 163                         hcursor_.fill(col);
 164                         show_hcursor_ = true;
 165                 }
 166 */
 167         }
 168         /// shown?
 169         bool on_;
 170         ///
 171         CursorShape shape_;
 172 };
 173
 174
 175 // This is a 'heartbeat' generating synthetic mouse move events when the
 176 // cursor is at the top or bottom edge of the viewport. One scroll per 0.2 s
 177 SyntheticMouseEvent::SyntheticMouseEvent()
 178         : timeout(200), restart_timeout(true),
 179           x_old(-1), y_old(-1), scrollbar_value_old(-1.0)
 180 {}
 181
 182
 183 GuiWorkArea::GuiWorkArea(int w, int h, LyXView & lyx_view)
 184         : WorkArea(lyx_view)
 185 {
 186         cursor_ = new frontend::CursorWidget(this);
 187
 188         setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOn);
 189         setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
 190         setAcceptDrops(true);
 191         setMinimumSize(100, 70);
 192
 193         //viewport()->setAutoFillBackground(false);
 194         //viewport()->setAttribute(Qt::WA_OpaquePaintEvent);
 195         setFocusPolicy(Qt::WheelFocus);
 196
 197         viewport()->setCursor(Qt::IBeamCursor);
 198
 199         resize(w, h);
 200
 201         synthetic_mouse_event_.timeout.timeout.connect(
 202                 boost::bind(&GuiWorkArea::generateSyntheticMouseEvent,
 203                             this));
 204
 205         // Initialize the vertical Scroll Bar
 206         QObject::connect(verticalScrollBar(), SIGNAL(actionTriggered(int)),
 207                 this, SLOT(adjustViewWithScrollBar(int)));
 208
 209         // PageStep only depends on the viewport height.
 210         verticalScrollBar()->setPageStep(viewport()->height());
 211
 212         lyxerr[Debug::GUI] << BOOST_CURRENT_FUNCTION
 213                 << "\n Area width\t" << width()
 214                 << "\n Area height\t" << height()
 215                 << "\n viewport width\t" << viewport()->width()
 216                 << "\n viewport height\t" << viewport()->height()
 217                 << endl;
 218
 219         if (USE_EVENT_PRUNING) {
 220                 // This is the keyboard buffering stuff...
 221                 // I don't see any need for this under windows. The keyboard is reactive
 222                 // enough...
 223
 224                 if ( !QObject::connect(&step_timer_, SIGNAL(timeout()),
 225                         this, SLOT(keyeventTimeout())) )
 226                         lyxerr[Debug::GUI] << "ERROR: keyeventTimeout cannot connect!" << endl;
 227
 228                 // Start the timer, one-shot.
 229                 step_timer_.setSingleShot(true);
 230                 step_timer_.start(50);
 231         }
 232
 233         // Enables input methods for asian languages.
 234         // Must be set when creating custom text editing widgets.
 235         setAttribute(Qt::WA_InputMethodEnabled, true);
 236 }
 237
 238
 239 void GuiWorkArea::setScrollbarParams(int h, int scroll_pos, int scroll_line_step)
 240 {
 241         verticalScrollBar()->setTracking(false);
 242
 243         // do what cursor movement does (some grey)
 244         h += height() / 4;
 245         int scroll_max_ = std::max(0, h - height());
 246
 247         verticalScrollBar()->setRange(0, scroll_max_);
 248         verticalScrollBar()->setSliderPosition(scroll_pos);
 249         verticalScrollBar()->setSingleStep(scroll_line_step);
 250         verticalScrollBar()->setValue(scroll_pos);
 251
 252         verticalScrollBar()->setTracking(true);
 253 }
 254
 255
 256 void GuiWorkArea::adjustViewWithScrollBar(int)
 257 {
 258         scrollBufferView(verticalScrollBar()->sliderPosition());
 259 }
 260
 261
 262 void GuiWorkArea::dragEnterEvent(QDragEnterEvent * event)
 263 {
 264         if (event->mimeData()->hasUrls())
 265                 event->accept();
 266         /// \todo Ask lyx-devel is this is enough:
 267         /// if (event->mimeData()->hasFormat("text/plain"))
 268         ///     event->acceptProposedAction();
 269 }
 270
 271
 272 void GuiWorkArea::dropEvent(QDropEvent* event)
 273 {
 274         QList<QUrl> files = event->mimeData()->urls();
 275         if (files.isEmpty())
 276                 return;
 277
 278         lyxerr[Debug::GUI] << "GuiWorkArea::dropEvent: got URIs!" << endl;
 279         for (int i = 0; i!=files.size(); ++i) {
 280                 string const file = os::internal_path(fromqstr(files.at(i).toLocalFile()));
 281                 if (!file.empty())
 282                         dispatch(FuncRequest(LFUN_FILE_OPEN, file));
 283         }
 284 }
 285
 286
 287 void GuiWorkArea::mousePressEvent(QMouseEvent * e)
 288 {
 289         if (dc_event_.active && dc_event_ == *e) {
 290                 dc_event_.active = false;
 291                 FuncRequest cmd(LFUN_MOUSE_TRIPLE,
 292                         dc_event_.x, dc_event_.y,
 293                         q_button_state(dc_event_.state));
 294                 dispatch(cmd);
 295                 return;
 296         }
 297
 298         FuncRequest const cmd(LFUN_MOUSE_PRESS, e->x(), e->y(),
 299                               q_button_state(e->button()));
 300         dispatch(cmd);
 301 }
 302
 303
 304 void GuiWorkArea::mouseReleaseEvent(QMouseEvent * e)
 305 {
 306         if (synthetic_mouse_event_.timeout.running())
 307                 synthetic_mouse_event_.timeout.stop();
 308
 309         FuncRequest const cmd(LFUN_MOUSE_RELEASE, e->x(), e->y(),
 310                               q_button_state(e->button()));
 311         dispatch(cmd);
 312 }
 313
 314
 315 void GuiWorkArea::mouseMoveEvent(QMouseEvent * e)
 316 {
 317         FuncRequest cmd(LFUN_MOUSE_MOTION, e->x(), e->y(),
 318                               q_motion_state(e->button()));
 319
 320         // If we're above or below the work area...
 321         if (e->y() <= 20 || e->y() >= viewport()->height() - 20) {
 322                 // Make sure only a synthetic event can cause a page scroll,
 323                 // so they come at a steady rate:
 324                 if (e->y() <= 20)
 325                         // _Force_ a scroll up:
 326                         cmd.y = -40;
 327                 else
 328                         cmd.y = viewport()->height();
 329                 // Store the event, to be handled when the timeout expires.
 330                 synthetic_mouse_event_.cmd = cmd;
 331
 332                 if (synthetic_mouse_event_.timeout.running())
 333                         // Discard the event. Note that it _may_ be handled
 334                         // when the timeout expires if
 335                         // synthetic_mouse_event_.cmd has not been overwritten.
 336                         // Ie, when the timeout expires, we handle the
 337                         // most recent event but discard all others that
 338                         // occurred after the one used to start the timeout
 339                         // in the first place.
 340                         return;
 341                 else {
 342                         synthetic_mouse_event_.restart_timeout = true;
 343                         synthetic_mouse_event_.timeout.start();
 344                         // Fall through to handle this event...
 345                 }
 346
 347         } else if (synthetic_mouse_event_.timeout.running()) {
 348                 // Store the event, to be possibly handled when the timeout
 349                 // expires.
 350                 // Once the timeout has expired, normal control is returned
 351                 // to mouseMoveEvent (restart_timeout = false).
 352                 // This results in a much smoother 'feel' when moving the
 353                 // mouse back into the work area.
 354                 synthetic_mouse_event_.cmd = cmd;
 355                 synthetic_mouse_event_.restart_timeout = false;
 356                 return;
 357         }
 358
 359         // Has anything changed on-screen since the last QMouseEvent
 360         // was received?
 361         double const scrollbar_value = verticalScrollBar()->value();
 362         if (e->x() != synthetic_mouse_event_.x_old ||
 363             e->y() != synthetic_mouse_event_.y_old ||
 364             scrollbar_value != synthetic_mouse_event_.scrollbar_value_old) {
 365                 // Yes it has. Store the params used to check this.
 366                 synthetic_mouse_event_.x_old = e->x();
 367                 synthetic_mouse_event_.y_old = e->y();
 368                 synthetic_mouse_event_.scrollbar_value_old = scrollbar_value;
 369
 370                 // ... and dispatch the event to the LyX core.
 371                 dispatch(cmd);
 372         }
 373 }
 374
 375
 376 void GuiWorkArea::wheelEvent(QWheelEvent * e)
 377 {
 378         // Wheel rotation by one notch results in a delta() of 120 (see
 379         // documentation of QWheelEvent)
 380         int const lines = qApp->wheelScrollLines() * e->delta() / 120;
 381         verticalScrollBar()->setValue(verticalScrollBar()->value() -
 382                         lines *  verticalScrollBar()->singleStep());
 383         adjustViewWithScrollBar();
 384 }
 385
 386
 387 void GuiWorkArea::generateSyntheticMouseEvent()
 388 {
 389 // Set things off to generate the _next_ 'pseudo' event.
 390         if (synthetic_mouse_event_.restart_timeout)
 391                 synthetic_mouse_event_.timeout.start();
 392
 393         // Has anything changed on-screen since the last timeout signal
 394         // was received?
 395         double const scrollbar_value = verticalScrollBar()->value();
 396         if (scrollbar_value != synthetic_mouse_event_.scrollbar_value_old) {
 397                 // Yes it has. Store the params used to check this.
 398                 synthetic_mouse_event_.scrollbar_value_old = scrollbar_value;
 399
 400                 // ... and dispatch the event to the LyX core.
 401                 dispatch(synthetic_mouse_event_.cmd);
 402         }
 403 }
 404
 405
 406 void GuiWorkArea::keyPressEvent(QKeyEvent * e)
 407 {
 408         lyxerr[Debug::KEY] << BOOST_CURRENT_FUNCTION
 409                 << " count=" << e->count()
 410                 << " text=" << fromqstr(e->text())
 411                 << " isAutoRepeat=" << e->isAutoRepeat()
 412                 << " key=" << e->key()
 413                 << endl;
 414
 415         if (USE_EVENT_PRUNING) {
 416                 keyeventQueue_.push(boost::shared_ptr<QKeyEvent>(new QKeyEvent(*e)));
 417         }
 418         else {
 419                 boost::shared_ptr<QLyXKeySym> sym(new QLyXKeySym);
 420                 sym->set(e);
 421                 processKeySym(sym, q_key_state(e->modifiers()));
 422         }
 423 }
 424
 425
 426 // This is used only if USE_EVENT_PRUNING is defined...
 427 void GuiWorkArea::keyeventTimeout()
 428 {
 429         bool handle_autos = true;
 430
 431         while (!keyeventQueue_.empty()) {
 432                 boost::shared_ptr<QKeyEvent> ev = keyeventQueue_.front();
 433
 434                 // We never handle more than one auto repeated
 435                 // char in a list of queued up events.
 436                 if (!handle_autos && ev->isAutoRepeat()) {
 437                         keyeventQueue_.pop();
 438                         continue;
 439                 }
 440
 441                 boost::shared_ptr<QLyXKeySym> sym(new QLyXKeySym);
 442                 sym->set(ev.get());
 443
 444                 lyxerr[Debug::GUI] << BOOST_CURRENT_FUNCTION
 445                                    << " count=" << ev->count()
 446                                    << " text=" <<  fromqstr(ev->text())
 447                                    << " isAutoRepeat=" << ev->isAutoRepeat()
 448                                    << " key=" << ev->key()
 449                                    << endl;
 450
 451                 processKeySym(sym, q_key_state(ev->modifiers()));
 452                 keyeventQueue_.pop();
 453
 454                 handle_autos = false;
 455         }
 456
 457         // Restart the timer.
 458         step_timer_.setSingleShot(true);
 459         step_timer_.start(25);
 460 }
 461
 462
 463 void GuiWorkArea::mouseDoubleClickEvent(QMouseEvent * e)
 464 {
 465         dc_event_ = double_click(e);
 466
 467         if (!dc_event_.active)
 468                 return;
 469
 470         dc_event_.active = false;
 471
 472         FuncRequest cmd(LFUN_MOUSE_DOUBLE,
 473                 dc_event_.x, dc_event_.y,
 474                 q_button_state(dc_event_.state));
 475         dispatch(cmd);
 476 }
 477
 478
 479 void GuiWorkArea::resizeEvent(QResizeEvent * ev)
 480 {
 481         verticalScrollBar()->setPageStep(viewport()->height());
 482         //paint_device_ = QPixmap(viewport()->width(), viewport()->height());
 483         QAbstractScrollArea::resizeEvent(ev);
 484         resizeBufferView();
 485 }
 486
 487
 488 void GuiWorkArea::update(int x, int y, int w, int h)
 489 {
 490         viewport()->update(x, y, w, h);
 491 }
 492
 493
 494 void GuiWorkArea::doGreyOut(QLPainter & pain)
 495 {
 496         greyed_out_ = true;
 497         pain.fillRectangle(0, 0, width(), height(),
 498                 LColor::bottomarea);
 499
 500         //if (!lyxrc.show_banner)
 501         //      return;
 502         lyxerr << "show banner: " << lyxrc.show_banner << endl;
 503         /// The text to be written on top of the pixmap
 504         string const text = lyx_version ? lyx_version : "unknown";
 505         string const file = support::libFileSearch("images", "banner", "ppm");
 506         if (file.empty())
 507                 return;
 508
 509         QPixmap pm(toqstr(file));
 510         if (!pm) {
 511                 lyxerr << "could not load splash screen: '" << file << "'" << endl;
 512                 return;
 513         }
 514
 515         QFont font;
 516         // The font used to display the version info
 517         font.setStyleHint(QFont::SansSerif);
 518         font.setWeight(QFont::Bold);
 519         font.setPointSize(LyXFont::SIZE_NORMAL);
 520
 521         int const w = pm.width();
 522         int const h = pm.height();
 523
 524         int x = (width() - w) / 2;
 525         int y = (height() - h) / 2;
 526
 527         pain.drawPixmap(x, y, pm);
 528
 529         x += 260;
 530         y += 265;
 531
 532         pain.setPen(QColor(255, 255, 0));
 533         pain.setFont(font);
 534         pain.drawText(x, y, toqstr(text));
 535 }
 536
 537
 538 void GuiWorkArea::paintEvent(QPaintEvent * ev)
 539 {
 540         /*
 541         lyxerr[Debug::GUI] << BOOST_CURRENT_FUNCTION
 542                 << "\n QWidget width\t" << this->width()
 543                 << "\n QWidget height\t" << this->height()
 544                 << "\n viewport width\t" << viewport()->width()
 545                 << "\n viewport height\t" << viewport()->height()
 546                 << "\n pixmap width\t" << pixmap_->width()
 547                 << "\n pixmap height\t" << pixmap_->height()
 548                 << "\n QPaintEvent x\t" << e->rect().x()
 549                 << "\n QPaintEvent y\t" << e->rect().y()
 550                 << "\n QPaintEvent w\t" << e->rect().width()
 551                 << "\n QPaintEvent h\t" << e->rect().height()
 552                 << endl;
 553         */
 554
 555         QRect const rc = ev->rect();
 556         //lyxerr << "paintEvent begin: x: " << rc.x()
 557         //      << " y: " << rc.y()
 558         //      << " w: " << rc.width()
 559         //      << " h: " << rc.height() << endl;
 560
 561         if (!buffer_view_) {
 562                 lyxerr << "no bufferview" << endl;
 563                 return;
 564         }
 565
 566
 567         if (rc.width() == 3) { // FIXME HACK
 568                 // Assume splash screen drawing is requested when
 569                 // width == 3
 570                 lyxerr << "splash screen requested" << endl;
 571                 QLPainter pain(viewport());
 572                 doGreyOut(pain);
 573                 return;
 574         }
 575
 576         if (!buffer_view_->buffer()) {
 577                 lyxerr << "no buffer: " << endl;
 578                 QLPainter pain(viewport());
 579                 doGreyOut(pain);
 580                 updateScrollbar();
 581                 return;
 582         }
 583
 584         //lyxerr << "real drawing" << endl;
 585         QLPainter pain(viewport());
 586         ViewMetricsInfo const & vi = buffer_view_->viewMetricsInfo();
 587         paintText(*buffer_view_, vi, pain);
 588 }
 589
 590
 591
 592 void GuiWorkArea::expose(int x, int y, int w, int h)
 593 {
 594         update(x, y, w, h);
 595 }
 596
 597
 598 void GuiWorkArea::showCursor(int x, int y, int h, CursorShape shape)
 599 {
 600         if (!qApp->focusWidget())
 601                 return;
 602
 603         cursor_->move(x, y);
 604         cursor_->shape_ = shape;
 605         cursor_->on_ = true;
 606         cursor_->show();
 607 }
 608
 609
 610 void GuiWorkArea::removeCursor()
 611 {
 612         cursor_->hide();
 613 }
 614
 615
 616 void GuiWorkArea::inputMethodEvent(QInputMethodEvent * e)
 617 {
 618         QString const & text = e->commitString();
 619         if (!text.isEmpty()) {
 620
 621                 lyxerr[Debug::KEY] << BOOST_CURRENT_FUNCTION
 622                         << " preeditString =" << fromqstr(e->preeditString())
 623                         << " commitString  =" << fromqstr(e->commitString())
 624                         << endl;
 625
 626                 int key = 0;
 627                 // needed to make math superscript work on some systems
 628                 // ideally, such special coding should not be necessary
 629                 if (text == "^")
 630                         key = Qt::Key_AsciiCircum;
 631                 // FIXME: Needs for investigation, this key is not really used,
 632                 // the ctor below just check if key is different from 0.
 633                 QKeyEvent ev(QEvent::KeyPress, key, Qt::NoModifier, text);
 634                 keyPressEvent(&ev);
 635         }
 636         e->accept();
 637 }
 638
 639 } // namespace frontend
 640 } // namespace lyx
 641
 642 #include "GuiWorkArea_moc.cpp"