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

UCommonUserWidget

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UUserWidget

UCommonUserWidget

UCommonActivatableWidget

UCommonButtonBase

	UCommonBoundActionButton
	UCommonRotator

UCommonTabListWidgetBase

References

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

Syntax

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

Variables

		Name	Description
	bool	bDisplayInActionBar	True to generally display this widget's actions in the action bar, assuming it has actions.

Constructors

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

Functions

	Name	Description
void	AddActionBinding ( FUIActionBindingHandle ActionBindin... )
const TArray...	GetActionBindings()
GameInstance...	GetGameInstanceChecked()
UCommonInput...	GetInputSubsystem()
TSharedPtr< ...	GetOwnerSlateUser()
PlayerContro...	GetOwningPlayerChecked()
const TArray...	GetScrollRecipients()
UCommonUISub...	GetUISubsystem()
void	RegisterScrollRecipient ( const UWidget& AnalogScrollRecipie... )
FUIActionBin...	RegisterUIActionBinding ( const FBindUIActionArgs& BindActio... )	Convenience methods for menu action registrations (any UWidget can register via FCommonUIActionRouter directly, though generally that shouldn't be needed).
void	RemoveActionBinding ( FUIActionBindingHandle ActionBindin... )
void	SetConsumePointerInput ( bool bInConsumePointerInput )	Sets whether or not this widget will consume ALL pointer input that reaches it
void	UnregisterScrollRecipient ( const UWidget& AnalogScrollRecipie... )

Overridden from UUserWidget

		Name	Description
	void	NativeDestruct()
	FReply	NativeOnMouseButtonDoubleClick ( const FGeometry& InGeometry, const FPointerEvent& InMouseEvent )
	FReply	NativeOnMouseButtonDown ( const FGeometry& InGeometry, const FPointerEvent& InMouseEvent )
	FReply	NativeOnMouseButtonUp ( const FGeometry& InGeometry, const FPointerEvent& InMouseEvent )
	FReply	NativeOnMouseWheel ( const FGeometry& InGeometry, const FPointerEvent& InMouseEvent )
	FReply	NativeOnTouchEnded ( const FGeometry& InGeometry, const FPointerEvent& InGestureEven... )
	FReply	NativeOnTouchGesture ( const FGeometry& InGeometry, const FPointerEvent& InGestureEven... )
	FReply	NativeOnTouchMoved ( const FGeometry& InGeometry, const FPointerEvent& InGestureEven... )
	FReply	NativeOnTouchStarted ( const FGeometry& InGeometry, const FPointerEvent& InGestureEven... )

Overridden from UWidget

		Name	Description
	void	OnWidgetRebuilt()	Function called after the underlying SWidget is constructed.