[Overview][Types][Classes][Procedures and functions][Variables][Index] Reference for unit 'Buttons' (#lcl)

TCustomSpeedButton

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

The ancestor class for TSpeedButton

Declaration

Source position: buttons.pp line 236

type TCustomSpeedButton = class(TGraphicControl)

protected

  FState: TButtonState;

  

The state of the speedbutton (whether checked or not)

  function GetNumGlyphs;

  

Find the number of Glyphs

  procedure GlyphChanged();

  

What to do if the Glyph has changed

  function DialogChar(); override;

  

DialogChar - a LCL Key Message; returns True if a Dialog character has an associated message

  procedure MouseEnter; override;

  

MouseEnter - a procedure that allows the programmer to simulate a mouse entering the control, and initiates the same Action as that associated with the OnMouseEnter event

  procedure MouseLeave; override;

  

MouseLeave - a procedure that allows the programmer to simulate a mouse leaving the control, and initiates the same Action as that associated with the OnMouseLeave event

  procedure MouseDown(); override;

  

MouseDown - a procedure that allows the programmer to simulate a mouse button being down over the control, and initiates the same Action as that associated with the OnMouseDown event

  procedure MouseMove(); override;

  

MouseMove - a procedure that allows the programmer to simulate a mouse being moved over the control, and initiates the same Action as that associated with the OnMouseMove event

  procedure MouseUp(); override;

  

MouseUp - a procedure that allows the programmer to simulate a mouse button being Up over the control, and initiates the same Action as that associated with the OnMouseUp event

  procedure Paint; override;

  

Virtual Paint method called in response to paint requests.

  procedure PaintBackground(); virtual;

  

Paint the background

  procedure SetDown();

  

  procedure SetGroupIndex();

  

  procedure SetFlat();

  

  procedure SetMargin();

  

  procedure SetNumGlyphs();

  

  procedure SetSpacing();

  

  procedure RealSetText(); override;

  

Procedure to store text associated with the control in a string

  procedure SetEnabled(); override;

  

Set up the flag to determine whether the control is to be enabled

  procedure UpdateState(); virtual;

  

  function GetDrawDetails; virtual;

  property MouseInControl: Boolean; [r]

  

  procedure ActionChange(); override;

  

  function GetActionLinkClass; override;

  

  function GetControlClassDefaultSize; override;

  

Find the default size for this class of controls (by reference to parents)

  procedure Loaded; override;

  function GetGlyphSize(); virtual;

  function GetTextSize(); virtual;

  function DrawGlyph(); virtual;

  

Draw the glyph in the specified canvas in the specified rectangle at a given offset within the client, with specified state and transparency

public

  constructor Create(); override;

  destructor Destroy; override;

  

Destroy this instance of a graphic control and return its resources

  function FindDownButton;

  

Find any Down button

  procedure Click; override;

  

Click - a procedure that allows the programmer to simulate a mouse click over the control, and initiates the same Action as that associated with the OnClick event

  procedure LoadGlyphFromLazarusResource();

  property AllowAllUp: Boolean; [rw]

  

Boolean flag to determine whether all buttons are allowed to be Up (default false)

  property Down: Boolean; [rw]

  

The button has been set in the Down state

  property Flat: Boolean; [rw]

  

Whether the button is to be displayed Flat or in relief

  property Glyph: TBitmap; [rw]

  

The Bitmap glyph to be used on this button

  property GroupIndex: Integer; [rw]

  

The Index within the group of speedbuttons

  property Layout: TButtonLayout; [rw]

  

The button layout - Glyph at top, bottom, left or right

  property Margin: Integer; [rw]

  

Margin - the space around glyphs

  property NumGlyphs: Integer; [rw]

  

The number of Glyphs available

  property ShowAccelChar: Boolean; [rw]

  

Should accelerator character be shown (ie underlined character denoting key to be pressed for quick action)

  property ShowCaption: Boolean; [rw]

  

Should caption be displayed?

  property Spacing: Integer; [rw]

  

Spacing around button

  property Transparent: Boolean; [rw]

  

Whether button is transparent

end;

Inheritance

TCustomSpeedButton

  

The ancestor class for TSpeedButton

|

TGraphicControl

?

TObject

Description

TCustomSpeedButton is the ancestor for TSpeedButton. If you want to define your own speedbutton class, you should use this class to derive it from.

The Speed Button is designed to automate a process when it is selected. An user pushes a button to start an action or set a mode.

When a user clicks on a SpeedButton focus is not shifted; a Speed Button never gets focus. The button may carry an descriptive glyph, and has a state (checked or not, etc)

The latest version of this document can be found at lazarus-ccr.sourceforge.net.