]> git.lyx.org Git - features.git/blob - src/frontends/qt4/GuiWorkArea.cpp
shuffle stuff around
[features.git] / src / frontends / qt4 / GuiWorkArea.cpp
1 /**
2  * \file GuiWorkArea.cpp
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 "GuiPainter.h"
18 #include "GuiKeySymbol.h"
19 #include "qt_helpers.h"
20
21 #include "frontends/LyXView.h"
22
23 #include "BufferView.h"
24 #include "Color.h"
25 #include "debug.h"
26 #include "FuncRequest.h"
27 #include "LyXRC.h"
28 #include "version.h"
29
30 #include "support/filetools.h" // LibFileSearch
31
32 #include "graphics/GraphicsImage.h"
33 #include "graphics/GraphicsLoader.h"
34
35 #include <QInputContext>
36 #include <QLayout>
37 #include <QMainWindow>
38 #include <QPainter>
39 #include <QScrollBar>
40 #include <QTimer>
41
42 #include <boost/bind.hpp>
43 #include <boost/current_function.hpp>
44
45 #ifdef Q_WS_X11
46 #include <QX11Info>
47 extern "C" int XEventsQueued(Display *display, int mode);
48 #endif
49
50 #ifdef Q_WS_WIN
51 int const CursorWidth = 2;
52 #else
53 int const CursorWidth = 1;
54 #endif
55
56 #undef KeyPress
57 #undef NoModifier 
58
59 using std::endl;
60 using std::string;
61
62 namespace lyx {
63
64 using support::FileName;
65
66 /// return the LyX mouse button state from Qt's
67 static mouse_button::state q_button_state(Qt::MouseButton button)
68 {
69         mouse_button::state b = mouse_button::none;
70         switch (button) {
71                 case Qt::LeftButton:
72                         b = mouse_button::button1;
73                         break;
74                 case Qt::MidButton:
75                         b = mouse_button::button2;
76                         break;
77                 case Qt::RightButton:
78                         b = mouse_button::button3;
79                         break;
80                 default:
81                         break;
82         }
83         return b;
84 }
85
86
87 /// return the LyX mouse button state from Qt's
88 mouse_button::state q_motion_state(Qt::MouseButtons state)
89 {
90         mouse_button::state b = mouse_button::none;
91         if (state & Qt::LeftButton)
92                 b |= mouse_button::button1;
93         if (state & Qt::MidButton)
94                 b |= mouse_button::button2;
95         if (state & Qt::RightButton)
96                 b |= mouse_button::button3;
97         return b;
98 }
99
100
101 namespace frontend {
102
103 class CursorWidget {
104 public:
105         CursorWidget() {}
106
107         void draw(QPainter & painter)
108         {
109                 if (show_ && rect_.isValid()) {
110                         switch (shape_) {
111                         case L_SHAPE:
112                                 painter.fillRect(rect_.x(), rect_.y(), CursorWidth, rect_.height(), color_);
113                                 painter.setPen(color_);
114                                 painter.drawLine(rect_.bottomLeft().x() + CursorWidth, rect_.bottomLeft().y(),
115                                                                                                  rect_.bottomRight().x(), rect_.bottomLeft().y());
116                                 break;
117                         
118                         case REVERSED_L_SHAPE:
119                                 painter.fillRect(rect_.x() + rect_.height() / 3, rect_.y(), CursorWidth, rect_.height(), color_);
120                                 painter.setPen(color_);
121                                 painter.drawLine(rect_.bottomRight().x() - CursorWidth, rect_.bottomLeft().y(),
122                                                                                                          rect_.bottomLeft().x(), rect_.bottomLeft().y());
123                                 break;
124                                         
125                         default:
126                                 painter.fillRect(rect_, color_);
127                                 break;
128                         }
129                 }
130         }
131
132         void update(int x, int y, int h, CursorShape shape)
133         {
134                 color_ = guiApp->colorCache().get(Color::cursor);
135                 shape_ = shape;
136                 switch (shape) {
137                 case L_SHAPE:
138                         rect_ = QRect(x, y, CursorWidth + h / 3, h);
139                         break;
140                 case REVERSED_L_SHAPE:
141                         rect_ = QRect(x - h / 3, y, CursorWidth + h / 3, h);
142                         break;
143                 default: 
144                         rect_ = QRect(x, y, CursorWidth, h);
145                         break;
146                 }
147         }
148
149         void show(bool set_show = true) { show_ = set_show; }
150         void hide() { show_ = false; }
151
152         QRect const & rect() { return rect_; }
153
154 private:
155         ///
156         CursorShape shape_;
157         ///
158         bool show_;
159         ///
160         QColor color_;
161         ///
162         QRect rect_;
163 };
164
165
166 // This is a 'heartbeat' generating synthetic mouse move events when the
167 // cursor is at the top or bottom edge of the viewport. One scroll per 0.2 s
168 SyntheticMouseEvent::SyntheticMouseEvent()
169         : timeout(200), restart_timeout(true),
170           x_old(-1), y_old(-1), scrollbar_value_old(-1.0)
171 {}
172
173
174 GuiWorkArea::GuiWorkArea(Buffer & buf, LyXView & lv)
175         : WorkArea(buf, lv), need_resize_(false), schedule_redraw_(false),
176           preedit_lines_(1)
177 {
178         screen_ = QPixmap(viewport()->width(), viewport()->height());
179         cursor_ = new frontend::CursorWidget();
180         cursor_->hide();
181
182         setVerticalScrollBarPolicy(Qt::ScrollBarAsNeeded);
183         setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
184         setAcceptDrops(true);
185         setMouseTracking(true);
186         setMinimumSize(100, 70);
187
188         viewport()->setAutoFillBackground(false);
189         // We don't need double-buffering nor SystemBackground on
190         // the viewport because we have our own backing pixmap.
191         viewport()->setAttribute(Qt::WA_NoSystemBackground);
192
193         setFocusPolicy(Qt::WheelFocus);
194
195         viewport()->setCursor(Qt::IBeamCursor);
196
197         synthetic_mouse_event_.timeout.timeout.connect(
198                 boost::bind(&GuiWorkArea::generateSyntheticMouseEvent,
199                             this));
200
201         // Initialize the vertical Scroll Bar
202         QObject::connect(verticalScrollBar(), SIGNAL(actionTriggered(int)),
203                 this, SLOT(adjustViewWithScrollBar(int)));
204
205         // disable context menu for the scrollbar
206         verticalScrollBar()->setContextMenuPolicy(Qt::NoContextMenu);
207
208         // PageStep only depends on the viewport height.
209         verticalScrollBar()->setPageStep(viewport()->height());
210
211         LYXERR(Debug::GUI) << BOOST_CURRENT_FUNCTION
212                 << "\n Area width\t" << width()
213                 << "\n Area height\t" << height()
214                 << "\n viewport width\t" << viewport()->width()
215                 << "\n viewport height\t" << viewport()->height()
216                 << endl;
217
218         // Enables input methods for asian languages.
219         // Must be set when creating custom text editing widgets.
220         setAttribute(Qt::WA_InputMethodEnabled, true);
221 }
222
223
224 void GuiWorkArea::setScrollbarParams(int h, int scroll_pos, int scroll_line_step)
225 {
226         if (verticalScrollBarPolicy() != Qt::ScrollBarAlwaysOn)
227                 setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOn);
228
229         verticalScrollBar()->setTracking(false);
230
231         // do what cursor movement does (some grey)
232         h += height() / 4;
233         int scroll_max_ = std::max(0, h - height());
234
235         verticalScrollBar()->setRange(0, scroll_max_);
236         verticalScrollBar()->setSliderPosition(scroll_pos);
237         verticalScrollBar()->setSingleStep(scroll_line_step);
238         verticalScrollBar()->setValue(scroll_pos);
239
240         verticalScrollBar()->setTracking(true);
241 }
242
243
244 void GuiWorkArea::adjustViewWithScrollBar(int)
245 {
246         scrollBufferView(verticalScrollBar()->sliderPosition());
247         QApplication::syncX();
248 }
249
250
251 void GuiWorkArea::focusInEvent(QFocusEvent * /*event*/)
252 {
253         // No need to do anything if we didn't change views...
254 //      if (theApp() == 0 || &lyx_view_ == theApp()->currentView())
255 //              return;
256
257         theApp()->setCurrentView(*lyx_view_);
258
259         // Repaint the whole screen.
260         // Note: this is different from redraw() as only the backing pixmap
261         // will be redrawn, which is cheap.
262         viewport()->repaint();
263
264         startBlinkingCursor();
265 }
266
267
268 void GuiWorkArea::focusOutEvent(QFocusEvent * /*event*/)
269 {
270         stopBlinkingCursor();
271 }
272
273
274 void GuiWorkArea::mousePressEvent(QMouseEvent * e)
275 {
276         if (dc_event_.active && dc_event_ == *e) {
277                 dc_event_.active = false;
278                 FuncRequest cmd(LFUN_MOUSE_TRIPLE,
279                         e->x(), e->y(),
280                         q_button_state(e->button()));
281                 dispatch(cmd);
282                 return;
283         }
284
285         inputContext()->reset();
286
287         FuncRequest const cmd(LFUN_MOUSE_PRESS, e->x(), e->y(),
288                 q_button_state(e->button()));
289         dispatch(cmd, q_key_state(e->modifiers()));
290 }
291
292
293 void GuiWorkArea::mouseReleaseEvent(QMouseEvent * e)
294 {
295         if (synthetic_mouse_event_.timeout.running())
296                 synthetic_mouse_event_.timeout.stop();
297
298         FuncRequest const cmd(LFUN_MOUSE_RELEASE, e->x(), e->y(),
299                               q_button_state(e->button()));
300         dispatch(cmd);
301 }
302
303
304 void GuiWorkArea::mouseMoveEvent(QMouseEvent * e)
305 {
306         // we kill the triple click if we move
307         doubleClickTimeout();
308         FuncRequest cmd(LFUN_MOUSE_MOTION, e->x(), e->y(),
309                               q_motion_state(e->buttons()));
310
311         // If we're above or below the work area...
312         if (e->y() <= 20 || e->y() >= viewport()->height() - 20) {
313                 // Make sure only a synthetic event can cause a page scroll,
314                 // so they come at a steady rate:
315                 if (e->y() <= 20)
316                         // _Force_ a scroll up:
317                         cmd.y = -40;
318                 else
319                         cmd.y = viewport()->height();
320                 // Store the event, to be handled when the timeout expires.
321                 synthetic_mouse_event_.cmd = cmd;
322
323                 if (synthetic_mouse_event_.timeout.running())
324                         // Discard the event. Note that it _may_ be handled
325                         // when the timeout expires if
326                         // synthetic_mouse_event_.cmd has not been overwritten.
327                         // Ie, when the timeout expires, we handle the
328                         // most recent event but discard all others that
329                         // occurred after the one used to start the timeout
330                         // in the first place.
331                         return;
332                 else {
333                         synthetic_mouse_event_.restart_timeout = true;
334                         synthetic_mouse_event_.timeout.start();
335                         // Fall through to handle this event...
336                 }
337
338         } else if (synthetic_mouse_event_.timeout.running()) {
339                 // Store the event, to be possibly handled when the timeout
340                 // expires.
341                 // Once the timeout has expired, normal control is returned
342                 // to mouseMoveEvent (restart_timeout = false).
343                 // This results in a much smoother 'feel' when moving the
344                 // mouse back into the work area.
345                 synthetic_mouse_event_.cmd = cmd;
346                 synthetic_mouse_event_.restart_timeout = false;
347                 return;
348         }
349
350         // Has anything changed on-screen since the last QMouseEvent
351         // was received?
352         double const scrollbar_value = verticalScrollBar()->value();
353         if (e->x() != synthetic_mouse_event_.x_old ||
354             e->y() != synthetic_mouse_event_.y_old ||
355             scrollbar_value != synthetic_mouse_event_.scrollbar_value_old) {
356                 // Yes it has. Store the params used to check this.
357                 synthetic_mouse_event_.x_old = e->x();
358                 synthetic_mouse_event_.y_old = e->y();
359                 synthetic_mouse_event_.scrollbar_value_old = scrollbar_value;
360
361                 // ... and dispatch the event to the LyX core.
362                 dispatch(cmd);
363         }
364 }
365
366
367 void GuiWorkArea::wheelEvent(QWheelEvent * e)
368 {
369         // Wheel rotation by one notch results in a delta() of 120 (see
370         // documentation of QWheelEvent)
371         int const lines = qApp->wheelScrollLines() * e->delta() / 120;
372         verticalScrollBar()->setValue(verticalScrollBar()->value() -
373                         lines *  verticalScrollBar()->singleStep());
374         adjustViewWithScrollBar();
375 }
376
377
378 void GuiWorkArea::generateSyntheticMouseEvent()
379 {
380 // Set things off to generate the _next_ 'pseudo' event.
381         if (synthetic_mouse_event_.restart_timeout)
382                 synthetic_mouse_event_.timeout.start();
383
384         // Has anything changed on-screen since the last timeout signal
385         // was received?
386         double const scrollbar_value = verticalScrollBar()->value();
387         if (scrollbar_value != synthetic_mouse_event_.scrollbar_value_old) {
388                 // Yes it has. Store the params used to check this.
389                 synthetic_mouse_event_.scrollbar_value_old = scrollbar_value;
390
391                 // ... and dispatch the event to the LyX core.
392                 dispatch(synthetic_mouse_event_.cmd);
393         }
394 }
395
396
397 void GuiWorkArea::keyPressEvent(QKeyEvent * e)
398 {
399         // do nothing if there are other events
400         // (the auto repeated events come too fast)
401         // \todo FIXME: remove hard coded Qt keys, process the key binding
402 #ifdef Q_WS_X11
403         if (XEventsQueued(QX11Info::display(), 0) > 1 && e->isAutoRepeat() 
404                         && (Qt::Key_PageDown || Qt::Key_PageUp)) {
405                 LYXERR(Debug::KEY)      
406                         << BOOST_CURRENT_FUNCTION << endl
407                         << "system is busy: scroll key event ignored" << endl;
408                 e->ignore();
409                 return;
410         }
411 #endif
412
413         LYXERR(Debug::KEY) << BOOST_CURRENT_FUNCTION
414                 << " count=" << e->count()
415                 << " text=" << fromqstr(e->text())
416                 << " isAutoRepeat=" << e->isAutoRepeat()
417                 << " key=" << e->key()
418                 << endl;
419
420         boost::shared_ptr<GuiKeySymbol> sym(new GuiKeySymbol);
421         sym->set(e);
422         processKeySym(sym, q_key_state(e->modifiers()));
423 }
424
425
426 void GuiWorkArea::doubleClickTimeout()
427 {
428         dc_event_.active = false;
429 }
430
431
432 void GuiWorkArea::mouseDoubleClickEvent(QMouseEvent * e)
433 {
434         dc_event_ = double_click(e);
435         QTimer::singleShot(QApplication::doubleClickInterval(), this,
436                            SLOT(doubleClickTimeout()));
437         FuncRequest cmd(LFUN_MOUSE_DOUBLE,
438                         e->x(), e->y(),
439                         q_button_state(e->button()));
440         dispatch(cmd);
441 }
442
443
444 void GuiWorkArea::resizeEvent(QResizeEvent * ev)
445 {
446         QAbstractScrollArea::resizeEvent(ev);
447         need_resize_ = true;
448 }
449
450
451 void GuiWorkArea::update(int x, int y, int w, int h)
452 {
453         viewport()->repaint(x, y, w, h);
454 }
455
456
457 void GuiWorkArea::paintEvent(QPaintEvent * ev)
458 {
459         QRect const rc = ev->rect();
460         /*
461         LYXERR(Debug::PAINTING) << "paintEvent begin: x: " << rc.x()
462                 << " y: " << rc.y()
463                 << " w: " << rc.width()
464                 << " h: " << rc.height() << endl;
465         */
466
467         if (need_resize_) {
468                 verticalScrollBar()->setPageStep(viewport()->height());
469                 screen_ = QPixmap(viewport()->width(), viewport()->height());
470                 resizeBufferView();
471                 updateScreen();
472                 WorkArea::hideCursor();
473                 WorkArea::showCursor();
474                 need_resize_ = false;
475         }
476
477         QPainter pain(viewport());
478         pain.drawPixmap(rc, screen_, rc);
479         cursor_->draw(pain);
480 }
481
482
483 void GuiWorkArea::expose(int x, int y, int w, int h)
484 {
485         updateScreen();
486         update(x, y, w, h);
487 }
488
489
490 void GuiWorkArea::updateScreen()
491 {
492         GuiPainter pain(&screen_);
493         verticalScrollBar()->show();
494         buffer_view_->draw(pain);
495 }
496
497
498 void GuiWorkArea::showCursor(int x, int y, int h, CursorShape shape)
499 {
500         if (schedule_redraw_) {
501                 buffer_view_->update(Update::Force);
502                 updateScreen();
503                 viewport()->update(QRect(0, 0, viewport()->width(), viewport()->height()));
504                 schedule_redraw_ = false;
505                 // Show the cursor immediately after the update.
506                 hideCursor();
507                 toggleCursor();
508                 return;
509         }
510
511         cursor_->update(x, y, h, shape);
512         cursor_->show();
513         viewport()->update(cursor_->rect());
514 }
515
516
517 void GuiWorkArea::removeCursor()
518 {
519         cursor_->hide();
520         //if (!qApp->focusWidget())
521                 viewport()->update(cursor_->rect());
522 }
523
524
525 void GuiWorkArea::inputMethodEvent(QInputMethodEvent * e)
526 {
527         QString const & commit_string = e->commitString();
528         docstring const & preedit_string
529                 = qstring_to_ucs4(e->preeditString());
530
531         if (!commit_string.isEmpty()) {
532
533                 LYXERR(Debug::KEY) << BOOST_CURRENT_FUNCTION
534                         << " preeditString =" << fromqstr(e->preeditString())
535                         << " commitString  =" << fromqstr(e->commitString())
536                         << endl;
537
538                 int key = 0;
539
540                 // FIXME Iwami 04/01/07: we should take care also of UTF16 surrogates here.
541                 for (int i = 0; i < commit_string.size(); ++i) {
542                         QKeyEvent ev(QEvent::KeyPress, key, Qt::NoModifier, commit_string[i]);
543                         keyPressEvent(&ev);
544                 }
545         }
546
547         // Hide the cursor during the kana-kanji transformation.
548         if (preedit_string.empty())
549                 startBlinkingCursor();
550         else
551                 stopBlinkingCursor();
552
553         // last_width : for checking if last preedit string was/wasn't empty.
554         static bool last_width = false;
555         if (!last_width && preedit_string.empty()) {
556                 // if last_width is last length of preedit string.
557                 e->accept();
558                 return;
559         }
560
561         GuiPainter pain(&screen_);
562         buffer_view_->updateMetrics(false);
563         buffer_view_->draw(pain);
564         Font font = buffer_view_->cursor().getFont();
565         FontMetrics const & fm = theFontMetrics(font);
566         int height = fm.maxHeight();
567         int cur_x = cursor_->rect().left();
568         int cur_y = cursor_->rect().bottom();
569
570         // redraw area of preedit string.
571         update(0, cur_y - height, GuiWorkArea::width(),
572                 (height + 1) * preedit_lines_);
573
574         if (preedit_string.empty()) {
575                 last_width = false;
576                 preedit_lines_ = 1;
577                 e->accept();
578                 return;
579         }
580         last_width = true;
581
582         // att : stores an IM attribute.
583         QList<QInputMethodEvent::Attribute> const & att = e->attributes();
584
585         // get attributes of input method cursor.
586         // cursor_pos : cursor position in preedit string.
587         size_t cursor_pos = 0;
588         bool cursor_is_visible = false;
589         for (int i = 0; i < att.size(); ++i) {
590                 if (att.at(i).type == QInputMethodEvent::Cursor) {
591                         cursor_pos = att.at(i).start;
592                         cursor_is_visible = att.at(i).length != 0;
593                         break;
594                 }
595         }
596
597         size_t preedit_length = preedit_string.length();
598
599         // get position of selection in input method.
600         // FIXME: isn't there a way to do this simplier?
601         // rStart : cursor position in selected string in IM.
602         size_t rStart = 0;
603         // rLength : selected string length in IM.
604         size_t rLength = 0;
605         if (cursor_pos < preedit_length) {
606                 for (int i = 0; i < att.size(); ++i) {
607                         if (att.at(i).type == QInputMethodEvent::TextFormat) {
608                                 if (att.at(i).start <= int(cursor_pos)
609                                         && int(cursor_pos) < att.at(i).start + att.at(i).length) {
610                                                 rStart = att.at(i).start;
611                                                 rLength = att.at(i).length;
612                                                 if (!cursor_is_visible)
613                                                         cursor_pos += rLength;
614                                                 break;
615                                 }
616                         }
617                 }
618         }
619         else {
620                 rStart = cursor_pos;
621                 rLength = 0;
622         }
623
624         int const right_margin = rightMargin();
625         Painter::preedit_style ps;
626         // Most often there would be only one line:
627         preedit_lines_ = 1;
628         for (size_t pos = 0; pos != preedit_length; ++pos) {
629                 char_type const typed_char = preedit_string[pos];
630                 // reset preedit string style
631                 ps = Painter::preedit_default;
632
633                 // if we reached the right extremity of the screen, go to next line.
634                 if (cur_x + fm.width(typed_char) > GuiWorkArea::width() - right_margin) {
635                         cur_x = right_margin;
636                         cur_y += height + 1;
637                         ++preedit_lines_;
638                 }
639                 // preedit strings are displayed with dashed underline
640                 // and partial strings are displayed white on black indicating
641                 // that we are in selecting mode in the input method.
642                 // FIXME: rLength == preedit_length is not a changing condition
643                 // FIXME: should be put out of the loop.
644                 if (pos >= rStart
645                         && pos < rStart + rLength
646                         && !(cursor_pos < rLength && rLength == preedit_length))
647                         ps = Painter::preedit_selecting;
648
649                 if (pos == cursor_pos
650                         && (cursor_pos < rLength && rLength == preedit_length))
651                         ps = Painter::preedit_cursor;
652
653                 // draw one character and update cur_x.
654                 cur_x += pain.preeditText(cur_x, cur_y, typed_char, font, ps);
655         }
656
657         // update the preedit string screen area.
658         update(0, cur_y - preedit_lines_*height, GuiWorkArea::width(),
659                 (height + 1) * preedit_lines_);
660
661         // Don't forget to accept the event!
662         e->accept();
663 }
664
665
666 QVariant GuiWorkArea::inputMethodQuery(Qt::InputMethodQuery query) const
667 {
668         QRect cur_r(0,0,0,0);
669         switch (query) {
670                 // this is the CJK-specific composition window position.
671                 case Qt::ImMicroFocus:
672                         cur_r = cursor_->rect();
673                         if (preedit_lines_ != 1)
674                                 cur_r.moveLeft(10);
675                         cur_r.moveBottom(cur_r.bottom() + cur_r.height() * preedit_lines_);
676                         // return lower right of cursor in LyX.
677                         return cur_r;
678                 default:
679                         return QWidget::inputMethodQuery(query);
680         }
681 }
682
683 } // namespace frontend
684 } // namespace lyx
685
686 #include "GuiWorkArea_moc.cpp"