Sign in Join
FPDoc Onlineexperiment

TButtonGlyph.DrawEffectsEnabled property

Member of TButtonGlyphpublicIn unit Buttons

Indicates whether drawing effects are enabled for mouse-over and mouse-down events for the button glyph.

Declaration

pascal
property DrawEffectsEnabled: TGlyphDrawEffectsEnabled read FDrawEffectsEnabled write FDrawEffectsEnabled default deeApplication;

Description

DrawEffectsEnabled is a TGlyphDrawEffectsEnabled property which controls glyph drawing effects for the TButtonGlyph class instance and the button control to which it is attached. It determines whether glyph drawing effects are applied when mouse-over or mouse-down events occur for the associated button control. The values defined in TGlyphDrawEffectsEnabled can enable or disable the glyph drawing effects for the associated control, or defer the decision to the theme services supported for the platform / widgetset.

When enabled, the glyph image is modified using the drawing style needed for a mouse hover or mouse down event. See TGlyphDrawEffectsEnabled for the values in the enumeration and their meanings.

The property value is set when the DrawEffectsEnabled property in a button control (like TBitBtn or TSpeedButton) has been changed. Or, when the GlyphDrawEffectsEnabled in TApplication has been modified.

The property value is used in the GetImageIndexAndEffect method. It is translated to a TGraphicsDrawEffect value needed for the scaled image resolution with the Glyph(s) or external Images used in the class instance. The Draw method uses the scaled resolution, image index, and the drawing effect to render the glyph image to the Canvas passed to the method.

Added in LCL version 5.0.

See also

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