wx.adv.AnimationDecoder¶

wx.adv.AnimationDecoder is used by wx.adv.Animation for loading frames and other information for the animation from the animation image file.

Class Hierarchy¶

Inheritance diagram for class AnimationDecoder:

Known Subclasses¶

wx.adv.ANIDecoder, wx.adv.GIFDecoder

Methods Summary¶

`__init__`
`CanRead`	Returns `True` if this decoder supports loading from the given stream.
`Clone`	Create a copy of this decoder.
`ConvertToImage`	Convert given frame to wx.Image.
`DoCanRead`	Checks the signature of the data in the given stream and returns `True` if it appears to be a valid animation format recognized by the animation decoder; this function should modify the stream current position without taking care of restoring it since `CanRead` will do it.
`GetAnimationSize`
`GetBackgroundColour`
`GetDelay`	Return the number of milliseconds this frame should be displayed.
`GetDisposalMethod`	What should be done after displaying this frame.
`GetFrameCount`
`GetFramePosition`
`GetFrameSize`
`GetTransparentColour`	The transparent colour for this frame, if any, or `NullColour` .
`GetType`	Return the animation type this decoder implements.
`Load`	Load the animation image frames from the given stream.

Properties Summary¶

`AnimationSize`	See `GetAnimationSize`
`BackgroundColour`	See `GetBackgroundColour`
`FrameCount`	See `GetFrameCount`
`Type`	See `GetType`

Class API¶

class wx.adv.AnimationDecoder(ObjectRefData)¶

Possible constructors:

AnimationDecoder() -> None

AnimationDecoder is used by Animation for loading frames and other information for the animation from the animation image file.

Methods¶

__init__(self)¶

Return type:: None

CanRead(self, stream)¶

Returns True if this decoder supports loading from the given stream.

Parameters:: stream (wx.InputStream)
Return type:: bool

Clone(self)¶

Create a copy of this decoder.

Return type:: wx.adv.AnimationDecoder

ConvertToImage(self, frame, image)¶

Convert given frame to wx.Image.

Parameters:

frame (int)
image (wx.Image)

Return type:

bool

DoCanRead(self, stream)¶

Checks the signature of the data in the given stream and returns True if it appears to be a valid animation format recognized by the animation decoder; this function should modify the stream current position without taking care of restoring it since CanRead will do it.

Parameters:: stream (wx.InputStream)
Return type:: bool

GetAnimationSize(self)¶

Return type:: Size

GetBackgroundColour(self)¶

Return type:: Colour

GetDelay(self, frame)¶

Return the number of milliseconds this frame should be displayed.

If -1 is returned then the frame must be displayed forever.

Parameters:: frame (int)
Return type:: int

GetDisposalMethod(self, frame)¶

What should be done after displaying this frame.

Parameters:: frame (int)
Return type:: wx.adv.AnimationDisposal

GetFrameCount(self)¶

Return type:: int

GetFramePosition(self, frame)¶

Parameters:: frame (int)
Return type:: Point

GetFrameSize(self, frame)¶

Parameters:: frame (int)
Return type:: Size

GetTransparentColour(self, frame)¶

The transparent colour for this frame, if any, or NullColour .

Parameters:: frame (int)
Return type:: Colour

GetType(self)¶

Return the animation type this decoder implements.

Return type:: wx.adv.AnimationType

Load(self, stream)¶

Load the animation image frames from the given stream.

Parameters:: stream (wx.InputStream)
Return type:: bool

Properties¶

AnimationSize¶: See GetAnimationSize

BackgroundColour¶: See GetBackgroundColour

FrameCount¶: See GetFrameCount

Type¶: See GetType