Navigation
API > API/Plugins > API/Plugins/CommonUI
A display stack of ActivatableWidget elements.
- Only the widget at the top of the stack is displayed and activated. All others are deactivated.
- When that top-most displayed widget deactivates, it's automatically removed and the preceding entry is displayed/activated.
- If RootContent is provided, it can never be removed regardless of activation state
| Name | UCommonActivatableWidgetStack |
| Type | class |
| Header File | /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/Widgets/CommonActivatableWidgetContainer.h |
| Include Path | #include "Widgets/CommonActivatableWidgetContainer.h" |
Syntax
UCLASS (MinimalAPI)
class UCommonActivatableWidgetStack : public UCommonActivatableWidgetContainerBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UVisual → UWidget → UCommonActivatableWidgetContainerBase → UCommonActivatableWidgetStack
Implements Interfaces
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| RootContentWidget | TObjectPtr< UCommonActivatableWidget > | Widgets/CommonActivatableWidgetContainer.h |
|
|
| RootContentWidgetClass | TSubclassOf< UCommonActivatableWidget > | Optional widget to auto-generate as the permanent root element of the stack | Widgets/CommonActivatableWidgetContainer.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UCommonActivatableWidget * GetRootContent() |
Widgets/CommonActivatableWidgetContainer.h |
Protected
Overridden from UCommonActivatableWidgetContainerBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnWidgetAddedToList
(
UCommonActivatableWidget& AddedWidget |
Widgets/CommonActivatableWidgetContainer.h |
Overridden from UWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void SynchronizeProperties() |
Widgets/CommonActivatableWidgetContainer.h |