Share via


CImageList Class

Provides the functionality of the Windows common image list control.

class CImageList : public CObject

Members

Public Constructors

Name

Description

CImageList::CImageList

Constructs a CImageList object.

Public Methods

Name

Description

CImageList::Add

Adds an image or images to an image list.

CImageList::Attach

Attaches an image list to a CImageList object.

CImageList::BeginDrag

Begins dragging an image.

CImageList::Copy

Copies an image within a CImageList object.

CImageList::Create

Initializes an image list and attaches it to a CImageList object.

CImageList::DeleteImageList

Deletes an image list.

CImageList::DeleteTempMap

Called by the CWinApp idle-time handler to delete any temporary CImageList object created by FromHandle.

CImageList::Detach

Detaches an image list object from a CImageList object and returns a handle to an image list.

CImageList::DragEnter

Locks updates during a drag operation and displays the drag image at a specified position.

CImageList::DragLeave

Unlocks the window and hides the drag image so that the window can be updated.

CImageList::DragMove

Moves the image that is being dragged during a drag-and-drop operation.

CImageList::DragShowNolock

Shows or hides the drag image during a drag operation, without locking the window.

CImageList::Draw

Draws the image that is being dragged during a drag-and-drop operation.

CImageList::DrawEx

Draws an image list item in the specified device context. The function uses the specified drawing style and blends the image with the specified color.

CImageList::DrawIndirect

Draws an image from an image list.

CImageList::EndDrag

Ends a drag operation.

CImageList::ExtractIcon

Creates an icon based on an image and mask in an image list.

CImageList::FromHandle

Returns a pointer to a CImageList object when given a handle to an image list. If a CImageList object is not attached to the handle, a temporary CImageList object is created and attached.

CImageList::FromHandlePermanent

Returns a pointer to a CImageList object when given a handle to an image list. If a CImageList object is not attached to the handle, NULL is returned.

CImageList::GetBkColor

Retrieves the current background color for an image list.

CImageList::GetDragImage

Gets the temporary image list that is used for dragging.

CImageList::GetImageCount

Retrieves the number of images in an image list.

CImageList::GetImageInfo

Retrieves information about an image.

CImageList::GetSafeHandle

Retrieves m_hImageList.

CImageList::Read

Reads an image list from an archive.

CImageList::Remove

Removes an image from an image list.

CImageList::Replace

Replaces an image in an image list with a new image.

CImageList::SetBkColor

Sets the background color for an image list.

CImageList::SetDragCursorImage

Creates a new drag image.

CImageList::SetImageCount

Resets the count of images in an image list.

CImageList::SetOverlayImage

Adds the zero-based index of an image to the list of images to be used as overlay masks.

CImageList::Write

Writes an image list to an archive.

Public Operators

Name

Description

CImageList::operator HIMAGELIST

Returns the HIMAGELIST attached to the CImageList.

Public Data Members

Name

Description

CImageList::m_hImageList

A handle containing the image list attached to this object.

Remarks

An "image list" is a collection of same-sized images, each of which can be referred to by its zero-based index. Image lists are used to efficiently manage large sets of icons or bitmaps. All images in an image list are contained in a single, wide bitmap in screen device format. An image list may also include a monochrome bitmap that contains masks used to draw images transparently (icon style). The Microsoft Win32 application programming interface (API) provides image list functions that enable you to draw images, create and destroy image lists, add and remove images, replace images, merge images, and drag images.

This control (and therefore the CImageList class) is available only to programs running under Windows 95/98 and Windows NT version 3.51 and later.

For more information on using CImageList, see Controls and Using CImageList.

Inheritance Hierarchy

CObject

CImageList

Requirements

Header: afxcmn.h

See Also

Reference

CObject Class

Hierarchy Chart

CListCtrl Class

CTabCtrl Class