WidgetNavigation.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "StructUtils/InstancedStruct.h"
#include "Types/NavigationMetaData.h"
#include "Input/NavigationMethod.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "UObject/WeakObjectPtr.h"
 
#include "WidgetNavigation.generated.h"
 
class UWidget;
 
DECLARE_DYNAMIC_DELEGATE_RetVal_OneParam(UWidget*, FCustomWidgetNavigationDelegate, EUINavigation, Navigation);
 
USTRUCT(BlueprintType)
struct FWidgetNavigationData
{
    GENERATED_USTRUCT_BODY()
 
public:
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Navigation")
    EUINavigationRule Rule = EUINavigationRule::Escape;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Navigation")
    FName WidgetToFocus;
 
    UPROPERTY()
    TWeakObjectPtr<UWidget> Widget;
 
    UPROPERTY()
    FCustomWidgetNavigationDelegate CustomDelegate;
 
    UMG_API void Resolve(class UUserWidget* Outer, class UWidgetTree* WidgetTree);
 
#if WITH_EDITOR
    UMG_API void TryToRenameBinding(FName OldName, FName NewName);
#endif
};
 
UCLASS(MinimalAPI)
class UWidgetNavigation : public UObject
{
    GENERATED_UCLASS_BODY()
    
public:
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Navigation")
    FWidgetNavigationData Up;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Navigation")
    FWidgetNavigationData Down;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Navigation")
    FWidgetNavigationData Left;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Navigation")
    FWidgetNavigationData Right;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Navigation")
    FWidgetNavigationData Next;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Navigation")
    FWidgetNavigationData Previous;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Navigation")
    EWidgetNavigationRoutingPolicy RoutingPolicy = EWidgetNavigationRoutingPolicy::AcceptFocus;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Navigation", meta=(ExcludeBaseStruct))
    TInstancedStruct<FNavigationMethod> NavigationMethod;
 
public:
 
#if WITH_EDITOR
 
    UMG_API FWidgetNavigationData& GetNavigationData(EUINavigation Nav);
 
    UMG_API EUINavigationRule GetNavigationRule(EUINavigation Nav);
 
    UMG_API virtual void TryToRenameBinding(FName OldName, FName NewName);
 
#endif
 
    UMG_API virtual void ResolveRules(class UUserWidget* Outer, class UWidgetTree* WidgetTree);
 
    UMG_API void UpdateMetaData(TSharedRef<FNavigationMetaData> MetaData);
 
    UMG_API bool IsDefaultNavigation() const;
 
private:
 
    void UpdateMetaDataEntry(TSharedRef<FNavigationMetaData> MetaData, const FWidgetNavigationData & NavData, EUINavigation Nav);
};