1. Epic GamesDeveloper
  3. UButton

UButton

The button is a click-able primitive widget to enable basic interaction, you can place any other widget inside a button to make a more complex and interesting click-able element in your UI.

API > API/Runtime > API/Runtime/UMG > API/Runtime/UMG/Components

Inheritance Hierarchy

References

   
Module UMG
Header /Engine/Source/Runtime/UMG/Public/Components/Button.h
Include #include "Components/Button.h"

Syntax

UCLASS (MinimalAPI)  
class UButton : public UContentWidget

Remarks

The button is a click-able primitive widget to enable basic interaction, you can place any other widget inside a button to make a more complex and interesting click-able element in your UI.

  • Single Child
  • Clickable

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter, getter, setter FLinearColor BackgroundColor The color multiplier for the button background
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite blueprintsetter, getter, setter TEnumAsByte< EButtonClickMethod::Type > ClickMethod The type of mouse action required by the user to trigger the buttons 'Click'
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter, getter, setter FLinearColor ColorAndOpacity The color multiplier for the button content
Public variable UProperty Category, EditAnywhere BlueprintReadOnly getter bool IsFocusable Sometimes a button should only be mouse-clickable and never keyboard focusable.
Protected variable TSharedPtr< SButton > MyButton Cached pointer to the underlying slate button owned by this UWidget
Public variable UProperty Category BlueprintAssignable FOnButtonClickedEvent OnClicked Called when the button is clicked
Public variable UProperty Category BlueprintAssignable FOnButtonHoverEvent OnHovered  
Public variable UProperty Category BlueprintAssignable FOnButtonPressedEvent OnPressed Called when the button is pressed
Public variable UProperty Category BlueprintAssignable FOnButtonReleasedEvent OnReleased Called when the button is released
Public variable UProperty Category BlueprintAssignable FOnButtonHoverEvent OnUnhovered  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite blueprintsetter, getter, setter TEnumAsByte< EButtonPressMethod::Type > PressMethod The type of keyboard/gamepad button press action required by the user to trigger the buttons 'Click'
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite blueprintsetter, getter, setter TEnumAsByte< EButtonTouchMethod::Type > TouchMethod The type of touch action required by the user to trigger the buttons 'Click'
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter, getter, setter FButtonStyle WidgetStyle The button style used at runtime

Constructors

  Type Name Description
Public function  

UButton ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const FLinearColor  
Public function Const EButtonClickMethod::Type  
Public function Const FLinearColor  
Public function Const bool  
Public function Const EButtonPressMethod::Type  
Public function Const const FButtonStyle &  
Public function Const EButtonTouchMethod::Type  
Protected function void

InitIsFocusable ( bool InIsFocusable
)

 Initialize IsFocusable in the constructor before the SWidget is constructed.
Public function Const UFunction BlueprintCallable, Category bool Returns true if the user is actively pressing the button.
Public function UFunction BlueprintCallable, Category void

SetBackgroundColor ( FLinearColor InBackgroundColor
)

 Sets the color multiplier for the button background
Public function UFunction BlueprintCallable, Category void

SetClickMethod ( EButtonClickMethod::Type InClickMethod
)

  
Public function UFunction BlueprintCallable, Category void

SetColorAndOpacity ( FLinearColor InColorAndOpacity
)

 Sets the color multiplier for the button content
Public function UFunction BlueprintCallable, Category void

SetPressMethod ( EButtonPressMethod::Type InPressMethod
)

  
Public function UFunction BlueprintCallable, Category void

SetStyle ( const FButtonStyle& InStyle
)

 Sets the color multiplier for the button background
Public function UFunction BlueprintCallable, Category void

SetTouchMethod ( EButtonTouchMethod::Type InTouchMethod
)

  
Protected function FReply Handle the actual click event from slate and forward it on
Protected function void  
Protected function void  
Protected function void  
Protected function void  

Overridden from UPanelWidget

  Type Name Description
Protected function Virtual Const UClass * UPanelWidget.
Protected function Virtual void  
Protected function Virtual void  
Public function Virtual void Begin UObject.

Overridden from UWidget

  Type Name Description
Public function Virtual const FText Gets the palette category of the widget
Protected function Virtual TSharedRef< SWidget >

RebuildDesignWidget ( TSharedRef< SWidget > Content
)

  
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
Public function Virtual void Applies all properties to the native widget if possible.

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page