Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > CommonUI > UCommonActivatableWidget

Light Theme

Dark Theme

UCommonActivatableWidget

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

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UUserWidget

UCommonUserWidget

UCommonActivatableWidget

References

Module	CommonUI
Header	/Engine/Plugins/Experimental/CommonUI/Source/CommonUI/Public/CommonActivatableWidget.h
Include	#include "CommonActivatableWidget.h"

Syntax

UCLASS(Meta=(DisableNativeTick))
class UCommonActivatableWidget : public UCommonUserWidget

Remarks

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

This is generally desired for one or more of the following purposes:

This widget can turn on/off without being removed from the hierarchy (or otherwise reconstructing the underlying SWidgets), so Construct/Destruct are insufficient
You'd like to be able to "go back" from this widget, whether that means back a breadcrumb, closing a modal, or something else. This is built-in here.
This widget's place in the hierarchy is such that it defines a meaningful node-point in the tree of activatable widgets through which input is routed to all widgets.

By default, an activatable widget:

Is not automatically activated upon construction
Does not register to receive back actions (or any other actions, for that matter)
If classified as a back handler, is automatically deactivated (but not destroyed) when it receives a back action

that removing an activatable widget from the UI (i.e. triggering Destruct()) will always deactivate it, even if the UWidget is not destroyed. Re-constructing the underlying SWidget will only result in re-activation if auto-activate is enabled. TODO: ADD MORE INFO ON INPUTS

Variables

	Name	Description
ESlateVisibilit...	ActivatedVisibility
bool	bAutoActivate	True to automatically activate upon construction
bool	bIsBackActionDisplayedInActionBar	True to receive "Back" actions automatically.
bool	bIsBackHandler	True to receive "Back" actions automatically.
bool	bIsModal	True to have this widget be treated as a root node for input routing, regardless of its actual parentage.
bool	bSetVisibilityOnActivated
bool	bSetVisibilityOnDeactivated
bool	bSupportsActivationFocus	True if this widget is a candidate to receive/route focus or specify a desired UIInputConfig when active.
ESlateVisibilit...	DeactivatedVisibility
If	false	True to prefer automatically restoring focus to the widget that was focused when this widget last became the non-leafmost-active-widget.

Functions

	Name	Description
void	ActivateWidget()
bool	AutoRestoresFocus()
void	BindVisibilityToActivation ( UCommonActivatableWidget* Acti... )	Bind our visibility to the activation of another widget, useful for making mouse collisions behave similiar to console navigation w.r.t activation Will immediately update visibility based on the bound widget activation & visibilites set by SetBindVisibilities.
UWidget *...	BP_GetDesiredFocusTarget()	Implement to provide the desired widget to focus if/when this activatable becomes the primary active widget.
void	BP_OnActivated()
void	BP_OnDeactivated()
bool	BP_OnHandleBackAction()	Override in BP implementations to provide custom behavior when receiving a back action
void	ClearActiveHoldInputs()
void	DeactivateWidget()
TOptional< F...	GetDesiredCameraConfig()	COMMONUI_SCOPE:
UWidget *...	GetDesiredFocusTarget()	Returns the desired widget to focus when this Widget Activates.
If we simply...	GetDesiredFocusTarget()
TOptional< F...	GetDesiredInputConfig()	Gets the desired input configuration to establish when this widget activates and can receive input (i.e. all parents are also active).
void	HandleBackAction()
void	InternalProcessActivation()
void	InternalProcessDeactivation()
bool	IsActivated()
bool	IsModal()
UWidget *...	NativeGetDesiredFocusTarget()	Override to provide the desired widget that should receive focus when this becomes the primary active widget.
void	NativeOnActivated()
void	NativeOnDeactivated()
bool	NativeOnHandleBackAction()
FSimpleMulti...	OnActivated()
FSimpleMulti...	OnDeactivated()
FSimpleMulti...	OnRequestRefreshFocus()
FSimpleMulti...	OnSlateReleased()
void	RegisterInputTreeNode ( const TSharedPtr< FActivatableTreeN... )
void	RequestRefreshFocus()	Ask for focus to be re-set to our current DesiredFocusTarget, but only if our node is currently the leaf-most active node (no stealing!).
void	Reset()
void	SetBindVisibilities ( ESlateVisibility OnActivatedVisibil..., ESlateVisibility OnDeactivatedVisib..., bool bInAllActive )	Visibilities to use for when bound widgets in BindVisibilityToActivation are activated.
bool	SetsVisibilityOnActivated()
bool	SetsVisibilityOnDeactivated()
bool	SupportsActivationFocus()

Overridden from UUserWidget

		Name	Description
	void	NativeConstruct()
	void	NativeDestruct()

Overridden from UWidget

		Name	Description
	TSharedRef< ...	RebuildWidget()	Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.

Overridden from UVisual

		Name	Description
	void	ReleaseSlateResources ( bool bReleaseChildren )

Typedefs

Name	Description
FActivatableWidgetRebuildEvent

Constants

Name	Description
OnRebuilding