Navigation
Unreal Engine C++ API Reference > Runtime > SlateCore > Input
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
| Type | Name | Description | |
|---|---|---|---|
  |
FNavigationReply | Custom
(
const FNavigationDelegate& InFocusDelegate |
An event should return a FNavigationReply::Custom() to let the system know to call a custom delegate to get the widget to navigate to. |
  |
FNavigationReply | CustomBoundary
(
const FNavigationDelegate& InFocusDelegate |
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. |
  |
FNavigationReply | Escape () |
An event should return a FNavigationReply::Escape() to let the system know that a navigation can escape the bounds of this widget. |
  |
FNavigationReply | Explicit
(
TSharedPtr< SWidget > InFocusRecipient |
An event should return a FNavigationReply::Explicit() to let the system know to navigate to an explicit widget at the bounds of this widget. |
  |
EUINavigationRule | Get the navigation boundary rule. | |
  |
const FNavigationDelegate & | If the event replied with a delegate explicit boundary rule this returns the delegate to get the focus recipient. | |
  |
const TSharedPtr< SWidget > & | If the event replied with a constant explicit boundary rule this returns the desired focus recipient. | |
  |
const TSharedPtr< SWidget > | GetHandler () |
The widget that ultimately specified the boundary rule for the navigation |
  |
FNavigationReply | Stop () |
An event should return a FNavigationReply::Stop() to let the system know to stop at the bounds of this widget. |
  |
FNavigationReply | Wrap () |
An event should return a FNavigationReply::Wrap() to let the system know to wrap at the bounds of this widget. |