QIcon Class

成员函数文档

这是一个重载函数。

返回current icon theme 中与icon 对应的QIcon 。

如果当前主题没有为icon 提供图标，则会查询fallback icon theme ，然后再返回到fallback icon search path 中查找独立图标文件。最后，会查询平台的本地图标库。

如果未找到图标且提供了fallback ，则返回fallback 。无论当前的图标主题和回退路径集是否支持所请求的图标，这都有助于提供有保证的回退。

如果没有找到图标，也没有提供fallback ，则会返回一个默认构造的空QIcon 。

此函数在 Qt 6.7 中引入。

[noexcept] QIcon::QIcon()

构造一个空图标。

[explicit] QIcon::QIcon(QIconEngine *engine)

创建一个具有特定图标engine 的图标。图标拥有引擎的所有权。

QIcon::QIcon(const QPixmap &pixmap)

从pixmap 构建一个图标。

[explicit] QIcon::QIcon(const QString &fileName)

用给定的fileName 文件构建一个图标。文件将按需加载。

如果fileName 包含相对路径（例如只包含文件名），则必须相对于运行时工作目录找到相关文件。

文件名可以是磁盘上的实际文件，也可以是应用程序的嵌入式资源。有关如何在应用程序的可执行文件中嵌入图像和其他资源文件的详细信息，请参阅资源系统概述。

使用QImageReader::supportedImageFormats() 和QImageWriter::supportedImageFormats() 函数可获取所支持文件格式的完整列表。

QIcon::QIcon(const QIcon &other)

构建other 的副本。速度非常快。

[noexcept] QIcon::QIcon(QIcon &&other)

Move-构建一个 QIcon 实例，使其指向other 所指向的同一对象。

[noexcept] QIcon::~QIcon()

销毁图标。

QSize QIcon::actualSize(const QSize &size, QIcon::Mode mode = Normal, QIcon::State state = Off) const

返回所请求的size 、mode 和state 图标的实际大小。结果可能会比请求的小，但绝不会比请求的大。返回的大小与设备无关，单位为像素（这与高分辨率像素图有关）。

另请参阅 pixmap() 和paint()。

void QIcon::addFile(const QString &fileName, const QSize &size = QSize(), QIcon::Mode mode = Normal, QIcon::State state = Off)

作为size 、mode 和state 的特化，将给定fileName 文件中的图像添加到图标中。该文件将按需加载。注意：自定义图标引擎可以忽略额外添加的像素图。

如果fileName 包含相对路径（例如只包含文件名），则必须相对于运行时工作目录找到相关文件。

文件名可以是磁盘上的实际文件，也可以是应用程序的嵌入式资源。有关如何在应用程序的可执行文件中嵌入图像和其他资源文件的详细信息，请参阅资源系统概述。

使用QImageReader::supportedImageFormats() 和QImageWriter::supportedImageFormats() 函数可获取所支持文件格式的完整列表。

如果存在高分辨率版本的图像（通过基本名称上的后缀@2x 标识），则会自动加载并添加，同时将设备像素比设置为 2。可通过设置环境变量QT_HIGHDPI_DISABLE_2X_IMAGE_LOADING 禁用此功能（请参阅QImageReader ）。

另请参阅 addPixmap() 和QPixmap::devicePixelRatio()。

void QIcon::addPixmap(const QPixmap &pixmap, QIcon::Mode mode = Normal, QIcon::State state = Off)

为图标添加pixmap ，作为mode 和state 的特化。

自定义图标引擎可以忽略额外添加的像素图。

另请参见 addFile()。

QList<QSize> QIcon::availableSizes(QIcon::Mode mode = Normal, QIcon::State state = Off) const

返回指定mode 和state 的可用图标尺寸列表。

qint64 QIcon::cacheKey() const

返回一个数字，用于标识此QIcon 对象的内容。如果不同的QIcon 对象指向相同的内容，则它们可以具有相同的键。

通过addPixmap() 或addFile() 更改图标时，cacheKey() 将发生变化。

缓存键主要用于缓存。

另请参见 QPixmap::cacheKey()。

[static] QStringList QIcon::fallbackSearchPaths()

返回图标的后备搜索路径。

如果current icon theme 或fallback icon theme 没有提供图标查询结果，则会查询独立图标文件的后备搜索路径。

如果未设置，后备搜索路径将由平台定义。

另请参阅 setFallbackSearchPaths() 和themeSearchPaths()。

[static] QString QIcon::fallbackThemeName()

返回后备图标主题的名称。

如果未设置，后备图标主题将由平台定义。

另请参阅 setFallbackThemeName() 和themeName()。

[static] QIcon QIcon::fromTheme(const QString &name)

在current icon theme 中返回与name 对应的QIcon 。

如果当前主题没有为name 提供图标，则会查询fallback icon theme ，然后返回到fallback icon search path 中查找独立图标文件。最后，会查询平台的本地图标库。

从当前图标主题中获取图标：

QIcon undoicon = QIcon::fromTheme(QIcon::ThemeIcon::EditUndo);

如果未通过setThemeName() 明确设置icon theme ，则将使用平台定义的图标主题。

另请参阅 themeName()、fallbackThemeName()、setThemeName()、themeSearchPaths()、fallbackSearchPaths() 和《Freedesktop 图标命名规范》。

[static] QIcon QIcon::fromTheme(const QString &name, const QIcon &fallback)

这是一个重载函数。

返回current icon theme 中与name 对应的QIcon 。

如果当前主题没有为name 提供图标，则会查询fallback icon theme ，然后返回到fallback icon search path 中查找独立图标文件。最后，会查询平台的本地图标库。

如果找不到图标，fallback 。

无论当前的图标主题和回退路径集是否支持所请求的图标，这都有助于提供有保证的回退。

例如

QIcon undoicon = QIcon::fromTheme(QIcon::ThemeIcon::EditUndo, QIcon(":/undo.png"));

另请参阅 fallbackThemeName() 和fallbackSearchPaths()。

[static] bool QIcon::hasThemeIcon(const QString &name)

如果当前图标主题或fromTheme() 所描述的任何回退中都有name 可用的图标，则返回true ，否则返回false 。

另请参阅 themeSearchPaths()、fromTheme() 和setThemeName()。

[static, since 6.7] bool QIcon::hasThemeIcon(QIcon::ThemeIcon icon)

这是一个重载函数。

如果当前图标主题或任何回退（如fromTheme() 所述）中有可用图标icon ，则返回true ，否则返回false 。

此函数在 Qt 6.7 中引入。

另请参阅 fromTheme()。

bool QIcon::isMask() const

如果该图标已被标记为遮罩图像，则返回true 。某些平台会以不同方式呈现遮罩图标（例如 macOS 上的菜单图标）。

另请参阅 setIsMask()。

bool QIcon::isNull() const

如果图标为空，则返回true ；否则返回false 。

如果既没有像素图也没有文件名，则图标为空。

注意：即使是非空图标也可能无法创建有效的像素图，例如，如果文件不存在或无法读取。

QString QIcon::name() const

返回创建图标时使用的名称（如果有）。

根据图标的创建方式，它可能有一个相关名称。使用fromTheme() 创建的图标就是这种情况。

另请参阅 fromTheme() 和QIconEngine::iconName()。

void QIcon::paint(QPainter *painter, const QRect &rect, Qt::Alignment alignment = Qt::AlignCenter, QIcon::Mode mode = Normal, QIcon::State state = Off) const

使用painter 将图标绘制到指定的alignment 、所需的mode 和state 矩形rect 中。

另请参阅 actualSize() 和pixmap()。

void QIcon::paint(QPainter *painter, int x, int y, int w, int h, Qt::Alignment alignment = Qt::AlignCenter, QIcon::Mode mode = Normal, QIcon::State state = Off) const

这是一个重载函数。

将图标绘制到矩形QRect(x,y,w,h) 中。

QPixmap QIcon::pixmap(const QSize &size, QIcon::Mode mode = Normal, QIcon::State state = Off) const

返回包含所请求的size 、mode 和state 的像素图，必要时生成一个。除非返回的像素图的设备像素比大于 1，否则该像素图可能比请求的小，但绝不会比请求的大。

另请参阅 actualSize() 和paint()。

QPixmap QIcon::pixmap(int extent, QIcon::Mode mode = Normal, QIcon::State state = Off) const

这是一个重载函数。

返回大小为QSize(extent,extent) 的像素图。除非返回的像素图的设备像素比大于 1，否则该像素图可能比请求的小，但绝不会比请求的大。

[since 6.0] QPixmap QIcon::pixmap(const QSize &size, qreal devicePixelRatio, QIcon::Mode mode = Normal, QIcon::State state = Off) const

这是一个重载函数。

返回包含所请求的size 、devicePixelRatio 、mode 和state 的像素图，必要时生成包含所给mode 和state 的像素图。除非返回的像素图的设备像素比大于 1，否则该像素图可能会比请求的小，但绝不会比请求的大。

该函数在 Qt 6.0 中引入。

另请参阅 actualSize() 和paint()。

QPixmap QIcon::pixmap(int w, int h, QIcon::Mode mode = Normal, QIcon::State state = Off) const

这是一个重载函数。

返回大小为QSize(w,h) 的像素图。除非返回的像素图的设备像素比大于 1，否则该像素图可能比请求的小，但绝不会比请求的大。

[static] void QIcon::setFallbackSearchPaths(const QStringList &paths)

将图标的后备搜索路径设置为paths 。

如果current icon theme 或fallback icon theme 无法提供图标查询结果，则会查询独立图标文件的后备搜索路径。

例如

QIcon::setFallbackSearchPaths(QIcon::fallbackSearchPaths() << "my/search/path");

另请参阅 fallbackSearchPaths() 和setThemeSearchPaths()。

[static] void QIcon::setFallbackThemeName(const QString &name)

将后备图标主题设置为name 。

如果current icon theme 未提供图标，或current icon theme 不存在，则会参考后备图标主题。

name 应与setThemeName() 中记录的主题格式一致，并将在themeSearchPaths() 中查找。

另请参阅 fallbackThemeName()、themeSearchPaths() 和themeName()。

void QIcon::setIsMask(bool isMask)

表示该图标是遮罩图像（布尔isMask ），因此有可能根据显示位置进行修改。

另请参阅 isMask()。

[static] void QIcon::setThemeName(const QString &name)

将当前图标主题设置为name 。

如果主题与提供命名字形的已安装字体的名称相匹配，那么与其中一个字形相匹配的QIcon::fromTheme 调用将生成该字形的图标。

否则，将在themeSearchPaths() 中查找主题。目前唯一支持的图标主题格式是自由桌面图标主题规范。name 应与主题搜索路径（themeSearchPath()）中的目录名相对应，该目录包含一个描述其内容的index.theme 文件。

另请参阅 themeSearchPaths(),themeName() 和Freedesktop 图标主题规范。

[static] void QIcon::setThemeSearchPaths(const QStringList &paths)

将图标主题的搜索路径设置为paths 。

paths 的内容应遵循setThemeName() 所记录的主题格式。

另请参阅 themeSearchPaths()、fromTheme() 和setThemeName()。

[noexcept] void QIcon::swap(QIcon &other)

将该图标与other 互换。该操作速度非常快，从未出现过故障。

[static] QString QIcon::themeName()

返回当前图标主题的名称。

如果未设置，当前图标主题将由平台定义。

另请参阅 setThemeName()、themeSearchPaths()、fromTheme() 和hasThemeIcon()。

[static] QStringList QIcon::themeSearchPaths()

返回图标主题的搜索路径。

默认搜索路径将由平台定义。所有平台也都将资源目录:\icons 作为备用。

另请参阅 setThemeSearchPaths()、fromTheme() 和setThemeName()。

QVariant QIcon::operator QVariant() const

以QVariant 的形式返回图标。

[noexcept] QIcon &QIcon::operator=(QIcon &&other)

Move-assignsother 到此QIcon 实例。

QIcon &QIcon::operator=(const QIcon &other)

将other 图标分配给该图标，并返回对该图标的引用。