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 "kitemlistselectionmanager.h"
  27
  28 #include <QEvent>
  29 #include <QGraphicsSceneEvent>
  30 #include <QTransform>
  31
  32 #include <KDebug>
  33
  34 KItemListController::KItemListController(QObject* parent) :
  35     QObject(parent),
  36     m_selectionBehavior(NoSelection),
  37     m_model(0),
  38     m_view(0),
  39     m_selectionManager(new KItemListSelectionManager(this)),
  40     m_pressedIndex(-1)
  41 {
  42 }
  43
  44 KItemListController::~KItemListController()
  45 {
  46 }
  47
  48 void KItemListController::setModel(KItemModelBase* model)
  49 {
  50     if (m_model == model) {
  51         return;
  52     }
  53
  54     KItemModelBase* oldModel = m_model;
  55     m_model = model;
  56
  57     if (m_view) {
  58         m_view->setModel(m_model);
  59     }
  60
  61     m_selectionManager->setModel(m_model);
  62
  63     emit modelChanged(m_model, oldModel);
  64 }
  65
  66 KItemModelBase* KItemListController::model() const
  67 {
  68     return m_model;
  69 }
  70
  71 KItemListSelectionManager* KItemListController::selectionManager() const
  72 {
  73     return m_selectionManager;
  74 }
  75
  76 void KItemListController::setView(KItemListView* view)
  77 {
  78     if (m_view == view) {
  79         return;
  80     }
  81
  82     KItemListView* oldView = m_view;
  83     m_view = view;
  84
  85     if (m_view) {
  86         m_view->setController(this);
  87         m_view->setModel(m_model);
  88     }
  89
  90     emit viewChanged(m_view, oldView);
  91 }
  92
  93 KItemListView* KItemListController::view() const
  94 {
  95     return m_view;
  96 }
  97
  98 void KItemListController::setSelectionBehavior(SelectionBehavior behavior)
  99 {
 100     m_selectionBehavior = behavior;
 101 }
 102
 103 KItemListController::SelectionBehavior KItemListController::selectionBehavior() const
 104 {
 105     return m_selectionBehavior;
 106 }
 107
 108 bool KItemListController::showEvent(QShowEvent* event)
 109 {
 110     Q_UNUSED(event);
 111     return false;
 112 }
 113
 114 bool KItemListController::hideEvent(QHideEvent* event)
 115 {
 116     Q_UNUSED(event);
 117     return false;
 118 }
 119
 120 bool KItemListController::keyPressEvent(QKeyEvent* event)
 121 {
 122     switch (event->key()) {
 123     case Qt::Key_Home:
 124         m_selectionManager->setCurrentItem(0);
 125         break;
 126     case Qt::Key_End:
 127         m_selectionManager->setCurrentItem(m_model->count() - 1);
 128         break;
 129     }
 130     return false;
 131 }
 132
 133 bool KItemListController::inputMethodEvent(QInputMethodEvent* event)
 134 {
 135     Q_UNUSED(event);
 136     return false;
 137 }
 138
 139 bool KItemListController::mousePressEvent(QGraphicsSceneMouseEvent* event, const QTransform& transform)
 140 {
 141     const QPointF pos = transform.map(event->pos());
 142     m_pressedIndex = m_view->itemAt(pos);
 143
 144     const bool shiftOrControlPressed = event->modifiers() & Qt::ShiftModifier ||
 145                                        event->modifiers() & Qt::ControlModifier;
 146     if (!shiftOrControlPressed) {
 147         m_selectionManager->clearSelection();
 148         m_selectionManager->setAnchorItem(m_pressedIndex);
 149     }
 150
 151     if (m_pressedIndex >= 0) {
 152         m_selectionManager->setCurrentItem(m_pressedIndex);
 153         if (!m_view->isAboveExpansionToggle(m_pressedIndex, pos)) {
 154             m_selectionManager->setSelected(m_pressedIndex);
 155         }
 156     }
 157
 158     return false;
 159 }
 160
 161 bool KItemListController::mouseMoveEvent(QGraphicsSceneMouseEvent* event, const QTransform& transform)
 162 {
 163     Q_UNUSED(event);
 164     Q_UNUSED(transform);
 165     return false;
 166 }
 167
 168 bool KItemListController::mouseReleaseEvent(QGraphicsSceneMouseEvent* event, const QTransform& transform)
 169 {
 170     if (m_view) {
 171         const QPointF pos = transform.map(event->pos());
 172         const int index = m_view->itemAt(pos);
 173         const bool shiftOrControlPressed = event->modifiers() & Qt::ShiftModifier || event->modifiers() & Qt::ControlModifier;
 174
 175         if (index >= 0 && index == m_pressedIndex) {
 176             // The release event is done above the same item as the press event
 177             bool emitItemClicked = true;
 178             if (event->button() & Qt::LeftButton) {
 179                 if (m_view->isAboveExpansionToggle(index, pos)) {
 180                     emit itemExpansionToggleClicked(index);
 181                     emitItemClicked = false;
 182                 }
 183                 else if (shiftOrControlPressed) {
 184                     // The mouse click should only update the selection, not trigger the item
 185                     emitItemClicked = false;
 186                 }
 187             }
 188
 189             if (emitItemClicked) {
 190                 emit itemClicked(index, event->button());
 191             }
 192         } else if (!shiftOrControlPressed) {
 193             m_selectionManager->clearSelection();
 194         }
 195     }
 196
 197     m_pressedIndex = -1;
 198     return false;
 199 }
 200
 201 bool KItemListController::mouseDoubleClickEvent(QGraphicsSceneMouseEvent* event, const QTransform& transform)
 202 {
 203     Q_UNUSED(event);
 204     Q_UNUSED(transform);
 205     return false;
 206 }
 207
 208 bool KItemListController::dragEnterEvent(QGraphicsSceneDragDropEvent* event, const QTransform& transform)
 209 {
 210     Q_UNUSED(event);
 211     Q_UNUSED(transform);
 212     return false;
 213 }
 214
 215 bool KItemListController::dragLeaveEvent(QGraphicsSceneDragDropEvent* event, const QTransform& transform)
 216 {
 217     Q_UNUSED(event);
 218     Q_UNUSED(transform);
 219     return false;
 220 }
 221
 222 bool KItemListController::dragMoveEvent(QGraphicsSceneDragDropEvent* event, const QTransform& transform)
 223 {
 224     Q_UNUSED(event);
 225     Q_UNUSED(transform);
 226     return false;
 227 }
 228
 229 bool KItemListController::dropEvent(QGraphicsSceneDragDropEvent* event, const QTransform& transform)
 230 {
 231     Q_UNUSED(event);
 232     Q_UNUSED(transform);
 233     return false;
 234 }
 235
 236 bool KItemListController::hoverEnterEvent(QGraphicsSceneHoverEvent* event, const QTransform& transform)
 237 {
 238     Q_UNUSED(event);
 239     Q_UNUSED(transform);
 240     return false;
 241 }
 242
 243 bool KItemListController::hoverMoveEvent(QGraphicsSceneHoverEvent* event, const QTransform& transform)
 244 {
 245     // The implementation assumes that only one item can get hovered no matter
 246     // whether they overlap or not.
 247
 248     Q_UNUSED(transform);
 249     if (!m_model || !m_view) {
 250         return false;
 251     }
 252
 253     // Search the previously hovered item that might get unhovered
 254     KItemListWidget* unhoveredWidget = 0;
 255     foreach (KItemListWidget* widget, m_view->visibleItemListWidgets()) {
 256         if (widget->isHovered()) {
 257             unhoveredWidget = widget;
 258             break;
 259         }
 260     }
 261
 262     // Search the currently hovered item
 263     KItemListWidget* hoveredWidget = 0;
 264     foreach (KItemListWidget* widget, m_view->visibleItemListWidgets()) {
 265         const QPointF mappedPos = widget->mapFromItem(m_view, event->pos());
 266
 267         const bool hovered = widget->contains(mappedPos) &&
 268                              !widget->expansionToggleRect().contains(mappedPos) &&
 269                              !widget->selectionToggleRect().contains(mappedPos);
 270         if (hovered) {
 271             hoveredWidget = widget;
 272             break;
 273         }
 274     }
 275
 276     if (unhoveredWidget != hoveredWidget) {
 277         if (unhoveredWidget) {
 278             unhoveredWidget->setHovered(false);
 279             emit itemUnhovered(unhoveredWidget->index());
 280         }
 281
 282         if (hoveredWidget) {
 283             hoveredWidget->setHovered(true);
 284             emit itemHovered(hoveredWidget->index());
 285         }
 286     }
 287
 288     return false;
 289 }
 290
 291 bool KItemListController::hoverLeaveEvent(QGraphicsSceneHoverEvent* event, const QTransform& transform)
 292 {
 293     Q_UNUSED(event);
 294     Q_UNUSED(transform);
 295
 296     if (!m_model || !m_view) {
 297         return false;
 298     }
 299
 300     foreach (KItemListWidget* widget, m_view->visibleItemListWidgets()) {
 301         if (widget->isHovered()) {
 302             widget->setHovered(false);
 303             emit itemUnhovered(widget->index());
 304         }
 305     }
 306     return false;
 307 }
 308
 309 bool KItemListController::wheelEvent(QGraphicsSceneWheelEvent* event, const QTransform& transform)
 310 {
 311     Q_UNUSED(event);
 312     Q_UNUSED(transform);
 313     return false;
 314 }
 315
 316 bool KItemListController::resizeEvent(QGraphicsSceneResizeEvent* event, const QTransform& transform)
 317 {
 318     Q_UNUSED(event);
 319     Q_UNUSED(transform);
 320     return false;
 321 }
 322
 323 bool KItemListController::processEvent(QEvent* event, const QTransform& transform)
 324 {
 325     if (!event) {
 326         return false;
 327     }
 328
 329     switch (event->type()) {
 330     case QEvent::KeyPress:
 331         return keyPressEvent(static_cast<QKeyEvent*>(event));
 332     case QEvent::InputMethod:
 333         return inputMethodEvent(static_cast<QInputMethodEvent*>(event));
 334     case QEvent::GraphicsSceneMousePress:
 335         return mousePressEvent(static_cast<QGraphicsSceneMouseEvent*>(event), QTransform());
 336     case QEvent::GraphicsSceneMouseMove:
 337         return mouseMoveEvent(static_cast<QGraphicsSceneMouseEvent*>(event), QTransform());
 338     case QEvent::GraphicsSceneMouseRelease:
 339         return mouseReleaseEvent(static_cast<QGraphicsSceneMouseEvent*>(event), QTransform());
 340     case QEvent::GraphicsSceneWheel:
 341          return wheelEvent(static_cast<QGraphicsSceneWheelEvent*>(event), QTransform());
 342     case QEvent::GraphicsSceneDragEnter:
 343         return dragEnterEvent(static_cast<QGraphicsSceneDragDropEvent*>(event), QTransform());
 344     case QEvent::GraphicsSceneDragLeave:
 345         return dragLeaveEvent(static_cast<QGraphicsSceneDragDropEvent*>(event), QTransform());
 346     case QEvent::GraphicsSceneDragMove:
 347         return dragMoveEvent(static_cast<QGraphicsSceneDragDropEvent*>(event), QTransform());
 348     case QEvent::GraphicsSceneDrop:
 349         return dropEvent(static_cast<QGraphicsSceneDragDropEvent*>(event), QTransform());
 350     case QEvent::GraphicsSceneHoverEnter:
 351         return hoverEnterEvent(static_cast<QGraphicsSceneHoverEvent*>(event), QTransform());
 352     case QEvent::GraphicsSceneHoverMove:
 353         return hoverMoveEvent(static_cast<QGraphicsSceneHoverEvent*>(event), QTransform());
 354     case QEvent::GraphicsSceneHoverLeave:
 355         return hoverLeaveEvent(static_cast<QGraphicsSceneHoverEvent*>(event), QTransform());
 356     case QEvent::GraphicsSceneResize:
 357         return resizeEvent(static_cast<QGraphicsSceneResizeEvent*>(event), transform);
 358     default:
 359         break;
 360     }
 361
 362     return false;
 363 }
 364
 365 #include "kitemlistcontroller.moc"