wx.ImageList Class Reference

Inheritance diagram for wx.ImageList:

List of all members.

Public Types
enum	DrawStyle
Public Member Functions
int	Add (Bitmap bitmap, Colour maskColour)
int	Add (Icon icon)
int	Add (Bitmap bitmap, Bitmap mask)
int	Add (Bitmap bitmap)
bool	Create (int width, int height, bool mask, int initialCount)
bool	Create (int width, int height, bool mask)
bool	Create (int width, int height)
bool	Draw (int index, DC dc, int x, int y, DrawStyle flags, bool solidBackground)
bool	Draw (int index, DC dc, int x, int y, DrawStyle flags)
bool	Draw (int index, DC dc, int x, int y)
Bitmap	GetBitmap (int index)
bool	GetSize (int index, ref int width, ref int height)
	ImageList ()
	ImageList (IntPtr wxObject)
	ImageList (int width, int height, bool mask, int initialCount)
	ImageList (int width, int height, bool mask)
	ImageList (int width, int height)
bool	Remove (int index)
bool	RemoveAll ()
bool	Replace (int index, Bitmap bitmap)
Properties
int	Count [get]
int	ImageCount [get]
Bitmap	this [int index] [get]

---

Detailed Description

An image list is a list of images that may have transparent areas. The class helps an application organise a collection of images so that they can be referenced by integer index instead of by pointer.

---

Member Enumeration Documentation

enum wx::ImageList::DrawStyle

Style flags for Draw().

Enumerator:

NORMAL
TRANSPARENT
SELECTED
FOCUSED

---

Constructor & Destructor Documentation

wx.ImageList.ImageList	(	int	width,
		int	height
	)

Constructor specifying the image size, whether image masks should be created, and the initial size of the list. The mask will be created for all images.

Parameters:

	width	Width of the images in the list.
	height	Height of the images in the list.

wx.ImageList.ImageList	(	int	width,
		int	height,
		bool	mask
	)

Constructor specifying the image size, whether image masks should be created, and the initial size of the list.

Parameters:

	width	Width of the images in the list.
	height	Height of the images in the list.
	mask	true if masks should be created for all images (default).

wx.ImageList.ImageList	(	int	width,
		int	height,
		bool	mask,
		int	initialCount
	)

Constructor specifying the image size, whether image masks should be created, and the initial size of the list.

Parameters:

	width	Width of the images in the list.
	height	Height of the images in the list.
	mask	true if masks should be created for all images.
	initialCount	The initial size of the list.

wx.ImageList.ImageList

(

IntPtr

wxObject

)

wx.ImageList.ImageList

(

)

---

Member Function Documentation

int wx.ImageList.Add	(	Bitmap	bitmap,
		Colour	maskColour
	)

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

Parameters:

	bitmap	Bitmap representing the opaque areas of the image.
	maskColour	Colour indicating which parts of the image are transparent.

Returns:

The zero-based image index of the new bitmap.

int wx.ImageList.Add

(

Icon

icon

)

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

Parameters:

icon

Icon to use as the image.

Returns:

The zero-based image index of the new bitmap.

int wx.ImageList.Add	(	Bitmap	bitmap,
		Bitmap	mask
	)

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

Parameters:

	bitmap	Bitmap representing the opaque areas of the image.
	mask	Monochrome mask bitmap, representing the transparent areas of the image.

Returns:

The zero-based image index of the new bitmap.

int wx.ImageList.Add

(

Bitmap

bitmap

)

Adds a new image or images using a bitmap.

Parameters:

bitmap

Bitmap representing the opaque areas of the image.

Returns:

The zero-based image index of the new bitmap.

bool wx.ImageList.Create	(	int	width,
		int	height,
		bool	mask,
		int	initialCount
	)

bool wx.ImageList.Create	(	int	width,
		int	height,
		bool	mask
	)

bool wx.ImageList.Create	(	int	width,
		int	height
	)

bool wx.ImageList.Draw	(	int	index,
		DC	dc,
		int	x,
		int	y,
		DrawStyle	flags,
		bool	solidBackground
	)

bool wx.ImageList.Draw	(	int	index,
		DC	dc,
		int	x,
		int	y,
		DrawStyle	flags
	)

bool wx.ImageList.Draw	(	int	index,
		DC	dc,
		int	x,
		int	y
	)

Bitmap wx.ImageList.GetBitmap

(

int

index

)

Returns the bitmap of the provided zero-based index.

Parameters:

index

The index of the bitmap to be returned

bool wx.ImageList.GetSize	(	int	index,
		ref int	width,
		ref int	height
	)

bool wx.ImageList.Remove

(

int

index

)

bool wx.ImageList.RemoveAll

(

)

bool wx.ImageList.Replace	(	int	index,
		Bitmap	bitmap
	)

---

Property Documentation

int wx.ImageList.Count [get]

Number of images.

int wx.ImageList.ImageCount [get]

Number of images

Bitmap wx.ImageList::this

(

)

[get]

Synonym for GetBitmap().

Parameters:

index

The zero-based index of the bitmap to return.

Synonym for GetBitmap((int) index). This is a convenience functions for those using enumerations as image indices.

Parameters:

index

The enumeration instance designating the image.

Returns:

The designated bitmap.

---