Sign in Join
FPDoc Onlineexperiment

GetButtonIcon function

In unit Buttons

Gets a bitmap with the glyph image for the specified button identifier.

Declaration

pascal
function GetButtonIcon(idButton: Integer): TCustomBitmap

Description

GetButtonIcon is a TCustomBitmap function used to get a bitmap with the glyph for the button identifier in idButton. GetButtonIcon calls the GetStockImage routine in ThemeServices to get the handle used for the stock image. If the return value is False, the GetDefaultButtonIcon routine is called to get the icon for the button identifier.

GetButtonIcon is used in the implementation of the LoadGlyphFromStock routine.

See also

An experiment, built from Lazarus main 2dfa93c66e of 10-22-2026. Not the official Lazarus documentation.