1. Epic GamesDeveloper
  3. UCommonUserWidget

UCommonUserWidget

API > API/Plugins > API/Plugins/CommonUI

   
Name UCommonUserWidget
Type class
Header File /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonUserWidget.h
Include Path #include "CommonUserWidget.h"

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UCommonUserWidget ( const FObjectInitializer& ObjectInitializer
)

   CommonUserWidget.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActionBindings TArray< FUIActionBindingHandle >   CommonUserWidget.h  
bConsumePointerInput bool Set this to true if you don't want any pointer (mouse and touch) input to bubble past this widget CommonUserWidget.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Input
  • Meta=(AllowPrivateAccess=true)
ScrollRecipients TArray< TWeakObjectPtr< const UWidget > >   CommonUserWidget.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddActionBinding ( FUIActionBindingHandle ActionBinding
)

   CommonUserWidget.h  

const TArray< FUIActionBindingHandle > & GetActionBindings()

   CommonUserWidget.h  

const TArray< TWeakObjectPtr< const UWidget > > GetScrollRecipients()

   CommonUserWidget.h  

void RegisterScrollRecipientExternal ( const UWidget* AnalogScrollRecipient
)

 Add a widget to the list of widgets to get scroll events for this input root node CommonUserWidget.h
  • BlueprintCallable
  • Category=CommonUserWidget
Convenience methods for menu action registrations (any UWidget can register via FCommonUIActionRouter directly, though generally that shouldn't be needed). CommonUserWidget.h  

void RemoveActionBinding ( FUIActionBindingHandle ActionBinding
)

   CommonUserWidget.h  

void SetConsumePointerInput ( bool bInConsumePointerInput
)

 Sets whether or not this widget will consume ALL pointer input that reaches it CommonUserWidget.h
  • BlueprintCallable
  • Category=CommonUserWidget

void UnregisterScrollRecipientExternal ( const UWidget* AnalogScrollRecipient
)

 Remove a widget from the list of widgets to get scroll events for this input root node CommonUserWidget.h
  • BlueprintCallable
  • Category=CommonUserWidget

Protected

Name Remarks Include Path Unreal Specifiers

GameInstanceT & GetGameInstanceChecked()

   CommonUserWidget.h  

UCommonInputSubsystem * GetInputSubsystem()

   CommonUserWidget.h  

TSharedPtr< FSlateUser > GetOwnerSlateUser()

   CommonUserWidget.h  

PlayerControllerT & GetOwningPlayerChecked()

   CommonUserWidget.h  

UCommonUISubsystemBase * GetUISubsystem()

   CommonUserWidget.h  

void RegisterScrollRecipient ( const UWidget& AnalogScrollRecipient
)

   CommonUserWidget.h  

void UnregisterScrollRecipient ( const UWidget& AnalogScrollRecipient
)

   CommonUserWidget.h  

Overridden from UUserWidget

Name Remarks Include Path Unreal Specifiers

virtual ERequiresLegacyPlayer GetLegacyPlayerRequirement()

   CommonUserWidget.h  

virtual void NativeDestruct()

   CommonUserWidget.h  

virtual FReply NativeOnMouseButtonDoubleClick ( const FGeometry& InGeometry,
const FPointerEvent& InMouseEvent
)

   CommonUserWidget.h  

virtual FReply NativeOnMouseButtonDown ( const FGeometry& InGeometry,
const FPointerEvent& InMouseEvent
)

   CommonUserWidget.h  

virtual FReply NativeOnMouseButtonUp ( const FGeometry& InGeometry,
const FPointerEvent& InMouseEvent
)

   CommonUserWidget.h  

virtual FReply NativeOnMouseWheel ( const FGeometry& InGeometry,
const FPointerEvent& InMouseEvent
)

   CommonUserWidget.h  

virtual FReply NativeOnTouchEnded ( const FGeometry& InGeometry,
const FPointerEvent& InGestureEvent
)

   CommonUserWidget.h  

virtual FReply NativeOnTouchGesture ( const FGeometry& InGeometry,
const FPointerEvent& InGestureEvent
)

   CommonUserWidget.h  

virtual FReply NativeOnTouchMoved ( const FGeometry& InGeometry,
const FPointerEvent& InGestureEvent
)

   CommonUserWidget.h  

virtual FReply NativeOnTouchStarted ( const FGeometry& InGeometry,
const FPointerEvent& InGestureEvent
)

   CommonUserWidget.h  

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual const FText GetPaletteCategory()

   CommonUserWidget.h  

virtual void OnWidgetRebuilt()

   CommonUserWidget.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page