GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing docs.wxpython.org — wx.TIFFHandler — wxPython 4.3.2 Docs

wx.TIFFHandler¶

This is the image handler for the TIFF format.

Class Hierarchy¶

Inheritance diagram for class TIFFHandler:

Methods Summary¶

`__init__`	Default constructor for wx.TIFFHandler.
`DoCanRead`	Called to test if this handler can read an image from the given stream.
`LoadFile`	Loads an image from a stream, putting the resulting data into image.

Class API¶

class wx.TIFFHandler(ImageHandler)¶

Possible constructors:

TIFFHandler() -> None

This is the image handler for the TIFF format.

Methods¶

__init__(self)¶

Default constructor for wx.TIFFHandler.

Return type:: None

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

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.