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).

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SCompoundWidget

SBorder

SButton

SHyperlink

SRichTextHyperlink

SPrimaryButton

SSimpleButton

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().

Constructors

	Name	Description
	SButton()

Functions

	Name	Description
void	Construct ( const FArguments& InArgs )	Construct this widget
void	ExecuteHoverStateChanged ( bool bPlaySound )
FReply	ExecuteOnClick()	Execute the "OnClicked" delegate, and get the reply
TSlateAttrib...	GetAppearPressedAttribute()
TSlateAttrib...	GetBorderForegroundColorAttribute()
TEnumAsByte<...	GetClickMethodFromInputType ( const FPointerEvent& MouseEvent )	Utility function to translate other input click methods to regular ones.
FMargin	GetCombinedPadding()
TSlateAttrib...	GetContentPaddingAttribute()
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	SetAppearPressed ( TAttribute< bool > InValue )	Set the AppearPressed look.
void	SetButtonStyle ( const FButtonStyle* ButtonStyl... )	See ButtonStyle attribute
void	SetClickMethod ( EButtonClickMethod::Type InClickMet... )
void	SetContentPadding ( TAttribute< FMargin > InContentPadd... )	See ContentPadding attribute
void	SetHoveredSound ( TOptional< FSlateSound > InHoveredS... )	See HoveredSound attribute
void	SetIsFocusable ( bool bInIsFocusable )	Set if this button can be focused
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... )
void	SimulateClick()
const FSlate...	StaticWidgetClass()

Overridden from SWidget

	Name	Description
TSharedRef< ...	CreateAccessibleWidget()
FSlateColor	GetDisabledForegroundColor()
FSlateColor	GetForegroundColor()
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.

Overridden from FSlateControlledConstruction

		Name	Description
	const FSlate...	GetWidgetClass()

Classes

	Name	Description
	FArguments

Typedefs

Name	Description
PrivateParentType
PrivateThisType
Super
ThisClass

Deprecated Variables

	Name	Description
FMargin	BorderPadding	BorderPadding is now deprecated. Use the ButtonStyle.
TSlateDeprecate...	ContentPadding	Direct access to ContentPadding is now deprecated. Use the setter or getter.
const FSlateBru...	DisabledImage	DisabledImage is now deprecated. Use the ButtonStyle.
const FSlateBru...	HoverImage	HoverImage is now deprecated. Use the ButtonStyle.
const FSlateBru...	NormalImage	NormalImage is now deprecated. Use the ButtonStyle.
FMargin	PressedBorderPadding	PressedBorderPadding is now deprecated. Use the ButtonStyle.
const FSlateBru...	PressedImage	PressedImage is now deprecated. Use the ButtonStyle.

Deprecated Functions

		Name	Description
	const FSlate...	GetBorder()	GetBorder is deprecated. Use SetBorderImage or GetBorderImage