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

Light Theme

Dark Theme

UCommonButtonInternalBase

Custom [UButton](API\Runtime\UMG\Components\UButton) override that allows us to disable clicking without disabling the widget entirely

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UPanelWidget

UContentWidget

UButton

UCommonButtonInternalBase

References

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

Syntax

UCLASS(Experimental)
class UCommonButtonInternalBase : public UButton

Remarks

Custom UButton override that allows us to disable clicking without disabling the widget entirely

Variables

	Name	Description
bool	bButtonEnabled	If true, this button is enabled.
bool	bInteractionEnabled	If true, this button can be interacted with it normally.
FOnButtonDouble...	HandleDoubleClicked	Called when the button is clicked
int32	MinHeight	The minimum height of the button
int32	MinWidth	The minimum width of the button
TSharedPtr< SBo...	MyBox	Cached pointer to the underlying slate button owned by this UWidget
TSharedPtr< cla...	MyCommonButton	Cached pointer to the underlying slate button owned by this UWidget
FOnButtonClicke...	OnDoubleClicked	Called when the button is clicked
FSimpleDelegate	OnReceivedFocus	Called when the button receives focus

Constructors

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

Functions

	Name	Description
bool	IsPressed()
void	SetButtonEnabled ( bool bInIsButtonEnabled )
void	SetButtonFocusable ( bool bInIsButtonFocusable )	Updates the IsFocusable flag and updates the bIsFocusable flag of the underlying slate button widget
void	SetInteractionEnabled ( bool bInIsInteractionEnabled )
void	SetMinDesiredHeight ( int32 InMinHeight )
void	SetMinDesiredWidth ( int32 InMinWidth )
FReply	SlateHandleClickedOverride()
FReply	SlateHandleDoubleClicked()
void	SlateHandleOnReceivedFocus()	Called when internal slate button receives focus; Fires OnReceivedFocus
void	SlateHandlePressedOverride()
void	SlateHandleReleasedOverride()

Overridden from UWidget

		Name	Description
	bool	IsHovered()	Returns true if the widget is currently being hovered by a pointer device
	TSharedRef< ...	RebuildWidget()	Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.

Overridden from UVisual

		Name	Description
	void	ReleaseSlateResources ( bool bReleaseChildren )