wx.lib.agw.ultimatelistctrl.PyImageList

A PyImageList contains a list of images. Images can have masks for transparent drawing, and can be made from a variety of sources including bitmaps and icons.

PyImageList is used in conjunction with UltimateListCtrl.

Note

The main improvements that PyImageList introduces is the removal of the limitation of same-size images inside the image list. If you use the style IL_VARIABLE_SIZE then each image can have any size (in terms of width and height).

Class Hierarchy

Inheritance diagram for class PyImageList:

Methods Summary

__init__	Default class constructor.
Add	Adds a new image or images using a bitmap.
AddIcon	Adds a new image using an icon.
AddWithColourMask	Adds a new image or images using a bitmap and a colour mask.
Draw	Draws a specified image onto a device context.
GetBitmap	Returns the bitmap corresponding to the given index, or NullBitmap
GetIcon	Returns the icon corresponding to the given index, or NullIcon
GetImageCount	Returns the number of images in the list.
GetSize	Retrieves the size of an image in the list.
Remove	Removes the image at the given position.
RemoveAll	Removes all the images in the list.
Replace	Replaces the existing image with the new bitmap.
ReplaceIcon	Replaces the existing image with the new icon.

Class API

class PyImageList(object)

A PyImageList contains a list of images. Images can have masks for transparent drawing, and can be made from a variety of sources including bitmaps and icons.

PyImageList is used in conjunction with UltimateListCtrl.

Note

The main improvements that PyImageList introduces is the removal of the limitation of same-size images inside the image list. If you use the style IL_VARIABLE_SIZE then each image can have any size (in terms of width and height).

Methods

__init__(self, width, height, mask=True, initialCount=1, style=IL_VARIABLE_SIZE)

Default class constructor.

Parameters:

• width – the width of the images in the image list, in pixels (unused if you specify the IL_VARIABLE_SIZE style;

• height – the height of the images in the image list, in pixels (unused if you specify the IL_VARIABLE_SIZE style;

• mask – True if masks should be created for all images (unused in PyImageList);

• initialCount – the initial size of the list (unused in PyImageList);

• style – can be one of the following bits:

  Style Flag	Value	Description
  IL_FIXED_SIZE	0	All the images in PyImageList have the same size (width, height)
  IL_VARIABLE_SIZE	1	Each image can have any size (in terms of width and height)

---

Add(self, bitmap)

Adds a new image or images using a bitmap.

Parameters:

bitmap – a valid wx.Bitmap object.

Returns:

The new zero-based image index.

Note

If the bitmap is wider than the images in the list and you are not using the IL_VARIABLE_SIZE style, then the bitmap will automatically be split into smaller images, each matching the dimensions of the image list.

---

AddIcon(self, icon)

Adds a new image using an icon.

Parameters:

icon – a valid Icon object.

Returns:

The new zero-based image index.

Note

If the icon is wider than the images in the list and you are not using the IL_VARIABLE_SIZE style, then the icon will automatically be split into smaller images, each matching the dimensions of the image list.

---

AddWithColourMask(self, bitmap, maskColour)

Adds a new image or images using a bitmap and a colour mask.

Parameters:

• bitmap – a valid wx.Bitmap object;

• colour – an instance of wx.Colour, a colour indicating which parts of the image are transparent.

Returns:

The new zero-based image index.

Note

If the bitmap is wider than the images in the list and you are not using the IL_VARIABLE_SIZE style, then the bitmap will automatically be split into smaller images, each matching the dimensions of the image list.

---

Draw(self, index, dc, x, y, flags, solidBackground=True)

Draws a specified image onto a device context.

Parameters:

• index – the image index, starting from zero;

• dc – an instance of wx.DC;

• x – x position on the device context;

• y – y position on the device context;

• flags – how to draw the image. A bitlist of a selection of the following:

  Flag Paarameter	Description
  wx.IMAGELIST_DRAW_NORMAL	Draw the image normally
  wx.IMAGELIST_DRAW_TRANSPARENT	Draw the image with transparency
  wx.IMAGELIST_DRAW_SELECTED	Draw the image in selected state
  wx.IMAGELIST_DRAW_FOCUSED	Draw the image in a focused state

• solidBackground – currently unused.

---

GetBitmap(self, index)

Returns the bitmap corresponding to the given index, or NullBitmap if the index is invalid.

Parameters:

index – the bitmap index.

---

GetIcon(self, index)

Returns the icon corresponding to the given index, or NullIcon if the index is invalid.

Parameters:

index – the icon index.

---

GetImageCount(self)

Returns the number of images in the list.

---

GetSize(self, index)

Retrieves the size of an image in the list.

Parameters:

index – the zero-based index of the image.

Returns:

a tuple of (width, height) properties of the chosen bitmap.

---

Remove(self, index)

Removes the image at the given position.

Parameters:

index – the zero-based index of the image to be removed.

---

RemoveAll(self)

Removes all the images in the list.

---

Replace(self, index, bitmap)

Replaces the existing image with the new bitmap.

Parameters:

• index – the index at which the image should be replaced;

• bitmap – the new bitmap to add to the image list, an instance of wx.Bitmap.

---

ReplaceIcon(self, index, icon)

Replaces the existing image with the new icon.

Parameters:

• index – the index at which the image should be replaced;

• icon – the new icon to add to the image list, an instance of Icon.