UCommonWidgetCarousel

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

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

CommonUI

Header

/Engine/Plugins/Experimental/CommonUI/Source/CommonUI/Public/CommonWidgetCarousel.h

Include

#include "CommonWidgetCarousel.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(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

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly

int32

 

ActiveWidgetIndex

The slot index to display

Protected variable

TArray< TShared...

 

CachedSlotWidgets

Protected variable

TSharedPtr< SWi...

 

MyCommonWidgetCarousel

Public variable UProperty Category BlueprintAssignable

FOnCurrentPageI...

 

OnCurrentPageIndexChanged

Protected variable

FDelegateHandle

 

TickerHandle

Constructors

Name Description

Public function

UCommonWidgetCarousel

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Protected function

bool

 

AutoScrollCallback

(
    float DeltaTime
)

Public function UFunction BlueprintCallable, Category

void

 

BeginAutoScrolling

(
    float ScrollInterval
)

Public function UFunction BlueprintCallable, Category

void

 

EndAutoScrolling()

Public function Const UFunction BlueprintCallable, Category

int32

 

GetActiveWidgetIndex()

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

 

NextPage()

Protected function

TSharedRef< ...

 

OnGenerateWidgetForCarousel

(
    UPanelSlot* PanelSlot
)

Public function UFunction BlueprintCallable, Category

void

 

PreviousPage()

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

Name Description

Protected function Virtual Const

UClass *

 

GetSlotClass()

UPanelWidget.

Protected function Virtual

void

 

OnSlotAdded

(
    UPanelSlot* InSlot
)

Overridden from UWidget

Name Description

Public function Virtual

const FText

 

GetPaletteCategory()

Gets the palette category of the widget

Public function Virtual

void

 

OnDescendantDeselectedByDesigner

(
    UWidget* DescendantWidget
)

Public function Virtual

void

 

OnDescendantSelectedByDesigner

(
    UWidget* DescendantWidget
)

Protected function Virtual

TSharedRef< ...

 

RebuildWidget()

Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.

Public function Virtual

void

 

SynchronizeProperties()

Applies all properties to the native widget if possible.

Overridden from UVisual

Name Description

Public function Virtual

void

 

ReleaseSlateResources

(
    bool bReleaseChildren
)

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss