FNavigationMetaData Class Reference

#include <NavigationMetaData.h>

Inheritance diagram for FNavigationMetaData:

Public Member Functions
	FNavigationMetaData ()
EUINavigationRule	GetBoundaryRule (EUINavigation InNavigation) const
const TWeakPtr< SWidget > &	GetFocusRecipient (EUINavigation InNavigation) const
const FNavigationDelegate &	GetFocusDelegate (EUINavigation InNavigation) const
void	SetNavigationExplicit (EUINavigation InNavigation, TSharedPtr< SWidget > InFocusRecipient)
void	SetNavigationCustom (EUINavigation InNavigation, EUINavigationRule InCustomBoundaryRule, FNavigationDelegate InFocusDelegate)
void	SetNavigationWrap (EUINavigation InNavigation)
void	SetNavigationStop (EUINavigation InNavigation)
void	SetNavigationEscape (EUINavigation InNavigation)
void	SetNavigationMethodStruct (const TInstancedStruct< FNavigationMethod > &InNavigationMethodStruct)
const TInstancedStruct< FNavigationMethod > &	GetNavigationMethodStruct () const
void	SetNavigationRoutingPolicy (EWidgetNavigationRoutingPolicy InNavigationRoutingPolicy)
EWidgetNavigationRoutingPolicy	GetNavigationRoutingPolicy () const
Public Member Functions inherited from ISlateMetaData
template<class TType >
bool	IsOfType () const
virtual	~ISlateMetaData ()

Additional Inherited Members
Protected Member Functions inherited from ISlateMetaData
virtual bool	IsOfTypeImpl (const FName &Type) const

Detailed Description

Metadata to override the navigation behavior or regular SWidget

Constructor & Destructor Documentation

FNavigationMetaData()

FNavigationMetaData::FNavigationMetaData ( )

inline

Member Function Documentation

GetBoundaryRule()

EUINavigationRule FNavigationMetaData::GetBoundaryRule ( EUINavigation  InNavigation ) const

inline

Get the boundary rule for the provided navigation type

Parameters

InNavigation

the type of navigation to get the boundary rule for

Returns

the boundary rule for the provided navigation type

GetFocusDelegate()

const FNavigationDelegate & FNavigationMetaData::GetFocusDelegate ( EUINavigation  InNavigation ) const

inline

Get the focus recipient delegate for the provided navigation type

Parameters

InNavigation

the type of navigation to get the focus recipient delegate for

Returns

the focus recipient delegate for the provided navigation type

GetFocusRecipient()

const TWeakPtr< SWidget > & FNavigationMetaData::GetFocusRecipient ( EUINavigation  InNavigation ) const

inline

Get the focus recipient for the provided navigation type

Parameters

InNavigation

the type of navigation to get the focus recipient for

Returns

the focus recipient for the provided navigation type

GetNavigationMethodStruct()

const TInstancedStruct< FNavigationMethod > & FNavigationMetaData::GetNavigationMethodStruct ( ) const

inline

GetNavigationRoutingPolicy()

EWidgetNavigationRoutingPolicy FNavigationMetaData::GetNavigationRoutingPolicy ( ) const

inline

SetNavigationCustom()

void FNavigationMetaData::SetNavigationCustom ( EUINavigation  InNavigation, EUINavigationRule  InCustomBoundaryRule, FNavigationDelegate  InFocusDelegate  )

inline

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

Parameters

InNavigation	the type of navigation to set custom
InCustomBoundaryRule
InFocusRecipient	the delegate used when the system requests the destination for the custom navigation

SetNavigationEscape()

void FNavigationMetaData::SetNavigationEscape ( EUINavigation  InNavigation )

inline

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

SetNavigationExplicit()

void FNavigationMetaData::SetNavigationExplicit ( EUINavigation  InNavigation, TSharedPtr< SWidget >  InFocusRecipient  )

inline

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

Parameters

InNavigation	the type of navigation to set explicit
InFocusRecipient	the widget used when the system requests the destination for the explicit navigation

SetNavigationMethodStruct()

void FNavigationMetaData::SetNavigationMethodStruct ( const TInstancedStruct< FNavigationMethod > &  InNavigationMethodStruct )

inline

SetNavigationRoutingPolicy()

void FNavigationMetaData::SetNavigationRoutingPolicy ( EWidgetNavigationRoutingPolicy  InNavigationRoutingPolicy )

inline

SetNavigationStop()

void FNavigationMetaData::SetNavigationStop ( EUINavigation  InNavigation )

inline

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

SetNavigationWrap()

void FNavigationMetaData::SetNavigationWrap ( EUINavigation  InNavigation )

inline

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

Parameters

InNavigation

the type of navigation to set wrapping

---

The documentation for this class was generated from the following file:

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