Improve drawing selected items in Compact/Details View and Places Panel

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

diff --git a/src/kitemviews/kitemlistwidget.h b/src/kitemviews/kitemlistwidget.h
index 20efa7c94475e6f3013d9bd44223a8399223f21b..c086ee6d332e47055631a2e504e758325b9edc70 100644 (file)
--- a/src/kitemviews/kitemlistwidget.h
+++ b/src/kitemviews/kitemlistwidget.h
@@ -32,8 +32,30 @@
 #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 LIBDOLPHINPRIVATE_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.
  *
@@ -46,7 +68,7 @@ class LIBDOLPHINPRIVATE_EXPORT KItemListWidget : public QGraphicsWidget
     Q_OBJECT
 
 public:
-    KItemListWidget(QGraphicsItem* parent);
+    KItemListWidget(KItemListWidgetInformant* informant, QGraphicsItem* parent);
     virtual ~KItemListWidget();
 
     void setIndex(int index);
@@ -65,8 +87,12 @@ public:
     void setVisibleRoles(const QList<QByteArray>& roles);
     QList<QByteArray> visibleRoles() const;
 
-    void setVisibleRolesSizes(const QHash<QByteArray, QSizeF> rolesSizes);
-    QHash<QByteArray, QSizeF> visibleRolesSizes() const;
+    /**
+     * Sets the width of a role that should be used if the alignment of the content
+     * should be done in columns.
+     */
+    void setColumnWidth(const QByteArray& role, qreal width);
+    qreal columnWidth(const QByteArray& role) const;
 
     void setStyleOption(const KItemListStyleOption& option);
     const KItemListStyleOption& styleOption() const;
@@ -82,8 +108,10 @@ public:
     void setHovered(bool hovered);
     bool isHovered() const;
 
-    void setAlternatingBackgroundColors(bool enable);
-    bool alternatingBackgroundColors() const;
+    void setHoverPosition(const QPointF& pos);
+
+    void setAlternateBackground(bool enable);
+    bool alternateBackground() const;
 
     void setEnabledSelectionToggle(bool enabled);
     bool enabledSelectionToggle() const;
@@ -98,6 +126,16 @@ 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()
@@ -116,6 +154,20 @@ public:
      */
     virtual QRectF textRect() const = 0;
 
+    /**
+     * @return Focus rectangle for indicating the current item. Per default
+     *         textRect() will be returned. Overwrite this method if textRect()
+     *         provides a larger rectangle than the actual text (e.g. to
+     *         be aligned with the iconRect()). The textFocusRect() may not be
+     *         outside the boundaries of textRect().
+     */
+    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
@@ -130,17 +182,28 @@ 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 = 0);
+
+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);
-    virtual void visibleRolesSizesChanged(const QHash<QByteArray, QSizeF>& current, const QHash<QByteArray, QSizeF>& previous);
+    virtual void columnWidthChanged(const QByteArray& role, qreal current, qreal previous);
     virtual void styleOptionChanged(const KItemListStyleOption& current, const KItemListStyleOption& previous);
     virtual void currentChanged(bool current);
     virtual void selectedChanged(bool selected);
     virtual void hoveredChanged(bool hovered);
-    virtual void alternatingBackgroundColorsChanged(bool enabled);
+    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);
+    virtual void resizeEvent(QGraphicsSceneResizeEvent* event);
 
     /**
      * @return The current opacity of the hover-animation. When implementing a custom painting-code for a hover-state
@@ -148,6 +211,8 @@ protected:
      */
     qreal hoverOpacity() const;
 
+    const KItemListWidgetInformant* informant() const;
+
 private slots:
     void slotHoverAnimationFinished();
 
@@ -160,15 +225,16 @@ private:
 private:
     Q_PROPERTY(qreal hoverOpacity READ hoverOpacity WRITE setHoverOpacity)
 
+    KItemListWidgetInformant* m_informant;
     int m_index;
     bool m_selected;
     bool m_current;
     bool m_hovered;
-    bool m_alternatingBackgroundColors;
+    bool m_alternateBackground;
     bool m_enabledSelectionToggle;
     QHash<QByteArray, QVariant> m_data;
     QList<QByteArray> m_visibleRoles;
-    QHash<QByteArray, QSizeF> m_visibleRolesSizes;
+    QHash<QByteArray, qreal> m_columnWidths;
     KItemListStyleOption m_styleOption;
     QBitArray m_siblingsInfo;
 
@@ -177,7 +243,15 @@ private:
     QPropertyAnimation* m_hoverAnimation;
 
     KItemListSelectionToggle* m_selectionToggle;
+
+    QByteArray m_editedRole;
 };
+
+inline const KItemListWidgetInformant* KItemListWidget::informant() const
+{
+    return m_informant;
+}
+
 #endif