TCustomImageListResolution class

In unit ImgList

Implements an image resolution (or size) used in TCustomImageList.

Declaration

pascal

TCustomImageListResolution = class(TLCLReferenceComponent)

Inheritance

Descends from it: TDragImageListResolution

Description

TCustomImageListResolution is a TLCLReferenceComponent descendant that implements an image resolution (or size) used in TCustomImageList. TCustomImageListResolution (along with TCustomImageListResolutions) is the mechanism which makes multiple resolutions possible in TCustomImageList.

TCustomImageListResolution provides properties that indicate the Height and Width of images stored in the resolution. It also contains the 32-bit RGBA raw image data for its images, the handle for its image list, and whether the resolution was created at design-time. Methods are provided to access and maintain the bitmap images (or their masks) used in the resolution. Other methods can be used to get the images as bitmaps, icons, or raw image data.

TCustomImageListResolution instances are created and stored in a TCustomImageListResolutions container. TCustomImageListResolution is the type used for the Resolution and ResolutionByIndex properties in TCustomImageList.

Properties

`ImageList`	public	Image list which owns the resolution.
`Width`	public	Width of the images stored in the resolution.
`Height`	public	Height of the images stored in the resolution.
`Count`	public	Number of images stored in the resolution.
`AutoCreatedInDesignTime`	public	Indicates if the Resolution was auto-created at design-time.
`Reference`	public	Reference to the widgetset image list using this resolution.

Methods

`ReadData`	protected	Reads raw image data from the specified Stream.
`WriteData`	protected	Stores the raw image data for the resolution to a Stream.
`GetReferenceHandle`	protected	Gets the handle from the widgetset Reference for the image list.
`WSCreateReference`	protected	Creates the Reference image list using the facilities for the widgetset.
`WSRegisterClass`	protected	Registers the class type used to create references for the widgetset.
`ReferenceDestroying`	protected	Notifies an image list list when the handle for the resolution is freed.
`UpdateReference`	protected	Forces the reference counted image list for the resolution to be freed and recreated.
`Destroy`	public	Destructor for the class instance.
`GetHotSpot`	public	Get the coordinates for the HotSpot in an image in the list.
`FillDescription`	public	Stores the image description for the raw image data for the resolution.
`GetBitmap`	public	Gets the bitmap for an image drawn using the specified drawing effect.
`GetIcon`	public	Gets an Icon rendered using the specified drawing effect.
`GetFullBitmap`	public	Gets a bitmap representing all images in the resolution.
`GetRawImage`	public	Gets the 32-bit RGBA raw image data for the specified image.
`Draw`	public	Renders an image to the specified canvas.
`StretchDraw`	public	Draws an image stretched to the dimensions for the target rectangle.
`DrawOverlay`	public	Draws the specified image with the given overlay.