CommonUI

Choose your operating system:

Windows

macOS

Linux

Filters

Classes

Name

Description

Public class

CommonUI

Public class

FCommonActionCommited

Action Delegates Action committed delegate tells the handler that an action is ready to handle.

Public class

FCommonActionComplete

Public class

FCommonActionCompleteSingle

Action complete delegate will tell a listener if a held action completed.

Public class

FCommonActionProgress

Public class

FCommonActionProgressSingle

Action progress delegate will tell a listener about the progress of an action being held.

Public class

FCommonButtonBaseClicked

Public class

FCommonButtonMetaData

Public struct UStruct BlueprintType

FCommonButtonStyleOptionalSlateSound

Public struct UStruct BlueprintType

FCommonInputActionDataBase

Public struct UStruct BlueprintType

FCommonInputActionHandlerData

Public struct

FCommonInputActionHandlerDelegateData

Action Handle Data used to trigger any callbacks by an object implementing the ICommonActionHandlerInterface.

Public struct UStruct BlueprintType

FCommonInputTypeInfo

Public class

FCommonNativeListItem

Base item class for any UMG ListViews based on native, non-UObject items.

Public struct UStruct BlueprintType

FCommonNumberFormattingOptions

Public struct UStruct

FCommonRegisteredTabInfo

Information about a registered tab in the tab list

Public class

FCommonSelectedStateChangedBase

Public struct

FGlobalUITags

END_UI_TAG_DECL(FUIWidgetTag, TEXT("UI.Widget"))

Public class

FHardwareVisibilityTagsChangedDynamicEvent

Public class

FOnCurrentPageIndexChanged

Public class

FOnItemClicked

Public class

FOnItemSelected

Public class

FOnLoadGuardStateChangedDynamic

Public class

FOnRotated

Public class

FOnWidgetActivationChanged

Public struct UStruct BlueprintType

FRichTextIconData

Public struct UStruct meta

FUIActionTag

Public struct UStruct meta

FUITag

Public class

ICommonActionHandlerInterface

Public class

ICommonPoolableWidgetInterface

Widget pool, if implemented WidgetFactory will attempt to reuse implementing widget objects.

Public class

ICommonUIModule

Interface for the purchase flow module.

Public class

SAnalogSlider

A Slate slider control is a linear scale and draggable handle.

Public class

SCommonButtonTableRow

A CommonUI version of the object table row that is aware of UCommonButtonBase.

Public class

SCommonHierarchicalScrollBox

SScrollBox can scroll through an arbitrary number of widgets.

Public class

SCommonListView

SCommonListView.

Public class

SCommonTreeView

SCommonTreeView.

Public class

SLoadGuard

Public class

STextScroller

Public class

SVisualAttachmentBox

Wrapper widget meant to handle native-side painting for UCommonVisualAttachment.

Public class

TTypedTagStaticImpl

Copyright Epic Games, Inc. All Rights Reserved.

Public class

TWidgetFactory

Public class UClass

UAnalogSlider

A simple widget that shows a sliding bar with a handle that allows you to control the value between 0..1.

Public class

UCommonActionHandlerInterface

Action Handler Interface is primarily used to take key input and do something with it in the implementation of the interface or another user widget.

Public class UClass Blueprintable, BlueprintType

UCommonActionWidget

A widget that shows a platform-specific icon for the given input action.

Public class UClass Meta

UCommonActivatableWidget

The base for widgets that are capable of being "activated" and "deactivated" during their lifetime without being otherwise modified or destroyed.

Public class UClass

UCommonActivatableWidgetSwitcher

An animated switcher that knows about CommonActivatableWidgets. It can also hold other Widgets.

Public class UClass

UCommonAnimatedSwitcher

A widget switcher that activates / deactivates CommonActivatableWidgets, allowing for associated animations to trigger.

Public class UClass ClassGroup, Meta Config defaultconfig

UCommonBorder

Uses the border style template defined in CommonUI project settings by default

Public class UClass Abstract Blueprintable ClassGroup, Meta

UCommonBorderStyle

  • All properties must be EditDefaultsOnly, BlueprintReadOnly !!! -- We return the CDO to blueprints, so we cannot allow any changes (blueprint doesn't support const variables)

Public class UClass Abstract Blueprintable ClassGroup, Meta

UCommonButtonBase

Button that disables itself when not active.

Public class UClass experimental

UCommonButtonInternalBase

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

Public class UClass Abstract Blueprintable ClassGroup, Meta

UCommonButtonStyle

  • All properties must be EditDefaultsOnly, BlueprintReadOnly !!! -- we return the CDO to blueprints, so we cannot allow any changes (blueprint doesn't support const variables)

Public class UClass ClassGroup, Meta Config defaultconfig

UCommonCustomNavigation

Exposes a bindable event that can be used to stomp default border navigation with custom behaviors.

Public class UClass BlueprintType

UCommonDateTimeTextBlock

Public class UClass Transient, Config within

UCommonGameViewportClient

CommonUI Viewport to reroute input to UI first.

Public class UClass

UCommonHardwareVisibilityBorder

A container that controls visibility based on Platform, Input

Public class UClass

UCommonHierarchicalScrollBox

An arbitrary scrollable collection of widgets.

Public class UClass

UCommonLazyImage

A special Image widget that can show unloaded images and takes care of the loading for you!

Public class UClass

UCommonLazyWidget

A special Image widget that can show unloaded images and takes care of the loading for you!

Public class UClass

UCommonListView

UCommonListView.

Public class UClass Config defaultconfig

UCommonLoadGuard

The Load Guard behaves similarly to a Border, but with the ability to hide its primary content and display a loading spinner and optional message while needed content is loaded or otherwise prepared.

Public class UClass BlueprintType

UCommonNumericTextBlock

Numeric text block that provides interpolation, and some type support (numbers, percents, seconds, distance).

Public class

UCommonPoolableWidgetInterface

Public class UClass

UCommonRichTextBlock

Text block that supports custom scaling for mobile platforms, with option to only show icons if space is sparse.

Public class UClass Meta

UCommonRotator

A button that can rotate between given text labels.

Public class UClass Abstract Blueprintable ClassGroup, Meta

UCommonTabListWidgetBase

Base class for a list of selectable tabs that correspondingly activate and display an arbitrary widget in a linked switcher

Public class UClass ClassGroup, Meta Config defaultconfig

UCommonTextBlock

Text block with automatic scrolling for FX / large texts, also supports a larger set of default styling, & custom mobile scaling.

Public class UClass Abstract Blueprintable ClassGroup, Meta

UCommonTextScrollStyle

  • All properties must be EditDefaultsOnly, BlueprintReadOnly !!! -- We return the CDO to blueprints, so we cannot allow any changes (blueprint doesn't support const variables)

Public class UClass Abstract Blueprintable ClassGroup, Meta

UCommonTextStyle

  • All properties must be EditDefaultsOnly, BlueprintReadOnly !!! -- We return the CDO to blueprints, so we cannot allow any changes (blueprint doesn't support const variables)

Public class UClass Meta

UCommonTileView

TileView specialized to navigate on focus for consoles & enable scrolling when not focused for touch

Public class UClass

UCommonTreeView

UCommonTreeView.

Public class UClass Config defaultconfig

UCommonUIEditorSettings

Public class UClass

UCommonUILibrary

Public class UClass Abstract Blueprintable Meta

UCommonUIRichTextData

Derive from this class for rich text data per game it is referenced in CommonUI Settings, found in project settings UI

Public class UClass Config defaultconfig

UCommonUISettings

Public class UClass displayname

UCommonUISubsystemBase

Public class UClass displayname

UCommonUIVisibilitySubsystem

Public class UClass ClassGroup, Meta

UCommonUserWidget

Public class UClass ClassGroup, Meta

UCommonVideoPlayer

Public class UClass Meta

UCommonVisibilitySwitcher

Basic switcher that toggles visibility on its children to only show one widget at a time.

Public class UClass

UCommonVisibilitySwitcherSlot

Public class UClass ClassGroup, Meta

UCommonVisualAttachment

Adds a widget as a zero-size attachment to another.

Public class UClass Blueprintable

UCommonWidgetCarousel

A widget switcher is like a tab control, but without tabs. At most one widget is visible at time.

Public class UClass Blueprintable

UCommonWidgetCarouselNavBar

A Navigation control for a Carousel

Public class UClass deprecated

UDEPRECATED_UCommonVisibilityWidgetBase

A container that controls visibility based on Input type and Platform

Public class UClass

ULoadGuardSlot

ULoadGuardSlot.

Typedefs

Enums

Name

Description

Public enum

CommonUIUtils::ECollisionPolicy

Public enum UEnum BlueprintType

ECommonNumericType

Public enum UEnum BlueprintType

EInputActionState

Public enum UEnum BlueprintType

ERichTextInlineIconDisplayMode

Various ways that we display inline icon that have an icon-name association.

Functions

Name Description

Public function

UserWidgetT ...

 

CommonUIUtils::GetOwningUserWidget

(
    const UWidget* Widget
)

Traverses the UserWidgets that the given widget resides in until we find one matching the given type (or we run out of parents)

Public function

void

 

CommonUIUtils::ValidateBoundWidgetHierarchy

(
    const UWidgetTree& WidgetTree,
    IWidgetCompilerLog& CompileLog,
    ECollisionPolicy CollisionPolicy,
    FName ParentWidgetName,
    ChildNameArgs&&... ChildNames
)

Validates that a given widget tree hierarchy satisfies the condition that a given widget contains N other widgets (optionally requiring individual slots for each) Intended to be called from within a widget subclass's ValidateCompiledWidgetTree override If the given hierarchy does not satisfy the requirements, we'll log an error in the compiler log

Variables