Navigation
API > API/Plugins > API/Plugins/CommonUI
Base of widgets built to manage N activatable widgets, displaying one at a time. Intentionally meant to be black boxes that do not expose child/slot modification like a normal panel widget.
| Name | UCommonActivatableWidgetContainerBase |
| Type | class |
| Header File | /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/Widgets/CommonActivatableWidgetContainer.h |
| Include Path | #include "Widgets/CommonActivatableWidgetContainer.h" |
Syntax
UCLASS (MinimalAPI, Abstract)
class UCommonActivatableWidgetContainerBase : public UWidget
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UVisual → UWidget → UCommonActivatableWidgetContainerBase
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UCommonActivatableWidgetContainerBase
(
const FObjectInitializer& Initializer |
Widgets/CommonActivatableWidgetContainer.h |
Classes
| Name | Remarks |
|---|---|
| FOnDisplayedWidgetChanged | |
| FTransitioningChanged |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnTransitioningChanged | FTransitioningChanged | Widgets/CommonActivatableWidgetContainer.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bRemoveDisplayedWidgetPostTransition | bool | Widgets/CommonActivatableWidgetContainer.h | ||
| OnDisplayedWidgetChangedEvent | FOnDisplayedWidgetChanged | Widgets/CommonActivatableWidgetContainer.h | ||
| ReleasedWidgets | TArray< TSharedPtr< SWidget > > | Widgets/CommonActivatableWidgetContainer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
ActivatableWidgetT * AddWidget
(
TSubclassOf< UCommonActivatableWidget > ActivatableWidgetClass, |
Generates (either creates or pulls from the inactive pool) instance of the given widget class and adds it to the container. | Widgets/CommonActivatableWidgetContainer.h | |
ActivatableWidgetT * AddWidget
(
TSubclassOf< UCommonActivatableWidget > ActivatableWidgetClass |
Adds an activatable widget to the container. See BP_AddWidget for more info. | Widgets/CommonActivatableWidgetContainer.h | |
void AddWidgetInstance
(
UCommonActivatableWidget& ActivatableWidget |
Adds an activatable widget instance to the container. | Widgets/CommonActivatableWidgetContainer.h | |
void ClearWidgets() |
Widgets/CommonActivatableWidgetContainer.h |
|
|
UCommonActivatableWidget * GetActiveWidget() |
Widgets/CommonActivatableWidgetContainer.h |
|
|
int32 GetNumWidgets() |
Widgets/CommonActivatableWidgetContainer.h | ||
float GetTransitionDuration() |
Widgets/CommonActivatableWidgetContainer.h |
|
|
const TArray< UCommonActivatableWidget * > & GetWidgetList() |
Widgets/CommonActivatableWidgetContainer.h | ||
FOnDisplayedWidgetChanged & OnDisplayedWidgetChanged() |
Widgets/CommonActivatableWidgetContainer.h | ||
void RemoveWidget
(
UCommonActivatableWidget& WidgetToRemove |
Widgets/CommonActivatableWidgetContainer.h | ||
void SetTransitionDuration
(
float Duration |
Widgets/CommonActivatableWidgetContainer.h |
|
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnWidgetAddedToList
(
UCommonActivatableWidget& AddedWidget |
Widgets/CommonActivatableWidgetContainer.h | ||
void SetSwitcherIndex
(
int32 TargetIndex, |
Widgets/CommonActivatableWidgetContainer.h |
Overridden from UWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const FText GetPaletteCategory() |
Widgets/CommonActivatableWidgetContainer.h | ||
virtual void OnWidgetRebuilt() |
Widgets/CommonActivatableWidgetContainer.h | ||
virtual TSharedRef< SWidget > RebuildWidget() |
Widgets/CommonActivatableWidgetContainer.h |
Overridden from UVisual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ReleaseSlateResources
(
bool bReleaseChildren |
Widgets/CommonActivatableWidgetContainer.h |