Reply.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "InputCoreTypes.h"
#include "Types/SlateEnums.h"
#include "Input/ReplyBase.h"
#include "Input/Events.h"
#include "Input/DragAndDrop.h"
 
class SWidget;
 
// @todo Slate: this is highly sketchy, as FDragDropOperation is declared in Slate,
// but cannot currently be brought into SlateCore due to dependencies to SWindow.
class FDragDropOperation;
 
class FReply : public TReplyBase<FReply>
{
public:
        
    FReply& CaptureMouse( TSharedRef<SWidget> InMouseCaptor )
    {
        this->MouseCaptor = InMouseCaptor;
        return Me();
    }
 
    FReply& UseHighPrecisionMouseMovement( TSharedRef<SWidget> InMouseCaptor )
    {
        this->MouseCaptor = InMouseCaptor;
        this->bUseHighPrecisionMouse = true;
        return Me();
    }
 
    SLATECORE_API FReply& SetMousePos( const FIntPoint& NewMousePos );
 
    SLATECORE_API FReply& SetUserFocus(TSharedRef<SWidget> GiveMeFocus, EFocusCause ReasonFocusIsChanging = EFocusCause::SetDirectly, bool bInAllUsers = false);
 
    FReply& ClearUserFocus(bool bInAllUsers = false)
    {
        return ClearUserFocus(EFocusCause::SetDirectly, bInAllUsers);
    }
 
    SLATECORE_API FReply& ClearUserFocus(EFocusCause ReasonFocusIsChanging, bool bInAllUsers = false);
 
    SLATECORE_API FReply& CancelFocusRequest();
 
    FReply& SetNavigation(EUINavigation InNavigationType, const ENavigationGenesis InNavigationGenesis, const ENavigationSource InNavigationSource = ENavigationSource::FocusedWidget)
    {
        this->NavigationType = InNavigationType;
        this->NavigationGenesis = InNavigationGenesis;
        this->NavigationSource = InNavigationSource;
        this->NavigationDestination = nullptr;
        return Me();
    }
 
    FReply& SetNavigation(TSharedRef<SWidget> InNavigationDestination, const ENavigationGenesis InNavigationGenesis, const ENavigationSource InNavigationSource = ENavigationSource::FocusedWidget)
    {
        this->NavigationType = EUINavigation::Invalid;
        this->NavigationGenesis = InNavigationGenesis;
        this->NavigationSource = InNavigationSource;
        this->NavigationDestination = InNavigationDestination;
        return Me();
    }
 
    FReply& LockMouseToWidget( TSharedRef<SWidget> InWidget )
    {
        this->MouseLockWidget = InWidget;
        this->bShouldReleaseMouseLock = false;
        return Me();
    }
 
    FReply& ReleaseMouseLock()
    {
        this->bShouldReleaseMouseLock = true;
        MouseLockWidget.Reset();
        return Me();
    }
 
    FReply& ReleaseMouseCapture()
    {
        this->MouseCaptor.Reset();
        this->bReleaseMouseCapture = true;
        this->bUseHighPrecisionMouse = false;
        return Me();
    }
 
    FReply& DetectDrag( const TSharedRef<SWidget>& DetectDragInMe, FKey MouseButton )
    {
        this->DetectDragForWidget = DetectDragInMe;
        this->DetectDragForMouseButton = MouseButton;
        return Me();
    }
 
    FReply& BeginDragDrop(TSharedRef<FDragDropOperation> InDragDropContent)
    {
        this->DragDropContent = InDragDropContent;
        return Me();
    }
 
    FReply& EndDragDrop()
    {
        this->bEndDragDrop = true;
        return Me();
    }
 
    FReply& PreventThrottling()
    {
        this->bPreventThrottling = true;
        return Me();
    }
 
public:
 
    bool ShouldReleaseMouse() const { return bReleaseMouseCapture; }
 
    bool ShouldSetUserFocus() const { return bSetUserFocus; }
 
    bool ShouldReleaseUserFocus() const { return bReleaseUserFocus; }
 
    bool AffectsAllUsers() const { return bAllUsers; }
 
    bool ShouldUseHighPrecisionMouse() const { return bUseHighPrecisionMouse; }
 
    bool ShouldReleaseMouseLock() const { return bShouldReleaseMouseLock; }
 
    bool ShouldThrottle() const { return !bPreventThrottling; }
 
    TSharedPtr<SWidget> GetMouseLockWidget() const { return MouseLockWidget.Pin(); }
 
    TSharedPtr<SWidget> GetUserFocusRecepient() const { return FocusRecipient.Pin(); }
 
    EFocusCause GetFocusCause() const { return FocusChangeReason; }
 
    TSharedPtr<SWidget> GetMouseCaptor() const { return MouseCaptor.Pin(); }
 
    EUINavigation GetNavigationType() const { return NavigationType; }
 
    ENavigationGenesis GetNavigationGenesis() const { return NavigationGenesis; }
 
    ENavigationSource GetNavigationSource() const { return NavigationSource; }
 
    TSharedPtr<SWidget> GetNavigationDestination() const { return NavigationDestination.Pin(); }
 
    const TSharedPtr<FDragDropOperation>& GetDragDropContent() const { return DragDropContent; }
 
    bool ShouldEndDragDrop() const { return bEndDragDrop; }
 
    TSharedPtr<SWidget> GetDetectDragRequest() const { return DetectDragForWidget.Pin(); }
 
    FKey GetDetectDragRequestButton() const { return DetectDragForMouseButton; }
 
    const TOptional<FIntPoint>& GetRequestedMousePos() const { return RequestedMousePos; }
 
    SLATECORE_API FString ToString();
        
public:
 
    [[nodiscard]] static FReply Handled( )
    {
        return FReply(true);
    }
 
    [[nodiscard]] static FReply Unhandled( )
    {
        return FReply(false);
    }
 
public:
    SLATECORE_API FReply(const FReply&);
 
    SLATECORE_API FReply& operator=(const FReply&);
 
private:
 
    SLATECORE_API FReply( bool bIsHandled );
 
private:
    friend class FSlateApplication;
 
private:
 
    TOptional<FIntPoint> RequestedMousePos;
    TWeakPtr<SWidget> EventHandler;
    TWeakPtr<SWidget> MouseCaptor;
    TWeakPtr<SWidget> FocusRecipient;
    TWeakPtr<SWidget> MouseLockWidget;
    TWeakPtr<SWidget> DetectDragForWidget;
    TWeakPtr<SWidget> NavigationDestination;
    FKey DetectDragForMouseButton;
    TSharedPtr<FDragDropOperation> DragDropContent;
    EFocusCause FocusChangeReason;
    EUINavigation NavigationType;
    ENavigationGenesis NavigationGenesis;
    ENavigationSource NavigationSource;
    uint32 bReleaseMouseCapture : 1;
    uint32 bSetUserFocus : 1;
    uint32 bReleaseUserFocus : 1;
    uint32 bAllUsers : 1;
    uint32 bShouldReleaseMouseLock : 1;
    uint32 bUseHighPrecisionMouse : 1;
    uint32 bPreventThrottling : 1;
    uint32 bEndDragDrop : 1;
};