Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Slate > Widgets > Input > SButton

Light Theme

Dark Theme

SButton

Slate's Buttons are clickable Widgets that can contain arbitrary widgets as its [Content()](API\Developer\TargetPlatform\EProjectType).

Windows

MacOS

Linux

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SCompoundWidget

SBorder

SButton

SHyperlink

SRichTextHyperlink

References

Module	Slate
Header	/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Include	#include "Widgets/Input/SButton.h"

Syntax

class SButton : public SBorder

Remarks

Slate's Buttons are clickable Widgets that can contain arbitrary widgets as its Content().

Variables

	Name	Description
uint8: 1	bIsFocusable	Can this button be focused?
uint8: 1	bIsPressed	True if this button is currently in a pressed state
FMargin	BorderPadding	Padding that accounts for the button border
TEnumAsByte< EB...	ClickMethod	Sets whether a click should be triggered on mouse down, mouse up, or that both a mouse down and up are required.
TAttribute< FMa...	ContentPadding	Padding specified by the user; it will be combind with the button's internal padding.
const FSlateBru...	DisabledImage	Brush resource that represents a button when it is disabled
FSlateSound	HoveredSound	The Sound to play when the button is hovered
const FSlateBru...	HoverImage	Brush resource that represents a button when it is hovered
const FSlateBru...	NormalImage	Brush resource that represents a button
FOnClicked	OnClicked	The delegate to execute when the button is clicked
FSimpleDelegate	OnHovered
FSimpleDelegate	OnPressed	The delegate to execute when the button is pressed
FSimpleDelegate	OnReleased	The delegate to execute when the button is released
FSimpleDelegate	OnUnhovered
FMargin	PressedBorderPadding	Padding that accounts for the button border when pressed
const FSlateBru...	PressedImage	Brush resource that represents a button when it is pressed
FVector2D	PressedScreenSpacePosition	The location in screenspace the button was pressed
FSlateSound	PressedSound	The Sound to play when the button is pressed
TEnumAsByte< EB...	PressMethod	How should the button be clicked with keyboard/controller button events?
const FButtonSt...	Style	Style resource for the button
TEnumAsByte< EB...	TouchMethod	How should the button be clicked with touch events?

Constructors

	Name	Description
	SButton()

Functions

	Name	Description
void	Construct ( const FArguments& InArgs )	Construct this widget
FReply	ExecuteOnClick()
const FSlate...	GetBorder()
TEnumAsByte<...	GetClickMethodFromInputType ( const FPointerEvent& MouseEvent )	Utility function to translate other input click methods to regular ones.
FMargin	GetCombinedPadding()
bool	GetShowDisabledEffect()
bool	IsPreciseTapOrClick ( const FPointerEvent& MouseEvent )	Utility function to determine if the incoming mouse event is for a precise tap or click
bool	IsPressed()	Returns true if this button is currently pressed
void	PlayHoverSound()	Play the hovered sound
void	PlayPressedSound()	Play the pressed sound
void	Press()	Press the button
void	Release()	Release the button
void	SetButtonStyle ( const FButtonStyle* ButtonStyl... )	See ButtonStyle attribute
void	SetClickMethod ( EButtonClickMethod::Type InClickMet... )
void	SetContentPadding ( const TAttribute< FMargin >& InCon... )	See ContentPadding attribute
void	SetHoveredSound ( TOptional< FSlateSound > InHoveredS... )	See HoveredSound attribute
void	SetOnClicked ( FOnClicked InOnClicked )	See OnClicked event
void	SetOnHovered ( FSimpleDelegate InOnHovered )	Set OnHovered event
void	SetOnUnhovered ( FSimpleDelegate InOnUnhovered )	Set OnUnhovered event
void	SetPressedSound ( TOptional< FSlateSound > InPressedS... )	See PressedSound attribute
void	SetPressMethod ( EButtonPressMethod::Type InPressMet... )
void	SetTouchMethod ( EButtonTouchMethod::Type InTouchMet... )

Overridden from SWidget

	Name	Description
bool	ComputeVolatility()	Recomputes the volatility of the widget.
TSharedRef< ...	CreateAccessibleWidget()
bool	IsInteractable()
void	OnFocusLost ( const FFocusEvent& InFocusEvent )	Called when this widget loses focus. This event does not bubble.
FReply	OnKeyDown ( const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent )	Called after a key is pressed when this widget has focus (this event bubbles if not handled)
FReply	OnKeyUp ( const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent )	Called after a key is released when this widget has focus
FReply	OnMouseButtonDoubleClick ( const FGeometry& InMyGeometry, const FPointerEvent& InMouseEvent )	Called when a mouse button is double clicked. Override this in derived classes.
FReply	OnMouseButtonDown ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it.
FReply	OnMouseButtonUp ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	The system calls this method to notify the widget that a mouse button was release within it.
void	OnMouseCaptureLost ( const FCaptureLostEvent& CaptureLo... )	Called when this widget had captured the mouse, but that capture has been revoked for some reason.
void	OnMouseEnter ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	The system will use this event to notify a widget that the cursor has entered it.
void	OnMouseLeave ( const FPointerEvent& MouseEvent )	The system will use this event to notify a widget that the cursor has left it.
FReply	OnMouseMove ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	The system calls this method to notify the widget that a mouse moved within it.
int32	OnPaint ( const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawEl..., int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled )	The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children.
bool	SupportsKeyboardFocus()	Checks to see if this widget supports keyboard focus. Override this in derived classes.

Classes

	Name	Description
	FArguments

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss