Roson的Qt之旅 #134 QIconEngine类
目录
1.详细描述
2.成员类型说明
3.成员函数说明
1.详细描述
QIconEngine类为QIcon渲染器提供了一个抽象的基类。 一个图标引擎为一个QIcon提供渲染功能。每个图标都有一个相应的图标引擎，负责以要求的尺寸、模式和状态绘制图标。 图标是由paint()函数渲染的，另外还可以通过pixmap()函数获得一个像素图（默认实现只是使用paint()来实现）。addPixmap()函数可以用来向图标引擎添加新的像素图，并被QIcon用来添加专门的自定义像素图。 paint(), pixmap(), and addPixmap()函数都是虚拟的，因此可以在QIconEngine的子类中重新实现。 也请看QIconEnginePlugin。
2.成员类型说明
enum QIconEngine::IconEngineHook
这些枚举值用于virtual_hook()，以允许在不破坏二进制兼容性的情况下对图标引擎进行额外查询。
| Constant | Value | Description |
|---|---|---|
| QIconEngine::AvailableSizesHook | 1 | Allows to query the sizes of the contained pixmaps for pixmap-based engines. The data argument of the virtual_hook() function is a AvailableSizesArgument pointer that should be filled with icon sizes. Engines that work in terms of a scalable, vectorial format normally return an empty list. |
| QIconEngine::IconNameHook | 2 | Allows to query the name used to create the icon, for example when instantiating an icon using QIcon::fromTheme(). |
| QIconEngine::IsNullHook | 3 | Allow to query if this engine represents a null icon. The data argument of the virtual_hook() is a pointer to a bool that can be set to true if the icon is null. This enum value was added in Qt 5.7. |
| QIconEngine::ScaledPixmapHook | 4 | Provides a way to get a pixmap that is scaled according to the given scale (typically equal to the device pixel ratio). The data argument of the virtual_hook() function is a ScaledPixmapArgument pointer that contains both the input and output arguments. This enum value was added in Qt 5.9. |
这个枚举是在Qt 4.5中引入或修改的。 也请参见virtual_hook()。
3.成员函数说明
[virtual] QSize QIconEngine::actualSize(const QSize &size, QIcon::Mode mode, QIcon::State state)
返回引擎为请求的尺寸、模式和状态提供的图标的实际尺寸。默认的实现是返回给定的尺寸。
[virtual] void QIconEngine::addFile(const QString &fileName, const QSize &size, QIcon::Mode mode, QIcon::State state)
由QIcon::addFile()调用。从具有给定的fileName、大小、模式和状态的文件中添加一个专门的像素图。默认的基于像素图的引擎会存储任何提供的文件名，如果像素图的大小与请求的图标大小相匹配，它会按需加载像素图，而不是使用缩放的像素图。实现可缩放矢量格式的自定义图标引擎可以自由地忽略任何额外的文件。
[virtual] void QIconEngine::addPixmap(const QPixmap &pixmap, QIcon::Mode mode, QIcon::State state)
由QIcon::addPixmap()调用。为给定的模式和状态添加一个专门的像素图。默认的基于像素图的引擎会存储任何提供的像素图，如果像素图的大小与请求的图标大小相匹配，它会使用它们而不是按比例的像素图。实现可伸缩矢量格式的自定义图标引擎可以自由地忽略任何额外的像素图。
[virtual] QList
返回所有包含在引擎中的特定模式和状态的图像的尺寸。 注意：这是一个辅助方法，实际工作是由virtual_hook()方法完成的，因此这个方法取决于图标引擎的支持，可能无法在所有的图标引擎上工作。 这个函数是在Qt 4.5中引入的。
[pure virtual] QIconEngine *QIconEngine::clone() const
重新实现此方法以返回此图标引擎的克隆。
[virtual] QString QIconEngine::iconName() const
返回用于创建引擎的名称，如果有的话。 注意：这是一个辅助方法，实际工作由virtual_hook()方法完成，因此这个方法取决于图标引擎的支持，可能不适合所有的图标引擎。
bool QIconEngine::isNull() const
如果这个图标引擎代表一个空的QIcon，返回true。 注意：这是一个辅助方法，实际工作是由virtual_hook()方法完成的，因此这个方法取决于图标引擎的支持，可能不适合所有的图标引擎。
[virtual] QString QIconEngine::key() const
返回一个识别此图标引擎的键。
[pure virtual] void QIconEngine::paint(QPainter *painter, const QRect &rect, QIcon::Mode mode, QIcon::State state)
使用给定的绘画器将具有所需模式和状态的图标绘制到矩形的rect中。
[virtual] QPixmap QIconEngine::pixmap(const QSize &size, QIcon::Mode mode, QIcon::State state)
返回具有所需大小、模式和状态的像素图的图标。默认的实现是创建一个新的像素图并调用paint()来填充它。
[virtual] bool QIconEngine::read(QDataStream &in)
从QDataStream in读取图标引擎的内容。如果内容被读取，返回true；否则返回false。 QIconEngine的默认实现总是返回false。
QPixmap QIconEngine::scaledPixmap(const QSize &size, QIcon::Mode mode, QIcon::State state, qreal scale)
返回一个给定大小、模式、状态和比例的像素图。 scale参数通常等于显示器的设备像素比。 注意：这是一个辅助方法，实际工作是由virtual_hook()方法完成的，因此这个方法取决于图标引擎的支持，可能不会在所有的图标引擎上工作。 注意：有些引擎可能会把刻度投给一个整数。 这个函数是在Qt 5.9中引入的。 参见ScaledPixmapArgument。
[virtual] void QIconEngine::virtual_hook(int id, void *data)
额外的方法允许扩展QIconEngine而不添加新的虚拟方法（并且不破坏二进制兼容性）。实际的动作和数据的格式取决于id参数，实际上是IconEngineHook枚举中的一个常数。 这个函数是在Qt 4.5中引入的。 参见IconEngineHook。
[virtual] bool QIconEngine::write(QDataStream &out) const
把这个引擎的内容写到QDataStream out中。如果内容被写入，返回true；否则返回false。 QIconEngine的默认实现总是返回false。