New selection effects

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

diff --git a/src/kitemviews/kstandarditemlistwidget.h b/src/kitemviews/kstandarditemlistwidget.h
index 3edec0db55c8e75d4ddf6f0cd9004fbc7787a6ff..cabe3a8c963a0aa24c1a28803deb92610f054bf6 100644 (file)
--- a/src/kitemviews/kstandarditemlistwidget.h
+++ b/src/kitemviews/kstandarditemlistwidget.h
@@ -11,24 +11,31 @@
 #include "kitemviews/kitemlistwidget.h"
 
 #include <QPixmap>
 #include "kitemviews/kitemlistwidget.h"
 
 #include <QPixmap>

+#include <QPointer>

 #include <QPointF>
 #include <QStaticText>
 
 class KItemListRoleEditor;
 class KItemListStyleOption;
 class KItemListView;
 #include <QPointF>
 #include <QStaticText>
 
 class KItemListRoleEditor;
 class KItemListStyleOption;
 class KItemListView;

+class QVariantAnimation;

 
 

+/**
+ * @brief standard implementation of the ItemList widget informant for use with KStandardItemListView and KStandardItemModel.
+ *
+ * @see KItemListWidgetInformant
+ */

 class DOLPHIN_EXPORT KStandardItemListWidgetInformant : public KItemListWidgetInformant
 {
 public:
     KStandardItemListWidgetInformant();
     ~KStandardItemListWidgetInformant() override;
 class DOLPHIN_EXPORT KStandardItemListWidgetInformant : public KItemListWidgetInformant
 {
 public:
     KStandardItemListWidgetInformant();
     ~KStandardItemListWidgetInformant() override;

-    
-    void calculateItemSizeHints(QVector<std::pair<qreal /* height */, bool /* isElided */>>& logicalHeightHints, qreal& logicalWidthHint, const KItemListView* view) const override;

 
 

-    qreal preferredRoleColumnWidth(const QByteArray& role,
-                                           int index,
-                                           const KItemListView* view) const override;
+    void calculateItemSizeHints(QVector<std::pair<qreal /* height */, bool /* isElided */>> &logicalHeightHints,
+                                qreal &logicalWidthHint,
+                                const KItemListView *view) const override;
+
+    qreal preferredRoleColumnWidth(const QByteArray &role, int index, const KItemListView *view) const override;

 
 protected:
     /**
 
 protected:
     /**


@@ -38,55 +45,57 @@ protected:
      *         QHash<QByteArray, QVariant> returned by KItemModelBase::data(int),
      *         it can reimplement this function.
      */
      *         QHash<QByteArray, QVariant> returned by KItemModelBase::data(int),
      *         it can reimplement this function.
      */

-    virtual QString itemText(int index, const KItemListView* view) const;
+    virtual QString itemText(int index, const KItemListView *view) const;

 
     /**
      * @return The value of the "isLink" role. The default implementation returns false.
      *         The derived class should reimplement this function, when information about
      *         links is available and in usage.
      */
 
     /**
      * @return The value of the "isLink" role. The default implementation returns false.
      *         The derived class should reimplement this function, when information about
      *         links is available and in usage.
      */

-    virtual bool itemIsLink(int index, const KItemListView* view) const;
+    virtual bool itemIsLink(int index, const KItemListView *view) const;
+
+    /** Configure whether the requested text should be optimized for viewing on a screen or for being read out aloud by a text-to-speech engine. */
+    enum class ForUsageAs { DisplayedText, SpokenText };

 
     /**
 
     /**

+     * @param role          The role the text is being requested for.
+     * @param values        The data of the item. All the data is passed because the text might depend on multiple data points.
+     * @param forUsageAs    Whether the roleText should be optimized for displaying (i.e. kept somewhat short) or optimized for speaking e.g. by screen readers
+     *                      or text-to-speech in general (i.e. by prefering announcing a month as July instead of as the number 7).

      * @return String representation of the role \a role. The representation of
      *         a role might depend on other roles, so the values of all roles
      *         are passed as parameter.
      */
      * @return String representation of the role \a role. The representation of
      *         a role might depend on other roles, so the values of all roles
      *         are passed as parameter.
      */

-    virtual QString roleText(const QByteArray& role,
-                             const QHash<QByteArray, QVariant>& values) const;
+    virtual QString roleText(const QByteArray &role, const QHash<QByteArray, QVariant> &values, ForUsageAs forUsageAs = ForUsageAs::DisplayedText) const;

 
     /**
     * @return A font based on baseFont which is customized for symlinks.
     */
 
     /**
     * @return A font based on baseFont which is customized for symlinks.
     */

-    virtual QFont customizedFontForLinks(const QFont& baseFont) const;
+    virtual QFont customizedFontForLinks(const QFont &baseFont) const;

 
 

-    void calculateIconsLayoutItemSizeHints(QVector<std::pair<qreal, bool>>& logicalHeightHints, qreal& logicalWidthHint, const KItemListView* view) const;
-    void calculateCompactLayoutItemSizeHints(QVector<std::pair<qreal, bool>>& logicalHeightHints, qreal& logicalWidthHint, const KItemListView* view) const;
-    void calculateDetailsLayoutItemSizeHints(QVector<std::pair<qreal, bool>>& logicalHeightHints, qreal& logicalWidthHint, const KItemListView* view) const;
+    void calculateIconsLayoutItemSizeHints(QVector<std::pair<qreal, bool>> &logicalHeightHints, qreal &logicalWidthHint, const KItemListView *view) const;
+    void calculateCompactLayoutItemSizeHints(QVector<std::pair<qreal, bool>> &logicalHeightHints, qreal &logicalWidthHint, const KItemListView *view) const;
+    void calculateDetailsLayoutItemSizeHints(QVector<std::pair<qreal, bool>> &logicalHeightHints, qreal &logicalWidthHint, const KItemListView *view) const;

 
     friend class KStandardItemListWidget; // Accesses roleText()
 };
 
 /**
 
     friend class KStandardItemListWidget; // Accesses roleText()
 };
 
 /**

- * @brief ItemList widget implementation for KStandardItemListView and KStandardItemModel.
+ * @brief standard implementation of an ItemList widget for KStandardItemListView and KStandardItemModel.
+ *
+ * @see KItemListWidget

  */
 class DOLPHIN_EXPORT KStandardItemListWidget : public KItemListWidget
 {
     Q_OBJECT
 
 public:
  */
 class DOLPHIN_EXPORT KStandardItemListWidget : public KItemListWidget
 {
     Q_OBJECT
 
 public:

-    enum Layout
-    {
-        IconsLayout,
-        CompactLayout,
-        DetailsLayout
-    };
+    enum Layout { IconsLayout, CompactLayout, DetailsLayout };

 
 

-    KStandardItemListWidget(KItemListWidgetInformant* informant, QGraphicsItem* parent);
+    KStandardItemListWidget(KItemListWidgetInformant *informant, QGraphicsItem *parent);

     ~KStandardItemListWidget() override;
 
     void setLayout(Layout layout);
     ~KStandardItemListWidget() override;
 
     void setLayout(Layout layout);

-    Layout layout() const;

 
     void setHighlightEntireRow(bool highlightEntireRow);
     bool highlightEntireRow() const;
 
     void setHighlightEntireRow(bool highlightEntireRow);
     bool highlightEntireRow() const;


@@ -94,17 +103,19 @@ public:
     void setSupportsItemExpanding(bool supportsItemExpanding);
     bool supportsItemExpanding() const;
 
     void setSupportsItemExpanding(bool supportsItemExpanding);
     bool supportsItemExpanding() const;
 

-    void paint(QPainter* painter, const QStyleOptionGraphicsItem* option, QWidget* widget = nullptr) override;
+    void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = nullptr) override;

 
 

-    QRectF iconRect() const override;

     QRectF textRect() const override;
     QRectF textFocusRect() const override;
     QRectF textRect() const override;
     QRectF textFocusRect() const override;

-    QRectF selectionRect() const override;
+    QRectF selectionRectFull() const override;
+    QRectF selectionRectCore() const override;

     QRectF expansionToggleRect() const override;
     QRectF selectionToggleRect() const override;
     QRectF expansionToggleRect() const override;
     QRectF selectionToggleRect() const override;

-    QPixmap createDragPixmap(const QStyleOptionGraphicsItem* option, QWidget* widget = nullptr) override;
+    QPixmap createDragPixmap(const QStyleOptionGraphicsItem *option, QWidget *widget = nullptr) override;
+    /** @see KItemListWidget::startActivateSoonAnimation() */
+    void startActivateSoonAnimation(int timeUntilActivation) override;

 
 

-    static KItemListWidgetInformant* createInformant();
+    static KItemListWidgetInformant *createInformant();

 
 protected:
     /**
 
 protected:
     /**


@@ -129,7 +140,7 @@ protected:
      * @return True if the give role should be right aligned when showing it inside a column.
      *         Per default false is returned.
      */
      * @return True if the give role should be right aligned when showing it inside a column.
      *         Per default false is returned.
      */

-    virtual bool isRoleRightAligned(const QByteArray& role) const;
+    virtual bool isRoleRightAligned(const QByteArray &role) const;

 
     /**
      * @return True if the item should be visually marked as hidden item. Per default
 
     /**
      * @return True if the item should be visually marked as hidden item. Per default


@@ -140,61 +151,56 @@ protected:
     /**
      * @return A font based on baseFont which is customized according to the data shown in the widget.
      */
     /**
      * @return A font based on baseFont which is customized according to the data shown in the widget.
      */

-    virtual QFont customizedFont(const QFont& baseFont) const;
+    virtual QFont customizedFont(const QFont &baseFont) const;

 
     virtual QPalette::ColorRole normalTextColorRole() const;
 
 
     virtual QPalette::ColorRole normalTextColorRole() const;
 

-    void setTextColor(const QColor& color);
-    QColor textColor() const;
+    void setTextColor(const QColor &color);
+    QColor textColor(const QWidget &widget) const;

 
 

-    void setOverlay(const QPixmap& overlay);
-    QPixmap overlay() const;
+    void setOverlays(QHash<Qt::Corner, QString> &overlay);
+    QHash<Qt::Corner, QString> overlays() const;

 
     /**
      * @see KStandardItemListWidgetInformant::roleText().
      */
 
     /**
      * @see KStandardItemListWidgetInformant::roleText().
      */

-    QString roleText(const QByteArray& role, const QHash<QByteArray, QVariant>& values) const;
+    QString roleText(const QByteArray &role, const QHash<QByteArray, QVariant> &values) const;
+
+    static int numberOfUnicodeCharactersIn(const QString &text);

 
     /**
 
     /**

-     * Fixes:
-     * Select the text without MIME-type extension
-     * This is file-item-specific and should be moved
-     * into KFileItemListWidget.
-     *
-     * Inherited classes can define, if the MIME-type extension
-     * should be selected or not.
-     *
-     * @return Selection length (with or without MIME-type extension)
+     * @return Selection length (with or without MIME-type extension) in number of unicode characters, which might be different from number of QChars.

      */
      */

-    virtual int selectionLength(const QString& text) const;
+    virtual int selectionLength(const QString &text) const;

 
 

-    void dataChanged(const QHash<QByteArray, QVariant>& current, const QSet<QByteArray>& roles = QSet<QByteArray>()) override;
-    void visibleRolesChanged(const QList<QByteArray>& current, const QList<QByteArray>& previous) override;
-    void columnWidthChanged(const QByteArray& role, qreal current, qreal previous) override;
-    void leadingPaddingChanged(qreal width) override;
-    void styleOptionChanged(const KItemListStyleOption& current, const KItemListStyleOption& previous) override;
+    void dataChanged(const QHash<QByteArray, QVariant> &current, const QSet<QByteArray> &roles = QSet<QByteArray>()) override;
+    void visibleRolesChanged(const QList<QByteArray> &current, const QList<QByteArray> &previous) override;
+    void columnWidthChanged(const QByteArray &role, qreal current, qreal previous) override;
+    void sidePaddingChanged(qreal leftPaddingWidth, qreal rightPaddingWidth) override;
+    void styleOptionChanged(const KItemListStyleOption &current, const KItemListStyleOption &previous) override;

     void hoveredChanged(bool hovered) override;
     void selectedChanged(bool selected) override;
     void hoveredChanged(bool hovered) override;
     void selectedChanged(bool selected) override;

-    void siblingsInformationChanged(const QBitArray& current, const QBitArray& previous) override;
-    void editedRoleChanged(const QByteArray& current, const QByteArray& previous) override;
-    void resizeEvent(QGraphicsSceneResizeEvent* event) override;
-    void showEvent(QShowEvent* event) override;
-    void hideEvent(QHideEvent* event) override;
+    void siblingsInformationChanged(const QBitArray &current, const QBitArray &previous) override;
+    void editedRoleChanged(const QByteArray &current, const QByteArray &previous) override;
+    void iconSizeChanged(int current, int previous) override;
+    void resizeEvent(QGraphicsSceneResizeEvent *event) override;
+    void showEvent(QShowEvent *event) override;
+    void hideEvent(QHideEvent *event) override;

     bool event(QEvent *event) override;
 
     bool event(QEvent *event) override;
 

-    struct TextInfo
-    {
+    struct TextInfo {

         QPointF pos;
         QStaticText staticText;
     };
         QPointF pos;
         QStaticText staticText;
     };

+    void updateAdditionalInfoTextColor();

 
 public Q_SLOTS:
     void finishRoleEditing();
 
 private Q_SLOTS:
     void slotCutItemsChanged();
 
 public Q_SLOTS:
     void finishRoleEditing();
 
 private Q_SLOTS:
     void slotCutItemsChanged();

-    void slotRoleEditingCanceled(const QByteArray& role, const QVariant& value);
-    void slotRoleEditingFinished(const QByteArray& role, const QVariant& value);
+    void slotRoleEditingCanceled(const QByteArray &role, const QVariant &value);
+    void slotRoleEditingFinished(const QByteArray &role, const QVariant &value);

 
 private:
     void triggerCacheRefreshing();
 
 private:
     void triggerCacheRefreshing();


@@ -206,14 +212,26 @@ private:
     void updateCompactLayoutTextCache();
     void updateDetailsLayoutTextCache();
 
     void updateCompactLayoutTextCache();
     void updateDetailsLayoutTextCache();
 

-    void updateAdditionalInfoTextColor();
+    QPixmap addOverlays(const QPixmap &pixmap,
+                        const QHash<Qt::Corner, QString> &overlays,
+                        const QSize &size,
+                        qreal devicePixelRatioF,
+                        QIcon::Mode mode = QIcon::Normal) const;

 
 

-    void drawPixmap(QPainter* painter, const QPixmap& pixmap);
-    void drawSiblingsInformation(QPainter* painter);
+    void drawPixmap(QPainter *painter, const QPixmap &pixmap);
+    /** Draw the lines and arrows that visualize the expanded state and level of this row. */
+    void drawSiblingsInformation(QPainter *painter);

 
     QRectF roleEditingRect(const QByteArray &role) const;
 
 
     QRectF roleEditingRect(const QByteArray &role) const;
 

-    QString elideRightKeepExtension(const QString &text, int elidingWidth) const;
+    QString elideText(QString text, qreal elidingWidth) const;
+
+    /**
+     * Escapes text for display purposes.
+     *
+     * Replaces '\n' with Unicode line break (U+21B5).
+     */
+    QString escapeString(const QString &text) const;

 
     /**
      * Closes the role editor and returns the focus back
 
     /**
      * Closes the role editor and returns the focus back


@@ -221,23 +239,26 @@ private:
      */
     void closeRoleEditor();
 
      */
     void closeRoleEditor();
 

-    static QPixmap pixmapForIcon(const QString& name, const QStringList& overlays, int size, QIcon::Mode mode);
+    QPixmap pixmapForIcon(const QString &name, const QSize &size, QIcon::Mode mode) const;

 
     /**
      * @return Preferred size of the rating-image based on the given
      *         style-option. The height of the font is taken as
      *         reference.
      */
 
     /**
      * @return Preferred size of the rating-image based on the given
      *         style-option. The height of the font is taken as
      *         reference.
      */

-    static QSizeF preferredRatingSize(const KItemListStyleOption& option);
+    static QSizeF preferredRatingSize(const KItemListStyleOption &option);

 
     /**
      * @return Horizontal padding in pixels that is added to the required width of
      *         a column to display the content.
      */
 
     /**
      * @return Horizontal padding in pixels that is added to the required width of
      *         a column to display the content.
      */

-    static qreal columnPadding(const KItemListStyleOption& option);
+    static qreal columnPadding(const KItemListStyleOption &option);
+
+    /** @returns whether the usual icon should be shown or not. */
+    bool isIconControlledByActivateSoonAnimation() const;

 
 protected:
 
 protected:

-    QHash<QByteArray, TextInfo*> m_textInfo; // PlacesItemListWidget needs to access this
+    QHash<QByteArray, TextInfo *> m_textInfo; // PlacesItemListWidget needs to access this

 
 private:
     bool m_isCut;
 
 private:
     bool m_isCut;


@@ -258,8 +279,7 @@ private:
     QSize m_scaledPixmapSize; //Size of the pixmap in device independent pixels
 
     qreal m_columnWidthSum;
     QSize m_scaledPixmapSize; //Size of the pixmap in device independent pixels
 
     qreal m_columnWidthSum;

-    QRectF m_iconRect;          // Cache for KItemListWidget::iconRect()
-    QPixmap m_hoverPixmap;      // Cache for modified m_pixmap when hovering the item
+    QRectF m_iconRect; // Cache for KItemListWidget::iconRect()

 
     QRectF m_textRect;
 
 
     QRectF m_textRect;
 


@@ -270,11 +290,14 @@ private:
     QColor m_customTextColor;
     QColor m_additionalInfoTextColor;
 
     QColor m_customTextColor;
     QColor m_additionalInfoTextColor;
 

-    QPixmap m_overlay;
+    QHash<Qt::Corner, QString> m_overlays;

     QPixmap m_rating;
 
     QPixmap m_rating;
 

-    KItemListRoleEditor* m_roleEditor;
-    KItemListRoleEditor* m_oldRoleEditor;
+    KItemListRoleEditor *m_roleEditor;
+    KItemListRoleEditor *m_oldRoleEditor;
+
+    /** @see startActivateSoonAnimation() */
+    QPointer<QVariantAnimation> m_activateSoonAnimation;

 
     friend class KStandardItemListWidgetInformant; // Accesses private static methods to be able to
                                                    // share a common layout calculation
 
     friend class KStandardItemListWidgetInformant; // Accesses private static methods to be able to
                                                    // share a common layout calculation