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

UCommonWidgetCarousel

A widget switcher is like a tab control, but without tabs. At most one widget is visible at time.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UPanelWidget

UCommonWidgetCarousel

References

Module	CommonUI
Header	/Engine/Plugins/Experimental/CommonUI/Source/CommonUI/Public/CommonWidgetCarousel.h
Include	#include "CommonWidgetCarousel.h"

Syntax

UCLASS(Blueprintable)
class UCommonWidgetCarousel : public UPanelWidget

Remarks

A widget switcher is like a tab control, but without tabs. At most one widget is visible at time.

Variables

	Name	Description
int32	ActiveWidgetIndex	The slot index to display
TArray< TShared...	CachedSlotWidgets
TSharedPtr< SWi...	MyCommonWidgetCarousel
FOnCurrentPageI...	OnCurrentPageIndexChanged
FTSTicker::FDel...	TickerHandle

Constructors

	Name	Description
	UCommonWidgetCarousel ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
bool	AutoScrollCallback ( float DeltaTime )
void	BeginAutoScrolling ( float ScrollInterval )
void	EndAutoScrolling()
int32	GetActiveWidgetIndex()	Gets the slot index of the currently active widget
UWidget *...	GetWidgetAtIndex ( int32 Index )	Get a widget at the provided index
void	HandlePageChanged ( int32 PageIndex )
void	NextPage()
TSharedRef< ...	OnGenerateWidgetForCarousel ( UPanelSlot* PanelSlot )
void	PreviousPage()
void	SetActiveWidget ( UWidget* Widget )	Activates the widget and makes it the active index.
void	SetActiveWidgetIndex ( int32 Index )	Activates the widget at the specified index.

Overridden from UPanelWidget

		Name	Description
	UClass *	GetSlotClass()	UPanelWidget.
	void	OnSlotAdded ( 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 )
TSharedRef< ...	RebuildWidget()	Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
void	SynchronizeProperties()	Applies all properties to the native widget if possible.

Overridden from UVisual

		Name	Description
	void	ReleaseSlateResources ( bool bReleaseChildren )

Overridden from UObject

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