Sign in Join
FPDoc Onlineexperiment

TCustomImageList.FindResolution function

Member of TCustomImageListpublicIn unit ImgList

Finds the image resolution which uses the specified image width.

Declaration

pascal
function FindResolution(AImageWidth: Integer; 
 out AResolution: TCustomImageListResolution)
: Boolean

Arguments

AImageWidth

Image width for the resolution requested in the method.

AResolution

Image resolution class located in the method.

Function result

True when an image resolution using the specified width is found.

Description

FindResolution is a Boolean function used to find the image resolution with the image width specified in AImageWidth.

AResolution is a TCustomImageListResolution output parameter used to return the image resolution using the specified image width. AResolution contains Nil when the image width is not used in the resolutions for the image list.

FindResolution calls the Find method for the internal TCustomImageListResolutions container. The return value is True when an image resolution using the specified image width is found in the resolutions for the image list. The ResolutionByIndex property is used to get the class instance for AResolution when the return value is True.

FindResolution is used in the implementation of the Replace, ReplaceMasked, ReplaceSlice, and ReplaceSliceCentered methods.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.