Navigation
API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Framework > API/Runtime/Slate/Framework/Application
Inheritance Hierarchy
- TSharedFromThis
- FNavigationConfig
- FNullNavigationConfig
- FTwinStickNavigationConfig
References
| Module | Slate |
| Header | /Engine/Source/Runtime/Slate/Public/Framework/Application/NavigationConfig.h |
| Include | #include "Framework/Application/NavigationConfig.h" |
Syntax
class FNavigationConfig : public TSharedFromThis< FNavigationConfig >
Remarks
This class is used to control which FKeys and analog axis should move focus.
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
FKey | AnalogHorizontalKey | Which Axis Key controls horizontal navigation |
 |
float | AnalogNavigationHorizontalThreshold | |
 |
float | AnalogNavigationVerticalThreshold | |
 |
FKey | AnalogVerticalKey | Which Axis Key controls vertical navigation |
 |
bool | bAnalogNavigation | Should we respect the analog stick for navigation. |
 |
bool | bKeyNavigation | Should we respect keys for navigation. |
 |
bool | bTabNavigation | Should the Tab key perform next and previous style navigation. |
 |
TMap< FKey, EUINavigation > | KeyEventRules | Digital key navigation rules. |
 |
TMap< int, FUserNavigationState > | UserNavigationState | Navigation state that we store per user. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Ctor |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Dtor |
Functions
| Type | Name | Description | |
|---|---|---|---|
   |
EUINavigationAction | GetNavigationActionFromKey
(
const FKeyEvent& InKeyEvent |
Returns the navigation action corresponding to a key event. |
  |
EUINavigation | GetNavigationDirectionFromAnalog
(
const FAnalogInputEvent& InAnalogEvent |
Gets the navigation direction from a given analog event. |
  |
EUINavigation | GetNavigationDirectionFromAnalogInternal
(
const FAnalogInputEvent& InAnalogEvent |
Gets the navigation direction from the analog internally. |
   |
EUINavigation | GetNavigationDirectionFromKey
(
const FKeyEvent& InKeyEvent |
Gets the navigation direction from a given key event. |
   |
float | GetRepeatRateForPressure
(
float InPressure, |
Gets the repeat rate of the navigation based on the current pressure being applied. |
   |
bool | IsAnalogHorizontalKey
(
const FKey& InKey |
|
   |
bool | IsAnalogVerticalKey
(
const FKey& InKey |
|
  |
void | OnNavigationChangedFocus
(
TSharedPtr< SWidget > OldWidget, |
Notified when navigation has caused a widget change to occur |
  |
void | OnRegister () |
Called when the navigation config is registered with Slate Application |
  |
void | OnUnregister () |
Called when the navigation config is registered with Slate Application |
  |
void | OnUserRemoved
(
int32 UserIndex |
Notified when users are removed from the system, good chance to clean up any user specific state. |
   |
FString | ToString () |
Simplification of config as string |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
   |
EUINavigationAction | GetNavigationActionForKey
(
const FKey& InKey |
GetNavigationActionForKey doesn't handle multiple users properly, use GetNavigationActionFromKey instead |