139 lines
4.2 KiB
C++
139 lines
4.2 KiB
C++
// Copyright Epic Games, Inc. All Rights Reserved.
|
|
|
|
#pragma once
|
|
|
|
#include "CommonTabListWidgetBase.h"
|
|
#include "Containers/Array.h"
|
|
#include "Containers/Map.h"
|
|
#include "Delegates/Delegate.h"
|
|
#include "HAL/Platform.h"
|
|
#include "Internationalization/Text.h"
|
|
#include "Styling/SlateBrush.h"
|
|
#include "Templates/SubclassOf.h"
|
|
#include "UObject/Interface.h"
|
|
#include "UObject/NameTypes.h"
|
|
#include "UObject/UObjectGlobals.h"
|
|
|
|
#include "LyraTabListWidgetBase.generated.h"
|
|
|
|
class UCommonButtonBase;
|
|
class UCommonUserWidget;
|
|
class UObject;
|
|
class UWidget;
|
|
struct FFrame;
|
|
|
|
USTRUCT(BlueprintType)
|
|
struct FLyraTabDescriptor
|
|
{
|
|
GENERATED_BODY()
|
|
|
|
public:
|
|
FLyraTabDescriptor()
|
|
: bHidden(false)
|
|
, CreatedTabContentWidget(nullptr)
|
|
{ }
|
|
|
|
UPROPERTY(EditAnywhere, BlueprintReadOnly)
|
|
FName TabId;
|
|
|
|
UPROPERTY(EditAnywhere, BlueprintReadWrite)
|
|
FText TabText;
|
|
|
|
UPROPERTY(EditAnywhere, BlueprintReadWrite)
|
|
FSlateBrush IconBrush;
|
|
|
|
UPROPERTY(EditAnywhere, BlueprintReadOnly)
|
|
bool bHidden;
|
|
|
|
UPROPERTY(EditAnywhere, BlueprintReadOnly)
|
|
TSubclassOf<UCommonButtonBase> TabButtonType;
|
|
|
|
//TODO NDarnell - This should become a TSoftClassPtr<>, the underlying common tab list needs to be able to handle lazy tab content construction.
|
|
UPROPERTY(EditAnywhere, BlueprintReadOnly)
|
|
TSubclassOf<UCommonUserWidget> TabContentType;
|
|
|
|
UPROPERTY(Transient)
|
|
TObjectPtr<UWidget> CreatedTabContentWidget;
|
|
};
|
|
|
|
UINTERFACE(BlueprintType)
|
|
class ULyraTabButtonInterface : public UInterface
|
|
{
|
|
GENERATED_BODY()
|
|
};
|
|
|
|
class ILyraTabButtonInterface
|
|
{
|
|
GENERATED_BODY()
|
|
|
|
public:
|
|
UFUNCTION(BlueprintNativeEvent, Category = "Tab Button")
|
|
void SetTabLabelInfo(const FLyraTabDescriptor& TabDescriptor);
|
|
};
|
|
|
|
UCLASS(Blueprintable, BlueprintType, Abstract, meta = (DisableNativeTick))
|
|
class LYRAGAME_API ULyraTabListWidgetBase : public UCommonTabListWidgetBase
|
|
{
|
|
GENERATED_BODY()
|
|
|
|
public:
|
|
UFUNCTION(BlueprintCallable, BlueprintPure, Category = "Tab List")
|
|
bool GetPreregisteredTabInfo(const FName TabNameId, FLyraTabDescriptor& OutTabInfo);
|
|
|
|
/** Helper method to get at all the preregistered tab infos */
|
|
const TArray<FLyraTabDescriptor>& GetAllPreregisteredTabInfos() { return PreregisteredTabInfoArray; }
|
|
|
|
// Toggles whether or not a specified tab is hidden, can only be called before the switcher is associated
|
|
UFUNCTION(BlueprintCallable, Category = "Tab List")
|
|
void SetTabHiddenState(FName TabNameId, bool bHidden);
|
|
|
|
UFUNCTION(BlueprintCallable, Category = "Tab List")
|
|
bool RegisterDynamicTab(const FLyraTabDescriptor& TabDescriptor);
|
|
|
|
UFUNCTION(BlueprintCallable, Category = "Tab List")
|
|
bool IsFirstTabActive() const;
|
|
|
|
UFUNCTION(BlueprintCallable, Category = "Tab List")
|
|
bool IsLastTabActive() const;
|
|
|
|
UFUNCTION(BlueprintCallable, BlueprintPure, Category = "Tab List")
|
|
bool IsTabVisible(FName TabId);
|
|
|
|
UFUNCTION(BlueprintCallable, BlueprintPure, Category = "Tab List")
|
|
int32 GetVisibleTabCount();
|
|
|
|
/** Delegate broadcast when a new tab is created. Allows hook ups after creation. */
|
|
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnTabContentCreated, FName, TabId, UCommonUserWidget*, TabWidget);
|
|
DECLARE_EVENT_TwoParams(ULyraTabListWidgetBase, FOnTabContentCreatedNative, FName /* TabId */, UCommonUserWidget* /* TabWidget */);
|
|
|
|
/** Broadcasts when a new tab is created. */
|
|
UPROPERTY(BlueprintAssignable, Category = "Tab List")
|
|
FOnTabContentCreated OnTabContentCreated;
|
|
FOnTabContentCreatedNative OnTabContentCreatedNative;
|
|
|
|
protected:
|
|
// UUserWidget interface
|
|
virtual void NativeOnInitialized() override;
|
|
virtual void NativeConstruct() override;
|
|
virtual void NativeDestruct() override;
|
|
// End UUserWidget
|
|
|
|
virtual void HandlePreLinkedSwitcherChanged() override;
|
|
virtual void HandlePostLinkedSwitcherChanged() override;
|
|
|
|
virtual void HandleTabCreation_Implementation(FName TabId, UCommonButtonBase* TabButton) override;
|
|
|
|
private:
|
|
void SetupTabs();
|
|
|
|
UPROPERTY(EditAnywhere, meta=(TitleProperty="TabId"))
|
|
TArray<FLyraTabDescriptor> PreregisteredTabInfoArray;
|
|
|
|
/**
|
|
* Stores label info for tabs that have been registered at runtime but not yet created.
|
|
* Elements are removed once they are created.
|
|
*/
|
|
UPROPERTY()
|
|
TMap<FName, FLyraTabDescriptor> PendingTabLabelInfoMap;
|
|
};
|