Navigation
API > API/Plugins > API/Plugins/CommonUI
A widget switcher is like a tab control, but without tabs. At most one widget is visible at time.
| Name | UCommonWidgetCarousel |
| Type | class |
| Header File | /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonWidgetCarousel.h |
| Include Path | #include "CommonWidgetCarousel.h" |
Syntax
UCLASS (MinimalAPI, Blueprintable)
class UCommonWidgetCarousel : public UPanelWidget
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UVisual → UWidget → UPanelWidget → UCommonWidgetCarousel
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UCommonWidgetCarousel
(
const FObjectInitializer& ObjectInitializer |
CommonWidgetCarousel.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveWidgetIndex | int32 | The slot index to display | CommonWidgetCarousel.h |
|
| OnCurrentPageIndexChanged | FOnCurrentPageIndexChanged | CommonWidgetCarousel.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BeginAutoScrolling
(
float ScrollInterval |
CommonWidgetCarousel.h |
|
|
void EndAutoScrolling() |
CommonWidgetCarousel.h |
|
|
int32 GetActiveWidgetIndex() |
Gets the slot index of the currently active widget | CommonWidgetCarousel.h |
|
bool GetCacheChildren() |
Gets the current caching behavior. | CommonWidgetCarousel.h |
|
float GetMoveSpeed() |
Gets the Move Speed. | CommonWidgetCarousel.h |
|
UWidget * GetWidgetAtIndex
(
int32 Index |
Get a widget at the provided index | CommonWidgetCarousel.h |
|
void NextPage() |
CommonWidgetCarousel.h |
|
|
void PreviousPage() |
CommonWidgetCarousel.h |
|
|
virtual void SetActiveWidget
(
UWidget* Widget |
Activates the widget and makes it the active index. | CommonWidgetCarousel.h |
|
virtual void SetActiveWidgetIndex
(
int32 Index |
Activates the widget at the specified index. | CommonWidgetCarousel.h |
|
void SetCacheChildren
(
bool InCacheChildren |
Sets the current caching behavior. | CommonWidgetCarousel.h |
|
void SetMoveSpeed
(
float InMoveSpeed |
Sets the Move Speed. | CommonWidgetCarousel.h |
|
Overridden from UWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const FText GetPaletteCategory() |
CommonWidgetCarousel.h | ||
virtual void OnDescendantDeselectedByDesigner
(
UWidget* DescendantWidget |
CommonWidgetCarousel.h | ||
virtual void OnDescendantSelectedByDesigner
(
UWidget* DescendantWidget |
CommonWidgetCarousel.h | ||
virtual void SynchronizeProperties() |
CommonWidgetCarousel.h |
Overridden from UVisual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ReleaseSlateResources
(
bool bReleaseChildren |
CommonWidgetCarousel.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
CommonWidgetCarousel.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AutoScrollCallback
(
float DeltaTime |
CommonWidgetCarousel.h | ||
void HandlePageChanged
(
int32 PageIndex |
CommonWidgetCarousel.h | ||
TSharedRef< SWidget > OnGenerateWidgetForCarousel
(
UPanelSlot* PanelSlot |
CommonWidgetCarousel.h |
Overridden from UPanelWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual UClass * GetSlotClass() |
UPanelWidget. | CommonWidgetCarousel.h | |
virtual void OnSlotAdded
(
UPanelSlot* InSlot |
CommonWidgetCarousel.h | ||
virtual void OnSlotRemoved
(
UPanelSlot* InSlot |
CommonWidgetCarousel.h |
Overridden from UWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedRef< SWidget > RebuildWidget() |
CommonWidgetCarousel.h |