Interface INavigationEvents

Namespace

Icy.Input.Events

Assembly

IcyUI.dll

Represents an interface for navigation related events.

public interface INavigationEvents : IInputEventProvider, IUpdateableInput, IInitializable, IStartRepeatEvents, IRepeatableInputEvents

Inherited Members

IInputEventProvider.InputSystem

IUpdateableInput.Update(TimeSpan)

IInitializable.IsInitialized

IInitializable.Initialize()

IStartRepeatEvents.RepeatStartDelay

IRepeatableInputEvents.RepeatDelay

Extension Methods

PropertyReferencesExtensions.ContainsProperty(object, IPropertyReference)

Properties

MinimalFocusChangeDistance

Gets or sets the stick deflection, from 0 to 1, past which the left stick raises FocusChanging. The stick releases below 70% of it. Defaults to 0.5.

float MinimalFocusChangeDistance { get; set; }

Property Value

float

Events

AltKeyNavigation

Occurs when user presses any non-modifier key with the Alt pressed.

event EventHandler<AcceptableEventArgs<Keys>>? AltKeyNavigation

Event Type

EventHandler<AcceptableEventArgs<Keys>>

CloseModal

Occurs when user tries to close the modal window (or use cancel button).

event EventHandler? CloseModal

Event Type

EventHandler

FocusChanging

Occurs when user tries to navigate between UI elements using keyboard for navigation.

event EventHandler<AcceptableEventArgs<Vector2>>? FocusChanging

Event Type

EventHandler<AcceptableEventArgs<Vector2>>

Remarks

Direction of the navigation change is passed to event arguments, in UI space (+Y down).

Raised once per press of an arrow key (without Ctrl or Shift), a D-pad button, or the left stick crossing MinimalFocusChangeDistance, then repeated while held (see IStartRepeatEvents). Canvas routes it to the focused element and moves focus spatially when nothing claims it.

FocusNext

Occurs when user tries to focus the next UI element.

event EventHandler? FocusNext

Event Type

EventHandler

FocusPrevious

Occurs when user tries to focus previous UI element.

event EventHandler? FocusPrevious

Event Type

EventHandler

NavigateBack

Occurs when user tries to navigate back to the previous page.

event EventHandler? NavigateBack

Event Type

EventHandler

NavigateForward

Occurs when user tries to navigate forward to the next page.

event EventHandler? NavigateForward

Event Type

EventHandler

SelectElement

Occurs when user tries to use the selected element (or use accept button).

event EventHandler? SelectElement

Event Type

EventHandler