File indexing completed on 2024-04-28 15:27:42

 /*
  *  SPDX-FileCopyrightText: 2011 Marco Martin <mart@kde.org>
  *  SPDX-FileCopyrightText: 2014 Aleix Pol Gonzalez <aleixpol@blue-systems.com>
  *  SPDX-FileCopyrightText: 2020 Carson Black <uhhadd@gmail.com>
  *
  *  SPDX-License-Identifier: LGPL-2.0-or-later
  */
 
 #pragma once
 
 #include <QIcon>
 #include <QPointer>
 #include <QQuickItem>
 #include <QVariant>
 
 class QNetworkReply;
 
 namespace Kirigami
 {
 class PlatformTheme;
 }
 
 /**
  * Class for rendering an icon in UI.
  */
 class Icon : public QQuickItem
 {
     Q_OBJECT
 
     /**
      * @brief This property holds the source of this icon.
      *
      * The icon can be pulled from:
      * * The Freedesktop standard icon name:
      * @include icon/IconThemeSource.qml
      * * The filesystem:
      * @include icon/FilesystemSource.qml
      * * Remote URIs:
      * @include icon/InternetSource.qml
      * * Custom providers:
      * @include icon/CustomSource.qml
      * * Your application's bundled resources:
      * @include icon/ResourceSource.qml
      *
      * @note See https://doc.qt.io/qt-5/qtquickcontrols2-icons.html for how to
      * bundle icon themes in your application to refer to them by name instead of
      * by resource URL.
      *
      * @note Use `fallback` to provide a fallback theme name for icons.
      *
      * @note Cuttlefish is a KDE application that lets you view all the icons that
      * you can use for your application. It offers a number of useful features such
      * as previews of their appearance across different installed themes, previews
      * at different sizes, and more. You might find it a useful tool when deciding
      * on which icons to use in your application.
      */
     Q_PROPERTY(QVariant source READ source WRITE setSource NOTIFY sourceChanged)
 
     /**
      * @brief This property holds the name of an icon from the icon theme
      * as a fallback for when an icon set with the ``source`` property is not found.
      *
      * @include icon/Fallback.qml
      * @note This will only be loaded if source is unavailable (e.g. it doesn't exist, or network issues have prevented loading).
      */
     Q_PROPERTY(QString fallback READ fallback WRITE setFallback NOTIFY fallbackChanged)
 
     /**
      * @brief This property holds the name of an icon from the icon theme to show
      * while the icon set in `source` is being loaded.
      *
      * This will only be used if the source image is a type that can have such a
      * long loading time that showing a temporary image in its place makes sense
      * (e.g. a remote image, or an image from an ImageProvider of the type
      * QtQml.QQmlImageProviderBase.ImageResponse).
      *
      * default: ``"image-png"``
      *
      * @since KDE Frameworks 5.15
      */
     Q_PROPERTY(QString placeholder READ placeholder WRITE setPlaceholder NOTIFY placeholderChanged)
 
     /**
      * @brief This property sets whether the icon will use the
      * @link QtGui.QIcon.Mode QIcon.Active @endlink mode,
      * resulting in a graphical effect being applied when the icon is currently active.
      *
      * @note This is typically used to indicate when an item is being hovered or pressed.
      *
      * @image html icon/active.png
      *
      * The color differences under the default KDE color palette, Breeze. Note
      * that a dull highlight background is typically displayed behind active icons and
      * it is recommended to add one if you are creating a custom component.
      *
      * default: ``false``
      */
     Q_PROPERTY(bool active READ active WRITE setActive NOTIFY activeChanged)
 
     /**
      * @brief This property specifies whether the icon's `source` is valid and is being used.
      */
     Q_PROPERTY(bool valid READ valid NOTIFY validChanged)
 
     /**
      * @brief This property sets whether the icon will use the
      * @link QtGui.QIcon.Mode QIcon.Selected @endlink mode,
      * resulting in a graphical effect being applied when the icon is currently selected.
      *
      * This is typically used to indicate when a list item is currently selected.
      *
      * @image html icon/selected.png
      *
      * The color differences under the default KDE color palette, Breeze. Note
      * that a blue background is typically displayed behind selected elements.
      *
      * default: ``false``
      */
     Q_PROPERTY(bool selected READ selected WRITE setSelected NOTIFY selectedChanged)
 
     /**
      * @brief This property sets whether this icon will be treated as a mask.
      *
      * When an icon is being used as a mask, all non-transparent colors are replaced
      * with the color provided in the Icon's ::color property.
      *
      * default: ``false``
      *
      * @see ::color
      */
     Q_PROPERTY(bool isMask READ isMask WRITE setIsMask NOTIFY isMaskChanged)
 
     /**
      * @brief This property holds the color to use when drawing the icon.
      *
      * This property is used only when ::isMask is set to true.
      * If this property is not set or is `Qt::transparent`, the icon will use
      * the text or the selected text color, depending on if ::selected is set to
      * true.
      *
      * default: ``Qt::transparent``
      * @see Qt::GlobalColor
      */
     Q_PROPERTY(QColor color READ color WRITE setColor NOTIFY colorChanged)
 
     /**
      * @brief This property specifies the status of the icon.
      *
      * @note Image loading will not be initiated until the item is shown, so if the Icon is not visible,
      * it can only have Null or Loading states.
      *
      * default: ``Status::Null``
      *
      * @since KDE Frameworks 5.15
      */
     Q_PROPERTY(Icon::Status status READ status NOTIFY statusChanged)
 
     /**
      * @brief This property holds the width of the painted area in pixels.
      *
      * This will be smaller than or equal to the width of the area
      * taken up by the Item itself. This can be 0.
      *
      * default: ``0.0``
      *
      * @since KDE Frameworks 5.15
      */
     Q_PROPERTY(qreal paintedWidth READ paintedWidth NOTIFY paintedAreaChanged)
 
     /**
      * @brief This property holds the height of the painted area in pixels.
      *
      * This will be smaller than or equal to the height of the area
      * taken up by the Item itself. This can be 0.
      *
      * default: ``0.0``
      *
      * @since KDE Frameworks 5.15
      */
     Q_PROPERTY(qreal paintedHeight READ paintedHeight NOTIFY paintedAreaChanged)
 public:
     /**
      * @brief This enum indicates the current status of the icon.
      */
     enum Status {
         /**
          * @brief No icon source has been set.
          */
         Null = 0,
 
         /**
          * @brief The icon has been loaded correctly.
          */
         Ready,
 
         /**
          * @brief The icon is currently being loaded.
          */
         Loading,
 
         /**
          * @brief There was an error while loading the icon, for instance
          * a non existent themed name, or an invalid url.
          */
         Error,
     };
     Q_ENUM(Status)
 
     Icon(QQuickItem *parent = nullptr);
     ~Icon() override;
 
     void setSource(const QVariant &source);
     QVariant source() const;
 
     void setActive(bool active = true);
     bool active() const;
 
     bool valid() const;
 
     void setSelected(bool selected = true);
     bool selected() const;
 
     void setIsMask(bool mask);
     bool isMask() const;
 
     void setColor(const QColor &color);
     QColor color() const;
 
     QString fallback() const;
     void setFallback(const QString &fallback);
 
     QString placeholder() const;
     void setPlaceholder(const QString &placeholder);
 
     Status status() const;
 
     qreal paintedWidth() const;
     qreal paintedHeight() const;
 
     QSGNode *updatePaintNode(QSGNode *node, UpdatePaintNodeData *data) override;
 
 Q_SIGNALS:
     void sourceChanged();
     void activeChanged();
     void validChanged();
     void selectedChanged();
     void isMaskChanged();
     void colorChanged();
     void fallbackChanged(const QString &fallback);
     void placeholderChanged(const QString &placeholder);
     void statusChanged();
     void paintedAreaChanged();
 
 protected:
 #if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
     void geometryChanged(const QRectF &newGeometry, const QRectF &oldGeometry) override;
 #else
     void geometryChange(const QRectF &newGeometry, const QRectF &oldGeometry) override;
 #endif
     QImage findIcon(const QSize &size);
     void handleFinished(QNetworkReply *reply);
     void handleRedirect(QNetworkReply *reply);
     QIcon::Mode iconMode() const;
     bool guessMonochrome(const QImage &img);
     void setStatus(Status status);
     void updatePolish() override;
     void updatePaintedGeometry();
     void updateIsMaskHeuristic(const QString &iconSource);
     void itemChange(QQuickItem::ItemChange change, const QQuickItem::ItemChangeData &value) override;
 
 private:
     Kirigami::PlatformTheme *m_theme = nullptr;
     QPointer<QNetworkReply> m_networkReply;
     QHash<int, bool> m_monochromeHeuristics;
     QVariant m_source;
     Status m_status = Null;
     bool m_changed;
     bool m_active;
     bool m_selected;
     bool m_isMask;
     bool m_isMaskHeuristic = false;
     QImage m_loadedImage;
     QColor m_color = Qt::transparent;
     QString m_fallback = QStringLiteral("unknown");
     QString m_placeholder = QStringLiteral("image-png");
     qreal m_paintedWidth = 0.0;
     qreal m_paintedHeight = 0.0;
 
     QImage m_icon;
 };