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
{
    TitleBarMenuButton,
    TitleBarMinButton,
    TitleBarMaxButton,
    TitleBarCloseButton,
    TitleBarNormalButton,
    TitleBarShadeButton,
    TitleBarUnshadeButton,
    TitleBarContextHelpButton,
    DockWidgetCloseButton,
    MessageBoxInformation,
    MessageBoxWarning,
    MessageBoxCritical,
    MessageBoxQuestion,
    DesktopIcon,
    TrashIcon,
    ComputerIcon,
    DriveFDIcon,
    DriveHDIcon,
    DriveCDIcon,
    DriveDVDIcon,
    DriveNetIcon,
    DirOpenIcon,
    DirClosedIcon,
    DirLinkIcon,
    DirLinkOpenIcon,
    FileIcon,
    FileLinkIcon,
    ToolBarHorizontalExtensionButton,
    ToolBarVerticalExtensionButton,
    FileDialogStart,
    FileDialogEnd,
    FileDialogToParent,
    FileDialogNewFolder,
    FileDialogDetailedView,
    FileDialogInfoView,
    FileDialogContentsView,
    FileDialogListView,
    FileDialogBack,
    DirIcon,
    DialogOkButton,
    DialogCancelButton,
    DialogHelpButton,
    DialogOpenButton,
    DialogSaveButton,
    DialogCloseButton,
    DialogApplyButton,
    DialogResetButton,
    DialogDiscardButton,
    DialogYesButton,
    DialogNoButton,
    ArrowUp,
    ArrowDown,
    ArrowLeft,
    ArrowRight,
    ArrowBack,
    ArrowForward,
    DirHomeIcon,
    CommandLink,
    VistaShield,
    BrowserReload,
    BrowserStop,
    MediaPlay,
    MediaStop,
    MediaPause,
    MediaSkipForward,
    MediaSkipBackward,
    MediaSeekForward,
    MediaSeekBackward,
    MediaVolume,
    MediaVolumeMuted,
    LineEditClearButton,
    DialogYesToAllButton,
    DialogNoToAllButton,
    DialogSaveAllButton,
    DialogAbortButton,
    DialogRetryButton,
    DialogIgnoreButton,
    RestoreDefaultsButton,
    TabCloseButton
};
 
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