Merge branch 'Applications/18.04'

[dolphin.git] / src / kitemviews / kitemlistwidget.h

diff --git a/src/kitemviews/kitemlistwidget.h b/src/kitemviews/kitemlistwidget.h
index 4c8ff1a9520fd30975ab1f9f644e0274a866eed2..433048aa029e049bcabbfd06850dd19af0f89c1d 100644 (file)
--- a/src/kitemviews/kitemlistwidget.h
+++ b/src/kitemviews/kitemlistwidget.h
@@ -23,17 +23,38 @@
 #ifndef KITEMLISTWIDGET_H
 #define KITEMLISTWIDGET_H
 
-#include <libdolphin_export.h>
-
-#include <kitemviews/kitemliststyleoption.h>
+#include "dolphin_export.h"
+#include "kitemviews/kitemliststyleoption.h"
 
 #include <QBitArray>
 #include <QGraphicsWidget>
 #include <QStyle>
 
 class KItemListSelectionToggle;
+class KItemListView;
 class QPropertyAnimation;
 
+/**
+ * @brief Provides information for creating an instance of KItemListWidget.
+ *
+ * KItemListView only creates KItemListWidget instances for the visible
+ * area. For calculating the required size of all items the expected
+ * size for the invisible items must be accessible. KItemListWidgetInformant
+ * provides this information.
+ */
+class DOLPHIN_EXPORT KItemListWidgetInformant
+{
+public:
+    KItemListWidgetInformant();
+    virtual ~KItemListWidgetInformant();
+
+    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 Widget that shows a visible item from the model.
  *
@@ -41,13 +62,13 @@ class QPropertyAnimation;
  * All properties are set by KItemListView, for each property there is a corresponding
  * virtual protected method that allows to react on property changes.
  */
-class LIBDOLPHINPRIVATE_EXPORT KItemListWidget : public QGraphicsWidget
+class DOLPHIN_EXPORT KItemListWidget : public QGraphicsWidget
 {
     Q_OBJECT
 
 public:
-    KItemListWidget(QGraphicsItem* parent);
-    virtual ~KItemListWidget();
+    KItemListWidget(KItemListWidgetInformant* informant, QGraphicsItem* parent);
+    ~KItemListWidget() override;
 
     void setIndex(int index);
     int index() const;
@@ -60,7 +81,7 @@ public:
      * to show the data of the custom model provided by KItemListWidget::data().
      * @reimp
      */
-    virtual void paint(QPainter* painter, const QStyleOptionGraphicsItem* option, QWidget* widget = 0);
+    void paint(QPainter* painter, const QStyleOptionGraphicsItem* option, QWidget* widget = nullptr) override;
 
     void setVisibleRoles(const QList<QByteArray>& roles);
     QList<QByteArray> visibleRoles() const;
@@ -86,6 +107,8 @@ public:
     void setHovered(bool hovered);
     bool isHovered() const;
 
+    void setHoverPosition(const QPointF& pos);
+
     void setAlternateBackground(bool enable);
     bool alternateBackground() const;
 
@@ -102,13 +125,23 @@ public:
     void setSiblingsInformation(const QBitArray& siblings);
     QBitArray siblingsInformation() const;
 
+    /**
+     * Allows the user to edit the role \a role. The signals
+     * roleEditingCanceled() or roleEditingFinished() will be
+     * emitted after editing. An ongoing editing gets canceled if
+     * the role is empty. Derived classes must implement
+     * editedRoleChanged().
+     */
+    void setEditedRole(const QByteArray& role);
+    QByteArray editedRole() const;
+
     /**
      * @return True if \a point is inside KItemListWidget::hoverRect(),
      *         KItemListWidget::textRect(), KItemListWidget::selectionToggleRect()
      *         or KItemListWidget::expansionToggleRect().
      * @reimp
      */
-    virtual bool contains(const QPointF& point) const;
+    bool contains(const QPointF& point) const override;
 
     /**
      * @return Rectangle for the area that shows the icon.
@@ -129,6 +162,11 @@ public:
      */
     virtual QRectF textFocusRect() const;
 
+    /**
+     * @return Rectangle around which a selection box should be drawn if the item is selected.
+     */
+    virtual QRectF selectionRect() const = 0;
+
     /**
      * @return Rectangle for the selection-toggle that is used to select or deselect an item.
      *         Per default an empty rectangle is returned which means that no selection-toggle
@@ -143,6 +181,16 @@ public:
      */
     virtual QRectF expansionToggleRect() const;
 
+    /**
+     * @return Pixmap that is used when dragging an item. Per default the current state of the
+     *         widget is returned as pixmap.
+     */
+    virtual QPixmap createDragPixmap(const QStyleOptionGraphicsItem* option, QWidget* widget = nullptr);
+
+signals:
+    void roleEditingCanceled(int index, const QByteArray& role, const QVariant& value);
+    void roleEditingFinished(int index, const QByteArray& role, const QVariant& value);
+
 protected:
     virtual void dataChanged(const QHash<QByteArray, QVariant>& current, const QSet<QByteArray>& roles = QSet<QByteArray>());
     virtual void visibleRolesChanged(const QList<QByteArray>& current, const QList<QByteArray>& previous);
@@ -153,7 +201,8 @@ protected:
     virtual void hoveredChanged(bool hovered);
     virtual void alternateBackgroundChanged(bool enabled);
     virtual void siblingsInformationChanged(const QBitArray& current, const QBitArray& previous);
-    virtual void resizeEvent(QGraphicsSceneResizeEvent* event);
+    virtual void editedRoleChanged(const QByteArray& current, const QByteArray& previous);
+    void resizeEvent(QGraphicsSceneResizeEvent* event) override;
 
     /**
      * @return The current opacity of the hover-animation. When implementing a custom painting-code for a hover-state
@@ -161,6 +210,8 @@ protected:
      */
     qreal hoverOpacity() const;
 
+    const KItemListWidgetInformant* informant() const;
+
 private slots:
     void slotHoverAnimationFinished();
 
@@ -173,6 +224,7 @@ private:
 private:
     Q_PROPERTY(qreal hoverOpacity READ hoverOpacity WRITE setHoverOpacity)
 
+    KItemListWidgetInformant* m_informant;
     int m_index;
     bool m_selected;
     bool m_current;
@@ -190,7 +242,15 @@ private:
     QPropertyAnimation* m_hoverAnimation;
 
     KItemListSelectionToggle* m_selectionToggle;
+
+    QByteArray m_editedRole;
 };
+
+inline const KItemListWidgetInformant* KItemListWidget::informant() const
+{
+    return m_informant;
+}
+
 #endif