icon.h

// SPDX-FileCopyrightText: 2025 Manuel Schneider
// SPDX-License-Identifier: MIT
 
#pragma once
#include <QString>
#include <albert/export.h>
#include <memory>
#include <filesystem>
class QBrush;
class QIcon;
class QPainter;
class QPixmap;
class QRect;
class QSize;
class QString;
 
namespace albert
{
 
class ALBERT_EXPORT Icon
{
public:
 
    virtual ~Icon();
 
    virtual std::unique_ptr<Icon> clone() const = 0;
 
    virtual QSize actualSize(const QSize &device_independent_size, double device_pixel_ratio);
 
    virtual QPixmap pixmap(const QSize &device_independent_size, double device_pixel_ratio);
 
    virtual void paint(QPainter *painter, const QRect &rect) = 0;
 
    virtual bool isNull();
 
    virtual QString toUrl() const = 0;
 
    virtual QString cacheKey();
 
    static QIcon qIcon(std::unique_ptr<albert::Icon> icon);
 
    static std::unique_ptr<Icon> iconFromUrl(const QString &url);
 
    static std::unique_ptr<Icon> iconFromUrls(const QStringList &urls);
 
 
    static std::unique_ptr<Icon> image(const QString &path);
 
    static std::unique_ptr<Icon> image(const std::filesystem::path &path);
 
 
 
    static std::unique_ptr<Icon> fileType(const QString &path);
 
    static std::unique_ptr<Icon> fileType(const std::filesystem::path &path);
 
 
 
    static std::unique_ptr<Icon> theme(const QString &icon_name);
 
 
    enum StandardIconType
    {
        TitleBarMinButton = 1,                 
        TitleBarMenuButton = 0,                
        TitleBarMaxButton = 2,                 
        TitleBarCloseButton = 3,               
        TitleBarNormalButton = 4,              
        TitleBarShadeButton = 5,               
        TitleBarUnshadeButton = 6,             
        TitleBarContextHelpButton = 7,         
        MessageBoxInformation = 9,             
        MessageBoxWarning = 10,                
        MessageBoxCritical = 11,               
        MessageBoxQuestion = 12,               
        DesktopIcon = 13,                      
        TrashIcon = 14,                        
        ComputerIcon = 15,                     
        DriveFDIcon = 16,                      
        DriveHDIcon = 17,                      
        DriveCDIcon = 18,                      
        DriveDVDIcon = 19,                     
        DriveNetIcon = 20,                     
        DirHomeIcon = 56,                      
        DirOpenIcon = 21,                      
        DirClosedIcon = 22,                    
        DirIcon = 38,                          
        DirLinkIcon = 23,                      
        DirLinkOpenIcon = 24,                  
        FileIcon = 25,                         
        FileLinkIcon = 26,                     
        FileDialogStart = 29,                  
        FileDialogEnd = 30,                    
        FileDialogToParent = 31,               
        FileDialogNewFolder = 32,              
        FileDialogDetailedView = 33,           
        FileDialogInfoView = 34,               
        FileDialogContentsView = 35,           
        FileDialogListView = 36,               
        FileDialogBack = 37,                   
        DockWidgetCloseButton = 8,             
        ToolBarHorizontalExtensionButton = 27, 
        ToolBarVerticalExtensionButton = 28,   
        DialogOkButton = 39,                   
        DialogCancelButton = 40,               
        DialogHelpButton = 41,                 
        DialogOpenButton = 42,                 
        DialogSaveButton = 43,                 
        DialogCloseButton = 44,                
        DialogApplyButton = 45,                
        DialogResetButton = 46,                
        DialogDiscardButton = 47,              
        DialogYesButton = 48,                  
        DialogNoButton = 49,                   
        ArrowUp = 50,                          
        ArrowDown = 51,                        
        ArrowLeft = 52,                        
        ArrowRight = 53,                       
        ArrowBack = 54,                        
        ArrowForward = 55,                     
        CommandLink = 57,                      
        VistaShield = 58,                      
        BrowserReload = 59,                    
        BrowserStop = 60,                      
        MediaPlay = 61,                        
        MediaStop = 62,                        
        MediaPause = 63,                       
        MediaSkipForward = 64,                 
        MediaSkipBackward = 65,                
        MediaSeekForward = 66,                 
        MediaSeekBackward = 67,                
        MediaVolume = 68,                      
        MediaVolumeMuted = 69,                 
        LineEditClearButton = 70,              
        DialogYesToAllButton = 71,             
        DialogNoToAllButton = 72,              
        DialogSaveAllButton = 73,              
        DialogAbortButton = 74,                
        DialogRetryButton = 75,                
        DialogIgnoreButton = 76,               
        RestoreDefaultsButton = 77,            
        TabCloseButton = 78,                   
    };
    static std::unique_ptr<Icon> standard(StandardIconType type);
 
 
    static QBrush graphemeDefaultBrush();
 
    static std::unique_ptr<Icon> grapheme(const QString &grapheme, double scalar = 1.0);
 
    static std::unique_ptr<Icon> grapheme(const QString &grapheme,
                                          double scalar,
                                          const QBrush &brush);
 
 
 
    static const QBrush &iconifiedDefaultBackgroundBrush();
 
    static const QBrush &iconifiedDefaultBorderBrush();
 
    static std::unique_ptr<Icon> iconified(
        std::unique_ptr<Icon> icon,
        const QBrush &background_brush = iconifiedDefaultBackgroundBrush(),
        double border_radius = 1.0,
        int border_width = 1,
        const QBrush &border_color = iconifiedDefaultBorderBrush());
 
 
 
    static std::unique_ptr<Icon> composed(std::unique_ptr<Icon> icon1,
                                          std::unique_ptr<Icon> icon2,
                                          double size1 = 0.7,
                                          double size2 = 0.7,
                                          double x1 = 0.0,
                                          double y1 = 0.0,
                                          double x2 = 1.0,
                                          double y2 = 1.0);
 
 
};
 
}  // namespace albert