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 > Plugins > CommonUI > UCommonButtonBase

Light Theme

Dark Theme

UCommonButtonBase

Button that disables itself when not active.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UUserWidget

UCommonUserWidget

UCommonButtonBase

	UCommonBoundActionButton
	UCommonRotator

References

Module	CommonUI
Header	/Engine/Plugins/Experimental/CommonUI/Source/CommonUI/Public/CommonButtonBase.h
Include	#include "CommonButtonBase.h"

Syntax

UCLASS(Abstract, Blueprintable, ClassGroup=UI, Meta=(Category="Common UI", DisableNativeTick))
class UCommonButtonBase : public UCommonUserWidget

Remarks

Button that disables itself when not active. Also updates actions for CommonActionWidget if bound to display platform-specific icons.

Variables

	Name	Description
uint8: 1	bApplyAlphaOnDisable	The type of mouse action required by the user to trigger the button's 'Click'
uint8: 1	bDisplayInputActionWhenNotInteractable	True if the input action should be displayed when the button is not interactable
bool	bHideInputAction	Whether to hide the input action widget at all times (useful for textless small buttons)
uint8: 1	bHideInputActionWithKeyboard	True if the input action should be hidden while the user is using a keyboard
uint8: 1	bInteractableWhenSelected	If true, the button may be clicked while selected.
uint8: 1	bSelectable	True if the button supports being in a "selected" state, which will update the style accordingly
uint8: 1	bShouldSelectUponReceivingFocus	If true, the button will be selected when it receives focus.
uint8: 1	bShouldUseFallbackDefaultInputAction	True if this button should use the default fallback input action (bool is useful for buttons that shouldn't because they are never directly hit via controller)
bool	bStyleNoLongerNeedsConversion	Used to track widgets that were created before changing the default style pointer to null
uint8: 1	bToggleable	True if the button can be deselected by clicking it when selected
TEnumAsByte< EB...	ClickMethod	The type of mouse action required by the user to trigger the button's 'Click'
FSlateSound	HoveredSlateSoundOverride	Optional override for the sound to play when this button is hovered
UCommonActionWi...	InputActionWidget	Optionally bound widget for visualization behavior of an input action;
int32	InputPriority	This is the priority for the TriggeringInputAction.
int32	MinHeight	The minimum height of the button (only used if greater than the style's minimum)
int32	MinWidth	The minimum width of the button (only used if greater than the style's minimum)
FCommonButtonBa...	OnButtonBaseClicked
FCommonButtonBa...	OnButtonBaseDoubleClicked
FCommonButtonBa...	OnButtonBaseHovered
FCommonButtonBa...	OnButtonBaseUnhovered
FCommonSelected...	OnSelectedChangedBase
FSlateSound	PressedSlateSoundOverride	Optional override for the sound to play when this button is pressed
TEnumAsByte< EB...	PressMethod
TSubclassOf< UC...	Style	References the button style asset that defines a style in multiple sizes
TEnumAsByte< EB...	TouchMethod
FDataTableRowHa...	TriggeredInputAction	The input action that can be visualized as well as triggered when the user clicks the button.
FUIActionBindin...	TriggeringBindingHandle
FDataTableRowHa...	TriggeringInputAction	The input action that is bound to this button.

Constructors

	Name	Description
	UCommonButtonBase ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	BindInputMethodChangedDelegate()	Helper function to bind to input method change events
void	BindTriggeringInputActionToClick()	Associates this button at its priority with the given key
void	BP_OnClicked()
void	BP_OnDeselected()
void	BP_OnDisabled()
void	BP_OnDoubleClicked()
void	BP_OnEnabled()
void	BP_OnHovered()
void	BP_OnSelected()
void	BP_OnUnhovered()
void	ClearSelection()
UCommonButto...	ConstructInternalButton()
void	DisableButtonWithReason ( const FText& DisabledReason )	Disables this button with a reason (use instead of SetIsEnabled)
void	ExecuteTriggeredInput()
bool	GetButtonAnalyticInfo ( FString& ButtonName, FString& ABTestName, FString& ExtraData )
void	GetCurrentButtonPadding ( FMargin& OutButtonPadding )
void	GetCurrentCustomPadding ( FMargin& OutCustomPadding )
UCommonTextS...	GetCurrentTextStyle()
TSubclassOf<...	GetCurrentTextStyleClass()
bool	GetInputAction ( FDataTableRowHandle& InputActionRo... )	Gets the appropriate input action that is set
bool	GetIsFocusable()	Gets the bIsFocusable flag
bool	GetSelected()
bool	GetShouldSelectUponReceivingFocus()	Get whether the button should become selected upon receiving focus or not
UMaterialIns...	GetSingleMaterialStyleMID()	Returns the dynamic instance of the material being used for this button, if it is using a single material style.
UCommonButto...	GetStyle()	Current button style
const UCommo...	GetStyleCDO()
void	HandleButtonClicked()	Handler function registered to the underlying button's click.
FReply	HandleButtonDoubleClicked()	Handler function registered to the underlying button's double click.
void	HandleButtonPressed()	Helper function registered to the underlying button when pressed
void	HandleButtonReleased()	Helper function registered to the underlying button when released
void	HandleFocusReceived()	Helper function registered to the underlying button receiving focus
void	HandleTriggeringActionCommited ( bool& bPassthrough )
bool	IsInteractionEnabled()	Is this button currently interactable? (use instead of GetIsEnabled)
bool	IsPressed()	Is this button currently pressed?
void	NativeOnActionComplete()
void	NativeOnActionProgress ( float HeldPercent )
void	NativeOnClicked()
void	NativeOnCurrentTextStyleChanged()	Allows derived classes to take action when the current text style has changed
void	NativeOnDeselected ( bool bBroadcast )
void	NativeOnDisabled()
void	NativeOnDoubleClicked()
void	NativeOnEnabled()
void	NativeOnHovered()
void	NativeOnSelected ( bool bBroadcast )
void	NativeOnUnhovered()
void	OnActionComplete()
void	OnActionProgress ( float HeldPercent )
FCommonButto...	OnClicked()
void	OnCurrentTextStyleChanged()	Allows derived classes to take action when the current text style has changed
FCommonButto...	OnDoubleClicked()
FCommonButto...	OnFocusReceived()
FCommonButto...	OnHovered()
void	OnInputMethodChanged ( ECommonInputType CurrentInputType )	Called via delegate when the input method changes
FOnIsSelecte...	OnIsSelectedChanged()
FCommonButto...	OnPressed()
FCommonButto...	OnReleased()
void	OnTriggeredInputActionChanged ( const FDataTableRowHandle& NewTrig... )
FCommonButto...	OnUnhovered()
void	RefreshDimensions()
void	SetClickMethod ( EButtonClickMethod::Type InClickMet... )	Set the click method for mouse interaction
void	SetHoveredSoundOverride ( USoundBase* Sound )
void	SetInputActionProgressMaterial ( const FSlateBrush& InProgressMater..., const FName& InProgressMaterialPar... )
void	SetIsFocusable ( bool bInIsFocusable )	Updates the bIsFocusable flag
void	SetIsInteractableWhenSelected ( bool bInInteractableWhenSelected )	Change whether this widget is selectable at all. If false and currently selected, will deselect.
void	SetIsInteractionEnabled ( bool bInIsInteractionEnabled )	Change whether this widget is selectable at all. If false and currently selected, will deselect.
void	SetIsSelectable ( bool bInIsSelectable )	Change whether this widget is selectable at all. If false and currently selected, will deselect.
void	SetIsSelected ( bool InSelected, bool bGiveClickFeedback )	Change the selected state manually.
void	SetIsToggleable ( bool bInIsToggleable )	Change whether this widget is toggleable. If toggleable, clicking when selected will deselect.
void	SetMinDimensions ( int32 InMinWidth, int32 InMinHeight )	Sets the minimum dimensions of this button
void	SetPressedSoundOverride ( USoundBase* Sound )
void	SetPressMethod ( EButtonPressMethod::Type InPressMet... )	Set the click method for keyboard/gamepad button press interaction
void	SetSelectedInternal ( bool bInSelected, bool bAllowSound, bool bBroadcast )	Internal method to allow the selected state to be set regardless of selectability or toggleability
void	SetShouldSelectUponReceivingFocus ( bool bInShouldSelectUponReceivingFo... )	Set whether the button should become selected upon receiving focus or not; Only settable for buttons that are selectable
void	SetShouldUseFallbackDefaultInputAction ( bool bInShouldUseFallbackDefaultInp... )	Change whether this widget should use the fallback default input action.
void	SetStyle ( TSubclassOf< UCommonButtonStyle > I... )	Sets the style of this button, rebuilds the internal styling
void	SetTouchMethod ( EButtonTouchMethod::Type InTouchMet... )	Set the click method for touch interaction
void	SetTriggeredInputAction ( const FDataTableRowHandle& InputAc... )	Updates the current triggered action
void	SetTriggeringInputAction ( const FDataTableRowHandle& InputAc... )	Updates the current triggering action
void	StopDoubleClickPropagation()	Unless this is called, we will assume the double click should be converted into a normal click.
void	UnbindInputMethodChangedDelegate()	Helper function to unbind from input method change events
void	UnbindTriggeringInputActionToClick()	Associates this button at its priority with the given key
void	UpdateInputActionWidget()	Helper function to update the associated input action widget, if any, based upon the state of the button

Overridden from UUserWidget

		Name	Description
	bool	Initialize()
	void	NativeConstruct()
	void	NativeDestruct()
	bool	NativeIsInteractable()
	FReply	NativeOnFocusReceived ( const FGeometry& InGeometry, const FFocusEvent& InFocusEvent )
	void	NativeOnMouseEnter ( const FGeometry& InGeometry, const FPointerEvent& InMouseEvent )
	void	NativeOnMouseLeave ( const FPointerEvent& InMouseEvent )

Overridden from UWidget

	Name	Description
const FText	GetPaletteCategory()	Gets the palette category of the widget
bool	IsHovered()	Returns true if the widget is currently being hovered by a pointer device
void	OnCreationFromPalette()	Called by the palette after constructing a new widget, allows the widget to perform interesting default setup that we don't want to be UObject Defaults.
void	OnWidgetRebuilt()	Function called after the underlying SWidget is constructed.
void	SetIsEnabled ( bool bInIsEnabled )	Sets the current enabled status of the widget
void	SynchronizeProperties()	Applies all properties to the native widget if possible.

Overridden from UObject

		Name	Description
	void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Classes

	Name	Description
	FCommonButtonEvent
	FOnIsSelectedChanged