]> cloud.milkyroute.net Git - dolphin.git/blob - src/kitemviews/kitemlistcontroller.cpp
Improve the autoscrolling for the rubberband selection
[dolphin.git] / src / kitemviews / kitemlistcontroller.cpp
1 /***************************************************************************
2 * Copyright (C) 2011 by Peter Penz <peter.penz19@gmail.com> *
3 * *
4 * Based on the Itemviews NG project from Trolltech Labs: *
5 * http://qt.gitorious.org/qt-labs/itemviews-ng *
6 * *
7 * This program is free software; you can redistribute it and/or modify *
8 * it under the terms of the GNU General Public License as published by *
9 * the Free Software Foundation; either version 2 of the License, or *
10 * (at your option) any later version. *
11 * *
12 * This program is distributed in the hope that it will be useful, *
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
15 * GNU General Public License for more details. *
16 * *
17 * You should have received a copy of the GNU General Public License *
18 * along with this program; if not, write to the *
19 * Free Software Foundation, Inc., *
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
21 ***************************************************************************/
22
23 #include "kitemlistcontroller.h"
24
25 #include "kitemlistview.h"
26 #include "kitemlistrubberband_p.h"
27 #include "kitemlistselectionmanager.h"
28
29 #include <QApplication>
30 #include <QDrag>
31 #include <QEvent>
32 #include <QGraphicsSceneEvent>
33 #include <QMimeData>
34
35 #include <KGlobalSettings>
36 #include <KDebug>
37
38 KItemListController::KItemListController(QObject* parent) :
39 QObject(parent),
40 m_dragging(false),
41 m_selectionBehavior(NoSelection),
42 m_model(0),
43 m_view(0),
44 m_selectionManager(new KItemListSelectionManager(this)),
45 m_pressedIndex(-1),
46 m_pressedMousePos(),
47 m_oldSelection()
48 {
49 }
50
51 KItemListController::~KItemListController()
52 {
53 }
54
55 void KItemListController::setModel(KItemModelBase* model)
56 {
57 if (m_model == model) {
58 return;
59 }
60
61 KItemModelBase* oldModel = m_model;
62 m_model = model;
63
64 if (m_view) {
65 m_view->setModel(m_model);
66 }
67
68 m_selectionManager->setModel(m_model);
69
70 emit modelChanged(m_model, oldModel);
71 }
72
73 KItemModelBase* KItemListController::model() const
74 {
75 return m_model;
76 }
77
78 KItemListSelectionManager* KItemListController::selectionManager() const
79 {
80 return m_selectionManager;
81 }
82
83 void KItemListController::setView(KItemListView* view)
84 {
85 if (m_view == view) {
86 return;
87 }
88
89 KItemListView* oldView = m_view;
90 if (oldView) {
91 disconnect(oldView, SIGNAL(offsetChanged(qreal,qreal)), this, SLOT(slotViewOffsetChanged(qreal,qreal)));
92 }
93
94 m_view = view;
95
96 if (m_view) {
97 m_view->setController(this);
98 m_view->setModel(m_model);
99 connect(m_view, SIGNAL(offsetChanged(qreal,qreal)), this, SLOT(slotViewOffsetChanged(qreal,qreal)));
100 }
101
102 emit viewChanged(m_view, oldView);
103 }
104
105 KItemListView* KItemListController::view() const
106 {
107 return m_view;
108 }
109
110 void KItemListController::setSelectionBehavior(SelectionBehavior behavior)
111 {
112 m_selectionBehavior = behavior;
113 }
114
115 KItemListController::SelectionBehavior KItemListController::selectionBehavior() const
116 {
117 return m_selectionBehavior;
118 }
119
120 bool KItemListController::showEvent(QShowEvent* event)
121 {
122 Q_UNUSED(event);
123 return false;
124 }
125
126 bool KItemListController::hideEvent(QHideEvent* event)
127 {
128 Q_UNUSED(event);
129 return false;
130 }
131
132 bool KItemListController::keyPressEvent(QKeyEvent* event)
133 {
134 const bool shiftPressed = event->modifiers() & Qt::ShiftModifier;
135 const bool controlPressed = event->modifiers() & Qt::ControlModifier;
136 const bool shiftOrControlPressed = shiftPressed || controlPressed;
137
138 int index = m_selectionManager->currentItem();
139 const int itemCount = m_model->count();
140 const int itemsPerRow = m_view->itemsPerOffset();
141
142 // For horizontal scroll orientation, transform
143 // the arrow keys to simplify the event handling.
144 int key = event->key();
145 if (m_view->scrollOrientation() == Qt::Horizontal) {
146 switch (key) {
147 case Qt::Key_Up: key = Qt::Key_Left; break;
148 case Qt::Key_Down: key = Qt::Key_Right; break;
149 case Qt::Key_Left: key = Qt::Key_Up; break;
150 case Qt::Key_Right: key = Qt::Key_Down; break;
151 default: break;
152 }
153 }
154
155 switch (key) {
156 case Qt::Key_Home:
157 index = 0;
158 break;
159
160 case Qt::Key_End:
161 index = itemCount - 1;
162 break;
163
164 case Qt::Key_Left:
165 if (index > 0) {
166 index--;
167 }
168 break;
169
170 case Qt::Key_Right:
171 if (index < itemCount - 1) {
172 index++;
173 }
174 break;
175
176 case Qt::Key_Up:
177 if (index >= itemsPerRow) {
178 index -= itemsPerRow;
179 }
180 break;
181
182 case Qt::Key_Down:
183 if (index + itemsPerRow < itemCount) {
184 // We are not in the last row yet.
185 index += itemsPerRow;
186 }
187 else {
188 // We are either in the last row already, or we are in the second-last row,
189 // and there is no item below the current item.
190 // In the latter case, we jump to the very last item.
191 const int currentColumn = index % itemsPerRow;
192 const int lastItemColumn = (itemCount - 1) % itemsPerRow;
193 const bool inLastRow = currentColumn < lastItemColumn;
194 if (!inLastRow) {
195 index = itemCount - 1;
196 }
197 }
198 break;
199
200 case Qt::Key_Space:
201 if (controlPressed) {
202 m_selectionManager->endAnchoredSelection();
203 m_selectionManager->setSelected(index, 1, KItemListSelectionManager::Toggle);
204 m_selectionManager->beginAnchoredSelection(index);
205 }
206
207 default:
208 break;
209 }
210
211 if (m_selectionManager->currentItem() != index) {
212 if (controlPressed) {
213 m_selectionManager->endAnchoredSelection();
214 }
215
216 m_selectionManager->setCurrentItem(index);
217
218 if (!shiftOrControlPressed || m_selectionBehavior == SingleSelection) {
219 m_selectionManager->clearSelection();
220 m_selectionManager->setSelected(index, 1);
221 }
222
223 if (!shiftPressed) {
224 m_selectionManager->beginAnchoredSelection(index);
225 }
226 }
227 return true;
228 }
229
230 bool KItemListController::inputMethodEvent(QInputMethodEvent* event)
231 {
232 Q_UNUSED(event);
233 return false;
234 }
235
236 bool KItemListController::mousePressEvent(QGraphicsSceneMouseEvent* event, const QTransform& transform)
237 {
238 if (!m_view) {
239 return false;
240 }
241
242 m_dragging = false;
243 m_pressedMousePos = transform.map(event->pos());
244 m_pressedIndex = m_view->itemAt(m_pressedMousePos);
245
246 if (m_view->isAboveExpansionToggle(m_pressedIndex, m_pressedMousePos)) {
247 return true;
248 }
249
250 const bool shiftPressed = event->modifiers() & Qt::ShiftModifier;
251 const bool controlPressed = event->modifiers() & Qt::ControlModifier;
252
253 if (m_selectionBehavior == SingleSelection) {
254 m_selectionManager->clearSelection();
255 }
256
257 if (!shiftPressed) {
258 // Finish the anchored selection before the current index is changed
259 m_selectionManager->endAnchoredSelection();
260 }
261
262 if (m_pressedIndex >= 0) {
263 m_selectionManager->setCurrentItem(m_pressedIndex);
264
265 switch (m_selectionBehavior) {
266 case NoSelection:
267 break;
268
269 case SingleSelection:
270 m_selectionManager->setSelected(m_pressedIndex);
271 break;
272
273 case MultiSelection:
274 if (controlPressed) {
275 m_selectionManager->setSelected(m_pressedIndex, 1, KItemListSelectionManager::Toggle);
276 m_selectionManager->beginAnchoredSelection(m_pressedIndex);
277 } else if (!shiftPressed || !m_selectionManager->isAnchoredSelectionActive()) {
278 // Select the pressed item and start a new anchored selection
279 m_selectionManager->setSelected(m_pressedIndex, 1, KItemListSelectionManager::Select);
280 m_selectionManager->beginAnchoredSelection(m_pressedIndex);
281 }
282 break;
283
284 default:
285 Q_ASSERT(false);
286 break;
287 }
288
289 return true;
290 } else {
291 KItemListRubberBand* rubberBand = m_view->rubberBand();
292 QPointF startPos = m_pressedMousePos;
293 if (m_view->scrollOrientation() == Qt::Vertical) {
294 startPos.ry() += m_view->offset();
295 if (m_view->itemSize().width() < 0) {
296 // Use a special rubberband for views that have only one column and
297 // expand the rubberband to use the whole width of the view.
298 startPos.setX(0);
299 }
300 } else {
301 startPos.rx() += m_view->offset();
302 }
303
304 m_oldSelection = m_selectionManager->selectedItems();
305 rubberBand->setStartPosition(startPos);
306 rubberBand->setEndPosition(startPos);
307 rubberBand->setActive(true);
308 connect(rubberBand, SIGNAL(endPositionChanged(QPointF,QPointF)), this, SLOT(slotRubberBandChanged()));
309 m_view->setAutoScroll(true);
310 }
311
312 return false;
313 }
314
315 bool KItemListController::mouseMoveEvent(QGraphicsSceneMouseEvent* event, const QTransform& transform)
316 {
317 if (!m_view) {
318 return false;
319 }
320
321 if (m_pressedIndex >= 0) {
322 // Check whether a dragging should be started
323 if (!m_dragging && (event->buttons() & Qt::LeftButton)) {
324 const QPointF pos = transform.map(event->pos());
325 const qreal minDragDiff = 4;
326 const bool hasMinDragDiff = qAbs(pos.x() - m_pressedMousePos.x()) >= minDragDiff ||
327 qAbs(pos.y() - m_pressedMousePos.y()) >= minDragDiff;
328 if (hasMinDragDiff && startDragging()) {
329 m_dragging = true;
330 }
331 }
332 } else {
333 KItemListRubberBand* rubberBand = m_view->rubberBand();
334 if (rubberBand->isActive()) {
335 QPointF endPos = transform.map(event->pos());
336 if (m_view->scrollOrientation() == Qt::Vertical) {
337 endPos.ry() += m_view->offset();
338 if (m_view->itemSize().width() < 0) {
339 // Use a special rubberband for views that have only one column and
340 // expand the rubberband to use the whole width of the view.
341 endPos.setX(m_view->size().width());
342 }
343 } else {
344 endPos.rx() += m_view->offset();
345 }
346 rubberBand->setEndPosition(endPos);
347 }
348 }
349
350 return false;
351 }
352
353 bool KItemListController::mouseReleaseEvent(QGraphicsSceneMouseEvent* event, const QTransform& transform)
354 {
355 if (!m_view) {
356 return false;
357 }
358
359 const bool shiftOrControlPressed = event->modifiers() & Qt::ShiftModifier ||
360 event->modifiers() & Qt::ControlModifier;
361
362 bool clearSelection = !shiftOrControlPressed && !m_dragging && !(event->button() == Qt::RightButton);
363
364 KItemListRubberBand* rubberBand = m_view->rubberBand();
365 if (rubberBand->isActive()) {
366 disconnect(rubberBand, SIGNAL(endPositionChanged(QPointF,QPointF)), this, SLOT(slotRubberBandChanged()));
367 rubberBand->setActive(false);
368 m_oldSelection.clear();
369 m_view->setAutoScroll(false);
370
371 if (rubberBand->startPosition() != rubberBand->endPosition()) {
372 clearSelection = false;
373 }
374 }
375
376 const QPointF pos = transform.map(event->pos());
377 const int index = m_view->itemAt(pos);
378
379 if (index >= 0 && index == m_pressedIndex) {
380 // The release event is done above the same item as the press event
381
382 if (clearSelection) {
383 // Clear the previous selection but reselect the current index
384 m_selectionManager->setSelectedItems(QSet<int>() << index);
385 }
386
387 bool emitItemClicked = true;
388 if (event->button() & Qt::LeftButton) {
389 if (m_view->isAboveExpansionToggle(index, pos)) {
390 emit itemExpansionToggleClicked(index);
391 emitItemClicked = false;
392 } else if (shiftOrControlPressed || !KGlobalSettings::singleClick()) {
393 emitItemClicked = false;
394 }
395 }
396
397 if (emitItemClicked) {
398 emit itemClicked(index, event->button());
399 }
400 } else if (clearSelection) {
401 m_selectionManager->clearSelection();
402 }
403
404 m_dragging = false;
405 m_pressedMousePos = QPointF();
406 m_pressedIndex = -1;
407 return false;
408 }
409
410 bool KItemListController::mouseDoubleClickEvent(QGraphicsSceneMouseEvent* event, const QTransform& transform)
411 {
412 const QPointF pos = transform.map(event->pos());
413 const int index = m_view->itemAt(pos);
414
415 bool emitItemClicked = !KGlobalSettings::singleClick() &&
416 (event->button() & Qt::LeftButton) &&
417 index >= 0 && index < m_model->count();
418 if (emitItemClicked) {
419 emit itemClicked(index, event->button());
420 }
421 return false;
422 }
423
424 bool KItemListController::dragEnterEvent(QGraphicsSceneDragDropEvent* event, const QTransform& transform)
425 {
426 Q_UNUSED(event);
427 Q_UNUSED(transform);
428 return false;
429 }
430
431 bool KItemListController::dragLeaveEvent(QGraphicsSceneDragDropEvent* event, const QTransform& transform)
432 {
433 Q_UNUSED(event);
434 Q_UNUSED(transform);
435 return false;
436 }
437
438 bool KItemListController::dragMoveEvent(QGraphicsSceneDragDropEvent* event, const QTransform& transform)
439 {
440 Q_UNUSED(event);
441 Q_UNUSED(transform);
442 return false;
443 }
444
445 bool KItemListController::dropEvent(QGraphicsSceneDragDropEvent* event, const QTransform& transform)
446 {
447 Q_UNUSED(event);
448 Q_UNUSED(transform);
449
450 m_dragging = false;
451 return false;
452 }
453
454 bool KItemListController::hoverEnterEvent(QGraphicsSceneHoverEvent* event, const QTransform& transform)
455 {
456 Q_UNUSED(event);
457 Q_UNUSED(transform);
458 return false;
459 }
460
461 bool KItemListController::hoverMoveEvent(QGraphicsSceneHoverEvent* event, const QTransform& transform)
462 {
463 // The implementation assumes that only one item can get hovered no matter
464 // whether they overlap or not.
465
466 Q_UNUSED(transform);
467 if (!m_model || !m_view) {
468 return false;
469 }
470
471 // Search the previously hovered item that might get unhovered
472 KItemListWidget* unhoveredWidget = 0;
473 foreach (KItemListWidget* widget, m_view->visibleItemListWidgets()) {
474 if (widget->isHovered()) {
475 unhoveredWidget = widget;
476 break;
477 }
478 }
479
480 // Search the currently hovered item
481 KItemListWidget* hoveredWidget = 0;
482 foreach (KItemListWidget* widget, m_view->visibleItemListWidgets()) {
483 const QPointF mappedPos = widget->mapFromItem(m_view, event->pos());
484
485 const bool hovered = widget->contains(mappedPos) &&
486 !widget->expansionToggleRect().contains(mappedPos) &&
487 !widget->selectionToggleRect().contains(mappedPos);
488 if (hovered) {
489 hoveredWidget = widget;
490 break;
491 }
492 }
493
494 if (unhoveredWidget != hoveredWidget) {
495 if (unhoveredWidget) {
496 unhoveredWidget->setHovered(false);
497 emit itemUnhovered(unhoveredWidget->index());
498 }
499
500 if (hoveredWidget) {
501 hoveredWidget->setHovered(true);
502 emit itemHovered(hoveredWidget->index());
503 }
504 }
505
506 return false;
507 }
508
509 bool KItemListController::hoverLeaveEvent(QGraphicsSceneHoverEvent* event, const QTransform& transform)
510 {
511 Q_UNUSED(event);
512 Q_UNUSED(transform);
513
514 if (!m_model || !m_view) {
515 return false;
516 }
517
518 foreach (KItemListWidget* widget, m_view->visibleItemListWidgets()) {
519 if (widget->isHovered()) {
520 widget->setHovered(false);
521 emit itemUnhovered(widget->index());
522 }
523 }
524 return false;
525 }
526
527 bool KItemListController::wheelEvent(QGraphicsSceneWheelEvent* event, const QTransform& transform)
528 {
529 Q_UNUSED(event);
530 Q_UNUSED(transform);
531 return false;
532 }
533
534 bool KItemListController::resizeEvent(QGraphicsSceneResizeEvent* event, const QTransform& transform)
535 {
536 Q_UNUSED(event);
537 Q_UNUSED(transform);
538 return false;
539 }
540
541 bool KItemListController::processEvent(QEvent* event, const QTransform& transform)
542 {
543 if (!event) {
544 return false;
545 }
546
547 switch (event->type()) {
548 case QEvent::KeyPress:
549 return keyPressEvent(static_cast<QKeyEvent*>(event));
550 case QEvent::InputMethod:
551 return inputMethodEvent(static_cast<QInputMethodEvent*>(event));
552 case QEvent::GraphicsSceneMousePress:
553 return mousePressEvent(static_cast<QGraphicsSceneMouseEvent*>(event), QTransform());
554 case QEvent::GraphicsSceneMouseMove:
555 return mouseMoveEvent(static_cast<QGraphicsSceneMouseEvent*>(event), QTransform());
556 case QEvent::GraphicsSceneMouseRelease:
557 return mouseReleaseEvent(static_cast<QGraphicsSceneMouseEvent*>(event), QTransform());
558 case QEvent::GraphicsSceneMouseDoubleClick:
559 return mouseDoubleClickEvent(static_cast<QGraphicsSceneMouseEvent*>(event), QTransform());
560 case QEvent::GraphicsSceneWheel:
561 return wheelEvent(static_cast<QGraphicsSceneWheelEvent*>(event), QTransform());
562 case QEvent::GraphicsSceneDragEnter:
563 return dragEnterEvent(static_cast<QGraphicsSceneDragDropEvent*>(event), QTransform());
564 case QEvent::GraphicsSceneDragLeave:
565 return dragLeaveEvent(static_cast<QGraphicsSceneDragDropEvent*>(event), QTransform());
566 case QEvent::GraphicsSceneDragMove:
567 return dragMoveEvent(static_cast<QGraphicsSceneDragDropEvent*>(event), QTransform());
568 case QEvent::GraphicsSceneDrop:
569 return dropEvent(static_cast<QGraphicsSceneDragDropEvent*>(event), QTransform());
570 case QEvent::GraphicsSceneHoverEnter:
571 return hoverEnterEvent(static_cast<QGraphicsSceneHoverEvent*>(event), QTransform());
572 case QEvent::GraphicsSceneHoverMove:
573 return hoverMoveEvent(static_cast<QGraphicsSceneHoverEvent*>(event), QTransform());
574 case QEvent::GraphicsSceneHoverLeave:
575 return hoverLeaveEvent(static_cast<QGraphicsSceneHoverEvent*>(event), QTransform());
576 case QEvent::GraphicsSceneResize:
577 return resizeEvent(static_cast<QGraphicsSceneResizeEvent*>(event), transform);
578 default:
579 break;
580 }
581
582 return false;
583 }
584
585 void KItemListController::slotViewOffsetChanged(qreal current, qreal previous)
586 {
587 if (!m_view) {
588 return;
589 }
590
591 KItemListRubberBand* rubberBand = m_view->rubberBand();
592 if (rubberBand->isActive()) {
593 const qreal diff = current - previous;
594 // TODO: Ideally just QCursor::pos() should be used as
595 // new end-position but it seems there is no easy way
596 // to have something like QWidget::mapFromGlobal() for QGraphicsWidget
597 // (... or I just missed an easy way to do the mapping)
598 QPointF endPos = rubberBand->endPosition();
599 if (m_view->scrollOrientation() == Qt::Vertical) {
600 endPos.ry() += diff;
601 } else {
602 endPos.rx() += diff;
603 }
604
605 rubberBand->setEndPosition(endPos);
606 }
607 }
608
609 void KItemListController::slotRubberBandChanged()
610 {
611 if (!m_view || !m_model || m_model->count() <= 0) {
612 return;
613 }
614
615 const KItemListRubberBand* rubberBand = m_view->rubberBand();
616 const QPointF startPos = rubberBand->startPosition();
617 const QPointF endPos = rubberBand->endPosition();
618 QRectF rubberBandRect = QRectF(startPos, endPos).normalized();
619
620 const bool scrollVertical = (m_view->scrollOrientation() == Qt::Vertical);
621 if (scrollVertical) {
622 rubberBandRect.translate(0, -m_view->offset());
623 } else {
624 rubberBandRect.translate(-m_view->offset(), 0);
625 }
626
627 if (!m_oldSelection.isEmpty()) {
628 // Clear the old selection that was available before the rubberband has
629 // been activated in case if no Shift- or Control-key are pressed
630 const bool shiftOrControlPressed = QApplication::keyboardModifiers() & Qt::ShiftModifier ||
631 QApplication::keyboardModifiers() & Qt::ControlModifier;
632 if (!shiftOrControlPressed) {
633 m_oldSelection.clear();
634 }
635 }
636
637 QSet<int> selectedItems;
638
639 // Select all visible items that intersect with the rubberband
640 foreach (const KItemListWidget* widget, m_view->visibleItemListWidgets()) {
641 const int index = widget->index();
642
643 const QRectF widgetRect = m_view->itemBoundingRect(index);
644 if (widgetRect.intersects(rubberBandRect)) {
645 const QRectF iconRect = widget->iconBoundingRect().translated(widgetRect.topLeft());
646 const QRectF textRect = widget->textBoundingRect().translated(widgetRect.topLeft());
647 if (iconRect.intersects(rubberBandRect) || textRect.intersects(rubberBandRect)) {
648 selectedItems.insert(index);
649 }
650 }
651 }
652
653 // Select all invisible items that intersect with the rubberband. Instead of
654 // iterating all items only the area which might be touched by the rubberband
655 // will be checked.
656 const bool increaseIndex = scrollVertical ?
657 startPos.y() > endPos.y(): startPos.x() > endPos.x();
658
659 int index = increaseIndex ? m_view->lastVisibleIndex() + 1 : m_view->firstVisibleIndex() - 1;
660 bool selectionFinished = false;
661 do {
662 const QRectF widgetRect = m_view->itemBoundingRect(index);
663 if (widgetRect.intersects(rubberBandRect)) {
664 selectedItems.insert(index);
665 }
666
667 if (increaseIndex) {
668 ++index;
669 selectionFinished = (index >= m_model->count()) ||
670 ( scrollVertical && widgetRect.top() > rubberBandRect.bottom()) ||
671 (!scrollVertical && widgetRect.left() > rubberBandRect.right());
672 } else {
673 --index;
674 selectionFinished = (index < 0) ||
675 ( scrollVertical && widgetRect.bottom() < rubberBandRect.top()) ||
676 (!scrollVertical && widgetRect.right() < rubberBandRect.left());
677 }
678 } while (!selectionFinished);
679
680 m_selectionManager->setSelectedItems(selectedItems + m_oldSelection);
681 }
682
683 bool KItemListController::startDragging()
684 {
685 if (!m_view || !m_model) {
686 return false;
687 }
688
689 const QSet<int> selectedItems = m_selectionManager->selectedItems();
690 QMimeData* data = m_model->createMimeData(selectedItems);
691 if (!data) {
692 return false;
693 }
694
695 // The created drag object will be owned and deleted
696 // by QApplication::activeWindow().
697 QDrag* drag = new QDrag(QApplication::activeWindow());
698 drag->setMimeData(data);
699
700 const QPixmap pixmap = m_view->createDragPixmap(selectedItems);
701 drag->setPixmap(pixmap);
702
703 drag->exec(Qt::MoveAction | Qt::CopyAction | Qt::LinkAction, Qt::IgnoreAction);
704 return true;
705 }
706
707 #include "kitemlistcontroller.moc"