1. Epic GamesDeveloper
  3. UCommonVisibilitySwitcher

UCommonVisibilitySwitcher

Basic switcher that toggles visibility on its children to only show one widget at a time.

API > API/Plugins > API/Plugins/CommonUI

Inheritance Hierarchy

  • UOverlay
  • UCommonVisibilitySwitcher

References

   
Module CommonUI
Header /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonVisibilitySwitcher.h
Include #include "CommonVisibilitySwitcher.h"

Syntax

UCLASS (Meta=(DisableNativeTick))  
class UCommonVisibilitySwitcher : public UOverlay

Remarks

Basic switcher that toggles visibility on its children to only show one widget at a time. Activates visible widget if possible.

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere, Meta int32 ActiveWidgetIndex  
Protected variable UProperty Category, EditAnywhere bool bActivateFirstSlotOnAdding Whether or not to activate the first slot if one is added dynamically.
Protected variable UProperty Category, EditAnywhere bool bAutoActivateSlot Whether or not to automatically activate a slot when it becomes visible.
Protected variable bool bCurrentlySwitching  
Protected variable FOnActiveWidgetIndexChanged OnActiveWidgetIndexChangedEvent  
Protected variable UProperty Category, EditAnywhere ESlateVisibility ShownVisibility  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void

DecrementActiveWidgetIndex ( bool bAllowWrapping
)

  
Public function Const UFunction BlueprintCallable, Category UWidget *  
Public function Const UFunction BlueprintCallable, Category int32  
Public function Virtual const FText  
Protected function Virtual Const UClass *  
Public function Const UWidget *  
Public function UFunction BlueprintCallable, Category void

IncrementActiveWidgetIndex ( bool bAllowWrapping
)

  
Public function Const UFunction BlueprintPure, Category bool  
Public function void

MoveChild ( int32 CurrentIdx,
int32 NewIdx
)

  
Public function Const FOnActiveWidgetIndexChanged &  
Public function Virtual void

OnDescendantDeselectedByDesigner ( UWidget* DescendantWidget
)

  
Public function Virtual void

OnDescendantSelectedByDesigner ( UWidget* DescendantWidget
)

  
Protected function Virtual void

OnSlotAdded ( UPanelSlot* InSlot
)

  
Protected function Virtual void

OnSlotRemoved ( UPanelSlot* InSlot
)

  
Protected function Virtual void  
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Protected function void  
Public function UFunction BlueprintCallable, Category void

SetActiveWidget ( const UWidget* Widget
)

  
Public function UFunction BlueprintCallable, Category void  
Protected function Virtual void

SetActiveWidgetIndex_Internal ( int32 Index,
bool bBroadcastChange
)

  
Public function Virtual void  
Protected function Virtual Const void

ValidateCompiledDefaults ( IWidgetCompilerLog& CompileLog
)

  

Typedefs

Name Description
FOnActiveWidgetIndexChanged  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page