Sign in Join
FPDoc Onlineexperiment

TCustomIcon.PaletteAllocated function

Member of TCustomIconpublicIn unit Graphics

Determine if a handle has been allocated for the Palette in the icon.

Declaration

pascal
function PaletteAllocated: Boolean; override

Function result

True when the Palette handle has been allocated for the icon.

Description

PaletteAllocated is an overridden method used to determine if a handle has been allocated for the Palette in the icon image. PaletteAllocated 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 palette handle in the TIconImage instance for the shared icon image has a non-zero value.

While provided as property in TCustomIcon, Palette is never assigned in the TIconImage class instances used to represent the individual images in the icon. Effectively, Palette is not implemented for TCustomIcon and PaletteAllocated will always return False.

See also

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