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