1. Epic GamesDeveloper
  3. UCommonTabListWidgetBase

UCommonTabListWidgetBase

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

API > API/Plugins > API/Plugins/CommonUI

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;Abstract, Blueprintable, ClassGroup&61;UI, Meta&61;&40;Category&61;"Common UI", DisableNativeTick&41;&41;  
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

  Type Name Description
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly bool bAutoListenForInput Whether to register to handle tab list input immediately upon construction
Protected variable UProperty Category, EditAnywhere bool bDeferRebuildingTabList Whether to defer until next tick rebuilding tab list when inserting new tab (rather than adding to the end).
Protected variable bool bIsListeningForInput Is the tab list currently listening for tab input actions?
Protected variable UProperty Transient TWeakObjectPtr< UCommonAnimatedSwitcher > LinkedSwitcher The activatable widget switcher that this tab list is associated with and manipulates
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly TObjectPtr< UInputAction > NextTabEnhancedInputAction The input action to listen for causing the next tab to be selected
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FDataTableRowHandle NextTabInputActionData The input action to listen for causing the next tab to be selected
Public variable UProperty Category BlueprintAssignable FOnTabButtonCreation OnTabButtonCreation Broadcasts when a new tab is created.
Public variable UProperty Category BlueprintAssignable FOnTabButtonRemoval OnTabButtonRemoval Broadcasts when a new tab is created.
Public variable UProperty Category BlueprintAssignable FOnTabListRebuilt OnTabListRebuilt Broadcasts when the tab list has been rebuilt (after a new tab has been inserted rather than added to the end).
Public variable UProperty Category BlueprintAssignable FOnTabSelected OnTabSelected Broadcasts when a new tab is selected.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly TObjectPtr< UInputAction > PreviousTabEnhancedInputAction The input action to listen for causing the previous tab to be selected
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FDataTableRowHandle PreviousTabInputActionData The input action to listen for causing the previous tab to be selected
Protected variable UProperty Transient TObjectPtr< UCommonButtonGroupBase > TabButtonGroup The button group that manages all the created tab buttons

Constructors

  Type Name Description
Public function  

UCommonTabListWidgetBase ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type 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  
Public function Const UFunction BlueprintCallable, BlueprintPure, Category UCommonAnimatedSwitcher *  
Protected function Const const TMap< FName, FCommonRegisteredTabInfo > &  
Public function Const UFunction BlueprintCallable, Category FName  
Public function Const UFunction BlueprintCallable, Category UCommonButtonBase *

GetTabButtonBaseByID ( FName TabNameID
)

 Returns the tab button matching the ID, if found
Public function Const UFunction BlueprintCallable, Category int32  
Public function Const UFunction BlueprintCallable, Category FName

GetTabIdAtIndex ( int32 Index
)

  
Protected function UFunction void

HandleNextTabInputAction ( bool& bPassthrough
)

  
Protected function Virtual void  
Protected function UFunction Category, Meta, BlueprintImplementableEvent void  
Protected function Virtual void  
Protected function UFunction Category, Meta, BlueprintImplementableEvent void  
Protected function UFunction void

HandlePreviousTabInputAction ( bool& bPassthrough
)

  
Protected function UFunction void

HandleTabButtonSelected ( UCommonButtonBase* SelectedTabButton,
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
)

  
Protected function Const bool  
Public function UFunction BlueprintCallable, Category bool

RegisterTab ( FName TabNameID,
TSubclassOf< UCommonButtonBase > ButtonWidgetType,
UWidget* ContentWidget,
const int32 TabIndex
)

 Registers and adds a new tab to the list that corresponds to a given widget instance.
Public function UFunction BlueprintCallable, Category void  
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 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  

Overridden from UUserWidget

  Type Name Description
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void  

Classes

  Type 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 FOnTabListRebuilt Delegate broadcast when the tab list has been rebuilt (after a new tab has been inserted rather than added to the end).  
Public class FOnTabSelected Delegate broadcast when a new tab is selected.  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page