Phoenix Logo

phoenix_title wx.XPMHandler

This is the image handler for the XPM format.


class_hierarchy Class Hierarchy

Inheritance diagram for class XPMHandler:

method_summary Methods Summary

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

api Class API



class wx.XPMHandler(ImageHandler)

Possible constructors:

XPMHandler()

This is the image handler for the XPM format.


Methods



__init__(self)

Default constructor for wx.XPMHandler.



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 a 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 a 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.