Navigation
API > API/Runtime > API/Runtime/WidgetCarousel
Implements a widget Carousel.
A widget Carousel displays widgets that can be scrolled in and out.
| Name | SWidgetCarousel |
| Type | class |
| Header File | /Engine/Source/Runtime/WidgetCarousel/Public/SWidgetCarousel.h |
| Include Path | #include "SWidgetCarousel.h" |
Syntax
template<typename ItemType>
class SWidgetCarousel : public SCompoundWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SWidgetCarousel
- FSlateControlledConstruction → SWidget → SCompoundWidget → SWidgetCarousel
Structs
| Name | Remarks |
|---|---|
| FArguments |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnCarouselPageChanged | TBaseDelegate_OneParam< void, int32 > | SWidgetCarousel.h | |
| FOnGenerateWidget | TSlateDelegates< ItemType >::FOnGenerateWidget | SWidgetCarousel.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct
(
const FArguments& InArgs |
Constructs the widget. | SWidgetCarousel.h | |
void GenerateCurrentWidgets() |
SWidgetCarousel.h | ||
float GetMoveSpeed() |
SWidgetCarousel.h | ||
float GetPrimarySlide() |
SWidgetCarousel.h | ||
int32 GetWidgetIndex() |
Get the current widget index. | SWidgetCarousel.h | |
void Peak
(
EWidgetCarouselScrollDirection::Type Direction |
SWidgetCarousel.h | ||
void ResetTransition() |
SWidgetCarousel.h | ||
void SetActiveWidgetIndex
(
int32 Index |
Sets the active widget to display at the specified index. | SWidgetCarousel.h | |
void SetItemSource
(
const TArray< ItemType >* InWidgetItemsSource |
Set the item source, and scroll to the first item. | SWidgetCarousel.h | |
void SetMoveSpeed
(
float InMoveSpeed |
SWidgetCarousel.h | ||
void SetNextWidget() |
Scroll right. | SWidgetCarousel.h | |
void SetPreviousWidget() |
Scroll left. | SWidgetCarousel.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void GenerateWidgets() |
Regenerate the widgets to display them. | SWidgetCarousel.h | |
int32 GetLeftWidgetIndex
(
int32 Index |
SWidgetCarousel.h | ||
int32 GetRightWidgetIndex
(
int32 Index |
SWidgetCarousel.h | ||
bool IsInTransition() |
SWidgetCarousel.h | ||
EActiveTimerReturnType RegisteredTick
(
double InCurrentTime, |
SWidgetCarousel.h | ||
void SetSliderLimits() |
SWidgetCarousel.h | ||
void SwapBuffer
(
EWidgetCarouselScrollDirection::Type ScrollDirection, |
Swap the buffer index. | SWidgetCarousel.h |