iconutil.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2025 Manuel Schneider
// SPDX-License-Identifier: MIT
 
#pragma once
#include <albert/export.h>
#include <albert/icon.h>
#include <filesystem>
#include <QString>
class QIcon;
class QBrush;
 
namespace albert
{
 
 
ALBERT_EXPORT QIcon qIcon(std::unique_ptr<albert::Icon> icon);
 
ALBERT_EXPORT std::unique_ptr<Icon> iconFromUrl(const QString &url);
 
ALBERT_EXPORT std::unique_ptr<Icon> iconFromUrls(const QStringList &urls);
 
 
// ---------------------------------------------------------------------------------------------------------------------
 
 
ALBERT_EXPORT std::unique_ptr<Icon> makeImageIcon(const QString &path);
 
ALBERT_EXPORT std::unique_ptr<Icon> makeImageIcon(const std::filesystem::path &path);
 
 
// ---------------------------------------------------------------------------------------------------------------------
 
 
ALBERT_EXPORT std::unique_ptr<Icon> makeFileTypeIcon(const QString &path);
 
ALBERT_EXPORT std::unique_ptr<Icon> makeFileTypeIcon(const std::filesystem::path &path);
 
 
// ---------------------------------------------------------------------------------------------------------------------
 
 
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,                   
};
 
 
ALBERT_EXPORT std::unique_ptr<Icon> makeStandardIcon(StandardIconType type);
 
 
// ---------------------------------------------------------------------------------------------------------------------
 
 
ALBERT_EXPORT std::unique_ptr<Icon> makeThemeIcon(const QString &icon_name);
 
 
// ---------------------------------------------------------------------------------------------------------------------
 
 
ALBERT_EXPORT const QBrush &graphemeIconDefaultColor();
 
ALBERT_EXPORT double graphemeIconDefaultScalar();
 
ALBERT_EXPORT std::unique_ptr<Icon> makeGraphemeIcon(const QString &grapheme,
                                                     double scalar = graphemeIconDefaultScalar(),
                                                     const QBrush &color = graphemeIconDefaultColor());
 
 
// ---------------------------------------------------------------------------------------------------------------------
 
 
ALBERT_EXPORT const QBrush &rectIconDefaultColor();
 
ALBERT_EXPORT const QBrush &rectIconDefaultBorderColor();
 
ALBERT_EXPORT double rectIconDefaultRadius();
 
ALBERT_EXPORT int rectIconDefaultBorderWidth();
 
ALBERT_EXPORT std::unique_ptr<Icon> makeRectIcon(const QBrush &color = rectIconDefaultColor(),
                                                 double radius = rectIconDefaultRadius(),
                                                 int border_width = rectIconDefaultBorderWidth(),
                                                 const QBrush &border_color = rectIconDefaultBorderColor());
 
 
// ---------------------------------------------------------------------------------------------------------------------
 
 
ALBERT_EXPORT const QBrush &iconifiedIconDefaultColor();
 
ALBERT_EXPORT double iconifiedIconDefaultBorderRadius();
 
ALBERT_EXPORT int iconifiedIconDefaultBorderWidth();
 
ALBERT_EXPORT const QBrush &iconifiedIconDefaultBorderColor();
 
 
ALBERT_EXPORT std::unique_ptr<Icon> makeIconifiedIcon(std::unique_ptr<Icon> src,
                                                      const QBrush &color = iconifiedIconDefaultColor(),
                                                      double border_radius = iconifiedIconDefaultBorderRadius(),
                                                      int border_width = iconifiedIconDefaultBorderWidth(),
                                                      const QBrush &border_color = iconifiedIconDefaultBorderColor());
 
 
// ---------------------------------------------------------------------------------------------------------------------
 
 
ALBERT_EXPORT double composedIconDefaultSize();
 
ALBERT_EXPORT double composedIconDefaultPos1();
 
ALBERT_EXPORT double composedIconDefaultPos2();
 
ALBERT_EXPORT std::unique_ptr<Icon> makeComposedIcon(std::unique_ptr<Icon> src1,
                                                     std::unique_ptr<Icon> src2,
                                                     double size1 = composedIconDefaultSize(),
                                                     double size2 = composedIconDefaultSize(),
                                                     double x1 = composedIconDefaultPos1(),
                                                     double y1 = composedIconDefaultPos1(),
                                                     double x2 = composedIconDefaultPos2(),
                                                     double y2 = composedIconDefaultPos2());
 
 
 
}  // namespace albert