类
class	Cached

class	CachedData

枚举
enum	Option { DontFallbackToQIconFromTheme = 1 << 0 , IgnoreBuiltinIcons = 1 << 1 , IgnoreDciIcons = 1 << 2 , IgnoreIconCache = 1 << 3 }
	查找图标时的选项更多...

函数
Cached *	cached ()

QIcon	findQIcon (const QString &iconName, Options options=Options())

QIcon	findQIcon (const QString &iconName, const QIcon &fallback, Options options=Options())

QIconEngine *	createIconEngine (const QString &iconName, Options options=DontFallbackToQIconFromTheme)

QString	findDciIconFile (const QString &iconName, const QString &themeName)

QStringList	dciThemeSearchPaths ()

void	setDciThemeSearchPaths (const QStringList &path)

bool	isBuiltinIcon (const QIcon &icon)

bool	isXdgIcon (const QIcon &icon)

详细描述

dicontheme.h

用于提供一些接口，包括查找图标（包括 QIcon 和 DCI 图标），图标搜索路径等。

枚举类型说明

◆ Option

enum Dtk::Gui::DIconTheme::Option

查找图标时的选项

枚举值
DontFallbackToQIconFromTheme	是否不使用 QIcon::fromTheme 的方式去查找图标，当设置此 flag 时查找图标失败时直接返回空图标对象，否则回退到通过 QIcon::fromTheme 查找图标
IgnoreBuiltinIcons	是否忽略通过内置图标引擎方式查找图标资源，当设置此 flag 时查找图标会跳过内置图标引擎的方式查找图标资源，否则优先尝试内置图标引擎查找资源。

函数说明

◆ cached()

Dtk::Gui::DIconTheme::cached ( )

获取（首次次调用时构造）缓存对象。

◆ createIconEngine()

Dtk::Gui::DIconTheme::createIconEngine	(	const QString &	iconName,
		Options	options = `DontFallbackToQIconFromTheme`
	)

通过图标名构造图标引擎, 如果未设置 IgnoreBuiltinIcons 标志则优先尝试 qrc:/icons/deepin/builtin 目录查找图标来构造内置图标引擎，否则构造 XDG 图标引擎。

参数

[in]	iconName	图标名称
[in]	options	选项, 选项默认为 DIconTheme::DontFallbackToQIconFromTheme

返回: QIconEngine 对象指针，注意图标查找失败时返回 nullptr。

◆ dciThemeSearchPaths()

Dtk::Gui::DIconTheme::dciThemeSearchPaths ( )

返回 DCI 图标的搜索路径。默认会从这些路径查找 /usr/share/dsg/icons/$theme_name, qrc:/dsg/icons/$theme_name, qrc:/dsg/built-in-icons

参见: DIconTheme::findDciIconFile

◆ findDciIconFile()

Dtk::Gui::DIconTheme::findDciIconFile	(	const QString &	iconName,
		const QString &	themeName
	)

通过指定图标名 iconName 和主题名 themeName 查找 DCI 图标文件路径的接口

参数

[in]	iconName	要查找的图标名称
[in]	options	指定 DCI 图标主题

返回: 返回找到的 DCI 图标文件路径

参见: DDciIcon::fromTheme; DIconTheme::dciThemeSearchPaths()

◆ findQIcon() [1/2]

Dtk::Gui::DIconTheme::findQIcon	(	const QString &	iconName,
		const QIcon &	fallback,
		Options	options = `Options()`
	)

重载 DIconTheme::findQIcon, 当查找图标失败时返回调用者中提供的 fallback 图标

参数

[in]	iconName	要查找的图标名称
[in]	options	要查找的选项, 选项默认为空
[in]	fallback	如果 iconName 无法找到, 返回此图标

参见: DIconTheme::Cached::findQIcon; DIconTheme::createIconEngine

◆ findQIcon() [2/2]

Dtk::Gui::DIconTheme::findQIcon	(	const QString &	iconName,
		Options	options = `Options()`
	)

返回 DIconTheme::createIconEngine 接口创建的图标引擎构造 QIcon，当没有设置 DontFallbackToQIconFromTheme 和 createIconEngine 失败时回退到 QIcon::fromTheme

参数

[in]	iconName	要查找的图标名称
[in]	options	要查找的选项, 选项默认为空

参见: DIconTheme::Cached::findQIcon; DIconTheme::createIconEngine

◆ isBuiltinIcon()

Dtk::Gui::DIconTheme::isBuiltinIcon ( const QIcon & icon )

返回 QIcon 是否为内置图标，内置图标 是 DTK 中规定的一类集成在二进制内部的图标资源，其一般放置于 qrc:/icons/deepin/builtin 的路径下，在使用 findQIcon 或 createIconEngine 时，如找到此路径下对应的图标文件，则会为其使用一个自定义的 QIconEngine 进行渲染。此方法即通过判断 icon 所使用的 QIconEngine 确认其是否为内置图标。

◆ isXdgIcon()

Dtk::Gui::DIconTheme::isXdgIcon ( const QIcon & icon )

返回 QIcon 是否为 XDG 图标， XDG 图标一般放置于系统图标主题目录（如：/usr/share/icons）。和 isBuiltinIcon 类似，此方法是通过判断 icon 所使用的 QIconEngine 确认其是否为 XDG 图标。

◆ setDciThemeSearchPaths()

Dtk::Gui::DIconTheme::setDciThemeSearchPaths ( const QStringList & path )

设置查找 DCI 图标的搜索路径

参见: DIconTheme::dciThemeSearchPaths