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