Navigation
API > API/Runtime > API/Runtime/SlateCore
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().
| Name | FNavigationReply |
| Type | class |
| Header File | /Engine/Source/Runtime/SlateCore/Public/Input/NavigationReply.h |
| Include Path | #include "Input/NavigationReply.h" |
Syntax
class FNavigationReply
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Hidden default constructor. | Input/NavigationReply.h | ||
FNavigationReply
(
EUINavigationRule InBoundaryRule, |
Verbose Constructor. | Input/NavigationReply.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BoundaryRule | EUINavigationRule | Input/NavigationReply.h | ||
| EventHandler | TSharedPtr< SWidget > | Input/NavigationReply.h | ||
| FocusDelegate | FNavigationDelegate | Input/NavigationReply.h | ||
| FocusRecipient | TSharedPtr< SWidget > | Input/NavigationReply.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
EUINavigationRule GetBoundaryRule() |
Get the navigation boundary rule. | Input/NavigationReply.h | |
const FNavigationDelegate & GetFocusDelegate () |
If the event replied with a delegate explicit boundary rule this returns the delegate to get the focus recipient. | Input/NavigationReply.h | |
const TSharedPtr< SWidget > & GetFocusRecipient () |
If the event replied with a constant explicit boundary rule this returns the desired focus recipient. | Input/NavigationReply.h | |
const TSharedPtr< SWidget > GetHandler() |
The widget that ultimately specified the boundary rule for the navigation | Input/NavigationReply.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static 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. | Input/NavigationReply.h | |
static 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. | Input/NavigationReply.h | |
static FNavigationReply Escape() |
An event should return a FNavigationReply::Escape() to let the system know that a navigation can escape the bounds of this widget. | Input/NavigationReply.h | |
static 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. | Input/NavigationReply.h | |
static FNavigationReply Stop() |
An event should return a FNavigationReply::Stop() to let the system know to stop at the bounds of this widget. | Input/NavigationReply.h | |
static FNavigationReply Wrap() |
An event should return a FNavigationReply::Wrap() to let the system know to wrap at the bounds of this widget. | Input/NavigationReply.h |