-/***************************************************************************
- * 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 KITEMLISTVIEW_H
#define KITEMLISTVIEW_H
-#include <libdolphin_export.h>
+#include "dolphin_export.h"
+#include "kitemviews/kitemliststyleoption.h"
+#include "kitemviews/kitemlistwidget.h"
+#include "kitemviews/kitemmodelbase.h"
+#include "kitemviews/kstandarditemlistgroupheader.h"
+#include "kitemviews/private/kitemlistviewanimation.h"
-#include <kitemviews/kitemlistgroupheader.h>
-#include <kitemviews/kitemliststyleoption.h>
-#include <kitemviews/kitemlistviewanimation_p.h>
-#include <kitemviews/kitemlistwidget.h>
-#include <kitemviews/kitemmodelbase.h>
#include <QGraphicsWidget>
#include <QSet>
class KItemListViewAnimation;
class KItemListViewLayouter;
class KItemListWidget;
+class KItemListWidgetInformant;
class KItemListWidgetCreatorBase;
-class KItemListViewCreatorBase;
class QTimer;
+class QPropertyAnimation;
+class QVariantAnimation;
/**
* @brief Represents the view of an item-list.
* a GraphicsItem. Each visible item is represented by a KItemListWidget.
*
* The created view must be applied to the KItemListController with
- * KItemListController::setView(). For showing a custom model it is not
- * mandatory to derive from KItemListView, all that is necessary is
- * to set a widget-creator that is capable to create KItemListWidgets
- * showing the model items. A widget-creator can be set with
- * KItemListView::setWidgetCreator().
+ * KItemListController::setView() or with the constructor of
+ * KItemListController.
*
* @see KItemListWidget
* @see KItemModelBase
*/
-class LIBDOLPHINPRIVATE_EXPORT KItemListView : public QGraphicsWidget
+class DOLPHIN_EXPORT KItemListView : public QGraphicsWidget
{
Q_OBJECT
Q_PROPERTY(qreal itemOffset READ itemOffset WRITE setItemOffset)
public:
- KItemListView(QGraphicsWidget* parent = 0);
- virtual ~KItemListView();
-
- /**
- * If the scroll-orientation is vertical, the items are ordered
- * from top to bottom (= default setting). If the scroll-orientation
- * is horizontal, the items are ordered from left to right.
- */
- void setScrollOrientation(Qt::Orientation orientation);
- Qt::Orientation scrollOrientation() const;
-
- void setItemSize(const QSizeF& size);
- QSizeF itemSize() const;
+ explicit KItemListView(QGraphicsWidget* parent = nullptr);
+ ~KItemListView() override;
/**
* Offset of the scrollbar that represents the scroll-orientation
qreal maximumItemOffset() const;
+ int maximumVisibleItems() const;
+
void setVisibleRoles(const QList<QByteArray>& roles);
QList<QByteArray> visibleRoles() const;
* <code>
* itemListView->setWidgetCreator(new KItemListWidgetCreator<X>());
* </code>
- * Note that the ownership of the widget creator is not transferred to
- * the item-list view: One instance of a widget creator might get shared
- * by several item-list view instances.
+ * The ownership of the widget creator is transferred to
+ * the item-list view.
**/
void setWidgetCreator(KItemListWidgetCreatorBase* widgetCreator);
KItemListWidgetCreatorBase* widgetCreator() const;
+ /**
+ * Sets the creator that creates a group header. Usually it is sufficient
+ * to implement a custom header widget X derived from KItemListGroupHeader and
+ * set the creator by:
+ * <code>
+ * itemListView->setGroupHeaderCreator(new KItemListGroupHeaderCreator<X>());
+ * </code>
+ * The ownership of the gropup header creator is transferred to
+ * the item-list view.
+ **/
void setGroupHeaderCreator(KItemListGroupHeaderCreatorBase* groupHeaderCreator);
KItemListGroupHeaderCreatorBase* groupHeaderCreator() const;
- void setStyleOption(const KItemListStyleOption& option);
+ /**
+ * @return The basic size of all items. The size of an item may be larger than
+ * the basic size (see KItemListView::itemRect()).
+ */
+ QSizeF itemSize() const;
+
const KItemListStyleOption& styleOption() const;
- /** @reimp */
- virtual void setGeometry(const QRectF& rect);
+ void setGeometry(const QRectF& rect) override;
+
+ /**
+ * @return The page step which should be used by the vertical scroll bar.
+ * This is the height of the view except for the header widget.
+ */
+ qreal verticalPageStep() const;
/**
* @return Index of the item that is below the point \a pos.
int itemAt(const QPointF& pos) const;
bool isAboveSelectionToggle(int index, const QPointF& pos) const;
bool isAboveExpansionToggle(int index, const QPointF& pos) const;
+ bool isAboveText(int index, const QPointF& pos) const;
/**
* @return Index of the first item that is at least partly visible.
int lastVisibleIndex() const;
/**
- * @return Required size for the item with the index \p index.
- * Per default KItemListView::itemSize() is returned.
- * When reimplementing this method it is recommended to
- * also reimplement KItemListView::itemSizeHintUpdateRequired().
+ * Calculates the required size for all items in the model.
+ * It might be larger than KItemListView::itemSize().
+ * In this case the layout grid will be stretched to assure an
+ * unclipped item.
+ *
+ * @note the logical height (width) is actually the
+ * width (height) if the scroll orientation is Qt::Vertical!
*/
- virtual QSizeF itemSizeHint(int index) const;
-
- /**
- * @return The preferred column-width of the item with the index \a index
- * for the given \a role that is shown in the column.
- */
- virtual qreal preferredColumnWidth(int index, const QByteArray& role) const;
+ void calculateItemSizeHints(QVector<qreal>& logicalHeightHints, qreal& logicalWidthHint) const;
/**
* If set to true, items having child-items can be expanded to show the child-items as
- * part of the view. Per default the expanding of items is is disabled. If expanding of
+ * part of the view. Per default the expanding of items is disabled. If expanding of
* items is enabled, the methods KItemModelBase::setExpanded(), KItemModelBase::isExpanded(),
* KItemModelBase::isExpandable() and KItemModelBase::expandedParentsCount()
* must be reimplemented. The view-implementation
/**
* @return The context rectangle of the item relative to the top/left of
* the currently visible area (see KItemListView::offset()). The
- * context rectangle is defined by by the united rectangle of
+ * context rectangle is defined by the united rectangle of
* the icon rectangle and the text rectangle (see KItemListWidget::iconRect()
* and KItemListWidget::textRect()) and is useful as reference for e.g. aligning
* a tooltip or a context-menu for an item. Note that a context rectangle will
/**
* @return Pixmap that is used for a drag operation based on the
- * items given by \a indexes. The default implementation returns
- * a null-pixmap.
+ * items given by \a indexes.
*/
- virtual QPixmap createDragPixmap(const QSet<int>& indexes) const;
+ virtual QPixmap createDragPixmap(const KItemSet& indexes) const;
/**
- * @reimp
+ * Lets the user edit the role \a role for item with the index \a index.
*/
- virtual void paint(QPainter* painter, const QStyleOptionGraphicsItem* option, QWidget* widget = 0);
+ void editRole(int index, const QByteArray& role);
+
+ void paint(QPainter* painter, const QStyleOptionGraphicsItem* option, QWidget* widget = nullptr) override;
signals:
void scrollOrientationChanged(Qt::Orientation current, Qt::Orientation previous);
*/
void visibleRolesChanged(const QList<QByteArray>& current, const QList<QByteArray>& previous);
+ void roleEditingCanceled(int index, const QByteArray& role, const QVariant& value);
+ void roleEditingFinished(int index, const QByteArray& role, const QVariant& value);
+
protected:
+ QVariant itemChange(GraphicsItemChange change, const QVariant &value) override;
+ void setItemSize(const QSizeF& size);
+ void setStyleOption(const KItemListStyleOption& option);
+
+ /**
+ * If the scroll-orientation is vertical, the items are ordered
+ * from top to bottom (= default setting). If the scroll-orientation
+ * is horizontal, the items are ordered from left to right.
+ */
+ void setScrollOrientation(Qt::Orientation orientation);
+ Qt::Orientation scrollOrientation() const;
+
+ /**
+ * Factory method for creating a default widget-creator. The method will be used
+ * in case if setWidgetCreator() has not been set by the application.
+ * @return New instance of the widget-creator that should be used per
+ * default.
+ */
+ virtual KItemListWidgetCreatorBase* defaultWidgetCreator() const;
+
+ /**
+ * Factory method for creating a default group-header-creator. The method will be used
+ * in case if setGroupHeaderCreator() has not been set by the application.
+ * @return New instance of the group-header-creator that should be used per
+ * default.
+ */
+ virtual KItemListGroupHeaderCreatorBase* defaultGroupHeaderCreator() const;
+
+ /**
+ * Is called when creating a new KItemListWidget instance and allows derived
+ * classes to do a custom initialization.
+ */
virtual void initializeItemListWidget(KItemListWidget* item);
/**
virtual void onTransactionBegin();
virtual void onTransactionEnd();
- virtual bool event(QEvent* event);
- virtual void mousePressEvent(QGraphicsSceneMouseEvent* event);
- virtual void mouseMoveEvent(QGraphicsSceneMouseEvent* event);
- virtual void dragEnterEvent(QGraphicsSceneDragDropEvent* event);
- virtual void dragMoveEvent(QGraphicsSceneDragDropEvent* event);
- virtual void dragLeaveEvent(QGraphicsSceneDragDropEvent* event);
- virtual void dropEvent(QGraphicsSceneDragDropEvent* event);
+ bool event(QEvent* event) override;
+ void mousePressEvent(QGraphicsSceneMouseEvent* event) override;
+ void mouseMoveEvent(QGraphicsSceneMouseEvent* event) override;
+ void dragEnterEvent(QGraphicsSceneDragDropEvent* event) override;
+ void dragMoveEvent(QGraphicsSceneDragDropEvent* event) override;
+ void dragLeaveEvent(QGraphicsSceneDragDropEvent* event) override;
+ void dropEvent(QGraphicsSceneDragDropEvent* event) override;
QList<KItemListWidget*> visibleItemListWidgets() const;
+ virtual void updateFont();
+ virtual void updatePalette();
+
protected slots:
virtual void slotItemsInserted(const KItemRangeList& itemRanges);
virtual void slotItemsRemoved(const KItemRangeList& itemRanges);
virtual void slotItemsMoved(const KItemRange& itemRange, const QList<int>& movedToIndexes);
virtual void slotItemsChanged(const KItemRangeList& itemRanges,
const QSet<QByteArray>& roles);
+ virtual void slotGroupsChanged();
virtual void slotGroupedSortingChanged(bool current);
virtual void slotSortOrderChanged(Qt::SortOrder current, Qt::SortOrder previous);
virtual void slotSortRoleChanged(const QByteArray& current, const QByteArray& previous);
virtual void slotCurrentChanged(int current, int previous);
- virtual void slotSelectionChanged(const QSet<int>& current, const QSet<int>& previous);
+ virtual void slotSelectionChanged(const KItemSet& current, const KItemSet& previous);
private slots:
void slotAnimationFinished(QGraphicsWidget* widget,
*/
void slotGeometryOfGroupHeaderParentChanged();
+ void slotRoleEditingCanceled(int index, const QByteArray& role, const QVariant& value);
+ void slotRoleEditingFinished(int index, const QByteArray& role, const QVariant& value);
+
private:
enum LayoutAnimationHint
{
*/
bool scrollBarRequired(const QSizeF& size) const;
+ /**
+ * Shows a drop-indicator between items dependent on the given
+ * cursor position. The cursor position is relative to the upper left
+ * edge of the view.
+ * @return Index of the item where the dropping is done. An index of -1
+ * indicates that the item has been dropped after the last item.
+ */
+ int showDropIndicator(const QPointF& pos);
+ void hideDropIndicator();
+
/**
* Applies the height of the group header to the layouter. The height
* depends on the used scroll orientation.
*/
bool hasSiblingSuccessor(int index) const;
+ /**
+ * Helper method for slotRoleEditingCanceled() and slotRoleEditingFinished().
+ * Disconnects the two Signals "roleEditingCanceled" and
+ * "roleEditingFinished"
+ */
+ void disconnectRoleEditingSignals(int index);
+
/**
* Helper function for triggerAutoScrolling().
* @param pos Logical position of the mouse relative to the range.
bool m_enabledSelectionToggles;
bool m_grouped;
bool m_supportsItemExpanding;
+ bool m_editingRole;
int m_activeTransactions; // Counter for beginTransaction()/endTransaction()
LayoutAnimationHint m_endTransactionAnimationHint;
KItemListController* m_controller;
KItemModelBase* m_model;
QList<QByteArray> m_visibleRoles;
- KItemListWidgetCreatorBase* m_widgetCreator;
- KItemListGroupHeaderCreatorBase* m_groupHeaderCreator;
+ mutable KItemListWidgetCreatorBase* m_widgetCreator;
+ mutable KItemListGroupHeaderCreatorBase* m_groupHeaderCreator;
KItemListStyleOption m_styleOption;
QHash<int, KItemListWidget*> m_visibleItems;
bool m_skipAutoScrollForRubberBand;
KItemListRubberBand* m_rubberBand;
+ KItemListRubberBand* m_tapAndHoldIndicator;
QPointF m_mousePos;
int m_autoScrollIncrement;
KItemListHeader* m_header;
KItemListHeaderWidget* m_headerWidget;
+ QPropertyAnimation* m_indicatorAnimation;
+
+ // When dragging items into the view where the sort-role of the model
+ // is empty, a visual indicator should be shown during dragging where
+ // the dropping will happen. This indicator is specified by an index
+ // of the item. -1 means that no indicator will be shown at all.
+ // The m_dropIndicator is set by the KItemListController
+ // by KItemListView::showDropIndicator() and KItemListView::hideDropIndicator().
+ QRectF m_dropIndicator;
+
+ QList<QVariantAnimation*> m_rubberBandAnimations;
+
friend class KItemListContainer; // Accesses scrollBarRequired()
friend class KItemListHeader; // Accesses m_headerWidget
friend class KItemListController;
friend class KItemListControllerTest;
+ friend class KItemListViewAccessible;
+ friend class KItemListAccessibleCell;
};
/**
* KItemListWidgetCreatorBase and KItemListGroupHeaderCreatorBase.
* @internal
*/
-class LIBDOLPHINPRIVATE_EXPORT KItemListCreatorBase
+class DOLPHIN_EXPORT KItemListCreatorBase
{
public:
virtual ~KItemListCreatorBase();
* @brief Base class for creating KItemListWidgets.
*
* It is recommended that applications simply use the KItemListWidgetCreator-template class.
- * For a custom implementation the methods create() and recyle() must be reimplemented.
- * The intention of the widget creator is to prevent repetitive and expensive instantiations and
- * deletions of KItemListWidgets by recycling existing widget instances.
+ * For a custom implementation the methods create(), itemSizeHint() and preferredColumnWith()
+ * must be reimplemented. The intention of the widget creator is to prevent repetitive and
+ * expensive instantiations and deletions of KItemListWidgets by recycling existing widget
+ * instances.
*/
-class LIBDOLPHINPRIVATE_EXPORT KItemListWidgetCreatorBase : public KItemListCreatorBase
+class DOLPHIN_EXPORT KItemListWidgetCreatorBase : public KItemListCreatorBase
{
public:
- virtual ~KItemListWidgetCreatorBase();
+ ~KItemListWidgetCreatorBase() override;
+
virtual KItemListWidget* create(KItemListView* view) = 0;
+
virtual void recycle(KItemListWidget* widget);
+
+ virtual void calculateItemSizeHints(QVector<qreal>& logicalHeightHints, qreal& logicalWidthHint, const KItemListView* view) const = 0;
+
+ virtual qreal preferredRoleColumnWidth(const QByteArray& role,
+ int index,
+ const KItemListView* view) const = 0;
};
+/**
+ * @brief Template class for creating KItemListWidgets.
+ */
template <class T>
class KItemListWidgetCreator : public KItemListWidgetCreatorBase
{
public:
- virtual ~KItemListWidgetCreator();
- virtual KItemListWidget* create(KItemListView* view);
+ KItemListWidgetCreator();
+ ~KItemListWidgetCreator() override;
+
+ KItemListWidget* create(KItemListView* view) override;
+
+ void calculateItemSizeHints(QVector<qreal>& logicalHeightHints, qreal& logicalWidthHint, const KItemListView* view) const override;
+
+ qreal preferredRoleColumnWidth(const QByteArray& role,
+ int index,
+ const KItemListView* view) const override;
+private:
+ KItemListWidgetInformant* m_informant;
};
+template <class T>
+KItemListWidgetCreator<T>::KItemListWidgetCreator() :
+ m_informant(T::createInformant())
+{
+}
+
template <class T>
KItemListWidgetCreator<T>::~KItemListWidgetCreator()
{
+ delete m_informant;
}
template <class T>
{
KItemListWidget* widget = static_cast<KItemListWidget*>(popRecycleableWidget());
if (!widget) {
- widget = new T(view);
+ widget = new T(m_informant, view);
addCreatedWidget(widget);
}
return widget;
}
+template<class T>
+void KItemListWidgetCreator<T>::calculateItemSizeHints(QVector<qreal>& logicalHeightHints, qreal& logicalWidthHint, const KItemListView* view) const
+{
+ return m_informant->calculateItemSizeHints(logicalHeightHints, logicalWidthHint, view);
+}
+
+template<class T>
+qreal KItemListWidgetCreator<T>::preferredRoleColumnWidth(const QByteArray& role,
+ int index,
+ const KItemListView* view) const
+{
+ return m_informant->preferredRoleColumnWidth(role, index, view);
+}
+
/**
* @brief Base class for creating KItemListGroupHeaders.
*
* The intention of the group-header creator is to prevent repetitive and expensive instantiations and
* deletions of KItemListGroupHeaders by recycling existing header instances.
*/
-class LIBDOLPHINPRIVATE_EXPORT KItemListGroupHeaderCreatorBase : public KItemListCreatorBase
+class DOLPHIN_EXPORT KItemListGroupHeaderCreatorBase : public KItemListCreatorBase
{
public:
- virtual ~KItemListGroupHeaderCreatorBase();
+ ~KItemListGroupHeaderCreatorBase() override;
virtual KItemListGroupHeader* create(KItemListView* view) = 0;
virtual void recycle(KItemListGroupHeader* header);
};
class KItemListGroupHeaderCreator : public KItemListGroupHeaderCreatorBase
{
public:
- virtual ~KItemListGroupHeaderCreator();
- virtual KItemListGroupHeader* create(KItemListView* view);
+ ~KItemListGroupHeaderCreator() override;
+ KItemListGroupHeader* create(KItemListView* view) override;
};
template <class T>
projects / dolphin.git / blobdiff