Navigation
API > API/Runtime > API/Runtime/SlateCore
Metadata to override the navigation behavior or regular SWidget
| Name | FNavigationMetaData |
| Type | class |
| Header File | /Engine/Source/Runtime/SlateCore/Public/Types/NavigationMetaData.h |
| Include Path | #include "Types/NavigationMetaData.h" |
Syntax
class FNavigationMetaData : public ISlateMetaData
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FNavigationMetaData() |
Types/NavigationMetaData.h |
Structs
| Name | Remarks |
|---|---|
| SNavData |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| NavigationMethodStruct | TInstancedStruct< FNavigationMethod > | Types/NavigationMetaData.h | ||
| NavigationRoutingPolicy | EWidgetNavigationRoutingPolicy | Types/NavigationMetaData.h | ||
| Rules | SNavData | Types/NavigationMetaData.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
EUINavigationRule GetBoundaryRule
(
EUINavigation InNavigation |
Get the boundary rule for the provided navigation type | Types/NavigationMetaData.h | |
const FNavigationDelegate & GetFocusDelegate
(
EUINavigation InNavigation |
Get the focus recipient delegate for the provided navigation type | Types/NavigationMetaData.h | |
const TWeakPtr< SWidget > & GetFocusRecipient
(
EUINavigation InNavigation |
Get the focus recipient for the provided navigation type | Types/NavigationMetaData.h | |
const TInstancedStruct< FNavigationMethod > & GetNavigationMethodStruct() |
Types/NavigationMetaData.h | ||
EWidgetNavigationRoutingPolicy GetNavigationRoutingPolicy() |
Types/NavigationMetaData.h | ||
void SetNavigationCustom
(
EUINavigation InNavigation, |
Set the navigation behavior for the provided navigation type to be a custom delegate | Types/NavigationMetaData.h | |
void SetNavigationEscape
(
EUINavigation InNavigation |
An event should return a FNavigationReply::Escape() to let the system know that a navigation can escape the bounds of this widget. | Types/NavigationMetaData.h | |
void SetNavigationExplicit
(
EUINavigation InNavigation, |
Set the navigation behavior for the provided navigation type to be explicit, using a constant widget | Types/NavigationMetaData.h | |
void SetNavigationMethodStruct
(
const TInstancedStruct< FNavigationMethod >& InNavigationMethodStruct |
Types/NavigationMetaData.h | ||
void SetNavigationRoutingPolicy
(
EWidgetNavigationRoutingPolicy InNavigationRoutingPolicy |
Types/NavigationMetaData.h | ||
void SetNavigationStop
(
EUINavigation InNavigation |
An event should return a FNavigationReply::Explicit() to let the system know to stop at the bounds of this widget. | Types/NavigationMetaData.h | |
void SetNavigationWrap
(
EUINavigation InNavigation |
Set the navigation behavior for the provided navigation type to be wrap | Types/NavigationMetaData.h |
Overridden from ISlateMetaData
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool IsOfTypeImpl
(
const FName& Type |
Checks whether this drag and drop operation can cast safely to the specified type. | Types/NavigationMetaData.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const FName & GetTypeId() |
Types/NavigationMetaData.h |