Navigation
API > API/Plugins > API/Plugins/CommonUI
Basic switcher that toggles visibility on its children to only show one widget at a time. Activates visible widget if possible.
| Name | UCommonVisibilitySwitcher |
| Type | class |
| Header File | /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonVisibilitySwitcher.h |
| Include Path | #include "CommonVisibilitySwitcher.h" |
Syntax
UCLASS (MinimalAPI, Meta=(DisableNativeTick))
class UCommonVisibilitySwitcher : public UOverlay
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UVisual → UWidget → UPanelWidget → UOverlay → UCommonVisibilitySwitcher
Implements Interfaces
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnActiveWidgetIndexChanged | TMulticastDelegate_OneParam< void, int32 > | CommonVisibilitySwitcher.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DesignTime_ActiveIndex | int32 | CommonVisibilitySwitcher.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ActivateVisibleSlot() |
CommonVisibilitySwitcher.h |
|
|
void DeactivateVisibleSlot() |
CommonVisibilitySwitcher.h |
|
|
void DecrementActiveWidgetIndex
(
bool bAllowWrapping |
CommonVisibilitySwitcher.h |
|
|
UWidget * GetActiveWidget() |
CommonVisibilitySwitcher.h |
|
|
int32 GetActiveWidgetIndex() |
CommonVisibilitySwitcher.h |
|
|
UWidget * GetWidgetAtIndex
(
int32 Index |
CommonVisibilitySwitcher.h | ||
void IncrementActiveWidgetIndex
(
bool bAllowWrapping |
CommonVisibilitySwitcher.h |
|
|
bool IsCurrentlySwitching() |
CommonVisibilitySwitcher.h |
|
|
void MoveChild
(
int32 CurrentIdx, |
CommonVisibilitySwitcher.h | ||
FOnActiveWidgetIndexChanged & OnActiveWidgetIndexChanged() |
CommonVisibilitySwitcher.h | ||
void SetActiveWidget
(
const UWidget* Widget |
CommonVisibilitySwitcher.h |
|
|
void SetActiveWidgetIndex
(
int32 Index |
CommonVisibilitySwitcher.h |
|
Overridden from UWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const FText GetPaletteCategory() |
CommonVisibilitySwitcher.h | ||
virtual void OnDescendantDeselectedByDesigner
(
UWidget* DescendantWidget |
CommonVisibilitySwitcher.h | ||
virtual void OnDescendantSelectedByDesigner
(
UWidget* DescendantWidget |
CommonVisibilitySwitcher.h | ||
virtual void SynchronizeProperties() |
CommonVisibilitySwitcher.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
CommonVisibilitySwitcher.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ResetSlotVisibilities() |
CommonVisibilitySwitcher.h | ||
virtual void SetActiveWidgetIndex_Internal
(
int32 Index, |
CommonVisibilitySwitcher.h |
Overridden from UPanelWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual UClass * GetSlotClass() |
CommonVisibilitySwitcher.h | ||
virtual void OnSlotAdded
(
UPanelSlot* InSlot |
CommonVisibilitySwitcher.h | ||
virtual void OnSlotRemoved
(
UPanelSlot* InSlot |
CommonVisibilitySwitcher.h |
Overridden from UWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnWidgetRebuilt() |
CommonVisibilitySwitcher.h | ||
virtual void ValidateCompiledDefaults
(
IWidgetCompilerLog& CompileLog |
CommonVisibilitySwitcher.h |