1. Epic GamesDeveloper
  3. FReply

FReply

A Reply is something that a Slate event returns to the system to notify it about certain aspect of how an event was handled.

API > API/Runtime > API/Runtime/SlateCore > API/Runtime/SlateCore/Input

Inheritance Hierarchy

References

   
Module SlateCore
Header /Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
Include #include "Input/Reply.h"

Syntax

class FReply : public TReplyBase< FReply >

Remarks

A Reply is something that a Slate event returns to the system to notify it about certain aspect of how an event was handled. For example, a widget may handle an OnMouseDown event by asking the system to give mouse capture to a specific Widget. To do this, return FReply::CaptureMouse( NewMouseCapture ).

Constructors

No constructors are accessible with public or protected access.

Functions

  Type Name Description
Public function Const bool If the event replied with a request to change the user focus whether it should do it for all users or just the current UserIndex
Public function FReply &

BeginDragDrop ( TSharedRef< FDragDropOperation > InDragDropContent
)

 An event should return FReply::Handled().BeginDragDrop( Content ) to initiate a drag and drop operation.
Public function FReply & An event should rarely invoke FReply::CancelFocusRequest.
Public function FReply &

CaptureMouse ( TSharedRef< SWidget > InMouseCaptor
)

 An event should return a FReply::Handled().CaptureMouse( SomeWidget ) as a means of asking the system to forward all mouse events to SomeWidget
Public function FReply &

ClearUserFocus ( EFocusCause ReasonFocusIsChanging,
bool bInAllUsers
)

 An event should return a FReply::Handled().ClearUserFocus() to ask the system to clear user focus
Public function FReply &

ClearUserFocus ( bool bInAllUsers
)

 An event should return a FReply::Handled().ClearUserFocus() to ask the system to clear user focus
Public function FReply &

DetectDrag ( const TSharedRef< SWidget >& DetectDragInMe,
FKey MouseButton
)

 Ask Slate to detect if a user started dragging in this widget.
Public function FReply & An event should return FReply::Handled().EndDragDrop() to request that the current drag/drop operation be terminated.
Public function Const TSharedPtr< SWidget >  
Public function Const FKey  
Public function Const const TSharedPtr< FDragDropOperation > &  
Public function Const EFocusCause Get the reason that a focus change is being requested.
Public function Const TSharedPtr< SWidget > If the event replied with a request to capture the mouse, this returns the desired mouse captor.
Public function Const TSharedPtr< SWidget > Returns the widget that the mouse should be locked to (if any)
Public function Const TSharedPtr< SWidget > Get the widget that is the navigation destination.
Public function Const ENavigationGenesis Get the genesis of the navigation.
Public function Const ENavigationSource Get the source of the navigation.
Public function Const EUINavigation Get the navigation type (Invalid if no navigation is requested).
Public function Const const TOptional< FIntPoint > &  
Public function Const TSharedPtr< SWidget > When not nullptr, user focus has been requested to be set on the FocusRecipient.
Public function Static FReply

Handled ()

 An event should return a FReply::Handled() to let the system know that an event was handled.
Public function FReply & An event should return FReply::Handled().LockMouseToWidget( SomeWidget ) as a means of asking the system to Lock the mouse so it cannot move out of the bounds of the widget.
Public function FReply & Ensures throttling for SlateUI responsiveness is not done on mouse down
Public function FReply & An event should return a FReply::Handled().ReleaseMouse() to ask the system to release mouse capture NOTE: Deactivates high precision mouse movement if activated.
Public function FReply & An event should return a FReply::Handled().ReleaseMouseLock() to ask the system to release mouse lock on a widget
Public function FReply &

SetMousePos ( const FIntPoint& NewMousePos
)

 An event should return FReply::Handled().SetMousePos to ask Slate to move the mouse cursor to a different location
Public function FReply &

SetNavigation ( EUINavigation InNavigationType,
const ENavigationGenesis InNavigationGenesis,
const ENavigationSource InNavigationSource
)

 An event should return FReply::Handled().SetNavigation( NavigationType ) as a means of asking the system to attempt a navigation
Public function FReply &

SetNavigation ( TSharedRef< SWidget > InNavigationDestination,
const ENavigationGenesis InNavigationGenesis,
const ENavigationSource InNavigationSource
)

 An event should return FReply::Handled().SetNavigation( NavigationDestination ) as a means of asking the system to attempt a navigation to the specified destination
Public function FReply &

SetUserFocus ( TSharedRef< SWidget > GiveMeFocus,
EFocusCause ReasonFocusIsChanging,
bool bInAllUsers
)

 An event should return FReply::Handled().SetUserFocus( SomeWidget ) as a means of asking the system to set users focus to the provided widget
Public function Const bool  
Public function Const bool True if this reply indicated that we should release mouse capture as a result of the event being handled
Public function Const bool True if the reply indicated that we should release mouse lock
Public function Const bool True if this reply indicated that we should release focus as a result of the event being handled
Public function Const bool True if this reply indicated that we should set focus as a result of the event being handled
Public function Const bool Whether or not we should throttle on mouse down
Public function Const bool True if this reply indicated that we should use high precision mouse movement
Public function FString Converts the reply into an string representation.
Public function Static FReply An event should return a FReply::Unhandled() to let the system know that an event was unhandled.
Public function FReply & Enables the use of high precision (raw input) mouse movement, for more accurate mouse movement without mouse ballistics NOTE: This implies mouse capture and hidden mouse movement.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page