UCommonUserWidget

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

CommonUI

Header

/Engine/Plugins/Experimental/CommonUI/Source/CommonUI/Public/CommonUserWidget.h

Include

#include "CommonUserWidget.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(ClassGroup=UI, Meta=(Category="Common UI", DisableNativeTick))
class UCommonUserWidget : public UUserWidget

Constructors

Name Description

Public function

UCommonUserWidget

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Protected function

void

 

AddActionBinding

(
    FUIActionBindingHandle ActionBindin...
)

Public function Const

const TArray...

 

GetActionBindings()

Protected function Const

GameInstance...

 

GetGameInstanceChecked()

Protected function Const

UCommonInput...

 

GetInputSubsystem()

Protected function Const

TSharedPtr< ...

 

GetOwnerSlateUser()

Protected function Const

PlayerContro...

 

GetOwningPlayerChecked()

Public function Const

const TArray...

 

GetScrollRecipients()

Protected function Const

UCommonUISub...

 

GetUISubsystem()

Protected function

void

 

RegisterScrollRecipient

(
    const UWidget& AnalogScrollRecipie...
)

Protected function

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).

Protected function

void

 

RemoveActionBinding

(
    FUIActionBindingHandle ActionBindin...
)

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& AnalogScrollRecipie...
)

Overridden from UUserWidget

Name Description

Protected function Virtual

void

 

NativeDestruct()

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& InGestureEven...
)

Protected function Virtual

FReply

 

NativeOnTouchGesture

(
    const FGeometry& InGeometry,
    const FPointerEvent& InGestureEven...
)

Protected function Virtual

FReply

 

NativeOnTouchMoved

(
    const FGeometry& InGeometry,
    const FPointerEvent& InGestureEven...
)

Protected function Virtual

FReply

 

NativeOnTouchStarted

(
    const FGeometry& InGeometry,
    const FPointerEvent& InGestureEven...
)

Overridden from UWidget

Name Description

Protected function Virtual

void

 

OnWidgetRebuilt()

Function called after the underlying SWidget is constructed.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss