GIT_SILENT Update Appstream for new release

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

diff --git a/src/kitemviews/kfileitemlistwidget.h b/src/kitemviews/kfileitemlistwidget.h
index 094f6105f9c372b06f72af97b073b3bc5963f9c0..e2db43178bdb53b2b4f4ce5197b50cad4652749c 100644 (file)
--- a/src/kitemviews/kfileitemlistwidget.h
+++ b/src/kitemviews/kfileitemlistwidget.h
@@ -12,7 +12,13 @@
 
 class KFileItemListView;
 
-
+/**
+ * @brief ItemList widget informant implementation for use with KFileItems.
+ *
+ * Code that does not expect KFileItems specifically should go to KStandardItemListWidgetInformant.
+ *
+ * @see KItemListWidgetInformant
+ */
 class DOLPHIN_EXPORT KFileItemListWidgetInformant : public KStandardItemListWidgetInformant
 {
 public:
@@ -20,40 +26,51 @@ public:
     ~KFileItemListWidgetInformant() override;
 
 protected:
-    QString itemText(int index, const KItemListView* view) const override;
-    bool itemIsLink(int index, const KItemListView* view) const override;
-    QString roleText(const QByteArray& role, const QHash<QByteArray, QVariant>& values) const override;
-    QFont customizedFontForLinks(const QFont& baseFont) const override;
+    QString itemText(int index, const KItemListView *view) const override;
+    bool itemIsLink(int index, const KItemListView *view) const override;
+    /** @see KStandardItemListWidget::roleText(). */
+    QString roleText(const QByteArray &role, const QHash<QByteArray, QVariant> &values, ForUsageAs forUsageAs = ForUsageAs::DisplayedText) const override;
+    QFont customizedFontForLinks(const QFont &baseFont) const override;
+
+    friend class KItemListDelegateAccessible;
 };
 
+/**
+ * @brief ItemList widget implementation for use with KFileItems.
+ *
+ * Code that does not expect KFileItems specifically should go to KStandardItemListWidget.
+ *
+ * @see KItemListWidget
+ */
 class DOLPHIN_EXPORT KFileItemListWidget : public KStandardItemListWidget
 {
     Q_OBJECT
 
 public:
-    KFileItemListWidget(KItemListWidgetInformant* informant, QGraphicsItem* parent);
+    KFileItemListWidget(KItemListWidgetInformant *informant, QGraphicsItem *parent);
     ~KFileItemListWidget() override;
 
-    static KItemListWidgetInformant* createInformant();
+    static KItemListWidgetInformant *createInformant();
+
+    /// Force-update the displayed icon
+    void forceUpdate();
 
 protected:
     virtual void hoverSequenceStarted() override;
     virtual void hoverSequenceIndexChanged(int sequenceIndex) override;
     virtual void hoverSequenceEnded() override;
 
-    bool isRoleRightAligned(const QByteArray& role) const override;
+    bool isRoleRightAligned(const QByteArray &role) const override;
     bool isHidden() const override;
-    QFont customizedFont(const QFont& baseFont) const override;
+    QFont customizedFont(const QFont &baseFont) const override;
 
     /**
-     * @return Selection length without MIME-type extension
+     * @return Selection length without MIME-type extension in number of unicode characters, which might be different from number of QChars.
      */
-    int selectionLength(const QString& text) const override;
+    int selectionLength(const QString &text) const override;
 
 private:
-    KFileItemListView* listView();
+    KFileItemListView *listView();
 };
 
 #endif
-
-