src/kitemviews/kitemlistcontroller.h

   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 #ifndef KITEMLISTCONTROLLER_H
  24 #define KITEMLISTCONTROLLER_H
  25
  26 #include <libdolphin_export.h>
  27
  28 #include "kitemset.h"
  29
  30 #include <QObject>
  31 #include <QPixmap>
  32 #include <QPointF>
  33
  34 class KItemModelBase;
  35 class KItemListKeyboardSearchManager;
  36 class KItemListSelectionManager;
  37 class KItemListView;
  38 class KItemListWidget;
  39 class QGraphicsSceneHoverEvent;
  40 class QGraphicsSceneDragDropEvent;
  41 class QGraphicsSceneMouseEvent;
  42 class QGraphicsSceneResizeEvent;
  43 class QGraphicsSceneWheelEvent;
  44 class QHideEvent;
  45 class QInputMethodEvent;
  46 class QKeyEvent;
  47 class QMimeData;
  48 class QShowEvent;
  49 class QTransform;
  50
  51 /**
  52  * @brief Controls the view, model and selection of an item-list.
  53  *
  54  * For a working item-list it is mandatory to set a compatible view and model
  55  * with KItemListController::setView() and KItemListController::setModel().
  56  *
  57  * @see KItemListView
  58  * @see KItemModelBase
  59  * @see KItemListSelectionManager
  60  */
  61 class LIBDOLPHINPRIVATE_EXPORT KItemListController : public QObject
  62 {
  63     Q_OBJECT
  64     Q_ENUMS(SelectionBehavior)
  65     Q_PROPERTY(KItemModelBase* model READ model WRITE setModel)
  66     Q_PROPERTY(KItemListView *view READ view WRITE setView)
  67     Q_PROPERTY(SelectionBehavior selectionBehavior READ selectionBehavior WRITE setSelectionBehavior)
  68     Q_PROPERTY(AutoActivationBehavior autoActivationBehavior READ autoActivationBehavior WRITE setAutoActivationBehavior)
  69     Q_PROPERTY(MouseDoubleClickAction mouseDoubleClickAction READ mouseDoubleClickAction WRITE setMouseDoubleClickAction)
  70
  71 public:
  72     enum SelectionBehavior {
  73         NoSelection,
  74         SingleSelection,
  75         MultiSelection
  76     };
  77
  78     enum AutoActivationBehavior {
  79         ActivationAndExpansion,
  80         ExpansionOnly
  81     };
  82
  83     enum MouseDoubleClickAction {
  84         ActivateAndExpandItem,
  85         ActivateItemOnly
  86     };
  87
  88     /**
  89      * @param model  Model of the controller. The ownership is passed to the controller.
  90      * @param view   View of the controller. The ownership is passed to the controller.
  91      * @param parent Optional parent object.
  92      */
  93     KItemListController(KItemModelBase* model, KItemListView* view, QObject* parent = 0);
  94     virtual ~KItemListController();
  95
  96     void setModel(KItemModelBase* model);
  97     KItemModelBase* model() const;
  98
  99     void setView(KItemListView* view);
 100     KItemListView* view() const;
 101
 102     KItemListSelectionManager* selectionManager() const;
 103
 104     void setSelectionBehavior(SelectionBehavior behavior);
 105     SelectionBehavior selectionBehavior() const;
 106
 107     void setAutoActivationBehavior(AutoActivationBehavior behavior);
 108     AutoActivationBehavior autoActivationBehavior() const;
 109
 110     void setMouseDoubleClickAction(MouseDoubleClickAction action);
 111     MouseDoubleClickAction mouseDoubleClickAction() const;
 112
 113     /**
 114      * Sets the delay in milliseconds when dragging an object above an item
 115      * until the item gets activated automatically. A value of -1 indicates
 116      * that no automatic activation will be done at all (= default value).
 117      *
 118      * The hovered item must support dropping (see KItemModelBase::supportsDropping()),
 119      * otherwise the automatic activation is not available.
 120      *
 121      * After activating the item the signal itemActivated() will be
 122      * emitted. If the view supports the expanding of items
 123      * (KItemListView::supportsItemExpanding() returns true) and the item
 124      * itself is expandable (see KItemModelBase::isExpandable()) then instead
 125      * of activating the item it gets expanded instead (see
 126      * KItemModelBase::setExpanded()).
 127      */
 128     void setAutoActivationDelay(int delay);
 129     int autoActivationDelay() const;
 130
 131     /**
 132      * If set to true, the signals itemActivated() and itemsActivated() are emitted
 133      * after a single-click of the left mouse button. If set to false (the default),
 134      * the setting from KGlobalSettings::singleClick() is used.
 135      */
 136     void setSingleClickActivationEnforced(bool singleClick);
 137     bool singleClickActivationEnforced() const;
 138
 139     virtual bool showEvent(QShowEvent* event);
 140     virtual bool hideEvent(QHideEvent* event);
 141     virtual bool keyPressEvent(QKeyEvent* event);
 142     virtual bool inputMethodEvent(QInputMethodEvent* event);
 143     virtual bool mousePressEvent(QGraphicsSceneMouseEvent* event, const QTransform& transform);
 144     virtual bool mouseMoveEvent(QGraphicsSceneMouseEvent* event, const QTransform& transform);
 145     virtual bool mouseReleaseEvent(QGraphicsSceneMouseEvent* event, const QTransform& transform);
 146     virtual bool mouseDoubleClickEvent(QGraphicsSceneMouseEvent* event, const QTransform& transform);
 147     virtual bool dragEnterEvent(QGraphicsSceneDragDropEvent* event, const QTransform& transform);
 148     virtual bool dragLeaveEvent(QGraphicsSceneDragDropEvent* event, const QTransform& transform);
 149     virtual bool dragMoveEvent(QGraphicsSceneDragDropEvent* event, const QTransform& transform);
 150     virtual bool dropEvent(QGraphicsSceneDragDropEvent* event, const QTransform& transform);
 151     virtual bool hoverEnterEvent(QGraphicsSceneHoverEvent* event, const QTransform& transform);
 152     virtual bool hoverMoveEvent(QGraphicsSceneHoverEvent* event, const QTransform& transform);
 153     virtual bool hoverLeaveEvent(QGraphicsSceneHoverEvent* event, const QTransform& transform);
 154     virtual bool wheelEvent(QGraphicsSceneWheelEvent* event, const QTransform& transform);
 155     virtual bool resizeEvent(QGraphicsSceneResizeEvent* event, const QTransform& transform);
 156     virtual bool processEvent(QEvent* event, const QTransform& transform);
 157
 158 signals:
 159     /**
 160      * Is emitted if exactly one item has been activated by e.g. a mouse-click
 161      * or by pressing Return/Enter.
 162      */
 163     void itemActivated(int index);
 164
 165     /**
 166      * Is emitted if more than one item has been activated by pressing Return/Enter
 167      * when having a selection.
 168      */
 169     void itemsActivated(const KItemSet& indexes);
 170
 171     void itemMiddleClicked(int index);
 172
 173     /**
 174      * Emitted if a context-menu is requested for the item with
 175      * the index \a index. It is assured that the index is valid.
 176      */
 177     void itemContextMenuRequested(int index, const QPointF& pos);
 178
 179     /**
 180      * Emitted if a context-menu is requested for the KItemListView.
 181      */
 182     void viewContextMenuRequested(const QPointF& pos);
 183
 184     /**
 185      * Emitted if a context-menu is requested for the header of the KItemListView.
 186      */
 187     void headerContextMenuRequested(const QPointF& pos);
 188
 189     /**
 190      * Is emitted if the item with the index \p index gets hovered.
 191      */
 192     void itemHovered(int index);
 193
 194     /**
 195      * Is emitted if the item with the index \p index gets unhovered.
 196      * It is assured that the signal itemHovered() for this index
 197      * has been emitted before.
 198      */
 199     void itemUnhovered(int index);
 200
 201     /**
 202      * Is emitted if a mouse-button has been pressed above an item.
 203      * If the index is smaller than 0, the mouse-button has been pressed
 204      * above the viewport.
 205      */
 206     void mouseButtonPressed(int itemIndex, Qt::MouseButtons buttons);
 207
 208     /**
 209      * Is emitted if a mouse-button has been released above an item.
 210      * It is assured that the signal mouseButtonPressed() has been emitted before.
 211      * If the index is smaller than 0, the mouse-button has been pressed
 212      * above the viewport.
 213      */
 214     void mouseButtonReleased(int itemIndex, Qt::MouseButtons buttons);
 215
 216     void itemExpansionToggleClicked(int index);
 217
 218     /**
 219      * Is emitted if a drop event is done above the item with the index
 220      * \a index. If \a index is < 0 the drop event is done above an
 221      * empty area of the view.
 222      * TODO: Introduce a new signal viewDropEvent(QGraphicsSceneDragDropEvent),
 223      *       which is emitted if the drop event occurs on an empty area in
 224      *       the view, and make sure that index is always >= 0 in itemDropEvent().
 225      */
 226     void itemDropEvent(int index, QGraphicsSceneDragDropEvent* event);
 227
 228     /**
 229      * Is emitted if a drop event is done between the item with the index
 230      * \a index and the previous item.
 231      */
 232     void aboveItemDropEvent(int index, QGraphicsSceneDragDropEvent* event);
 233
 234     /**
 235      * Is emitted if the Escape key is pressed.
 236      */
 237     void escapePressed();
 238
 239     void modelChanged(KItemModelBase* current, KItemModelBase* previous);
 240     void viewChanged(KItemListView* current, KItemListView* previous);
 241
 242 private slots:
 243     void slotViewScrollOffsetChanged(qreal current, qreal previous);
 244
 245     /**
 246      * Is invoked when the rubberband boundaries have been changed and will select
 247      * all items that are touched by the rubberband.
 248      */
 249     void slotRubberBandChanged();
 250
 251     void slotChangeCurrentItem(const QString& text, bool searchFromNextItem);
 252
 253     void slotAutoActivationTimeout();
 254
 255 private:
 256     /**
 257      * Creates a QDrag object and initiates a drag-operation.
 258      */
 259     void startDragging();
 260
 261     /**
 262      * @return Widget that is currently in the hovered state. 0 is returned
 263      *         if no widget is marked as hovered.
 264      */
 265     KItemListWidget* hoveredWidget() const;
 266
 267     /**
 268      * @return Widget that is below the position \a pos. 0 is returned
 269      *         if no widget is below the position.
 270      */
 271     KItemListWidget* widgetForPos(const QPointF& pos) const;
 272
 273     /**
 274      * Updates m_keyboardAnchorIndex and m_keyboardAnchorPos. If no anchor is
 275      * set, it will be adjusted to the current item. If it is set it will be
 276      * checked whether it is still valid, otherwise it will be reset to the
 277      * current item.
 278      */
 279     void updateKeyboardAnchor();
 280
 281     /**
 282      * @return Index for the next row based on \a index.
 283      *         If there is no next row \a index will be returned.
 284      */
 285     int nextRowIndex(int index) const;
 286
 287     /**
 288      * @return Index for the previous row based on  \a index.
 289      *         If there is no previous row \a index will be returned.
 290      */
 291     int previousRowIndex(int index) const;
 292
 293     /**
 294      * Helper method for updateKeyboardAnchor(), previousRowIndex() and nextRowIndex().
 295      * @return The position of the keyboard anchor for the item with the index \a index.
 296      *         If a horizontal scrolling is used the y-position of the item will be returned,
 297      *         for the vertical scrolling the x-position will be returned.
 298      */
 299     qreal keyboardAnchorPos(int index) const;
 300
 301     /**
 302      * Dependent on the selection-behavior the extendedSelectionRegion-property
 303      * of the KItemListStyleOption from the view should be adjusted: If no
 304      * rubberband selection is used the property should be enabled.
 305      */
 306     void updateExtendedSelectionRegion();
 307
 308 private:
 309     bool m_singleClickActivationEnforced;
 310     bool m_selectionTogglePressed;
 311     bool m_clearSelectionIfItemsAreNotDragged;
 312     SelectionBehavior m_selectionBehavior;
 313     AutoActivationBehavior m_autoActivationBehavior;
 314     MouseDoubleClickAction m_mouseDoubleClickAction;
 315     KItemModelBase* m_model;
 316     KItemListView* m_view;
 317     KItemListSelectionManager* m_selectionManager;
 318     KItemListKeyboardSearchManager* m_keyboardManager;
 319     int m_pressedIndex;
 320     QPointF m_pressedMousePos;
 321
 322     QTimer* m_autoActivationTimer;
 323
 324     /**
 325      * When starting a rubberband selection during a Shift- or Control-key has been
 326      * pressed the current selection should never be deleted. To be able to restore
 327      * the current selection it is remembered in m_oldSelection before the
 328      * rubberband gets activated.
 329      */
 330     KItemSet m_oldSelection;
 331
 332     /**
 333      * Assuming a view is given with a vertical scroll-orientation, grouped items and
 334      * a maximum of 4 columns:
 335      *
 336      *  1  2  3  4
 337      *  5  6  7
 338      *  8  9 10 11
 339      * 12 13 14
 340      *
 341      * If the current index is on 4 and key-down is pressed, then item 7 gets the current
 342      * item. Now when pressing key-down again item 11 should get the current item and not
 343      * item 10. This makes it necessary to keep track of the requested column to have a
 344      * similar behavior like in a text editor:
 345      */
 346     int m_keyboardAnchorIndex;
 347     qreal m_keyboardAnchorPos;
 348 };
 349
 350 #endif
 351
 352