1. Epic GamesDeveloper
  3. SButton

SButton

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

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Widgets > API/Runtime/Slate/Widgets/Input

Inheritance Hierarchy

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

  Type Name Description
Protected function  

SButton ()

  

Functions

  Type Name Description
Public function void

Construct ( const FArguments& InArgs
)

 Construct this widget
Protected function void

ExecuteHoverStateChanged ( bool bPlaySound
)

  
Protected function FReply Execute the "OnClicked" delegate, and get the reply
Protected function Const TSlateAttributeRef< bool >  
Protected function Const TSlateAttributeRef< FSlateColor >  
Protected function Const TEnumAsByte< EButtonClickMethod::Type > Utility function to translate other input click methods to regular ones.
Protected function Const FMargin  
Protected function Const TSlateAttributeRef< FMargin >  
Protected function Const bool  
Protected function Const bool

IsPreciseTapOrClick ( const FPointerEvent& MouseEvent
)

 Utility function to determine if the incoming mouse event is for a precise tap or click
Public function Const bool Returns true if this button is currently pressed
Protected function Const void Play the hovered sound
Protected function Const void Play the pressed sound
Protected function Virtual void

Press ()

 Press the button
Protected function Virtual void

Release ()

 Release the button
Protected function void

SetAppearPressed ( TAttribute< bool > InValue
)

 Set the AppearPressed look.
Public function void

SetButtonStyle ( const FButtonStyle* ButtonStyle
)

 See ButtonStyle attribute
Public function void  
Public function void

SetContentPadding ( TAttribute< FMargin > InContentPadding
)

 See ContentPadding attribute
Public function void

SetHoveredSound ( TOptional< FSlateSound > InHoveredSound
)

 See HoveredSound attribute
Protected function void

SetIsFocusable ( bool bInIsFocusable
)

 Set if this button can be focused
Public function void

SetOnClicked ( FOnClicked InOnClicked
)

 See OnClicked event
Public function void

SetOnHovered ( FSimpleDelegate InOnHovered
)

 Set OnHovered event
Public function void

SetOnUnhovered ( FSimpleDelegate InOnUnhovered
)

 Set OnUnhovered event
Public function void

SetPressedSound ( TOptional< FSlateSound > InPressedSound
)

 See PressedSound attribute
Public function void  
Public function void  
Public function void  
Public function Static const FSlateWidgetClassData &  

Overridden from SWidget

  Type Name Description
Protected function Virtual Const FVector2D

ComputeDesiredSize ( float LayoutScaleMultiplier
)

 Compute the ideal size necessary to display this widget.
Public function Virtual TSharedRef< FSlateAccessibleWidget >  
Public function Virtual Const FSlateColor  
Public function Virtual Const FSlateColor  
Public function Virtual Const bool  
Public function Virtual void

OnFocusLost ( const FFocusEvent& InFocusEvent
)

 Called when this widget loses focus. This event does not bubble.
Public function Virtual 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)
Public function Virtual FReply

OnKeyUp ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

 Called after a key is released when this widget has focus
Public function Virtual FReply

OnMouseButtonDoubleClick ( const FGeometry& InMyGeometry,
const FPointerEvent& InMouseEvent
)

 Called when a mouse button is double clicked. Override this in derived classes.
Public function Virtual 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.
Public function Virtual 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.
Public function Virtual void

OnMouseCaptureLost ( const FCaptureLostEvent& CaptureLostEvent
)

 Called when this widget had captured the mouse, but that capture has been revoked for some reason.
Public function Virtual void

OnMouseEnter ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 The system will use this event to notify a widget that the cursor has entered it.
Public function Virtual void

OnMouseLeave ( const FPointerEvent& MouseEvent
)

 The system will use this event to notify a widget that the cursor has left it.
Public function Virtual FReply

OnMouseMove ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 The system calls this method to notify the widget that a mouse moved within it.
Public function Virtual Const int32

OnPaint ( const FPaintArgs& Args,
const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
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.
Public function Virtual Const bool Checks to see if this widget supports keyboard focus. Override this in derived classes.

Overridden from FSlateControlledConstruction

  Type Name Description
Public function Virtual Const const FSlateWidgetClassData &  

Classes

  Type Name Description
Public struct FArguments    

Typedefs

Name Description
PrivateParentType  
PrivateThisType  
Super  
ThisClass  

Deprecated Variables

  Type Name Description
Protected variable FMargin BorderPadding BorderPadding is now deprecated. Use the ButtonStyle.
Protected variable TSlateDeprecatedTAttribute< FMargin > ContentPadding Direct access to ContentPadding is now deprecated. Use the setter or getter.
Protected variable const FSlateBrush * DisabledImage DisabledImage is now deprecated. Use the ButtonStyle.
Protected variable const FSlateBrush * HoverImage HoverImage is now deprecated. Use the ButtonStyle.
Protected variable const FSlateBrush * NormalImage NormalImage is now deprecated. Use the ButtonStyle.
Protected variable FMargin PressedBorderPadding PressedBorderPadding is now deprecated. Use the ButtonStyle.
Protected variable const FSlateBrush * PressedImage PressedImage is now deprecated. Use the ButtonStyle.

Deprecated Functions

  Type Name Description
Public function Virtual Const const FSlateBrush * GetBorder is deprecated. Use SetBorderImage or GetBorderImage

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page