CommonUI


Name	CommonUI
Type	Runtime
Part of Plugins	Common UI Plugin
Location	/Engine/Plugins/Runtime/CommonUI/Source/CommonUI/
Module Build Rules	CommonUI.Build.cs

Name	Remarks
CommonUI
FActionBarUpdated
FButtonLostSelectionDelegate
FCommonActionCommited	Action Delegates Action committed delegate tells the handler that an action is ready to handle.
FCommonActionComplete
FCommonActionCompleteSingle	Action complete delegate will tell a listener if a held action completed.
FCommonActionProgress
FCommonActionProgressSingle	Action progress delegate will tell a listener about the progress of an action being held.
FCommonActivatableSlateMetaData	Metadata set on UCommonActivatableWidget's underlying slate widget to allow Slate -> UMG lookup
FCommonAnalogCursor	Analog cursor preprocessor that tastefully hijacks things a bit to support controller navigation by moving a hidden cursor around based on focus.
FCommonButtonBaseClicked
FCommonButtonMetaData
FCommonNativeListItem	Base item class for any UMG ListViews based on native, non-UObject items.
FCommonSelectedStateChangedBase
FHardwareVisibilityTagsChangedDynamicEvent
FOnActiveIndexChangedDelegate
FOnButtonBaseGeoOperationDynamic
FOnButtonBaseOperationDynamic
FOnCurrentPageIndexChanged
FOnItemClicked
FOnItemSelected
FOnLoadGuardStateChangedDynamic
FOnRotated
FOnRotatedWithDirection
FOnSelectionCleared
FOnWidgetActivationChanged
FSimpleButtonBaseGroupDelegate
FVirtualPointerEnabledChanged
SAnalogSlider	A Slate slider control is a linear scale and draggable handle.
SCommonAnimatedSwitcher
SCommonButtonTableRow	A CommonUI version of the object table row that is aware of UCommonButtonBase.
SCommonHierarchicalScrollBox	SScrollBox can scroll through an arbitrary number of widgets.
SCommonListView	SCommonListView.
SCommonTileView
SCommonTreeView	SCommonTreeView.
SLoadGuard
SVisualAttachmentBox	Wrapper widget meant to handle native-side painting for UCommonVisualAttachment.
TTypedTagStaticImpl	Implementation utility for typed subclasses of FGameplayTag.
TWidgetFactory
UAnalogSlider	A simple widget that shows a sliding bar with a handle that allows you to control the value in a user define range (between 0..1 by default).
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.
UCommonActionWidget	A widget that shows a platform-specific icon for the given input action.
UCommonActivatableWidget	The base for widgets that are capable of being "activated" and "deactivated" during their lifetime without being otherwise modified or destroyed.
UCommonActivatableWidgetContainerBase	Base of widgets built to manage N activatable widgets, displaying one at a time.
UCommonActivatableWidgetQueue	UCommonActivatableWidgetQueue.
UCommonActivatableWidgetStack	UCommonActivatableWidgetStack.
UCommonActivatableWidgetSwitcher	An animated switcher that knows about CommonActivatableWidgets. It can also hold other Widgets.
UCommonAnimatedSwitcher	A widget switcher that activates / deactivates CommonActivatableWidgets, allowing for associated animations to trigger.
UCommonBorder	Uses the border style template defined in CommonUI project settings by default
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)
UCommonBoundActionBar	A box populated with current actions available per CommonUI's Input Handler.
UCommonBoundActionButton
UCommonBoundActionButtonInterface
UCommonButtonBase	Button that disables itself when not active.
UCommonButtonGroupBase	Manages an arbitrary collection of CommonButton widgets.
UCommonButtonInternalBase	Custom UButton override that allows us to disable clicking without disabling the widget entirely
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)
UCommonCustomNavigation	Exposes a bindable event that can be used to stomp default border navigation with custom behaviors.
UCommonDateTimeTextBlock
UCommonGameViewportClient	CommonUI Viewport to reroute input to UI first.
UCommonGenericInputActionDataTable	Overrides postload to allow for derived classes to perform code-level changes to the datatable.
UCommonHardwareVisibilityBorder	A container that controls visibility based on Platform, Input
UCommonHierarchicalScrollBox	An arbitrary scrollable collection of widgets.
UCommonInputActionDataProcessor	Derive from to process common input action datatable
UCommonInputMetadata	Metadata CommonUI will try to acquire from Enhanced Input Mapping Contexts (IMC)
UCommonLazyImage	A special Image widget that can show unloaded images and takes care of the loading for you!
UCommonLazyWidget	A widget that can async load and create an instance of a UserWidget.
UCommonListView	UCommonListView.
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.
UCommonMappingContextMetadata	Base CommonUI metadata implementation for specification in IMC's.
UCommonMappingContextMetadataInterface	Interface for metadata objects specified in Enhanced Input Mapping Contexts (IMC).
UCommonNumericTextBlock	Numeric text block that provides interpolation, and some type support (numbers, percents, seconds, distance).
UCommonPoolableWidgetInterface
UCommonRichTextBlock	Text block that supports custom scaling for mobile platforms, with option to only show icons if space is sparse.
UCommonRotator	A button that can rotate between given text labels.
UCommonTabListWidgetBase	Base class for a list of selectable tabs that correspondingly activate and display an arbitrary widget in a linked switcher
UCommonTextBlock	Text block with automatic scrolling for FX / large texts, also supports a larger set of default styling, & custom mobile scaling.
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)
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)
UCommonTileView	TileView specialized to navigate on focus for consoles & enable scrolling when not focused for touch
UCommonTreeView	UCommonTreeView.
UCommonUIActionRouterBase	The nucleus of the CommonUI input routing system.
UCommonUIEditorSettings
UCommonUIInputSettings	Project-wide input settings for UI input actions
UCommonUILibrary
UCommonUIRichTextData	Derive from this class for rich text data per game it is referenced in Common UI Settings, found in project settings UI
UCommonUISettings
UCommonUISubsystemBase
UCommonUIVisibilitySubsystem
UCommonUserWidget
UCommonVideoPlayer
UCommonVisibilitySwitcher	Basic switcher that toggles visibility on its children to only show one widget at a time.
UCommonVisibilitySwitcherSlot
UCommonVisualAttachment	Adds a widget as a zero-size attachment to another.
UCommonWidgetCarousel	A widget switcher is like a tab control, but without tabs. At most one widget is visible at time.
UCommonWidgetCarouselNavBar	A Navigation control for a Carousel
UCommonWidgetGroupBase	Base class for CommonUI widget groups, currently only used for button groups
UDEPRECATED_UCommonVisibilityWidgetBase	A container that controls visibility based on Input type and Platform
ULoadGuardSlot	ULoadGuardSlot.
UVirtualPointerVisualStateInterface	Implement this interface on a widget to receive cursor visual state changes from FCommonAnalogCursor.
UWidgetLockedStateRegistration

Name	Remarks
FActivationMetadata	Metadata that can be set on activatable widgets via GetActivationMetadata & listened to via OnActivationMetadataChanged.
FBindUIActionArgs
FCommonAnalogCursorSettings
FCommonButtonStyleOptionalSlateSound
FCommonInputActionDataBase
FCommonInputActionHandlerData	@FIXME: This struct is related to legacy CommonUI and should be removed in 5.3 - UE-164871
FCommonInputActionHandlerDelegateData	Action Handle Data used to trigger any callbacks by an object implementing the ICommonActionHandlerInterface.
FCommonInputTypeInfo
FCommonNumberFormattingOptions
FCommonRegisteredTabInfo	Information about a registered tab in the tab list
FGlobalUITags	END_UI_TAG_DECL(FUIWidgetTag, TEXT("UI.Widget"))
FRichTextIconData
FUIActionBinding
FUIActionBindingHandle
FUIActionKeyMapping
FUIActionTag
FUIInputAction
FUIInputConfig	Input Config that can be applied on widget activation.
FUITag

Name	Remarks
ICommonActionHandlerInterface
ICommonBoundActionButtonInterface	Interface for runtime bindable action buttons.
ICommonMappingContextMetadataInterface
ICommonPoolableWidgetInterface	Widget pool, if implemented WidgetFactory will attempt to reuse implementing widget objects.
ICommonUIModule	Interface for the purchase flow module.
IVirtualPointerVisualStateInterface

Name	Type	Remarks	Include Path
FActivatableTreeNodePtr	TSharedPtr< FActivatableTreeNode >		Input/CommonUIActionRouterBase.h
FActivatableTreeNodeRef	TSharedRef< FActivatableTreeNode >		Input/CommonUIActionRouterBase.h
FActivatableTreeRootPtr	TSharedPtr< FActivatableTreeRoot >		Input/CommonUIActionRouterBase.h
FActivatableTreeRootRef	TSharedRef< FActivatableTreeRoot >		Input/CommonUIActionRouterBase.h
FCommonActionCommittedNative	TBaseDelegate_OneParam< void, bool & >		CommonActionHandlerInterface.h
FCommonActionCompleteNative	TMulticastDelegate_NoParams< void >		CommonActionHandlerInterface.h
FCommonActionCompleteSingleNative	TBaseDelegate_NoParams< void >		CommonActionHandlerInterface.h
FCommonActionProgressNative	TMulticastDelegate_OneParam< void, float >		CommonActionHandlerInterface.h
FCommonActionProgressSingleNative	TBaseDelegate_OneParam< void, float >		CommonActionHandlerInterface.h
FOnButtonDoubleClickedEvent	TBaseDelegate_NoParams< FReply >		CommonButtonBase.h
FOnLazyContentChangedEvent	TMulticastDelegate_OneParam< void, UUserWidget * >		CommonLazyWidget.h
FOnLoadGuardAssetLoaded	TBaseDelegate_OneParam< void, UObject * >		CommonLoadGuard.h
FOnLoadGuardStateChanged	TBaseDelegate_OneParam< void, bool >	SLoadGuard.	CommonLoadGuard.h
FOnLoadGuardStateChangedEvent	TMulticastDelegate_OneParam< void, bool >	ULoadGuard.	CommonLoadGuard.h
FOnRerouteAxisDelegate	TBaseDelegate_FourParams< void, FInputDeviceId, FKey, float, FReply & >		CommonGameViewportClient.h
FOnRerouteInputDelegate	TBaseDelegate_FourParams< void, FInputDeviceId, FKey, EInputEvent, FReply & >		CommonGameViewportClient.h
FOnRerouteTouchInputDelegate	TBaseDelegate_FiveParams< void, FInputDeviceId, uint32, ETouchType::Type, const FVector2D &, FReply & >		CommonGameViewportClient.h
FTouchRerouteDelegate	TBaseDelegate_FourParams< void, FTouchId, ETouchType::Type, const FVector2D &, FReply & >		CommonGameViewportClient.h
FUserWidgetFactory	TWidgetFactory< UUserWidget >		WidgetFactory.h

Name	Remarks
ECommonButtonAcceptKeyHandling
ECommonNumericType
ECommonSwitcherTransition
ECommonSwitcherTransitionFallbackStrategy	Determines the switcher's behavior if the target of a transition is removed before it becomes the active widget.
ECommonUIScrollRecipientOwningNodeSource	Enum to represent which common UI tree node takes scroll input
ECursorVisualState	Cumulative cursor visual states - flags can combine (e.g. Hover + Pressed + Drag).
EHoverEventSource
EInputActionState
EProcessHoldActionResult
ERichTextInlineIconDisplayMode	Various ways that we display inline icon that have an icon-name association.
ERotatorDirection
ERouteUIInputResult
ETransitionCurve

Name	Type	Remarks	Include Path	Unreal Specifiers
TAG_PlatformTrait_PlayInEditor	FNativeGameplayTag		CommonUISettings.h

Name	Remarks	Include Path	Unreal Specifiers
bool operator! ( ECursorVisualState E )		Input/CommonAnalogCursorTypes.h
ECursorVisualState operator& ( ECursorVisualState Lhs, ECursorVisualState Rhs )		Input/CommonAnalogCursorTypes.h
ECursorVisualState & operator&= ( ECursorVisualState& Lhs, ECursorVisualState Rhs )		Input/CommonAnalogCursorTypes.h
ECursorVisualState operator^ ( ECursorVisualState Lhs, ECursorVisualState Rhs )		Input/CommonAnalogCursorTypes.h
ECursorVisualState & operator^= ( ECursorVisualState& Lhs, ECursorVisualState Rhs )		Input/CommonAnalogCursorTypes.h
ECursorVisualState operator\| ( ECursorVisualState Lhs, ECursorVisualState Rhs )		Input/CommonAnalogCursorTypes.h
ECursorVisualState & operator\|= ( ECursorVisualState& Lhs, ECursorVisualState Rhs )		Input/CommonAnalogCursorTypes.h
ECursorVisualState operator~ ( ECursorVisualState E )		Input/CommonAnalogCursorTypes.h

Name	Remarks	Include Path	Unreal Specifiers
static ECurveEaseFunction TransitionCurveToCurveEaseFunction ( ETransitionCurve CurveType )		Slate/SCommonAnimatedSwitcher.h

Navigation

Classes

Structs

Interfaces

Typedefs

Enums

Public

Variables

Public

Functions

Public

Static