FNavigationReply Class Reference

#include <NavigationReply.h>

Public Member Functions
const TSharedPtr< SWidget >	GetHandler () const
EUINavigationRule	GetBoundaryRule () const
const TSharedPtr< SWidget > &	GetFocusRecipient () const
const FNavigationDelegate &	GetFocusDelegate () const

Static Public Member Functions
static FNavigationReply	Explicit (TSharedPtr< SWidget > InFocusRecipient)
static FNavigationReply	Custom (const FNavigationDelegate &InFocusDelegate)
static FNavigationReply	CustomBoundary (const FNavigationDelegate &InFocusDelegate)
static FNavigationReply	Wrap ()
static FNavigationReply	Stop ()
static FNavigationReply	Escape ()

Friends
class	FSlateApplication
class	FSlateNavigationEventSimulator
class	SWidget

Detailed Description

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().

Member Function Documentation

Custom()

static FNavigationReply FNavigationReply::Custom ( const FNavigationDelegate &  InFocusDelegate )

inlinestatic

An event should return a FNavigationReply::Custom() to let the system know to call a custom delegate to get the widget to navigate to.

CustomBoundary()

static FNavigationReply FNavigationReply::CustomBoundary ( const FNavigationDelegate &  InFocusDelegate )

inlinestatic

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.

Escape()

static FNavigationReply FNavigationReply::Escape ( )

inlinestatic

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

Explicit()

static FNavigationReply FNavigationReply::Explicit ( TSharedPtr< SWidget >  InFocusRecipient )

inlinestatic

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

GetBoundaryRule()

EUINavigationRule FNavigationReply::GetBoundaryRule ( ) const

inline

Get the navigation boundary rule.

GetFocusDelegate()

const FNavigationDelegate & FNavigationReply::GetFocusDelegate ( ) const

inline

If the event replied with a delegate explicit boundary rule this returns the delegate to get the focus recipient. Delegate will be unbound if a constant widget was provided.

GetFocusRecipient()

const TSharedPtr< SWidget > & FNavigationReply::GetFocusRecipient ( ) const

inline

If the event replied with a constant explicit boundary rule this returns the desired focus recipient. Otherwise returns an invalid pointer.

GetHandler()

const TSharedPtr< SWidget > FNavigationReply::GetHandler ( ) const

inline

The widget that ultimately specified the boundary rule for the navigation

Stop()

static FNavigationReply FNavigationReply::Stop ( )

inlinestatic

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

Wrap()

static FNavigationReply FNavigationReply::Wrap ( )

inlinestatic

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

Friends And Related Symbol Documentation

FSlateApplication

friend class FSlateApplication

friend

FSlateNavigationEventSimulator

friend class FSlateNavigationEventSimulator

friend

SWidget

friend class SWidget

friend

---

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

• Engine/Source/Runtime/SlateCore/Public/Input/NavigationReply.h