pyface.i_image module

The base interface for an image.

class pyface.i_image.IImage(adaptee, default=<class 'traits.adaptation.adaptation_error.AdaptationError'>)

Bases: Interface

The base interface for an image.

This provides the interface specification that different types of image classes need to provide to be used by Pyface.

create_image(size=None)

Creates a toolkit-specific image for this image.

An image is a toolkit datastructure that is optimized for I/O, pixel-level access and modification, such as a wx.Image or a QImage.

Parameters

size ((int, int) or None) – The desired size as a width, height tuple, or None if wanting default image size. This is a preferred size and concrete implementations may or may not return an image of the precise size requested (indeed, this may be ignored).

Returns

image – The toolkit image corresponding to the image and the specified size.

Return type

toolkit image

create_bitmap(size=None)

Creates a toolkit-specific bitmap image for this image.

A bitmap is a toolkit datastructure that is optimized for rendering to the screen, such as a wx.Bitmap or a QPixmap.

Parameters

size ((int, int) or None) – The desired size as a width, height tuple, or None if wanting default image size. This is a preferred size and concrete implementations may or may not return an image of the precise size requested (indeed, this may be ignored).

Returns

image – The toolkit bitmap corresponding to the image and the specified size.

Return type

toolkit bitmap

create_icon(size=None)

Creates a toolkit-specific icon for this image.

An icon is a toolkit datastructure that holds several different variants of an image (eg. selected, disabled, etc.), such as a wx.Icon or a QIcon. Most toolkits can automatically create these from other image classes.

Parameters

size ((int, int) or None) – The desired size as a width, height tuple, or None if wanting default icon size. This is a preferred size and concrete implementations may or may not return an icon of the precise size requested (indeed, this may be ignored).

Returns

image – The toolkit image corresponding to the image and the specified size as an icon.

Return type

toolkit icon