1 /***************************************************************************
2 * Copyright (C) 2011 by Peter Penz <peter.penz19@gmail.com> *
4 * Based on the Itemviews NG project from Trolltech Labs: *
5 * http://qt.gitorious.org/qt-labs/itemviews-ng *
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. *
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. *
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 ***************************************************************************/
23 #include "kitemlistcontroller.h"
25 #include "kitemlistview.h"
26 #include "kitemlistrubberband_p.h"
27 #include "kitemlistselectionmanager.h"
28 #include "kitemlistkeyboardsearchmanager_p.h"
30 #include <QApplication>
33 #include <QGraphicsSceneEvent>
36 #include <KGlobalSettings>
39 KItemListController::KItemListController(QObject
* parent
) :
41 m_selectionBehavior(NoSelection
),
44 m_selectionManager(new KItemListSelectionManager(this)),
45 m_keyboardManager(new KItemListKeyboardSearchManager(this)),
50 connect(m_keyboardManager
, SIGNAL(changeCurrentItem(QString
,bool)),
51 this, SLOT(slotChangeCurrentItem(QString
,bool)));
54 KItemListController::~KItemListController()
58 void KItemListController::setModel(KItemModelBase
* model
)
60 if (m_model
== model
) {
64 KItemModelBase
* oldModel
= m_model
;
68 m_view
->setModel(m_model
);
71 m_selectionManager
->setModel(m_model
);
73 emit
modelChanged(m_model
, oldModel
);
76 KItemModelBase
* KItemListController::model() const
81 KItemListSelectionManager
* KItemListController::selectionManager() const
83 return m_selectionManager
;
86 void KItemListController::setView(KItemListView
* view
)
92 KItemListView
* oldView
= m_view
;
94 disconnect(oldView
, SIGNAL(scrollOffsetChanged(qreal
,qreal
)), this, SLOT(slotViewScrollOffsetChanged(qreal
,qreal
)));
100 m_view
->setController(this);
101 m_view
->setModel(m_model
);
102 connect(m_view
, SIGNAL(scrollOffsetChanged(qreal
,qreal
)), this, SLOT(slotViewScrollOffsetChanged(qreal
,qreal
)));
105 emit
viewChanged(m_view
, oldView
);
108 KItemListView
* KItemListController::view() const
113 void KItemListController::setSelectionBehavior(SelectionBehavior behavior
)
115 m_selectionBehavior
= behavior
;
118 KItemListController::SelectionBehavior
KItemListController::selectionBehavior() const
120 return m_selectionBehavior
;
123 bool KItemListController::showEvent(QShowEvent
* event
)
129 bool KItemListController::hideEvent(QHideEvent
* event
)
135 bool KItemListController::keyPressEvent(QKeyEvent
* event
)
137 const bool shiftPressed
= event
->modifiers() & Qt::ShiftModifier
;
138 const bool controlPressed
= event
->modifiers() & Qt::ControlModifier
;
139 const bool shiftOrControlPressed
= shiftPressed
|| controlPressed
;
141 int index
= m_selectionManager
->currentItem();
142 const int itemCount
= m_model
->count();
143 const int itemsPerRow
= m_view
->itemsPerOffset();
145 // For horizontal scroll orientation, transform
146 // the arrow keys to simplify the event handling.
147 int key
= event
->key();
148 if (m_view
->scrollOrientation() == Qt::Horizontal
) {
150 case Qt::Key_Up
: key
= Qt::Key_Left
; break;
151 case Qt::Key_Down
: key
= Qt::Key_Right
; break;
152 case Qt::Key_Left
: key
= Qt::Key_Up
; break;
153 case Qt::Key_Right
: key
= Qt::Key_Down
; break;
164 index
= itemCount
- 1;
174 if (index
< itemCount
- 1) {
180 if (index
>= itemsPerRow
) {
181 index
-= itemsPerRow
;
186 if (index
+ itemsPerRow
< itemCount
) {
187 // We are not in the last row yet.
188 index
+= itemsPerRow
;
191 // We are either in the last row already, or we are in the second-last row,
192 // and there is no item below the current item.
193 // In the latter case, we jump to the very last item.
194 const int currentColumn
= index
% itemsPerRow
;
195 const int lastItemColumn
= (itemCount
- 1) % itemsPerRow
;
196 const bool inLastRow
= currentColumn
< lastItemColumn
;
198 index
= itemCount
- 1;
205 emit
itemActivated(index
);
209 if (controlPressed
) {
210 m_selectionManager
->endAnchoredSelection();
211 m_selectionManager
->setSelected(index
, 1, KItemListSelectionManager::Toggle
);
212 m_selectionManager
->beginAnchoredSelection(index
);
217 m_keyboardManager
->addKeys(event
->text());
221 if (m_selectionManager
->currentItem() != index
) {
222 if (controlPressed
) {
223 m_selectionManager
->endAnchoredSelection();
226 m_selectionManager
->setCurrentItem(index
);
228 if (!shiftOrControlPressed
|| m_selectionBehavior
== SingleSelection
) {
229 m_selectionManager
->clearSelection();
230 m_selectionManager
->setSelected(index
, 1);
234 m_selectionManager
->beginAnchoredSelection(index
);
240 void KItemListController::slotChangeCurrentItem(const QString
& text
, bool searchFromNextItem
)
245 const int currentIndex
= m_selectionManager
->currentItem();
247 if (searchFromNextItem
) {
248 index
= m_model
->indexForKeyboardSearch(text
, (currentIndex
+ 1) % m_model
->count());
251 index
= m_model
->indexForKeyboardSearch(text
, currentIndex
);
254 m_selectionManager
->setCurrentItem(index
);
255 m_selectionManager
->clearSelection();
256 m_selectionManager
->setSelected(index
, 1);
257 m_selectionManager
->beginAnchoredSelection(index
);
261 bool KItemListController::inputMethodEvent(QInputMethodEvent
* event
)
267 bool KItemListController::mousePressEvent(QGraphicsSceneMouseEvent
* event
, const QTransform
& transform
)
273 m_pressedMousePos
= transform
.map(event
->pos());
274 m_pressedIndex
= m_view
->itemAt(m_pressedMousePos
);
276 if (m_view
->isAboveExpansionToggle(m_pressedIndex
, m_pressedMousePos
)) {
277 m_selectionManager
->setCurrentItem(m_pressedIndex
);
281 const bool shiftPressed
= event
->modifiers() & Qt::ShiftModifier
;
282 const bool controlPressed
= event
->modifiers() & Qt::ControlModifier
;
284 if (m_selectionBehavior
== SingleSelection
) {
285 m_selectionManager
->clearSelection();
289 // Finish the anchored selection before the current index is changed
290 m_selectionManager
->endAnchoredSelection();
293 if (m_pressedIndex
>= 0) {
294 m_selectionManager
->setCurrentItem(m_pressedIndex
);
296 switch (m_selectionBehavior
) {
300 case SingleSelection
:
301 m_selectionManager
->setSelected(m_pressedIndex
);
305 if (controlPressed
) {
306 m_selectionManager
->setSelected(m_pressedIndex
, 1, KItemListSelectionManager::Toggle
);
307 m_selectionManager
->beginAnchoredSelection(m_pressedIndex
);
308 } else if (event
->buttons() & Qt::RightButton
) {
309 // Only clear the selection if a context menu is requested above a non-selected item
310 if (!m_selectionManager
->selectedItems().contains(m_pressedIndex
)) {
311 m_selectionManager
->setSelectedItems(QSet
<int>() << m_pressedIndex
);
313 } else if (!shiftPressed
|| !m_selectionManager
->isAnchoredSelectionActive()) {
314 // Select the pressed item and start a new anchored selection
315 m_selectionManager
->setSelected(m_pressedIndex
, 1, KItemListSelectionManager::Select
);
316 m_selectionManager
->beginAnchoredSelection(m_pressedIndex
);
325 if (event
->buttons() & Qt::RightButton
) {
326 emit
itemContextMenuRequested(m_pressedIndex
, event
->screenPos());
332 if (event
->buttons() & Qt::RightButton
) {
333 m_selectionManager
->clearSelection();
335 const QRectF headerBounds
= m_view
->headerBoundaries();
336 if (headerBounds
.contains(event
->pos())) {
337 emit
headerContextMenuRequested(event
->screenPos());
339 emit
viewContextMenuRequested(event
->screenPos());
344 KItemListRubberBand
* rubberBand
= m_view
->rubberBand();
345 QPointF startPos
= m_pressedMousePos
;
346 if (m_view
->scrollOrientation() == Qt::Vertical
) {
347 startPos
.ry() += m_view
->scrollOffset();
348 if (m_view
->itemSize().width() < 0) {
349 // Use a special rubberband for views that have only one column and
350 // expand the rubberband to use the whole width of the view.
354 startPos
.rx() += m_view
->scrollOffset();
357 m_oldSelection
= m_selectionManager
->selectedItems();
358 rubberBand
->setStartPosition(startPos
);
359 rubberBand
->setEndPosition(startPos
);
360 rubberBand
->setActive(true);
361 connect(rubberBand
, SIGNAL(endPositionChanged(QPointF
,QPointF
)), this, SLOT(slotRubberBandChanged()));
362 m_view
->setAutoScroll(true);
367 bool KItemListController::mouseMoveEvent(QGraphicsSceneMouseEvent
* event
, const QTransform
& transform
)
373 if (m_pressedIndex
>= 0) {
374 // Check whether a dragging should be started
375 if (event
->buttons() & Qt::LeftButton
) {
376 const QPointF pos
= transform
.map(event
->pos());
377 if ((pos
- m_pressedMousePos
).manhattanLength() >= QApplication::startDragDistance()) {
382 KItemListRubberBand
* rubberBand
= m_view
->rubberBand();
383 if (rubberBand
->isActive()) {
384 QPointF endPos
= transform
.map(event
->pos());
385 if (m_view
->scrollOrientation() == Qt::Vertical
) {
386 endPos
.ry() += m_view
->scrollOffset();
387 if (m_view
->itemSize().width() < 0) {
388 // Use a special rubberband for views that have only one column and
389 // expand the rubberband to use the whole width of the view.
390 endPos
.setX(m_view
->size().width());
393 endPos
.rx() += m_view
->scrollOffset();
395 rubberBand
->setEndPosition(endPos
);
402 bool KItemListController::mouseReleaseEvent(QGraphicsSceneMouseEvent
* event
, const QTransform
& transform
)
408 const bool shiftOrControlPressed
= event
->modifiers() & Qt::ShiftModifier
||
409 event
->modifiers() & Qt::ControlModifier
;
411 bool clearSelection
= !shiftOrControlPressed
&& event
->button() != Qt::RightButton
;
413 KItemListRubberBand
* rubberBand
= m_view
->rubberBand();
414 if (rubberBand
->isActive()) {
415 disconnect(rubberBand
, SIGNAL(endPositionChanged(QPointF
,QPointF
)), this, SLOT(slotRubberBandChanged()));
416 rubberBand
->setActive(false);
417 m_oldSelection
.clear();
418 m_view
->setAutoScroll(false);
420 if (rubberBand
->startPosition() != rubberBand
->endPosition()) {
421 clearSelection
= false;
425 const QPointF pos
= transform
.map(event
->pos());
426 const int index
= m_view
->itemAt(pos
);
428 if (index
>= 0 && index
== m_pressedIndex
) {
429 // The release event is done above the same item as the press event
431 if (clearSelection
) {
432 // Clear the previous selection but reselect the current index
433 m_selectionManager
->setSelectedItems(QSet
<int>() << index
);
436 if (event
->button() & Qt::LeftButton
) {
437 bool emitItemActivated
= true;
438 if (m_view
->isAboveExpansionToggle(index
, pos
)) {
439 emit
itemExpansionToggleClicked(index
);
440 emitItemActivated
= false;
441 } else if (shiftOrControlPressed
) {
442 // The mouse click should only update the selection, not trigger the item
443 emitItemActivated
= false;
444 } else if (!KGlobalSettings::singleClick()) {
445 emitItemActivated
= false;
447 if (emitItemActivated
) {
448 emit
itemActivated(index
);
450 } else if (event
->button() & Qt::MidButton
) {
451 emit
itemMiddleClicked(index
);
453 } else if (clearSelection
) {
454 m_selectionManager
->clearSelection();
457 m_pressedMousePos
= QPointF();
462 bool KItemListController::mouseDoubleClickEvent(QGraphicsSceneMouseEvent
* event
, const QTransform
& transform
)
464 const QPointF pos
= transform
.map(event
->pos());
465 const int index
= m_view
->itemAt(pos
);
467 bool emitItemActivated
= !KGlobalSettings::singleClick() &&
468 (event
->button() & Qt::LeftButton
) &&
469 index
>= 0 && index
< m_model
->count();
470 if (emitItemActivated
) {
471 emit
itemActivated(index
);
476 bool KItemListController::dragEnterEvent(QGraphicsSceneDragDropEvent
* event
, const QTransform
& transform
)
483 bool KItemListController::dragLeaveEvent(QGraphicsSceneDragDropEvent
* event
, const QTransform
& transform
)
490 bool KItemListController::dragMoveEvent(QGraphicsSceneDragDropEvent
* event
, const QTransform
& transform
)
493 if (!m_model
|| !m_view
) {
497 KItemListWidget
* oldHoveredWidget
= hoveredWidget();
498 KItemListWidget
* newHoveredWidget
= widgetForPos(event
->pos());
499 if (oldHoveredWidget
!= newHoveredWidget
) {
500 if (oldHoveredWidget
) {
501 oldHoveredWidget
->setHovered(false);
502 emit
itemUnhovered(oldHoveredWidget
->index());
505 if (newHoveredWidget
) {
506 const int index
= newHoveredWidget
->index();
507 if (m_model
->supportsDropping(index
)) {
508 newHoveredWidget
->setHovered(true);
510 emit
itemHovered(index
);
517 bool KItemListController::dropEvent(QGraphicsSceneDragDropEvent
* event
, const QTransform
& transform
)
524 const QPointF pos
= transform
.map(event
->pos());
525 const int index
= m_view
->itemAt(pos
);
526 emit
itemDropEvent(index
, event
);
531 bool KItemListController::hoverEnterEvent(QGraphicsSceneHoverEvent
* event
, const QTransform
& transform
)
538 bool KItemListController::hoverMoveEvent(QGraphicsSceneHoverEvent
* event
, const QTransform
& transform
)
541 if (!m_model
|| !m_view
) {
545 KItemListWidget
* oldHoveredWidget
= hoveredWidget();
546 KItemListWidget
* newHoveredWidget
= widgetForPos(event
->pos());
547 if (oldHoveredWidget
!= newHoveredWidget
) {
548 if (oldHoveredWidget
) {
549 oldHoveredWidget
->setHovered(false);
550 emit
itemUnhovered(oldHoveredWidget
->index());
553 if (newHoveredWidget
) {
554 newHoveredWidget
->setHovered(true);
555 emit
itemHovered(newHoveredWidget
->index());
562 bool KItemListController::hoverLeaveEvent(QGraphicsSceneHoverEvent
* event
, const QTransform
& transform
)
567 if (!m_model
|| !m_view
) {
571 foreach (KItemListWidget
* widget
, m_view
->visibleItemListWidgets()) {
572 if (widget
->isHovered()) {
573 widget
->setHovered(false);
574 emit
itemUnhovered(widget
->index());
580 bool KItemListController::wheelEvent(QGraphicsSceneWheelEvent
* event
, const QTransform
& transform
)
587 bool KItemListController::resizeEvent(QGraphicsSceneResizeEvent
* event
, const QTransform
& transform
)
594 bool KItemListController::processEvent(QEvent
* event
, const QTransform
& transform
)
600 switch (event
->type()) {
601 case QEvent::KeyPress
:
602 return keyPressEvent(static_cast<QKeyEvent
*>(event
));
603 case QEvent::InputMethod
:
604 return inputMethodEvent(static_cast<QInputMethodEvent
*>(event
));
605 case QEvent::GraphicsSceneMousePress
:
606 return mousePressEvent(static_cast<QGraphicsSceneMouseEvent
*>(event
), QTransform());
607 case QEvent::GraphicsSceneMouseMove
:
608 return mouseMoveEvent(static_cast<QGraphicsSceneMouseEvent
*>(event
), QTransform());
609 case QEvent::GraphicsSceneMouseRelease
:
610 return mouseReleaseEvent(static_cast<QGraphicsSceneMouseEvent
*>(event
), QTransform());
611 case QEvent::GraphicsSceneMouseDoubleClick
:
612 return mouseDoubleClickEvent(static_cast<QGraphicsSceneMouseEvent
*>(event
), QTransform());
613 case QEvent::GraphicsSceneWheel
:
614 return wheelEvent(static_cast<QGraphicsSceneWheelEvent
*>(event
), QTransform());
615 case QEvent::GraphicsSceneDragEnter
:
616 return dragEnterEvent(static_cast<QGraphicsSceneDragDropEvent
*>(event
), QTransform());
617 case QEvent::GraphicsSceneDragLeave
:
618 return dragLeaveEvent(static_cast<QGraphicsSceneDragDropEvent
*>(event
), QTransform());
619 case QEvent::GraphicsSceneDragMove
:
620 return dragMoveEvent(static_cast<QGraphicsSceneDragDropEvent
*>(event
), QTransform());
621 case QEvent::GraphicsSceneDrop
:
622 return dropEvent(static_cast<QGraphicsSceneDragDropEvent
*>(event
), QTransform());
623 case QEvent::GraphicsSceneHoverEnter
:
624 return hoverEnterEvent(static_cast<QGraphicsSceneHoverEvent
*>(event
), QTransform());
625 case QEvent::GraphicsSceneHoverMove
:
626 return hoverMoveEvent(static_cast<QGraphicsSceneHoverEvent
*>(event
), QTransform());
627 case QEvent::GraphicsSceneHoverLeave
:
628 return hoverLeaveEvent(static_cast<QGraphicsSceneHoverEvent
*>(event
), QTransform());
629 case QEvent::GraphicsSceneResize
:
630 return resizeEvent(static_cast<QGraphicsSceneResizeEvent
*>(event
), transform
);
638 void KItemListController::slotViewScrollOffsetChanged(qreal current
, qreal previous
)
644 KItemListRubberBand
* rubberBand
= m_view
->rubberBand();
645 if (rubberBand
->isActive()) {
646 const qreal diff
= current
- previous
;
647 // TODO: Ideally just QCursor::pos() should be used as
648 // new end-position but it seems there is no easy way
649 // to have something like QWidget::mapFromGlobal() for QGraphicsWidget
650 // (... or I just missed an easy way to do the mapping)
651 QPointF endPos
= rubberBand
->endPosition();
652 if (m_view
->scrollOrientation() == Qt::Vertical
) {
658 rubberBand
->setEndPosition(endPos
);
662 void KItemListController::slotRubberBandChanged()
664 if (!m_view
|| !m_model
|| m_model
->count() <= 0) {
668 const KItemListRubberBand
* rubberBand
= m_view
->rubberBand();
669 const QPointF startPos
= rubberBand
->startPosition();
670 const QPointF endPos
= rubberBand
->endPosition();
671 QRectF rubberBandRect
= QRectF(startPos
, endPos
).normalized();
673 const bool scrollVertical
= (m_view
->scrollOrientation() == Qt::Vertical
);
674 if (scrollVertical
) {
675 rubberBandRect
.translate(0, -m_view
->scrollOffset());
677 rubberBandRect
.translate(-m_view
->scrollOffset(), 0);
680 if (!m_oldSelection
.isEmpty()) {
681 // Clear the old selection that was available before the rubberband has
682 // been activated in case if no Shift- or Control-key are pressed
683 const bool shiftOrControlPressed
= QApplication::keyboardModifiers() & Qt::ShiftModifier
||
684 QApplication::keyboardModifiers() & Qt::ControlModifier
;
685 if (!shiftOrControlPressed
) {
686 m_oldSelection
.clear();
690 QSet
<int> selectedItems
;
692 // Select all visible items that intersect with the rubberband
693 foreach (const KItemListWidget
* widget
, m_view
->visibleItemListWidgets()) {
694 const int index
= widget
->index();
696 const QRectF widgetRect
= m_view
->itemBoundingRect(index
);
697 if (widgetRect
.intersects(rubberBandRect
)) {
698 const QRectF iconRect
= widget
->iconBoundingRect().translated(widgetRect
.topLeft());
699 const QRectF textRect
= widget
->textBoundingRect().translated(widgetRect
.topLeft());
700 if (iconRect
.intersects(rubberBandRect
) || textRect
.intersects(rubberBandRect
)) {
701 selectedItems
.insert(index
);
706 // Select all invisible items that intersect with the rubberband. Instead of
707 // iterating all items only the area which might be touched by the rubberband
709 const bool increaseIndex
= scrollVertical
?
710 startPos
.y() > endPos
.y(): startPos
.x() > endPos
.x();
712 int index
= increaseIndex
? m_view
->lastVisibleIndex() + 1 : m_view
->firstVisibleIndex() - 1;
713 bool selectionFinished
= false;
715 const QRectF widgetRect
= m_view
->itemBoundingRect(index
);
716 if (widgetRect
.intersects(rubberBandRect
)) {
717 selectedItems
.insert(index
);
722 selectionFinished
= (index
>= m_model
->count()) ||
723 ( scrollVertical
&& widgetRect
.top() > rubberBandRect
.bottom()) ||
724 (!scrollVertical
&& widgetRect
.left() > rubberBandRect
.right());
727 selectionFinished
= (index
< 0) ||
728 ( scrollVertical
&& widgetRect
.bottom() < rubberBandRect
.top()) ||
729 (!scrollVertical
&& widgetRect
.right() < rubberBandRect
.left());
731 } while (!selectionFinished
);
733 if (QApplication::keyboardModifiers() & Qt::ControlModifier
) {
734 // If Control is pressed, the selection state of all items in the rubberband is toggled.
735 // Therefore, the new selection contains:
736 // 1. All previously selected items which are not inside the rubberband, and
737 // 2. all items inside the rubberband which have not been selected previously.
738 m_selectionManager
->setSelectedItems((m_oldSelection
- selectedItems
) + (selectedItems
- m_oldSelection
));
741 m_selectionManager
->setSelectedItems(selectedItems
+ m_oldSelection
);
745 void KItemListController::startDragging()
747 if (!m_view
|| !m_model
) {
751 const QSet
<int> selectedItems
= m_selectionManager
->selectedItems();
752 QMimeData
* data
= m_model
->createMimeData(selectedItems
);
757 // The created drag object will be owned and deleted
758 // by QApplication::activeWindow().
759 QDrag
* drag
= new QDrag(QApplication::activeWindow());
760 drag
->setMimeData(data
);
762 const QPixmap pixmap
= m_view
->createDragPixmap(selectedItems
);
763 drag
->setPixmap(pixmap
);
765 drag
->exec(Qt::MoveAction
| Qt::CopyAction
| Qt::LinkAction
, Qt::IgnoreAction
);
768 KItemListWidget
* KItemListController::hoveredWidget() const
772 foreach (KItemListWidget
* widget
, m_view
->visibleItemListWidgets()) {
773 if (widget
->isHovered()) {
781 KItemListWidget
* KItemListController::widgetForPos(const QPointF
& pos
) const
785 foreach (KItemListWidget
* widget
, m_view
->visibleItemListWidgets()) {
786 const QPointF mappedPos
= widget
->mapFromItem(m_view
, pos
);
788 const bool hovered
= widget
->contains(mappedPos
) &&
789 !widget
->expansionToggleRect().contains(mappedPos
) &&
790 !widget
->selectionToggleRect().contains(mappedPos
);
799 #include "kitemlistcontroller.moc"