1. Epic GamesDeveloper
  3. UCommonWidgetCarousel

UCommonWidgetCarousel

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

Unreal Engine C++ API Reference > Plugins > CommonUI

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;Blueprintable&41;  
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

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly int32 ActiveWidgetIndex The slot index to display
Protected variable TArray< TSharedRef< SWidget > > CachedSlotWidgets  
Protected variable TSharedPtr< SWidgetCarousel< UPanelSlot * > > MyCommonWidgetCarousel  
Public variable UProperty Category BlueprintAssignable FOnCurrentPageIndexChanged OnCurrentPageIndexChanged  
Protected variable FTSTicker::FDelegateHandle TickerHandle  

Constructors

  Type Name Description
Public function  

UCommonWidgetCarousel ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function bool

AutoScrollCallback ( float DeltaTime
)

  
Public function UFunction BlueprintCallable, Category void

BeginAutoScrolling ( float ScrollInterval
)

  
Public function UFunction BlueprintCallable, Category void  
Public function Const UFunction BlueprintCallable, Category int32 Gets the slot index of the currently active widget
Public function Const UFunction BlueprintCallable, Category UWidget *

GetWidgetAtIndex ( int32 Index
)

 Get a widget at the provided index
Protected function void

HandlePageChanged ( int32 PageIndex
)

  
Public function UFunction BlueprintCallable, Category void  
Protected function TSharedRef< SWidget >  
Public function UFunction BlueprintCallable, Category void  
Public function Virtual UFunction BlueprintCallable, Category void

SetActiveWidget ( UWidget* Widget
)

 Activates the widget and makes it the active index.
Public function Virtual UFunction BlueprintCallable, Category void

SetActiveWidgetIndex ( int32 Index
)

 Activates the widget at the specified index.

Overridden from UPanelWidget

  Type Name Description
Protected function Virtual Const UClass * UPanelWidget.
Protected function Virtual void

OnSlotAdded ( UPanelSlot* InSlot
)

  

Overridden from UWidget

  Type Name Description
Public function Virtual const FText Gets the palette category of the widget
Public function Virtual void  
Public function Virtual void

OnDescendantSelectedByDesigner ( UWidget* DescendantWidget
)

  
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
Public function Virtual void Applies all properties to the native widget if possible.

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page