UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
FNavigationEvent Struct Reference

#include <Events.h>

+ Inheritance diagram for FNavigationEvent:

Public Member Functions

 FNavigationEvent ()
 
 FNavigationEvent (const FModifierKeysState &InModifierKeys, const int32 InUserIndex, EUINavigation InNavigationType, ENavigationGenesis InNavigationGenesis)
 
 FNavigationEvent (const FModifierKeysState &InModifierKeys, const FInputDeviceId InDeviceId, EUINavigation InNavigationType, ENavigationGenesis InNavigationGenesis)
 
EUINavigation GetNavigationType () const
 
ENavigationGenesis GetNavigationGenesis () const
 
- Public Member Functions inherited from FInputEvent
 FInputEvent ()
 
 FInputEvent (const FModifierKeysState &InModifierKeys, const int32 InUserIndex, const bool bInIsRepeat)
 
 FInputEvent (const FModifierKeysState &InModifierKeys, const FInputDeviceId InDeviceId, const bool bInIsRepeat)
 
virtual SLATECORE_API ~FInputEvent ()
 
bool IsRepeat () const
 
bool IsShiftDown () const
 
bool IsLeftShiftDown () const
 
bool IsRightShiftDown () const
 
bool IsControlDown () const
 
bool IsLeftControlDown () const
 
bool IsRightControlDown () const
 
bool IsAltDown () const
 
bool IsLeftAltDown () const
 
bool IsRightAltDown () const
 
bool IsCommandDown () const
 
bool IsLeftCommandDown () const
 
bool IsRightCommandDown () const
 
bool AreCapsLocked () const
 
const FModifierKeysState & GetModifierKeys () const
 
uint32 GetUserIndex () const
 
FInputDeviceId GetInputDeviceId () const
 
FPlatformUserId GetPlatformUserId () const
 
uint64 GetEventTimestamp () const
 
double GetMillisecondsSinceEvent () const
 
SLATECORE_API FGeometry FindGeometry (const TSharedRef< SWidget > &WidgetToFind) const
 
SLATECORE_API TSharedRef< SWindow > GetWindow () const
 
void SetEventPath (const FWidgetPath &InEventPath)
 
const FWidgetPath * GetEventPath () const
 
virtual SLATECORE_API FText ToText () const
 
virtual SLATECORE_API bool IsPointerEvent () const
 
virtual SLATECORE_API bool IsKeyEvent () const
 

Additional Inherited Members

- Protected Attributes inherited from FInputEvent
FModifierKeysState ModifierKeys
 
bool bIsRepeat
 
uint32 UserIndex
 
FInputDeviceId InputDeviceId
 
const FWidgetPath * EventPath
 
uint64 EventTimestamp
 

Detailed Description

FNavigationEvent describes a navigation action (Left, Right, Up, Down) It is passed to event handlers dealing with navigation.

Constructor & Destructor Documentation

◆ FNavigationEvent() [1/3]

FNavigationEvent::FNavigationEvent ( )
inline

UStruct Constructor. Not meant for normal usage.

◆ FNavigationEvent() [2/3]

FNavigationEvent::FNavigationEvent ( const FModifierKeysState &  InModifierKeys,
const int32  InUserIndex,
EUINavigation  InNavigationType,
ENavigationGenesis  InNavigationGenesis 
)
inline

◆ FNavigationEvent() [3/3]

FNavigationEvent::FNavigationEvent ( const FModifierKeysState &  InModifierKeys,
const FInputDeviceId  InDeviceId,
EUINavigation  InNavigationType,
ENavigationGenesis  InNavigationGenesis 
)
inline

Member Function Documentation

◆ GetNavigationGenesis()

ENavigationGenesis FNavigationEvent::GetNavigationGenesis ( ) const
inline

Returns the genesis of the navigation request (Keyboard, Controller, User)

◆ GetNavigationType()

EUINavigation FNavigationEvent::GetNavigationType ( ) const
inline

Returns the type of navigation request (Left, Right, Up, Down)

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