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

Light Theme

Dark Theme

UCommonVisibilitySwitcher

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

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UPanelWidget

UOverlay

UCommonVisibilitySwitcher

References

Module	CommonUI
Header	/Engine/Plugins/Experimental/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

	Name	Description
int32	ActiveWidgetIndex
bool	bActivateFirstSlotOnAdding	Whether or not to activate the first slot if one is added dynamically.
bool	bAutoActivateSlot	Whether or not to automatically activate a slot when it becomes visible.
FOnActiveWidget...	OnActiveWidgetIndexChangedEvent
ESlateVisibilit...	ShownVisibility

Functions

		Name	Description
	void	ActivateVisibleSlot()
	void	DeactivateVisibleSlot()
	void	DecrementActiveWidgetIndex ( bool bAllowWrapping )
	UWidget *...	GetActiveWidget()
	int32	GetActiveWidgetIndex()
	UWidget *...	GetWidgetAtIndex ( int32 Index )
	void	IncrementActiveWidgetIndex ( bool bAllowWrapping )
	void	MoveChild ( int32 CurrentIdx, int32 NewIdx )
	FOnActiveWid...	OnActiveWidgetIndexChanged()
	void	ResetSlotVisibilities()
	void	SetActiveWidget ( const UWidget* Widget )
	void	SetActiveWidgetIndex ( int32 Index )
	void	SetActiveWidgetIndex_Internal ( int32 Index, bool bBroadcastChange )

Overridden from UPanelWidget

	Name	Description
UClass *	GetSlotClass()	UPanelWidget.
void	OnSlotAdded ( UPanelSlot* InSlot )
void	OnSlotRemoved ( UPanelSlot* InSlot )

Overridden from UWidget

	Name	Description
const FText	GetPaletteCategory()	Gets the palette category of the widget
void	OnDescendantDeselectedByDesigner ( UWidget* DescendantWidget )
void	OnDescendantSelectedByDesigner ( UWidget* DescendantWidget )
void	OnWidgetRebuilt()	Function called after the underlying SWidget is constructed.
void	SynchronizeProperties()	Applies all properties to the native widget if possible.
void	ValidateCompiledDefaults ( IWidgetCompilerLog& CompileLog )	Called at the end of Widget Blueprint compilation.

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally

Typedefs

Name	Description
FOnActiveWidgetIndexChanged