FNavigationMetaData

Metadata to override the navigation behavior or regular [SWidget](API\Runtime\SlateCore\Widgets\SWidget)

Windows
MacOS
Linux

Inheritance Hierarchy

ISlateMetaData

FNavigationMetaData

References

Module

SlateCore

Header

/Engine/Source/Runtime/SlateCore/Public/Types/NavigationMetaData.h

Include

#include "Types/NavigationMetaData.h"

Syntax

class FNavigationMetaData : public ISlateMetaData

Remarks

Metadata to override the navigation behavior or regular SWidget

Constructors

Name Description

Public function

FNavigationMetaData()

Functions

Name Description

Public function Const

EUINavigatio...

 

GetBoundaryRule

(
    EUINavigation InNavigation
)

Get the boundary rule for the provided navigation type

Public function Const

const FNavig...

 

GetFocusDelegate

(
    EUINavigation InNavigation
)

Get the focus recipient delegate for the provided navigation type

Public function Const

const TWeakP...

 

GetFocusRecipient

(
    EUINavigation InNavigation
)

Get the focus recipient for the provided navigation type

Public function Static

const FName ...

 

GetTypeId()

Public function

void

 

SetNavigationCustom

(
    EUINavigation InNavigation,
    EUINavigationRule InCustomBoundaryR...,
    FNavigationDelegate InFocusDelegate
)

Set the navigation behavior for the provided navigation type to be a custom delegate

Public function

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.

Public function

void

 

SetNavigationExplicit

(
    EUINavigation InNavigation,
    TSharedPtr< SWidget > InFocusRecipi...
)

Set the navigation behavior for the provided navigation type to be explicit, using a constant widget

Public function

void

 

SetNavigationStop

(
    EUINavigation InNavigation
)

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

Public function

void

 

SetNavigationWrap

(
    EUINavigation InNavigation
)

Set the navigation behavior for the provided navigation type to be wrap

Overridden from ISlateMetaData

Name Description

Public function Virtual Const

bool

 

IsOfTypeImpl

(
    const FName& Type
)

Checks whether this drag and drop operation can cast safely to the specified type.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss