FNavigationReply

A [FNavigationReply](API\Runtime\SlateCore\Input\FNavigationReply) is something that a Slate navigation event returns to the system to notify it about the boundary rules for navigation.

Windows
MacOS
Linux

References

Module

SlateCore

Header

/Engine/Source/Runtime/SlateCore/Public/Input/NavigationReply.h

Include

#include "Input/NavigationReply.h"

Syntax

class FNavigationReply

Remarks

A FNavigationReply is something that a Slate navigation event returns to the system to notify it about the boundary rules for navigation. For example, a widget may handle an OnNavigate event by asking the system to wrap if it's boundary is hit. To do this, return FNavigationReply::Wrap() .

Constructors

No constructors are accessible with public or protected access.

Functions

Name Description

Public function Static

FNavigationR ...

 

Custom

(
    const FNavigationDelegate & InFocus...
)

An event should return a FNavigationReply::Custom() to let the system know to call a custom delegate to get the widget to navigate to.

Public function Static

FNavigationR ...

 

CustomBoundary

(
    const FNavigationDelegate & InFocus...
)

An event should return a FNavigationReply::CustomBoundary() to let the system know to call a custom delegate to get the widget to navigate to is the widgets boundary is hit.

Public function Static

FNavigationR ...

 

Escape()

An event should return a FNavigationReply::Escape() to let the system know that a navigation can escape the bounds of this widget.

Public function Static

FNavigationR ...

 

Explicit

(
    TSharedPtr < SWidget > InFocusRecipi...
)

An event should return a FNavigationReply::Explicit() to let the system know to navigate to an explicit widget at the bounds of this widget.

Public function Const

EUINavigatio ...

 

GetBoundaryRule()

Get the navigation boundary rule.

Public function Const

const FNavig ...

 

GetFocusDelegate()

If the event replied with a delegate explicit boundary rule this returns the delegate to get the focus recipient.

Public function Const

const TShare ...

 

GetFocusRecipient()

If the event replied with a constant explicit boundary rule this returns the desired focus recipient.

Public function Const

const TShare ...

 

GetHandler()

The widget that ultimately specified the boundary rule for the navigation

Public function Static

FNavigationR ...

 

Stop()

An event should return a FNavigationReply::Stop() to let the system know to stop at the bounds of this widget.

Public function Static

FNavigationR ...

 

Wrap()

An event should return a FNavigationReply::Wrap() to let the system know to wrap at the bounds of this widget.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback