-/***************************************************************************
- * Copyright (C) 2011 by Peter Penz <peter.penz19@gmail.com> *
- * *
- * Based on the Itemviews NG project from Trolltech Labs: *
- * http://qt.gitorious.org/qt-labs/itemviews-ng *
- * *
- * This program is free software; you can redistribute it and/or modify *
- * it under the terms of the GNU General Public License as published by *
- * the Free Software Foundation; either version 2 of the License, or *
- * (at your option) any later version. *
- * *
- * This program is distributed in the hope that it will be useful, *
- * but WITHOUT ANY WARRANTY; without even the implied warranty of *
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
- * GNU General Public License for more details. *
- * *
- * You should have received a copy of the GNU General Public License *
- * along with this program; if not, write to the *
- * Free Software Foundation, Inc., *
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
- ***************************************************************************/
+/*
+ * SPDX-FileCopyrightText: 2011 Peter Penz <peter.penz19@gmail.com>
+ *
+ * Based on the Itemviews NG project from Trolltech Labs
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
#ifndef KITEMLISTCONTROLLER_H
#define KITEMLISTCONTROLLER_H
-#include <libdolphin_export.h>
+#include <optional>
+
+#include "dolphin_export.h"
+#include "kitemset.h"
#include <QObject>
-#include <QPixmap>
#include <QPointF>
-#include <QSet>
+#include <QScroller>
+class QTimer;
class KItemModelBase;
class KItemListKeyboardSearchManager;
class KItemListSelectionManager;
class KItemListView;
class KItemListWidget;
+class QGestureEvent;
class QGraphicsSceneHoverEvent;
class QGraphicsSceneDragDropEvent;
class QGraphicsSceneMouseEvent;
class QGraphicsSceneResizeEvent;
class QGraphicsSceneWheelEvent;
-class QHideEvent;
class QInputMethodEvent;
class QKeyEvent;
-class QMimeData;
-class QShowEvent;
+class QTapGesture;
class QTransform;
+class QTouchEvent;
/**
* @brief Controls the view, model and selection of an item-list.
* @see KItemModelBase
* @see KItemListSelectionManager
*/
-class LIBDOLPHINPRIVATE_EXPORT KItemListController : public QObject
+class DOLPHIN_EXPORT KItemListController : public QObject
{
Q_OBJECT
- Q_ENUMS(SelectionBehavior)
Q_PROPERTY(KItemModelBase* model READ model WRITE setModel)
Q_PROPERTY(KItemListView *view READ view WRITE setView)
Q_PROPERTY(SelectionBehavior selectionBehavior READ selectionBehavior WRITE setSelectionBehavior)
+ Q_PROPERTY(AutoActivationBehavior autoActivationBehavior READ autoActivationBehavior WRITE setAutoActivationBehavior)
+ Q_PROPERTY(MouseDoubleClickAction mouseDoubleClickAction READ mouseDoubleClickAction WRITE setMouseDoubleClickAction)
public:
enum SelectionBehavior {
SingleSelection,
MultiSelection
};
+ Q_ENUM(SelectionBehavior)
- KItemListController(QObject* parent = 0);
- virtual ~KItemListController();
+ enum AutoActivationBehavior {
+ ActivationAndExpansion,
+ ExpansionOnly
+ };
+
+ enum MouseDoubleClickAction {
+ ActivateAndExpandItem,
+ ActivateItemOnly
+ };
+
+ /**
+ * @param model Model of the controller. The ownership is passed to the controller.
+ * @param view View of the controller. The ownership is passed to the controller.
+ * @param parent Optional parent object.
+ */
+ KItemListController(KItemModelBase* model, KItemListView* view, QObject* parent = nullptr);
+ ~KItemListController() override;
void setModel(KItemModelBase* model);
KItemModelBase* model() const;
void setSelectionBehavior(SelectionBehavior behavior);
SelectionBehavior selectionBehavior() const;
+ void setAutoActivationBehavior(AutoActivationBehavior behavior);
+ AutoActivationBehavior autoActivationBehavior() const;
+
+ void setMouseDoubleClickAction(MouseDoubleClickAction action);
+ MouseDoubleClickAction mouseDoubleClickAction() const;
+
+ int indexCloseToMousePressedPosition() const;
+
/**
* Sets the delay in milliseconds when dragging an object above an item
* until the item gets activated automatically. A value of -1 indicates
void setAutoActivationDelay(int delay);
int autoActivationDelay() const;
- virtual bool showEvent(QShowEvent* event);
- virtual bool hideEvent(QHideEvent* event);
- virtual bool keyPressEvent(QKeyEvent* event);
- virtual bool inputMethodEvent(QInputMethodEvent* event);
- virtual bool mousePressEvent(QGraphicsSceneMouseEvent* event, const QTransform& transform);
- virtual bool mouseMoveEvent(QGraphicsSceneMouseEvent* event, const QTransform& transform);
- virtual bool mouseReleaseEvent(QGraphicsSceneMouseEvent* event, const QTransform& transform);
- virtual bool mouseDoubleClickEvent(QGraphicsSceneMouseEvent* event, const QTransform& transform);
- virtual bool dragEnterEvent(QGraphicsSceneDragDropEvent* event, const QTransform& transform);
- virtual bool dragLeaveEvent(QGraphicsSceneDragDropEvent* event, const QTransform& transform);
- virtual bool dragMoveEvent(QGraphicsSceneDragDropEvent* event, const QTransform& transform);
- virtual bool dropEvent(QGraphicsSceneDragDropEvent* event, const QTransform& transform);
- virtual bool hoverEnterEvent(QGraphicsSceneHoverEvent* event, const QTransform& transform);
- virtual bool hoverMoveEvent(QGraphicsSceneHoverEvent* event, const QTransform& transform);
- virtual bool hoverLeaveEvent(QGraphicsSceneHoverEvent* event, const QTransform& transform);
- virtual bool wheelEvent(QGraphicsSceneWheelEvent* event, const QTransform& transform);
- virtual bool resizeEvent(QGraphicsSceneResizeEvent* event, const QTransform& transform);
- virtual bool processEvent(QEvent* event, const QTransform& transform);
-
-signals:
+ /**
+ * If set to true, the signals itemActivated() and itemsActivated() are emitted
+ * after a single-click of the left mouse button. If set to false (the default),
+ * the setting from style()->styleHint(QStyle::SH_ItemView_ActivateItemOnSingleClick) is used.
+ */
+ void setSingleClickActivationEnforced(bool singleClick);
+ bool singleClickActivationEnforced() const;
+
+ bool processEvent(QEvent* event, const QTransform& transform);
+
+Q_SIGNALS:
/**
* Is emitted if exactly one item has been activated by e.g. a mouse-click
* or by pressing Return/Enter.
* Is emitted if more than one item has been activated by pressing Return/Enter
* when having a selection.
*/
- void itemsActivated(const QSet<int>& indexes);
+ void itemsActivated(const KItemSet &indexes);
void itemMiddleClicked(int index);
/**
* Is emitted if a mouse-button has been pressed above an item.
+ * If the index is smaller than 0, the mouse-button has been pressed
+ * above the viewport.
*/
- void itemPressed(int index, Qt::MouseButton button);
+ void mouseButtonPressed(int itemIndex, Qt::MouseButtons buttons);
/**
* Is emitted if a mouse-button has been released above an item.
- * It is assured that the signal itemPressed() has been emitted before.
+ * It is assured that the signal mouseButtonPressed() has been emitted before.
+ * If the index is smaller than 0, the mouse-button has been pressed
+ * above the viewport.
*/
- void itemReleased(int index, Qt::MouseButton button);
+ void mouseButtonReleased(int itemIndex, Qt::MouseButtons buttons);
void itemExpansionToggleClicked(int index);
* Is emitted if a drop event is done above the item with the index
* \a index. If \a index is < 0 the drop event is done above an
* empty area of the view.
+ * TODO: Introduce a new signal viewDropEvent(QGraphicsSceneDragDropEvent),
+ * which is emitted if the drop event occurs on an empty area in
+ * the view, and make sure that index is always >= 0 in itemDropEvent().
*/
void itemDropEvent(int index, QGraphicsSceneDragDropEvent* event);
+ /**
+ * Is emitted if a drop event is done between the item with the index
+ * \a index and the previous item.
+ */
+ void aboveItemDropEvent(int index, QGraphicsSceneDragDropEvent* event);
+
+ /**
+ * Is emitted if the Escape key is pressed.
+ */
+ void escapePressed();
+
void modelChanged(KItemModelBase* current, KItemModelBase* previous);
void viewChanged(KItemListView* current, KItemListView* previous);
-private slots:
+ void selectedItemTextPressed(int index);
+
+ void scrollerStop();
+ void increaseZoom();
+ void decreaseZoom();
+ void swipeUp();
+
+public Q_SLOTS:
+ void slotStateChanged(QScroller::State newState);
+
+private Q_SLOTS:
void slotViewScrollOffsetChanged(qreal current, qreal previous);
/**
void updateKeyboardAnchor();
/**
- * @return Index for the next row based on the current index.
- * If there is no next row the current index will be returned.
+ * @return Index for the next row based on \a index.
+ * If there is no next row \a index will be returned.
*/
- int nextRowIndex() const;
+ int nextRowIndex(int index) const;
/**
- * @return Index for the previous row based on the current index.
- * If there is no previous row the current index will be returned.
+ * @return Index for the previous row based on \a index.
+ * If there is no previous row \a index will be returned.
*/
- int previousRowIndex() const;
+ int previousRowIndex(int index) const;
/**
* Helper method for updateKeyboardAnchor(), previousRowIndex() and nextRowIndex().
*/
qreal keyboardAnchorPos(int index) const;
+ /**
+ * Dependent on the selection-behavior the extendedSelectionRegion-property
+ * of the KItemListStyleOption from the view should be adjusted: If no
+ * rubberband selection is used the property should be enabled.
+ */
+ void updateExtendedSelectionRegion();
+
+ bool keyPressEvent(QKeyEvent* event);
+ bool inputMethodEvent(QInputMethodEvent* event);
+ bool mousePressEvent(QGraphicsSceneMouseEvent* event, const QTransform& transform);
+ bool mouseMoveEvent(QGraphicsSceneMouseEvent* event, const QTransform& transform);
+ bool mouseReleaseEvent(QGraphicsSceneMouseEvent* event, const QTransform& transform);
+ bool mouseDoubleClickEvent(QGraphicsSceneMouseEvent* event, const QTransform& transform);
+ bool dragEnterEvent(QGraphicsSceneDragDropEvent* event, const QTransform& transform);
+ bool dragLeaveEvent(QGraphicsSceneDragDropEvent* event, const QTransform& transform);
+ bool dragMoveEvent(QGraphicsSceneDragDropEvent* event, const QTransform& transform);
+ bool dropEvent(QGraphicsSceneDragDropEvent* event, const QTransform& transform);
+ bool hoverEnterEvent(QGraphicsSceneHoverEvent* event, const QTransform& transform);
+ bool hoverMoveEvent(QGraphicsSceneHoverEvent* event, const QTransform& transform);
+ bool hoverLeaveEvent(QGraphicsSceneHoverEvent* event, const QTransform& transform);
+ bool wheelEvent(QGraphicsSceneWheelEvent* event, const QTransform& transform);
+ bool resizeEvent(QGraphicsSceneResizeEvent* event, const QTransform& transform);
+ bool gestureEvent(QGestureEvent* event, const QTransform& transform);
+ bool touchBeginEvent(QTouchEvent* event, const QTransform& transform);
+ void tapTriggered(QTapGesture* tap, const QTransform& transform);
+ void tapAndHoldTriggered(QGestureEvent* event, const QTransform& transform);
+ void pinchTriggered(QGestureEvent* event, const QTransform& transform);
+ void swipeTriggered(QGestureEvent* event, const QTransform& transform);
+ void twoFingerTapTriggered(QGestureEvent* event, const QTransform& transform);
+ bool onPress(const QPoint& screenPos, const QPointF& pos, const Qt::KeyboardModifiers modifiers, const Qt::MouseButtons buttons);
+ bool onRelease(const QPointF& pos, const Qt::KeyboardModifiers modifiers, const Qt::MouseButtons buttons, bool touch);
+ void startRubberBand();
+
private:
+ bool m_singleClickActivationEnforced;
bool m_selectionTogglePressed;
+ bool m_clearSelectionIfItemsAreNotDragged;
+ bool m_isSwipeGesture;
+ bool m_dragActionOrRightClick;
+ bool m_scrollerIsScrolling;
+ bool m_pinchGestureInProgress;
+ bool m_mousePress;
+ bool m_isTouchEvent;
SelectionBehavior m_selectionBehavior;
+ AutoActivationBehavior m_autoActivationBehavior;
+ MouseDoubleClickAction m_mouseDoubleClickAction;
KItemModelBase* m_model;
KItemListView* m_view;
KItemListSelectionManager* m_selectionManager;
KItemListKeyboardSearchManager* m_keyboardManager;
- int m_pressedIndex;
+ std::optional<int> m_pressedIndex;
QPointF m_pressedMousePos;
QTimer* m_autoActivationTimer;
+ Qt::GestureType m_swipeGesture;
+ Qt::GestureType m_twoFingerTapGesture;
+
/**
* When starting a rubberband selection during a Shift- or Control-key has been
* pressed the current selection should never be deleted. To be able to restore
* the current selection it is remembered in m_oldSelection before the
* rubberband gets activated.
*/
- QSet<int> m_oldSelection;
+ KItemSet m_oldSelection;
/**
* Assuming a view is given with a vertical scroll-orientation, grouped items and
* similar behavior like in a text editor:
*/
int m_keyboardAnchorIndex;
- qreal m_keyboardAnchorXPos;
+ qreal m_keyboardAnchorPos;
};
#endif
projects / dolphin.git / blobdiff