Contents Up Previous Next

wxImageList

A wxImageList contains a list of images, which are stored in an unspecified form. Images can have masks for transparent drawing, and can be made from a variety of sources including bitmaps and icons.

wxImageList is used principally in conjunction with wxTreeCtrl and wxListCtrl classes.

Derived from

wxObject

Include files

<wx/imaglist.h>

See also

wxTreeCtrl, wxListCtrl

Members

wxImageList::wxImageList
wxImageList::Add
wxImageList::Create
wxImageList::Draw
wxImageList::GetImageCount
wxImageList::GetSize
wxImageList::Remove
wxImageList::RemoveAll
wxImageList::Replace


wxImageList::wxImageList

wxImageList()

Default constructor.

wxImageList(int width, int height, const bool mask = true, int initialCount = 1)

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

Parameters

width

height

mask

initialCount

See also

wxImageList::Create


wxImageList::Add

int Add(const wxBitmap& bitmap, const wxBitmap& mask = wxNullBitmap)

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

int Add(const wxBitmap& bitmap, const wxColour& maskColour)

Adds a new image using a bitmap and mask colour.

int Add(const wxIcon& icon)

Adds a new image using an icon.

Parameters

bitmap

mask

maskColour

icon

Return value

The new zero-based image index.

Remarks

The original bitmap or icon is not affected by the Add operation, and can be deleted afterwards.

wxPython note: In place of a single overloaded method name, wxPython implements the following methods:


wxImageList::Create

bool Create(int width, int height, const bool mask = true, int initialCount = 1)

Initializes the list. See wxImageList::wxImageList for details.


wxImageList::Draw

bool Draw(int index, wxDC& dc, int x, int x, int flags = wxIMAGELIST_DRAW_NORMAL, const bool solidBackground = false)

Draws a specified image onto a device context.

Parameters

index

dc

x

y

flags

solidBackground


wxImageList::GetImageCount

int GetImageCount() const

Returns the number of images in the list.


wxImageList::GetSize

bool GetSize(int index, int& width, int &height) const

Retrieves the size of the images in the list. Currently, the index parameter is ignored as all images in the list have the same size.

Parameters

index

width

height

Return value

true if the function succeeded, false if it failed (for example, if the image list was not yet initialized).


wxImageList::Remove

bool Remove(int index)

Removes the image at the given position.


wxImageList::RemoveAll

bool RemoveAll()

Removes all the images in the list.


wxImageList::Replace

bool Replace(int index, const wxBitmap& bitmap, const wxBitmap& mask = wxNullBitmap)

Replaces the existing image with the new image.

bool Replace(int index, const wxIcon& icon)

Replaces the existing image with the new image.

Parameters

bitmap

mask

icon

Return value

true if the replacement was successful, false otherwise.

Remarks

The original bitmap or icon is not affected by the Replace operation, and can be deleted afterwards.

wxPython note: The second form is called ReplaceIcon in wxPython.