Class: QgsAnimatedIcon

Animated icon is keeping an animation running if there are listeners connected to frameChanged.

Class Hierarchy

Base classes

QObject

Methods

connectFrameChanged	Connect a slot that will be notified repeatedly whenever a frame changes and which should request the current icon and trigger UI updates.
disconnectFrameChanged	Convenience function to disconnect the same style that the frame change connection was established.
height	The native height of the icon.
icon	Gets the icons representation in the current frame.
iconPath	Path to a movie, e.g. animated GIF.
setIconPath	Path to a movie, e.g. animated GIF.
width	The native width of the icon.

Signals

frameChanged

Emitted when the icon changed.

class qgis.core.QgsAnimatedIcon

Bases: QObject

__init__(iconPath: str | None = '', parent: QObject | None = None)

Create a new animated icon. Optionally, the iconPath can already be specified.

Parameters:

• iconPath (Optional[str] = '')

• parent (Optional[QObject] = None)

connectFrameChanged(self, receiver: QObject | None, method: str | None) → bool

Connect a slot that will be notified repeatedly whenever a frame changes and which should request the current icon and trigger UI updates.

Connect to the frame changed signal with this method and not directly. This method makes sure the annimation is started.

Parameters:

• receiver (Optional[QObject])

• method (Optional[str])

Return type:

bool

disconnectFrameChanged(self, receiver: QObject | None, method: str | None) → bool

Convenience function to disconnect the same style that the frame change connection was established.

Parameters:

• receiver (Optional[QObject])

• method (Optional[str])

Return type:

bool

signal frameChanged

Emitted when the icon changed. You should use connectFrameChanged instead of connecting to this signal directly. Connecting to this signal directly will cause the animation not to be started.

See also

connectFrameChanged()

height(self) → int

The native height of the icon.

Return type:

int

icon(self) → QIcon

Gets the icons representation in the current frame. This will need to be called repeatedly, whenever a frameChanged() signal is emitted.

Return type:

QIcon

iconPath(self) → str

Path to a movie, e.g. animated GIF

Return type:

str

setIconPath(self, iconPath: str | None)

Path to a movie, e.g. animated GIF

Parameters:

iconPath (Optional[str])

width(self) → int

The native width of the icon.

Return type:

int