UCommonTabListWidgetBase

Base class for a list of selectable tabs that correspondingly activate and display an arbitrary widget in a linked switcher

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

CommonUI

Header

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

Include

#include "CommonTabListWidgetBase.h"

Syntax

UCLASS(Abstract, Blueprintable, ClassGroup=UI, Meta=(Category="Common UI", DisableNativeTick))
class UCommonTabListWidgetBase : public UCommonUserWidget

Remarks

Base class for a list of selectable tabs that correspondingly activate and display an arbitrary widget in a linked switcher

Variables

Name Description

Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly

bool

 

bAutoListenForInput

Whether to register to handle tab list input immediately upon construction

Protected variable

bool

 

bIsListeningForInput

Is the tab list currently listening for tab input actions?

Protected variable UProperty Transient

TWeakObjectPtr<...

 

LinkedSwitcher

The activatable widget switcher that this tab list is associated with and manipulates

Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly

FDataTableRowHa...

 

NextTabInputActionData

The input action to listen for causing the next tab to be selected

Public variable UProperty Category BlueprintAssignable

FOnTabButtonCre...

 

OnTabButtonCreation

Broadcasts when a new tab is created.

Public variable UProperty Category BlueprintAssignable

FOnTabButtonRem...

 

OnTabButtonRemoval

Broadcasts when a new tab is created.

Public variable UProperty Category BlueprintAssignable

FOnTabSelected

 

OnTabSelected

Broadcasts when a new tab is selected.

Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly

FDataTableRowHa...

 

PreviousTabInputActionData

The input action to listen for causing the previous tab to be selected

Protected variable UProperty Transient

UCommonButtonGr...

 

TabButtonGroup

The button group that manages all the created tab buttons

Constructors

Name Description

Public function

UCommonTabListWidgetBase

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function UFunction BlueprintCallable, Category

void

 

DisableTabWithReason

(
    FName TabNameID,
    const FText& Reason
)

Disables the tab associated with the given ID with a reason

Public function Const UFunction BlueprintCallable, Category

FName

 

GetActiveTab()

Public function Const UFunction BlueprintCallable, BlueprintPure, Category

UCommonAnima...

 

GetLinkedSwitcher()

Public function Const UFunction BlueprintCallable, Category

FName

 

GetSelectedTabId()

Public function UFunction BlueprintCallable, Category

UCommonButto...

 

GetTabButtonBaseByID

(
    FName TabNameID
)

Returns the tab button matching the ID, if found

Public function Const UFunction BlueprintCallable, Category

int32

 

GetTabCount()

Public function Const UFunction BlueprintCallable, Category

FName

 

GetTabIdAtIndex

(
    int32 Index
)

Protected function UFunction

void

 

HandleNextTabInputAction

(
    bool& bPassthrough
)

Protected function Virtual

void

 

HandlePostLinkedSwitcherChanged()

Protected function UFunction Category, Meta, BlueprintImplementableEvent

void

 

HandlePostLinkedSwitcherChanged_BP()

Protected function Virtual

void

 

HandlePreLinkedSwitcherChanged()

Protected function UFunction Category, Meta, BlueprintImplementableEvent

void

 

HandlePreLinkedSwitcherChanged_BP()

Protected function UFunction

void

 

HandlePreviousTabInputAction

(
    bool& bPassthrough
)

Protected function UFunction

void

 

HandleTabButtonSelected

(
    UCommonButtonBase* SelectedTab...,
    int32 ButtonIndex
)

Protected function UFunction Category, Meta blueprintnativeevent

void

 

HandleTabCreation

(
    FName TabNameID,
    UCommonButtonBase* TabButton
)

Protected function UFunction Category, Meta blueprintnativeevent

void

 

HandleTabRemoval

(
    FName TabNameID,
    UCommonButtonBase* TabButton
)

Public function UFunction BlueprintCallable, Category

bool

 

RegisterTab

(
    FName TabNameID,
    TSubclassOf< UCommonButtonBase > Bu...,
    UWidget* ContentWidget
)

Registers and adds a new tab to the list that corresponds to a given widget instance.

Public function UFunction BlueprintCallable, Category

void

 

RemoveAllTabs()

Public function UFunction BlueprintCallable, Category

bool

 

RemoveTab

(
    FName TabNameID
)

Public function UFunction BlueprintCallable, Category

bool

 

SelectTabByID

(
    FName TabNameID,
    bool bSuppressClickFeedback
)

Selects the tab registered under the provided name ID

Public function Virtual UFunction BlueprintCallable, Category

void

 

SetLinkedSwitcher

(
    UCommonAnimatedSwitcher* Commo...
)

Establishes the activatable widget switcher instance that this tab list should interact with

Public function Virtual UFunction BlueprintCallable, Category

void

 

SetListeningForInput

(
    bool bShouldListen
)

Public function UFunction BlueprintCallable, Category

void

 

SetTabEnabled

(
    FName TabNameID,
    bool bEnable
)

Sets whether the tab associated with the given ID is enabled/disabled

Public function UFunction BlueprintCallable, Category

void

 

SetTabInteractionEnabled

(
    FName TabNameID,
    bool bEnable
)

Sets whether the tab associated with the given ID is interactable

Public function UFunction BlueprintCallable, Category

void

 

SetTabVisibility

(
    FName TabNameID,
    ESlateVisibility NewVisibility
)

Sets the visibility of the tab associated with the given ID

Protected function Virtual

void

 

UpdateBindings()

Overridden from UUserWidget

Classes

Name

Description

Public class

FOnTabButtonCreation

Delegate broadcast when a new tab is created. Allows hook ups after creation.

Public class

FOnTabButtonRemoval

Delegate broadcast when a tab is being removed. Allows clean ups after destruction.

Public class

FOnTabSelected

Delegate broadcast when a new tab is selected.