TSpeedButton class
A Button used to represent states (checked or unchecked).
Declaration
TSpeedButton = class(TCustomSpeedButton)Inheritance
- TSpeedButton
- TCustomSpeedButton
- TGraphicControl
- TControl
- TLCLComponent
TComponent
Descends from it: TDBNavButton TEditSpeedButton
Description
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).
See also
- How To Use Standard Controls
Properties
Action | published | The Action associated with the control. |
Align | published | Specifies the placement of the control on its Parent control. |
Alignment | published | Horizontal alignment for the text displayed on the button control. |
AllowAllUp | published | Indicates if all buttons in a group can be in an up state. |
Anchors | published | The set of anchor definitions for this control. |
AutoSize | published | Allows automatic adjustment of the size for the control, according to its content. |
BidiMode | published | Indicates the bi-directional text mode for the control. |
BorderSpacing | published | Determines the inner and outer border spacing for this control. |
Constraints | published | Contains the minimum and maximum Width and Height for the control. |
Caption | published | String with the caption displayed for the control. |
Color | published | The background color for the control. |
DisabledImageIndex | published | Ordinal position for the image displayed when the control is disabled. |
Down | published | Indicates if the button has been set to the Down state. |
DragCursor | published | The cursor shape shown during a drag operation. |
DragKind | published | Indicates the action performed for a drag operation: drag-and-drop or drag-and-dock. |
DragMode | published | Determines how a drag operation is started for the control. |
DrawEffectsEnabled | published | Enables or disables Glyph drawing effects for mouse over and mouse down events on the control. |
Enabled | published | Determines whether the control responds to mouse or keyboard input. |
Flat | published | Indicates whether the button is displayed with a Flat (non-relief) appearance. |
Font | published | The font to be used for text display in this control. |
Glyph | published | The bitmap with the glyph image(s) displayed for button states. |
GlyphImageLayout | published | |
GroupIndex | published | Identifies the group to which the speed button control belongs. |
HotImageIndex | published | Ordinal position for the glyph bitmap displayed when the mouse is hovered over the button control. |
Images | published | List of images available for use as state glyphs on the control. |
ImageIndex | published | Ordinal position for the glyph bitmap displayed when the button is in its up state. |
ImageWidth | published | Width for the glyph bitmap displayed on the control. |
Layout | published | Indicates the alignment of the glyph bitmap relative to the caption for the control. |
Margin | published | Space between the glyph bitmap and the aligned edge in the button layout. |
NumGlyphs | published | The number of glyph bitmaps available for the control. |
PressedImageIndex | published | Ordinal position for the glyph bitmap displayed when the button is in a pressed (down) state. |
SelectedImageIndex | published | Ordinal position for the glyph bitmap displayed when the button is selected. |
Spacing | published | Spacing between the Glyph bitmap and the Caption for the control. |
Transparent | published | Indicates if the control is drawn with transparency. |
Visible | published | Indicates if the control is visible on its parent. |
ShowCaption | published | Indicates if the Caption for the speed button is displayed. |
ShowHint | published | Enables Hint display for the control. |
ParentBidiMode | published | Indicates whether the BiDiMode settings in the Parent control are used. |
ParentFont | published | Indicates if the Font from the Parent control is used in the control. |
ParentShowHint | published | If True, the value of ShowHint for the control will be the same as the one from the Parent. Default is True. |
PopupMenu | published | A context-sensitive menu that pops up when the right mouse button is clicked over this control. |
Events
OnClick | published | Notification handler for mouse clicks. |
OnContextPopup | published | Invoked when a context-sensitive pop-up menu is requested. |
OnDblClick | published | Event handler signalled when a mouse double click occurs in the control. |
OnDragDrop | published | Event handler signalled when an object is dropped onto the control. |
OnDragOver | published | Event handler signalled when a control is dragged over the control instance. |
OnEndDrag | published | Event handler signalled for the end of a drag-drop operation. |
OnMouseDown | published | Event handler signalled when a mouse down event is handled for the control. |
OnMouseEnter | published | Event handler signalled when the mouse pointer has entered the control. |
OnMouseLeave | published | Event handler signalled when the mouse pointer has left the control. |
OnMouseMove | published | Event handler signalled when the mouse pointer is moved in the control. |
OnMouseUp | published | Event handler signalled when a mouse up event is handled for the control. |
OnMouseWheel | published | Event handler for mouse wheel turned. |
OnMouseWheelDown | published | Event handler signalled for a downward movement of the mouse wheel. |
OnMouseWheelUp | published | Event handler signalled for an upward movement of the mouse wheel. |
OnPaint | published | Event handler signalled to paint the control. |
OnResize | published | Notification handler for a resize of the control. |
OnStartDrag | published | Event handler signalled for the start of a dragging operation. |
OnChangeBounds | published | Event handler signalled when the Bounds for the control have been changed. |
Inherited
From TCustomSpeedButton (39)
ActionChange ButtonGlyph CalculatePreferredSize Click Create Destroy DialogChar DrawGlyph FindDownButton GetActionLinkClass GetControlClassDefaultSize GetDrawDetails GetGlyphSize GetNumGlyphs GetTextSize GlyphChanged Loaded LoadGlyphFromLazarusResource LoadGlyphFromResourceName MeasureDraw MouseDown MouseEnter MouseInControl MouseLeave MouseMove MouseUp Notification Paint PaintBackground RealSetText SetDown SetFlat SetGroupIndex SetMargin SetNumGlyphs SetSpacing ShowAccelChar UpdateState WSRegisterClass
From TGraphicControl (5)
Canvas CMCursorChanged DoOnChangeBounds DoOnParentHandleDestruction FontChanged
From TControl (360)
AccessibleDescription AccessibleName AccessibleRole AccessibleValue ActionLink ActiveDefaultControlChanged AddHandler AddHandlerOnBeforeDestruction AddHandlerOnChangeBounds AddHandlerOnEnabledChanged AddHandlerOnEnabledChanging AddHandlerOnKeyDown AddHandlerOnMouseWheel AddHandlerOnResize AddHandlerOnVisibleChanged AddHandlerOnVisibleChanging AdjustSize AnchorAsAlign AnchorClient AnchoredControlCount AnchoredControls AnchorHorizontalCenterTo AnchorParallel AnchorSame AnchorSide AnchorSideBottom AnchorSideChanged AnchorSideLeft AnchorSideRight AnchorSideTop AnchorToCompanion AnchorToNeighbour AnchorVerticalCenterTo AssignTo AutoAdjustLayout AutoSizeDelayed AutoSizeDelayedHandle AutoSizeDelayedReport AutoSizePhases AutoSizing AutoSizingAll AutoSizingLockCount BaseBounds BaseParentClientSize BeforeDestruction BeforeDragStart BeginAutoDrag BeginAutoSizing BeginDrag BoundsChanged BoundsRect BoundsRectForNewParent BringToFront CalculateDockSizes CanAutoSize CanTab CaptureChanged CaptureMouseButtons ChangeBounds Changed ChangeScale CheckChildClassAllowed CheckNewParent CheckOnChangeBounds ChildClassAllowed ClientHeight ClientOrigin ClientRect ClientToParent ClientToScreen ClientWidth CMBiDiModeChanged CMChanged CMEnabledChanged CMHintShow CMHitTest CMMouseEnter CMMouseLeave CMParentBiDiModeChanged CMParentColorChanged CMParentFontChanged CMParentShowHintChanged CMSysFontChanged CMTextChanged CMVisibleChanged CNPreferredSizeChanged ColorIsStored ConstrainedResize ControlFontClass ControlOrigin ControlState ControlStyle ControlToScreen CreateAccessibleObject CreateControlBorderSpacing CreateFloatingDockSite Cursor DblClick DefineProperties DesktopFont DisableAutoSizing DoAllAutoSize DoAutoAdjustLayout DoAutoSize DoBorderSpacingChange DoCallKeyEventHandler DoCallMouseWheelEventHandler DoCallNotifyHandler Dock Docked DockOrientation DockTrackNoTarget DoConstraintsChange DoContextPopup DoDock DoDragMsg DoEndDock DoEndDrag DoFixDesignFontPPI DoFloatMsg DoMouseDown DoMouseUp DoMouseWheel DoMouseWheelDown DoMouseWheelHorz DoMouseWheelLeft DoMouseWheelRight DoMouseWheelUp DoOnResize DoOnShowHint DoScaleFontPPI DoSetBounds DoStartDock DoStartDrag DragCanceled DragDrop Dragging DragOver EditingDone EnableAutoSizing EnabledChanged EnabledChanging EndAutoSizing EndDrag ExecuteCancelAction ExecuteDefaultAction FindSubComponent FixDesignFontsPPI Floating FloatingDockSiteClass ForeignAnchorSideChanged FormEndUpdated FormIsUpdating GetAccessibleObject GetAction GetAnchorsDependingOnParent GetCachedText GetCanvasScaleFactor GetChildAccessibleObjectAtPos GetChildrenRect GetClientOrigin GetClientRect GetClientScrollOffset GetColorResolvingParent GetControlOrigin GetCursor GetDefaultColor GetDefaultDockCaption GetDefaultHeight GetDefaultWidth GetDeviceContext GetDockEdge GetDragImages GetEnabled GetFloating GetFloatingDockSiteClass GetLogicalClientRect GetMouseCapture GetMousePosFromMessage GetPalette GetParentBackground GetParentComponent GetPopupMenu GetPreferredSize GetRGBColorResolvingParent GetScrolledClientRect GetSelectedChildAccessibleObject GetSidePosition GetTextBuf GetTextLen GetTopParent HandleObjectShouldBeVisible HasHelp HasParent Height HeightIsAnchored HelpContext HelpKeyword HelpType Hide Hint HostDockSite InitiateAction Invalidate InvalidateControl InvalidatePreferredSize IsAParentAligning IsBorderSpacingInnerBorderStored IsCaptionStored IsClientHeightStored IsClientWidthStored IsControl IsControlVisible IsEnabled IsParentColor IsParentFont IsParentOf IsProcessingPaintMsg IsRightToLeft IsVisible Left LMCaptureChanged LoadedAll LRDockWidth ManualDock ManualFloat MouseCapture MouseInClient OnConstrainedResize OnEditingDone OnEndDock OnMouseWheelHorz OnMouseWheelLeft OnMouseWheelRight OnQuadClick OnShowHint OnStartDock OnTripleClick Parent ParentBackground ParentColor ParentDestroyingHandle ParentFontChanged ParentFormHandleInitialized ParentHandlesAllocated ParentToClient Perform PositionDockRect QuadClick ReadBounds ReadState RealGetText Refresh RemoveAllHandlersOfObject RemoveHandler RemoveHandlerOnBeforeDestruction RemoveHandlerOnChangeBounds RemoveHandlerOnEnabledChanged RemoveHandlerOnEnabledChanging RemoveHandlerOnKeyDown RemoveHandlerOnMouseWheel RemoveHandlerOnResize RemoveHandlerOnVisibleChanged RemoveHandlerOnVisibleChanging Repaint ReplaceDockedControl RequestAlign Resize Scale96ToFont Scale96ToForm Scale96ToScreen ScaleConstraints ScaleDesignToForm ScaleFontsPPI ScaleFontTo96 ScaleFontToScreen ScaleFormTo96 ScaleFormToDesign ScaleScreenTo96 ScaleScreenToFont ScreenToClient ScreenToControl SendMoveSizeMessages SendToBack SessionProperties SetAction SetAlign SetAnchors SetAutoSize SetBiDiMode SetBounds SetBoundsKeepBase SetColor SetCursor SetDragMode SetEnabled SetHint SetInitialBounds SetName SetParent SetParentBackground SetParentBiDiMode SetParentComponent SetTempCursor SetTextBuf SetVisible SetZOrder ShouldAutoAdjust Show ShowHelp TBDockHeight Text TextChanged Top TripleClick UndockHeight UndockWidth Update UpdateAnchorRules UpdateBaseBounds UpdateMouseCursor UpdateRolesForForm UseRightToLeftAlignment UseRightToLeftReading UseRightToLeftScrollBar VisibleChanged VisibleChanging Width WidthIsAnchored WindowProc WMCancelMode WMContextMenu WMLButtonDBLCLK WMLButtonDown WMLButtonQuadCLK WMLButtonTripleCLK WMLButtonUp WMMButtonDBLCLK WMMButtonDown WMMButtonQuadCLK WMMButtonTripleCLK WMMButtonUp WMMouseHWheel WMMouseMove WMMouseWheel WMMove WMRButtonDBLCLK WMRButtonDown WMRButtonQuadCLK WMRButtonTripleCLK WMRButtonUp WMSize WMWindowPosChanged WMXButtonDBLCLK WMXButtonDown WMXButtonQuadCLK WMXButtonTripleCLK WMXButtonUp WndProc WriteLayoutDebugReport
From TLCLComponent (6)
DecLCLRefCount GetWSComponentClass IncLCLRefCount LCLRefCount NewInstance WidgetSetClass
An experiment, built from Lazarus main 2dfa93c66e of 10-22-2026. Not the official Lazarus documentation.