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

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

   
Name UCommonTabListWidgetBase
Type class
Header File /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonTabListWidgetBase.h
Include Path #include "CommonTabListWidgetBase.h"

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UCommonTabListWidgetBase ( const FObjectInitializer& ObjectInitializer
)

   CommonTabListWidgetBase.h  

Classes

Name Remarks
FOnTabButtonCreation Delegate broadcast when a new tab is created. Allows hook ups after creation.
FOnTabButtonRemoval Delegate broadcast when a tab is being removed. Allows clean ups after destruction.
FOnTabListRebuilt Delegate broadcast when the tab list has been rebuilt (after a new tab has been inserted rather than added to the end).
FOnTabSelected Delegate broadcast when a new tab is selected.

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnTabButtonCreation FOnTabButtonCreation Broadcasts when a new tab is created. CommonTabListWidgetBase.h
  • BlueprintAssignable
  • Category=TabList
OnTabButtonRemoval FOnTabButtonRemoval Broadcasts when a new tab is created. CommonTabListWidgetBase.h
  • BlueprintAssignable
  • Category=TabList
OnTabListRebuilt FOnTabListRebuilt Broadcasts when the tab list has been rebuilt (after a new tab has been inserted rather than added to the end). CommonTabListWidgetBase.h
  • BlueprintAssignable
  • Category=TabList
OnTabSelected FOnTabSelected Broadcasts when a new tab is selected. CommonTabListWidgetBase.h
  • BlueprintAssignable
  • Category=TabList

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveTabID FName The registration ID of the currently active tab CommonTabListWidgetBase.h  
bIsRebuildingList bool   CommonTabListWidgetBase.h  
bPendingRebuild bool   CommonTabListWidgetBase.h  
NextTabActionHandle FUIActionBindingHandle   CommonTabListWidgetBase.h  
PrevTabActionHandle FUIActionBindingHandle   CommonTabListWidgetBase.h  
RegisteredTabsByID TMap< FName, FCommonRegisteredTabInfo > Info about each of the currently registered tabs organized by a given registration name ID CommonTabListWidgetBase.h
  • Transient
TabButtonWidgetPool FUserWidgetPool   CommonTabListWidgetBase.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

void DisableTabWithReason ( FName TabNameID,
const FText& Reason
)

 Disables the tab associated with the given ID with a reason CommonTabListWidgetBase.h
  • BlueprintCallable
  • Category=TabList

FName GetActiveTab()

   CommonTabListWidgetBase.h
  • BlueprintCallable
  • Category=TabList

UCommonAnimatedSwitcher * GetLinkedSwitcher()

   CommonTabListWidgetBase.h
  • BlueprintCallable
  • BlueprintPure
  • Category=TabList

FName GetSelectedTabId()

   CommonTabListWidgetBase.h
  • BlueprintCallable
  • Category=TabList

UCommonButtonBase * GetTabButtonBaseByID ( FName TabNameID
) const

 Returns the tab button matching the ID, if found CommonTabListWidgetBase.h
  • BlueprintCallable
  • Category=TabList

int32 GetTabCount()

   CommonTabListWidgetBase.h
  • BlueprintCallable
  • Category=TabList

FName GetTabIdAtIndex ( int32 Index
) const

   CommonTabListWidgetBase.h
  • BlueprintCallable
  • Category=TabList

bool HasTabContentWidget ( const FName TabNameId
) const

 Checks if a tab has an associated content widget CommonTabListWidgetBase.h
  • BlueprintCallable
  • Category="Tab List"

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. CommonTabListWidgetBase.h
  • BlueprintCallable
  • Category=TabList

bool RegisterTabContentWidget ( const FName TabNameId,
UWidget* ContentWidget
)

 Registers a content widget with a previously created tab with ID TabNameId. CommonTabListWidgetBase.h
  • BlueprintCallable
  • Category="Tab List"

void RemoveAllTabs()

   CommonTabListWidgetBase.h
  • BlueprintCallable
  • Category=TabList

bool RemoveTab ( FName TabNameID
)

   CommonTabListWidgetBase.h
  • BlueprintCallable
  • Category=TabList

bool SelectTabByID ( FName TabNameID,
bool bSuppressClickFeedback
)

 Selects the tab registered under the provided name ID CommonTabListWidgetBase.h
  • BlueprintCallable
  • Category=TabList

virtual void SetLinkedSwitcher ( UCommonAnimatedSwitcher* CommonSwitcher
)

 Establishes the activatable widget switcher instance that this tab list should interact with CommonTabListWidgetBase.h
  • BlueprintCallable
  • Category=TabList

virtual void SetListeningForInput ( bool bShouldListen
)

   CommonTabListWidgetBase.h
  • BlueprintCallable
  • Category=TabList

void SetSelectionRequired ( bool bSelectionRequired
)

 Allows one to temporarily disable the selection-required behavior TabButtonGroup, useful during initialization and destruction of a UCommonTabListWidgetBase CommonTabListWidgetBase.h  

void SetTabEnabled ( FName TabNameID,
bool bEnable
)

 Sets whether the tab associated with the given ID is enabled/disabled CommonTabListWidgetBase.h
  • BlueprintCallable
  • Category=TabList

void SetTabInteractionEnabled ( FName TabNameID,
bool bEnable
)

 Sets whether the tab associated with the given ID is interactable CommonTabListWidgetBase.h
  • BlueprintCallable
  • Category=TabList

void SetTabVisibility ( FName TabNameID,
ESlateVisibility NewVisibility
)

 Sets the visibility of the tab associated with the given ID CommonTabListWidgetBase.h
  • BlueprintCallable
  • Category=TabList

Protected

Name Remarks Include Path Unreal Specifiers

const TMap< FName, FCommonRegisteredTabInfo > & GetRegisteredTabsByID()

   CommonTabListWidgetBase.h  

void HandleNextTabInputAction ( bool& bPassthrough
)

   CommonTabListWidgetBase.h  

virtual void HandlePostLinkedSwitcherChanged()

   CommonTabListWidgetBase.h  

void HandlePostLinkedSwitcherChanged_BP()

   CommonTabListWidgetBase.h
  • BlueprintImplementableEvent
  • Category=TabList
  • Meta=(BlueprintProtected="true")

virtual void HandlePreLinkedSwitcherChanged()

   CommonTabListWidgetBase.h  

void HandlePreLinkedSwitcherChanged_BP()

   CommonTabListWidgetBase.h
  • BlueprintImplementableEvent
  • Category=TabList
  • Meta=(BlueprintProtected="true")

void HandlePreviousTabInputAction ( bool& bPassthrough
)

   CommonTabListWidgetBase.h  

void HandleTabButtonSelected ( UCommonButtonBase* SelectedTabButton,
int32 ButtonIndex
)

   CommonTabListWidgetBase.h  

void HandleTabCreation ( FName TabNameID,
UCommonButtonBase* TabButton
)

   CommonTabListWidgetBase.h
  • BlueprintNativeEvent
  • Category=TabList
  • Meta=(BlueprintProtected="true")

void HandleTabRemoval ( FName TabNameID,
UCommonButtonBase* TabButton
)

   CommonTabListWidgetBase.h
  • BlueprintNativeEvent
  • Category=TabList
  • Meta=(BlueprintProtected="true")

bool IsRebuildingList()

   CommonTabListWidgetBase.h  

virtual void UpdateBindings()

   CommonTabListWidgetBase.h  

Overridden from UUserWidget

Name Remarks Include Path Unreal Specifiers

virtual void NativeConstruct()

   CommonTabListWidgetBase.h  

virtual void NativeDestruct()

   CommonTabListWidgetBase.h  

virtual void NativeOnInitialized()

   CommonTabListWidgetBase.h  

Overridden from UVisual

Name Remarks Include Path Unreal Specifiers

virtual void ReleaseSlateResources ( bool bReleaseChildren
)

   CommonTabListWidgetBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page