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