Sign in Join
FPDoc Onlineexperiment

TCustomIcon.MaskHandleAllocated function

Member of TCustomIconpublicIn unit Graphics

True if a handle has been allocated for the mask in the image.

Declaration

pascal
function MaskHandleAllocated: Boolean; override

Function result

True when the MaskHandle has been allocated for the icon image.

Description

MaskHandleAllocated is an overridden method used to determine if a handle for the image mask has been allocated in the class instance. MaskHandleAllocated implements the abstract virtual method defined in the ancestor class.

The return value is True when Current contains a value other than -1, and the MaskHandle for the TIconImage in the shared image list has a non-zero value.

MaskHandleAllocated is called from methods that required a valid handle prior to performing actions using the mask image data. For example:

  • Assign
  • AssignImage
  • BitmapHandleNeeded
  • MaskHandleNeeded
  • CreateMask
  • SetTransparentColor
  • SetBitmapHandle
  • SetMaskHandle

See also

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