QIcon 类

成员函数文档

这是一个重载函数。

返回对应于 icon 的 QIcon，其来自 当前图标主题。

如果当前主题不提供 icon 的图标，则查询 后备图标主题，然后再根据 后备图标搜索路径 查找独立的图标文件。最后，参考平台的原生图标库。

如果没有找到图标，并且提供了 fallback，则返回 fallback。这适用于无论当前图标主题和后备路径集是否支持请求的图标都可以提供保证的后备。

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

此函数自 Qt 6.7 起引入。

[noexcept] QIcon::QIcon()

创建一个空图标。

QIcon::QIcon(const QPixmap &pixmap)

从一个pixmap构造图标。

[显式] QIcon::QIcon(const QString &fileName)

从指定fileName的文件中构造图标。文件将在需要时加载。

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

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

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

[显式] QIcon::QIcon(QIconEngine *engine)

创建一个具有特定图标engine的图标。图标将接管引擎。

QIcon::QIcon(const QIcon &other)

构造other的副本。这非常快。

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

移动构造QIcon实例，使其指向对象与other指向的相同。

[noexcept] QIcon::~QIcon()

销毁图标。

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

返回请求的size、mode和state的图标的实际大小。结果可能小于请求的大小，但永远不会更大。返回的大小以设备无关像素为单位（这对于高dpi位图很重要）。

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

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

将来自指定fileName文件的图像作为对size、mode和state的专门化添加到图标中。文件将在需要时加载。注意：自定的图标引擎可以忽略额外添加的pixmap。

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

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

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

如果存在图像的高分辨率版本（通过基名上的后缀@2x标识），则它会自动加载并添加，并将device pixel ratio设置为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()。

[静态] QStringList QIcon::fallbackSearchPaths()

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

如果当前图标主题或备选图标主题在查找图标时没有提供结果，将查询备选搜索路径。

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

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

[静态] QString QIcon::fallbackThemeName()

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

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

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

[静态] QIcon QIcon::fromTheme(const QString &name)

返回对应于当前图标主题中name的QIcon。

如果当前主题未提供 name 的图标，则会咨询 备用图标主题，然后再回退到在 备用图标搜索路径 中查找单独的图标文件。最后，会咨询平台的原生图标库。

从当前图标主题获取图标

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

如果没有通过 setThemeName() 明确设置 图标主题，则会使用平台定义的图标主题。

另请参阅 themeName()，fallbackThemeName()，setThemeName()，themeSearchPaths()，fallbackSearchPaths() 以及 Freedesktop 图标命名规范。

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

这是一个重载函数。

返回对应于当前图标主题中name的QIcon。

如果当前主题未提供 name 的图标，则会咨询 备用图标主题，然后再回退到在 备用图标搜索路径 中查找单独的图标文件。最后，会咨询平台的原生图标库。

如果没有找到图标，则返回 fallback。

这在提供保证的回退非常有用，无论当前图标主题和回退路径是否支持请求的图标。

例如

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

另请参阅 fallbackThemeName() 和 fallbackSearchPaths。

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

如果在当前图标主题或任意回退中（正如 fromTheme 描述的那样）为 name 提供了图标，则返回 true，否则返回 false。

另请参阅 themeSearchPaths，fromTheme 以及 setThemeName。

[静态，自 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。

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

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

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

使用指定的 alignment、必需的 mode 和 state，使用 painter 在矩形 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 的 pixmap，如果需要则生成。该 pixmap 可能小于请求的大小，但永远不会更大，除非返回的 pixmap 的设备像素比大于 1。

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

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

这是一个重载函数。

返回一个大小为 QSize(w, h) 的 pixmap。该 pixmap 可能小于请求的大小，但永远不会更大，除非返回的 pixmap 的设备像素比大于 1。

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

这是一个重载函数。

返回一个大小为 QSize(extent, extent) 的 pixmap。该 pixmap 可能小于请求的大小，但永远不会更大，除非返回的 pixmap 的设备像素比大于 1。

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

这是一个重载函数。

返回一个具有所需的大小、设备像素比、模式及状态的小图，如果需要，将生成具有给定模式及状态的图。小图可能小于所需大小，但永远不会大于，除非返回的小图的设备像素比大于1。

此函数自Qt 6.0版开始提供。

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

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

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

如果当前图标主题或备选图标主题在查找图标时没有提供结果，将查询备选搜索路径。

例如

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

另请参阅fallbackSearchPaths() 和 setThemeSearchPaths。

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

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

当当前图标主题没有提供图标，或当前图标主题不存在时，将查询备用图标主题。

name应与setThemeName()中描述的格式相符，并将 themeSearchPaths 中进行查找。

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

void Qaeda::setIsMask(bool isMask)

指示此图是遮罩图像(布尔值 isMask)，因此可以根据显示的位置进行更改。

另请参阅isMask。

[静态] void Qaeda::setThemeName(const QString &name)

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

将在themeSearchPaths中进行查找。

目前，唯一支持的图标主题格式是Freedesktop 图标主题规范。 name应与setThemeName()中描述的格式相符，并且将在themeSearchPaths中进行查找，包含描述其内容的 index.theme 文件。

另请参阅themeSearchPaths，themeName 和 Freedesktop 图标主题规范。

[静态] void Qaeda::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返回。

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

将other图标赋给此图标，并返回对此图标的引用。

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

将other移动赋值给此QIcon实例。