1. Epic GamesDeveloper
  3. UCommonUserWidget

UCommonUserWidget

API > API/Plugins > API/Plugins/CommonUI

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;ClassGroup&61;UI, Meta&61;&40;Category&61;"Common UI", DisableNativeTick&41;&41;  
class UCommonUserWidget : public UUserWidget

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly bool bDisplayInActionBar True to generally display this widget's actions in the action bar, assuming it has actions.

Constructors

  Type Name Description
Public function  

UCommonUserWidget ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function void  
Public function Const const TArray< FUIActionBindingHandle > &  
Protected function Const GameInstanceT &  
Protected function Const UCommonInputSubsystem *  
Protected function Const TSharedPtr< FSlateUser >  
Protected function Const PlayerControllerT &  
Public function Const const TArray< TWeakObjectPtr< const UWidget > >  
Protected function Const UCommonUISubsystemBase *  
Protected function void

RegisterScrollRecipient ( const UWidget& AnalogScrollRecipient
)

  
Protected function FUIActionBindingHandle

RegisterUIActionBinding ( const FBindUIActionArgs& BindActionArgs
)

 Convenience methods for menu action registrations (any UWidget can register via FCommonUIActionRouter directly, though generally that shouldn't be needed).
Protected function void  
Public function UFunction BlueprintCallable, Category void

SetConsumePointerInput ( bool bInConsumePointerInput
)

 Sets whether or not this widget will consume ALL pointer input that reaches it
Protected function void

UnregisterScrollRecipient ( const UWidget& AnalogScrollRecipient
)

  

Overridden from UUserWidget

  Type Name Description
Protected function Virtual void  
Protected function Virtual FReply

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

  
Protected function Virtual FReply

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

  
Protected function Virtual FReply

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

  
Protected function Virtual FReply

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

  
Protected function Virtual FReply

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

  
Protected function Virtual FReply

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

  
Protected function Virtual FReply

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

  
Protected function Virtual FReply

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

  

Overridden from UWidget

  Type Name Description
Protected function Virtual void Function called after the underlying SWidget is constructed.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page