wx.JPEGHandler¶

This is the image handler for the JPEG format.

Class Hierarchy¶

Inheritance diagram for class JPEGHandler:

Methods Summary¶

 __init__ Default constructor for wx.JPEGHandler. DoCanRead Called to test if this handler can read an image from the given stream. GetLibraryVersionInfo Retrieve the version information about the JPEG library used by this handler. LoadFile Loads an image from a stream, putting the resulting data into image. SaveFile Saves an image in the output stream.

Class API¶

class wx.JPEGHandler(ImageHandler)

Possible constructors:

JPEGHandler()


This is the image handler for the JPEG format.

Methods¶

__init__(self)

Default constructor for wx.JPEGHandler.

DoCanRead(self, stream)

Called to test if this handler can read an image from the given stream.

NOTE: this function is allowed to change the current stream position since CallDoCanRead() will take care of restoring it later

Parameters

stream (wx.InputStream) –

Return type

bool

static GetLibraryVersionInfo()

Retrieve the version information about the JPEG library used by this handler.

Return type

wx.VersionInfo

New in version 2.9.2.

LoadFile(self, image, stream, verbose=True, index=-1)

Loads an image from a stream, putting the resulting data into image.

If the image file contains more than one image and the image handler is capable of retrieving these individually, index indicates which image to read from the stream.

Parameters
• image (wx.Image) – The image object which is to be affected by this operation.

• stream (wx.InputStream) – Opened input stream for reading image data.

• verbose (bool) – If set to True, errors reported by the image handler will produce LogMessages.

• index (int) – The index of the image in the file (starting from zero).

Return type

bool

Returns

True if the operation succeeded, False otherwise.

SaveFile(self, image, stream, verbose=True)

Saves an image in the output stream.

Parameters
• image (wx.Image) – The image object which is to be affected by this operation.

• stream (wx.OutputStream) – Opened output stream for writing the data.

• verbose (bool) – If set to True, errors reported by the image handler will produce LogMessages.

Return type

bool

Returns

True if the operation succeeded, False otherwise.