NavigationReply.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
 
#include "NavigationReply.generated.h"
 
class SWidget;
enum class EUINavigation : uint8;
 
UENUM(BlueprintType)
enum class EUINavigationRule : uint8
{
    Escape,
    Explicit,
    Wrap,
    Stop,
    Custom,
    CustomBoundary,
    Invalid
};
 
DECLARE_DELEGATE_RetVal_OneParam(TSharedPtr<SWidget>, FNavigationDelegate, EUINavigation);
 
class FNavigationReply
{
public:
 
    const TSharedPtr<SWidget> GetHandler() const { return EventHandler; }
 
    EUINavigationRule GetBoundaryRule() const { return BoundaryRule; }
 
    const TSharedPtr<SWidget>& GetFocusRecipient() const { return FocusRecipient; }
 
    const FNavigationDelegate& GetFocusDelegate() const { return FocusDelegate; }
 
public:
 
    static FNavigationReply Explicit(TSharedPtr<SWidget> InFocusRecipient)
    {
        FNavigationReply NewReply;
        NewReply.BoundaryRule = EUINavigationRule::Explicit;
        NewReply.FocusRecipient = InFocusRecipient;
        return NewReply;
    }
 
    static FNavigationReply Custom(const FNavigationDelegate& InFocusDelegate)
    {
        FNavigationReply NewReply;
        NewReply.BoundaryRule = EUINavigationRule::Custom;
        NewReply.FocusDelegate = InFocusDelegate;
        return NewReply;
    }
 
    static FNavigationReply CustomBoundary(const FNavigationDelegate& InFocusDelegate)
    {
        FNavigationReply NewReply;
        NewReply.BoundaryRule = EUINavigationRule::CustomBoundary;
        NewReply.FocusDelegate = InFocusDelegate;
        return NewReply;
    }
 
    static FNavigationReply Wrap()
    {
        FNavigationReply NewReply;
        NewReply.BoundaryRule = EUINavigationRule::Wrap;
        return NewReply;
    }
 
    static FNavigationReply Stop()
    {
        FNavigationReply NewReply;
        NewReply.BoundaryRule = EUINavigationRule::Stop;
        return NewReply;
    }
 
    static FNavigationReply Escape()
    {
        FNavigationReply NewReply;
        NewReply.BoundaryRule = EUINavigationRule::Escape;
        return NewReply;
    }
 
private:
 
    FNavigationReply& SetHandler(const TSharedRef<SWidget>& InHandler)
    {
        this->EventHandler = InHandler;
        return *this;
    }
 
    FNavigationReply()
        : EventHandler(nullptr)
        , FocusRecipient(nullptr)
        , FocusDelegate()
        , BoundaryRule(EUINavigationRule::Escape)
    { }
 
    FNavigationReply(EUINavigationRule InBoundaryRule, TSharedPtr<SWidget> InFocusRecipient, const FNavigationDelegate& InFocusDelegate)
        : EventHandler(nullptr)
        , FocusRecipient(InFocusRecipient)
        , FocusDelegate(InFocusDelegate)
        , BoundaryRule(InBoundaryRule)
    { }
 
private:
 
    TSharedPtr<SWidget> EventHandler;
    TSharedPtr<SWidget> FocusRecipient;
    FNavigationDelegate FocusDelegate;
    EUINavigationRule BoundaryRule;
 
    friend class FSlateApplication;
    friend class FSlateNavigationEventSimulator;
    friend class SWidget;
};