QtGui.QIconEngineV2 Class Reference

The QIconEngineV2 class provides an abstract base class for QIcon renderers. More...

Inheritance diagram for QtGui.QIconEngineV2:

Collaboration diagram for QtGui.QIconEngineV2:

Classes
class	AvailableSizesArgument

Public Types
enum	IconEngineHook { AvailableSizesHook = 1, IconNameHook = 2 }
	More...

Public Member Functions
	QIconEngineV2 ()
	QIconEngineV2 (QIconEngineV2 copy)
override void	CreateProxy ()
new System.Collections.Generic.List < QSize >	AvailableSizes (QIcon.Mode mode=QIcon.Mode.Normal, QIcon.State state=QIcon.State.Off)
virtual QIconEngineV2	Clone ()
new string	IconName ()
virtual string	Key ()
virtual bool	Read (QDataStream @in)
virtual bool	Write (QDataStream @out)
new void	Dispose ()
Public Member Functions inherited from QtGui.QIconEngine
	QIconEngine ()
	QIconEngine (QIconEngine copy)
virtual QSize	ActualSize (QSize size, QIcon.Mode mode, QIcon.State state)
virtual void	AddFile (string fileName, QSize size, QIcon.Mode mode, QIcon.State state)
virtual void	AddPixmap (QPixmap pixmap, QIcon.Mode mode, QIcon.State state)
abstract void	Paint (QPainter painter, QRect rect, QIcon.Mode mode, QIcon.State state)
virtual QPixmap	Pixmap (QSize size, QIcon.Mode mode, QIcon.State state)
new void	Dispose ()

Protected Member Functions
	QIconEngineV2 (System.Type dummy)
Protected Member Functions inherited from QtGui.QIconEngine
	QIconEngine (System.Type dummy)

Additional Inherited Members
Protected Attributes inherited from QtGui.QIconEngine
SmokeInvocation	interceptor
Properties inherited from QtGui.QIconEngine
virtual System.IntPtr	SmokeObject [get, set]

Detailed Description

The QIconEngineV2 class provides an abstract base class for QIcon renderers.

An icon engine renders QIcons. With icon engines, you can customize icons. Qt provides a default engine that makes icons adhere to the current style by scaling the icons and providing a disabled appearance.

An engine is installed on an icon either through a QIcon constructor or through a QIconEnginePluginV2. The plugins are used by Qt if a specific engine is not given when the icon is created. See the QIconEngineV2 class description to learn how to create icon engine plugins.

An icon engine provides the rendering functions for a QIcon. Each icon has a corresponding icon engine that is responsible for drawing the icon with a requested size, mode and state.

QIconEngineV2 extends the API of QIconEngine to allow streaming of the icon engine contents, and should be used instead of QIconEngine for implementing new icon engines.

See also QIconEnginePluginV2.

Member Enumeration Documentation

enum QtGui.QIconEngineV2.IconEngineHook

These enum values are used for virtual_hook() to allow additional queries to icon engine without breaking binary compatibility.

This enum was introduced or modified in Qt 4.5.

See also virtual_hook().

Enumerator:

AvailableSizesHook	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.
IconNameHook	Allows to query the name used to create the icon, for example when instantiating an icon using QIcon::fromTheme().

Constructor & Destructor Documentation

QtGui.QIconEngineV2.QIconEngineV2 ( System.Type  dummy )

protected

QtGui.QIconEngineV2.QIconEngineV2

(

)

QtGui.QIconEngineV2.QIconEngineV2

(

QIconEngineV2

copy

)

Member Function Documentation

new System.Collections.Generic.List<QSize> QtGui.QIconEngineV2.AvailableSizes	(	QIcon.Mode	mode = QIcon.Mode.Normal,
		QIcon.State	state = QIcon.State.Off
	)

Returns sizes of all images that are contained in the engine for the specific mode and state.

Note: This is a helper method and the actual work is done by virtual_hook() method, hence this method depends on icon engine support and may not work with all icon engines.

This function was introduced in Qt 4.5.

virtual QIconEngineV2 QtGui.QIconEngineV2.Clone ( )

virtual

Returns a clone of this icon engine.

override void QtGui.QIconEngineV2.CreateProxy ( )

virtual

Reimplemented from QtGui.QIconEngine.

new void QtGui.QIconEngineV2.Dispose

(

)

new string QtGui.QIconEngineV2.IconName

(

)

Returns the name used to create the engine, if available.

Note: This is a helper method and the actual work is done by virtual_hook() method, hence this method depends on icon engine support and may not work with all icon engines.

This function was introduced in Qt 4.7.

virtual string QtGui.QIconEngineV2.Key ( )

virtual

Returns a key that identifies this icon engine.

virtual bool QtGui.QIconEngineV2.Read ( QDataStream @  in )

virtual

Reads icon engine contents from the QDataStream in. Returns true if the contents were read; otherwise returns false.

QIconEngineV2's default implementation always return false.

virtual bool QtGui.QIconEngineV2.Write ( QDataStream @  out )

virtual

Writes the contents of this engine to the QDataStream out. Returns true if the contents were written; otherwise returns false.

QIconEngineV2's default implementation always return false.