phoenix_title wx.adv.GIFDecoder

An animation decoder supporting animated GIF files.


class_hierarchy Class Hierarchy

Inheritance diagram for class GIFDecoder:

method_summary Methods Summary

__init__

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.

GetDelay

Return the number of milliseconds this frame should be displayed.

GetDisposalMethod

What should be done after displaying this frame.

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.


property_summary Properties Summary

Type

See GetType


api Class API

class wx.adv.GIFDecoder(AnimationDecoder)

Possible constructors:

GIFDecoder()

An animation decoder supporting animated GIF files.


Methods

__init__(self)


Clone(self)

Create a copy of this decoder.

Return type:

wx.adv.AnimationDecoder



ConvertToImage(self, frame, image)

Convert given frame to wx.Image.

Parameters:
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



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:

long



GetDisposalMethod(self, frame)

What should be done after displaying this frame.

Parameters:

frame (int) –

Return type:

wx.adv.AnimationDisposal



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

Type

See GetType