[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 225

type TBitBtn = class(TCustomBitBtn)

published

  property Action: TBasicAction;

  

The Action associated with the 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 automatic adjustment of the size for the control, according to its content.

  property BidiMode: TBiDiMode;

  

Customization (of text controls) in bidirectional reading environments.

  property BorderSpacing: TControlBorderSpacing;

  

Determines the inner and outer border spacing for this control.

  property Cancel: Boolean;

  

True if the button is the modal Cancel button.

  property Caption: TCaption;

  

Contains the descriptive text displayed for the Bitmap button control.

  property Color: TColor;

  

The background color of the control.

  property Constraints: TSizeConstraints;

  

The minimum and maximum Width and Height for the control.

  property Default: Boolean;

  

True if the button is the default button in a modal form.

  property DefaultCaption: Boolean;

  

Indicates if Caption contains the default value for the button Kind.

  property DragCursor: TCursor;

  

The cursor shape shown while the control is dragged.

  property DragKind: TDragKind;

  

The operation when the control is dragged - Drag or Dock.

  property DragMode: TDragMode;

  

Allows the user to drag the control.

  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;

  

Bitmap with the Glyph displayed on the control.

  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;

  

Value returned when the control is clicked in a modal form.

  property NumGlyphs: Integer;

  

The number of glyphs available for the control.

  property Images: TCustomImageList;

  

Contains images available for the control.

  property ImageIndex: TImageIndex;

  

Ordinal position for the image displayed on the control.

  property ImageWidth: Integer;

  

Display width for the glyph image on the control.

  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;

  

Invoked when a context-sensitive pop-up menu is requested.

  property OnDragDrop: TDragDropEvent;

  

This handler determines the action on an drop onto this control, in a drag-drop operation.

  property OnDragOver: TDragOverEvent;

  

Event handler for a control being dragged over this control.

  property OnEndDrag: TEndDragEvent;

  

Notification handler for the end of a dragging operation.

  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;

  

Event handler signalled when a key is down while the control has focus.

  property OnKeyPress: TKeyPressEvent;

  

Event handler signalled when a key is pressed while the control has focus.

  property OnKeyUp: TKeyEvent;

  

Event handler signalled when a key is released while the control has focus.

  property OnMouseDown: TMouseEvent;

  

Event handler for mouse button going down.

  property OnMouseEnter: TNotifyEvent;

  

Event handler for mouse entering the area of the control.

  property OnMouseLeave: TNotifyEvent;

  

Event handler for mouse leaving the area of the control.

  property OnMouseMove: TMouseMoveEvent;

  

Event handler for mouse movement within the control.

  property OnMouseUp: TMouseEvent;

  

Event handler for mouse button going up.

  property OnMouseWheel: TMouseWheelEvent;

  

Event handler for mouse wheel turned.

  property OnMouseWheelDown: TMouseWheelUpDownEvent;

  

Event handler for downward movement of mouse wheel.

  property OnMouseWheelUp: TMouseWheelUpDownEvent;

  

Event handler for upward movement of the mouse wheel.

  property OnResize: TNotifyEvent;

  

Notification handler for a resize of the control.

  property OnStartDrag: TStartDragEvent;

  

Event handler for the start of a dragging operation.

  property OnUTF8KeyPress: TUTF8KeyPressEvent;

  

Handler for a character entered by the user.

  property ParentBidiMode: Boolean;

  

Allows to use the BiDiMode settings in the Parent control. Default is true.

  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 control navigation 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;

  

Indicates if the control is visible on its parent.

end;

Inheritance

TBitBtn

  

A Button with a small image attached.

|

TCustomBitBtn

  

TCustomBitBtn - the ancestor class for TBitBtn.

|

TCustomButton

  

The base class for a push button control.

|

TButtonControl

  

Specifies a base class for 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 which have an associated widget.

|

TComponent

?

TObject

Description

TBitBtn is a TCustomBitBtn descendant which provides the interface used to display a button with a glyph (or image) and a caption. It performs an action when the button is clicked.

TBitBtn sets the visibility for properties introduced in ancestor classes.

See also

How To Use Standard Controls

  

How to use StdCtrls, ComCtrls or ExtCtrls.

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