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, int id, LyXView & lyx_view)
 184         : WorkArea(id, lyx_view)
 185 {
 186         cursor_ = new frontend::CursorWidget(this);
 187         cursor_->hide();
 188
 189         setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOn);
 190         setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
 191         setAcceptDrops(true);
 192         setMinimumSize(100, 70);
 193
 194         //viewport()->setAutoFillBackground(false);
 195         //viewport()->setAttribute(Qt::WA_OpaquePaintEvent);
 196         setFocusPolicy(Qt::WheelFocus);
 197
 198         viewport()->setCursor(Qt::IBeamCursor);
 199
 200         resize(w, h);
 201
 202         synthetic_mouse_event_.timeout.timeout.connect(
 203                 boost::bind(&GuiWorkArea::generateSyntheticMouseEvent,
 204                             this));
 205
 206         // Initialize the vertical Scroll Bar
 207         QObject::connect(verticalScrollBar(), SIGNAL(actionTriggered(int)),
 208                 this, SLOT(adjustViewWithScrollBar(int)));
 209
 210         // PageStep only depends on the viewport height.
 211         verticalScrollBar()->setPageStep(viewport()->height());
 212
 213         lyxerr[Debug::GUI] << BOOST_CURRENT_FUNCTION
 214                 << "\n Area width\t" << width()
 215                 << "\n Area height\t" << height()
 216                 << "\n viewport width\t" << viewport()->width()
 217                 << "\n viewport height\t" << viewport()->height()
 218                 << endl;
 219
 220         if (USE_EVENT_PRUNING) {
 221                 // This is the keyboard buffering stuff...
 222                 // I don't see any need for this under windows. The keyboard is reactive
 223                 // enough...
 224
 225                 if ( !QObject::connect(&step_timer_, SIGNAL(timeout()),
 226                         this, SLOT(keyeventTimeout())) )
 227                         lyxerr[Debug::GUI] << "ERROR: keyeventTimeout cannot connect!" << endl;
 228
 229                 // Start the timer, one-shot.
 230                 step_timer_.setSingleShot(true);
 231                 step_timer_.start(50);
 232         }
 233
 234         // Enables input methods for asian languages.
 235         // Must be set when creating custom text editing widgets.
 236         setAttribute(Qt::WA_InputMethodEnabled, true);
 237 }
 238
 239
 240 void GuiWorkArea::setScrollbarParams(int h, int scroll_pos, int scroll_line_step)
 241 {
 242         verticalScrollBar()->setTracking(false);
 243
 244         // do what cursor movement does (some grey)
 245         h += height() / 4;
 246         int scroll_max_ = std::max(0, h - height());
 247
 248         setVerticalScrollBarPolicy(Qt::ScrollBarAsNeeded);
 249         verticalScrollBar()->setRange(0, scroll_max_);
 250         verticalScrollBar()->setSliderPosition(scroll_pos);
 251         verticalScrollBar()->setSingleStep(scroll_line_step);
 252         verticalScrollBar()->setValue(scroll_pos);
 253
 254         verticalScrollBar()->setTracking(true);
 255 }
 256
 257
 258 void GuiWorkArea::adjustViewWithScrollBar(int)
 259 {
 260         scrollBufferView(verticalScrollBar()->sliderPosition());
 261 }
 262
 263
 264 void GuiWorkArea::dragEnterEvent(QDragEnterEvent * event)
 265 {
 266         if (event->mimeData()->hasUrls())
 267                 event->accept();
 268         /// \todo Ask lyx-devel is this is enough:
 269         /// if (event->mimeData()->hasFormat("text/plain"))
 270         ///     event->acceptProposedAction();
 271 }
 272
 273
 274 void GuiWorkArea::dropEvent(QDropEvent* event)
 275 {
 276         QList<QUrl> files = event->mimeData()->urls();
 277         if (files.isEmpty())
 278                 return;
 279
 280         lyxerr[Debug::GUI] << "GuiWorkArea::dropEvent: got URIs!" << endl;
 281         for (int i = 0; i!=files.size(); ++i) {
 282                 string const file = os::internal_path(fromqstr(files.at(i).toLocalFile()));
 283                 if (!file.empty())
 284                         dispatch(FuncRequest(LFUN_FILE_OPEN, file));
 285         }
 286 }
 287
 288
 289 void GuiWorkArea::focusInEvent(QFocusEvent * /*event*/)
 290 {
 291         startBlinkingCursor();
 292 }
 293
 294
 295 void GuiWorkArea::focusOutEvent(QFocusEvent * /*event*/)
 296 {
 297         stopBlinkingCursor();
 298 }
 299
 300
 301 void GuiWorkArea::mousePressEvent(QMouseEvent * e)
 302 {
 303         if (dc_event_.active && dc_event_ == *e) {
 304                 dc_event_.active = false;
 305                 FuncRequest cmd(LFUN_MOUSE_TRIPLE,
 306                         dc_event_.x, dc_event_.y,
 307                         q_button_state(dc_event_.state));
 308                 dispatch(cmd);
 309                 return;
 310         }
 311
 312         FuncRequest const cmd(LFUN_MOUSE_PRESS, e->x(), e->y(),
 313                               q_button_state(e->button()));
 314         dispatch(cmd);
 315 }
 316
 317
 318 void GuiWorkArea::mouseReleaseEvent(QMouseEvent * e)
 319 {
 320         if (synthetic_mouse_event_.timeout.running())
 321                 synthetic_mouse_event_.timeout.stop();
 322
 323         FuncRequest const cmd(LFUN_MOUSE_RELEASE, e->x(), e->y(),
 324                               q_button_state(e->button()));
 325         dispatch(cmd);
 326 }
 327
 328
 329 void GuiWorkArea::mouseMoveEvent(QMouseEvent * e)
 330 {
 331         FuncRequest cmd(LFUN_MOUSE_MOTION, e->x(), e->y(),
 332                               q_motion_state(e->button()));
 333
 334         // If we're above or below the work area...
 335         if (e->y() <= 20 || e->y() >= viewport()->height() - 20) {
 336                 // Make sure only a synthetic event can cause a page scroll,
 337                 // so they come at a steady rate:
 338                 if (e->y() <= 20)
 339                         // _Force_ a scroll up:
 340                         cmd.y = -40;
 341                 else
 342                         cmd.y = viewport()->height();
 343                 // Store the event, to be handled when the timeout expires.
 344                 synthetic_mouse_event_.cmd = cmd;
 345
 346                 if (synthetic_mouse_event_.timeout.running())
 347                         // Discard the event. Note that it _may_ be handled
 348                         // when the timeout expires if
 349                         // synthetic_mouse_event_.cmd has not been overwritten.
 350                         // Ie, when the timeout expires, we handle the
 351                         // most recent event but discard all others that
 352                         // occurred after the one used to start the timeout
 353                         // in the first place.
 354                         return;
 355                 else {
 356                         synthetic_mouse_event_.restart_timeout = true;
 357                         synthetic_mouse_event_.timeout.start();
 358                         // Fall through to handle this event...
 359                 }
 360
 361         } else if (synthetic_mouse_event_.timeout.running()) {
 362                 // Store the event, to be possibly handled when the timeout
 363                 // expires.
 364                 // Once the timeout has expired, normal control is returned
 365                 // to mouseMoveEvent (restart_timeout = false).
 366                 // This results in a much smoother 'feel' when moving the
 367                 // mouse back into the work area.
 368                 synthetic_mouse_event_.cmd = cmd;
 369                 synthetic_mouse_event_.restart_timeout = false;
 370                 return;
 371         }
 372
 373         // Has anything changed on-screen since the last QMouseEvent
 374         // was received?
 375         double const scrollbar_value = verticalScrollBar()->value();
 376         if (e->x() != synthetic_mouse_event_.x_old ||
 377             e->y() != synthetic_mouse_event_.y_old ||
 378             scrollbar_value != synthetic_mouse_event_.scrollbar_value_old) {
 379                 // Yes it has. Store the params used to check this.
 380                 synthetic_mouse_event_.x_old = e->x();
 381                 synthetic_mouse_event_.y_old = e->y();
 382                 synthetic_mouse_event_.scrollbar_value_old = scrollbar_value;
 383
 384                 // ... and dispatch the event to the LyX core.
 385                 dispatch(cmd);
 386         }
 387 }
 388
 389
 390 void GuiWorkArea::wheelEvent(QWheelEvent * e)
 391 {
 392         // Wheel rotation by one notch results in a delta() of 120 (see
 393         // documentation of QWheelEvent)
 394         int const lines = qApp->wheelScrollLines() * e->delta() / 120;
 395         verticalScrollBar()->setValue(verticalScrollBar()->value() -
 396                         lines *  verticalScrollBar()->singleStep());
 397         adjustViewWithScrollBar();
 398 }
 399
 400
 401 void GuiWorkArea::generateSyntheticMouseEvent()
 402 {
 403 // Set things off to generate the _next_ 'pseudo' event.
 404         if (synthetic_mouse_event_.restart_timeout)
 405                 synthetic_mouse_event_.timeout.start();
 406
 407         // Has anything changed on-screen since the last timeout signal
 408         // was received?
 409         double const scrollbar_value = verticalScrollBar()->value();
 410         if (scrollbar_value != synthetic_mouse_event_.scrollbar_value_old) {
 411                 // Yes it has. Store the params used to check this.
 412                 synthetic_mouse_event_.scrollbar_value_old = scrollbar_value;
 413
 414                 // ... and dispatch the event to the LyX core.
 415                 dispatch(synthetic_mouse_event_.cmd);
 416         }
 417 }
 418
 419
 420 void GuiWorkArea::keyPressEvent(QKeyEvent * e)
 421 {
 422         lyxerr[Debug::KEY] << BOOST_CURRENT_FUNCTION
 423                 << " count=" << e->count()
 424                 << " text=" << fromqstr(e->text())
 425                 << " isAutoRepeat=" << e->isAutoRepeat()
 426                 << " key=" << e->key()
 427                 << endl;
 428
 429         if (USE_EVENT_PRUNING) {
 430                 keyeventQueue_.push(boost::shared_ptr<QKeyEvent>(new QKeyEvent(*e)));
 431         }
 432         else {
 433                 boost::shared_ptr<QLyXKeySym> sym(new QLyXKeySym);
 434                 sym->set(e);
 435                 processKeySym(sym, q_key_state(e->modifiers()));
 436         }
 437 }
 438
 439
 440 // This is used only if USE_EVENT_PRUNING is defined...
 441 void GuiWorkArea::keyeventTimeout()
 442 {
 443         bool handle_autos = true;
 444
 445         while (!keyeventQueue_.empty()) {
 446                 boost::shared_ptr<QKeyEvent> ev = keyeventQueue_.front();
 447
 448                 // We never handle more than one auto repeated
 449                 // char in a list of queued up events.
 450                 if (!handle_autos && ev->isAutoRepeat()) {
 451                         keyeventQueue_.pop();
 452                         continue;
 453                 }
 454
 455                 boost::shared_ptr<QLyXKeySym> sym(new QLyXKeySym);
 456                 sym->set(ev.get());
 457
 458                 lyxerr[Debug::GUI] << BOOST_CURRENT_FUNCTION
 459                                    << " count=" << ev->count()
 460                                    << " text=" <<  fromqstr(ev->text())
 461                                    << " isAutoRepeat=" << ev->isAutoRepeat()
 462                                    << " key=" << ev->key()
 463                                    << endl;
 464
 465                 processKeySym(sym, q_key_state(ev->modifiers()));
 466                 keyeventQueue_.pop();
 467
 468                 handle_autos = false;
 469         }
 470
 471         // Restart the timer.
 472         step_timer_.setSingleShot(true);
 473         step_timer_.start(25);
 474 }
 475
 476
 477 void GuiWorkArea::mouseDoubleClickEvent(QMouseEvent * e)
 478 {
 479         dc_event_ = double_click(e);
 480
 481         if (!dc_event_.active)
 482                 return;
 483
 484         dc_event_.active = false;
 485
 486         FuncRequest cmd(LFUN_MOUSE_DOUBLE,
 487                 dc_event_.x, dc_event_.y,
 488                 q_button_state(dc_event_.state));
 489         dispatch(cmd);
 490 }
 491
 492
 493 void GuiWorkArea::resizeEvent(QResizeEvent * ev)
 494 {
 495         cursor_->hide();
 496         verticalScrollBar()->setPageStep(viewport()->height());
 497         QAbstractScrollArea::resizeEvent(ev);
 498         resizeBufferView();
 499 }
 500
 501
 502 void GuiWorkArea::update(int x, int y, int w, int h)
 503 {
 504         viewport()->update(x, y, w, h);
 505 }
 506
 507
 508 void GuiWorkArea::doGreyOut(QLPainter & pain)
 509 {
 510         greyed_out_ = true;
 511         pain.fillRectangle(0, 0, width(), height(),
 512                 LColor::bottomarea);
 513
 514         //if (!lyxrc.show_banner)
 515         //      return;
 516         lyxerr << "show banner: " << lyxrc.show_banner << endl;
 517         /// The text to be written on top of the pixmap
 518         string const text = lyx_version ? lyx_version : "unknown";
 519         string const file = support::libFileSearch("images", "banner", "ppm");
 520         if (file.empty())
 521                 return;
 522
 523         QPixmap pm(toqstr(file));
 524         if (!pm) {
 525                 lyxerr << "could not load splash screen: '" << file << "'" << endl;
 526                 return;
 527         }
 528
 529         QFont font;
 530         // The font used to display the version info
 531         font.setStyleHint(QFont::SansSerif);
 532         font.setWeight(QFont::Bold);
 533         font.setPointSize(LyXFont::SIZE_NORMAL);
 534
 535         int const w = pm.width();
 536         int const h = pm.height();
 537
 538         int x = (width() - w) / 2;
 539         int y = (height() - h) / 2;
 540
 541         pain.drawPixmap(x, y, pm);
 542
 543         x += 260;
 544         y += 265;
 545
 546         pain.setPen(QColor(255, 255, 0));
 547         pain.setFont(font);
 548         pain.drawText(x, y, toqstr(text));
 549 }
 550
 551
 552 void GuiWorkArea::paintEvent(QPaintEvent * ev)
 553 {
 554         /*
 555         lyxerr[Debug::GUI] << BOOST_CURRENT_FUNCTION
 556                 << "\n QWidget width\t" << this->width()
 557                 << "\n QWidget height\t" << this->height()
 558                 << "\n viewport width\t" << viewport()->width()
 559                 << "\n viewport height\t" << viewport()->height()
 560                 << "\n QPaintEvent x\t" << e->rect().x()
 561                 << "\n QPaintEvent y\t" << e->rect().y()
 562                 << "\n QPaintEvent w\t" << e->rect().width()
 563                 << "\n QPaintEvent h\t" << e->rect().height()
 564                 << endl;
 565         */
 566
 567         QRect const rc = ev->rect();
 568         //lyxerr << "paintEvent begin: x: " << rc.x()
 569         //      << " y: " << rc.y()
 570         //      << " w: " << rc.width()
 571         //      << " h: " << rc.height() << endl;
 572
 573         if (!buffer_view_) {
 574                 lyxerr << "no bufferview" << endl;
 575                 return;
 576         }
 577
 578         QLPainter pain(viewport());
 579
 580         if (rc.width() == 3) { // FIXME HACK
 581                 // Assume splash screen drawing is requested when
 582                 // width == 3
 583                 lyxerr << "splash screen requested" << endl;
 584                 doGreyOut(pain);
 585                 return;
 586         }
 587
 588         if (!buffer_view_->buffer()) {
 589                 lyxerr << "no buffer: " << endl;
 590                 doGreyOut(pain);
 591                 updateScrollbar();
 592                 return;
 593         }
 594
 595         //lyxerr << "real drawing" << endl;
 596         paintText(*buffer_view_, pain);
 597 }
 598
 599
 600
 601 void GuiWorkArea::expose(int x, int y, int w, int h)
 602 {
 603         update(x, y, w, h);
 604 }
 605
 606
 607 void GuiWorkArea::showCursor(int x, int y, int h, CursorShape shape)
 608 {
 609         cursor_->setGeometry(x, y, 2, h);
 610         cursor_->shape_ = shape;
 611         cursor_->on_ = true;
 612         cursor_->show();
 613 }
 614
 615
 616 void GuiWorkArea::removeCursor()
 617 {
 618         if (!qApp->focusWidget())
 619                 return;
 620         cursor_->hide();
 621 }
 622
 623
 624 void GuiWorkArea::inputMethodEvent(QInputMethodEvent * e)
 625 {
 626         QString const & text = e->commitString();
 627         if (!text.isEmpty()) {
 628
 629                 lyxerr[Debug::KEY] << BOOST_CURRENT_FUNCTION
 630                         << " preeditString =" << fromqstr(e->preeditString())
 631                         << " commitString  =" << fromqstr(e->commitString())
 632                         << endl;
 633
 634                 int key = 0;
 635                 // needed to make math superscript work on some systems
 636                 // ideally, such special coding should not be necessary
 637                 if (text == "^")
 638                         key = Qt::Key_AsciiCircum;
 639                 // FIXME: Needs for investigation, this key is not really used,
 640                 // the ctor below just check if key is different from 0.
 641                 QKeyEvent ev(QEvent::KeyPress, key, Qt::NoModifier, text);
 642                 keyPressEvent(&ev);
 643         }
 644         e->accept();
 645 }
 646
 647 } // namespace frontend
 648 } // namespace lyx
 649
 650 #include "GuiWorkArea_moc.cpp"