Sign in Join
FPDoc Onlineexperiment

TSharedIcon class

In unit Graphics

Implements a reference-counted shared Icon image type.

Declaration

pascal
TSharedIcon = class(TSharedRasterImage)

Inheritance

  1. TSharedIcon
  2. TSharedRasterImage
  3. TSharedImage

Descends from it: TSharedCursorImage TSharedIcnsIcon

Description

TSharedIcon is a TSharedRasterImage descendant which implements a reference counted shared Icon. TSharedIcon provides access to the list of images available in the Icon as TIconImage instances using the Images property. Methods are provided to add, delete, clear, sort, and retrieve the images.

TSharedIcon is the type used to implement the internal shared image in TCustomIcon (and descendant classes).

Properties

ImagespublicProvides indexed access to the images available in the Icon.

Methods

FreeHandleprotectedFrees the handle for the shared reference-counted icon.
UpdateFromHandleprotectedFrees the existing icon image and reloads it from the specified handle.
IsEmptyprotectedIndicates if the shared icon is empty (contains no icon images).
GetImageprotectedGets the value for the indexed Images property.
CreatepublicCreate - constructor for TSharedIcon: performs inherited Create then creates a list of images.
DestroypublicDestroy - destructor for TSharedIcon: frees the list of images and performs inherited Destroy.
ClearpublicClear - remove the icon and free its resources.
DeletepublicRemoves the icon image with the specified index.
GetIndexpublicGets the Index of an image with specified pixel format, height and width.
GetImagesClasspublicGets the class reference used to create a new icon image in the Images property.
AddpublicAdds the specified image to the list of Images in the icon.
SortpublicSorts values in Images using the IconCompare routine.
CountpublicCount - returns the number of references to the shared icon.

Inherited

From TSharedRasterImage (5)

BitmapCanvas CreateDefaultHandle HandleAllocated ReleaseHandle SaveStream

From TSharedImage (3)

RefCount Reference Release

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