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

TBitBtn

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

A Button with a small image attached

Declaration

Source position: buttons.pp line 185

type TBitBtn = class(TCustomBitBtn) end;

published

  property Action: TBasicAction;

  

The Action associated with this control.

  property Align: TAlign;

  

Specifies the placement of the control inside its Parent.

  property Anchors: TAnchors;

  

The set of anchor definitions for this control.

  property AutoSize: Boolean;

  

Allows to automatically adjust the size of the control, according to its content.

  property BidiMode: TBiDiMode;

  property BorderSpacing: TControlBorderSpacing;

  

Determines the inner and outer border spacing for this control.

  property Cancel: Boolean;

  

True if this is the modal Cancel button.

  property Caption: TCaption;

  

The text describing the control to the user.

  property Color: TColor;

  

The background color of the control.

  property Constraints: TSizeConstraints;

  

The minimal and maximal Width and Height of this control.

  property Default: Boolean;

  

True if this is the modal Default button.

  property DefaultCaption: Boolean;

  property Enabled: Boolean;

  

Determines whether the control reacts on mouse or keyboard input.

  property Font: TFont;

  

The font to be used for text display in this control.

  property Glyph: TBitmap;

  

The BitMap Glyph to be displayed on the button

  property GlyphShowMode: TGlyphShowMode;

  

Indicates the policy for showing or hiding the glyph image of this button

  property Kind: TBitBtnKind;

  

What kind of BitButton? Custom, OK, Cancel, Yes, No etc

  property Layout: TButtonLayout;

  

Layout of button - Glyph at top, bottom, left or right

  property Margin: Integer;

  

The margin to be left around glyphs

  property ModalResult: TModalResult;

  

When clicked, the button will close the form and return its ModalResult. (unless mrNone)

  property NumGlyphs: Integer;

  

The number of glyphs for display

  property OnChangeBounds: TNotifyEvent;

  

Event handler for a change of the Bounds of the control.

  property OnClick: TNotifyEvent;

  

Notification handler for mouse clicks.

  property OnContextPopup: TContextPopupEvent;

  property OnDragDrop: TDragDropEvent;

  property OnDragOver: TDragOverEvent;

  property OnEndDrag: TEndDragEvent;

  property OnEnter: TNotifyEvent;

  

Handler for control receiving the focus.

  property OnExit: TNotifyEvent;

  

Handler for control loosing the focus. This is a good place for checking the finished user input.

  property OnKeyDown: TKeyEvent;

  

Handler for keyboard key pressed.

  property OnKeyPress: TKeyPressEvent;

  

Handler for a character entered by the user.

  property OnKeyUp: TKeyEvent;

  

Handler for keyboard key released.

  property OnMouseDown: TMouseEvent;

  

Event handler for mouse button going down.

  property OnMouseEnter: TNotifyEvent;

  property OnMouseLeave: TNotifyEvent;

  property OnMouseMove: TMouseMoveEvent;

  

Event handler for mouse movement within the control.

  property OnMouseUp: TMouseEvent;

  

Event handler for mouse button going up.

  property OnMouseWheel: TMouseWheelEvent;

  property OnMouseWheelDown: TMouseWheelUpDownEvent;

  property OnMouseWheelUp: TMouseWheelUpDownEvent;

  property OnResize: TNotifyEvent;

  

Notification handler for a resize of the control.

  property OnStartDrag: TStartDragEvent;

  property OnUTF8KeyPress: TUTF8KeyPressEvent;

  

Handler for a character entered by the user.

  property ParentBidiMode: Boolean;

  property ParentFont: Boolean;

  

If true, the Font of the control will be the same as the one from the Parent. Default is true.

  property ParentShowHint: Boolean;

  

If true, the value of ShowHint for the control will be the same as the one from the Parent. Default is true.

  property PopupMenu: TPopupMenu;

  

A context-sensitive menu that pops up when the right mouse button is clicked over this control

  property ShowHint: Boolean;

  

Enables the Hint display.

  property Spacing: Integer;

  

The spacing around the BitButton

  property TabOrder: TTabOrder;

  

Determines the sequence of controls, reachable when the user presses the Tab key.

  property TabStop: Boolean;

  

Allows the user to navigate to this control, by pressing the Tab key.

  property Visible: Boolean;

  

Allows to show or hide the control, and all of its children.

Inheritance

TBitBtn

  

A Button with a small image attached

|

TCustomBitBtn

  

TCustomBitBtn - the ancestor class for TBitBtn.

|

TCustomButton

  

The base class for clickable buttons (TButton and TBitBtn).

|

TButtonControl

  

The base class for various button controls.

|

TWinControl

  

The base class for controls which can contain other (child) controls.

|

TControl

  

The base class for visible controls.

|

TLCLComponent

  

The base class for LCL components associated with widgets.

|

TComponent

?

TObject

Description

Bit Button: a push button control on a toolbar causing a particular action to be executed. It often displays a glyph or small graphic to denote its function.

See also

HowToUseStdCtrls

  

How to use StdCtrls, ComCtrls or ExtCtrls

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