Module input 

The input system: input elements, routed input events, input devices and focus.

Re-exports

pub use navigation::XYFocus;

pub use navigation::XYFocusNavigationModes;

pub use navigation::XYFocusNavigationStrategy;

Modules

gesture_recognizers

Gesture recognizers: objects attached to an input element that turn pointer input into higher-level gestures.

navigation

Keyboard navigation: tab navigation and directional (XY) focus.

platform

Platform-dependent input configuration.

raw

Raw input events: input as reported by the platform, before it is turned into routed events by the input devices.

text_input

Text input methods (IME): the contract between text editing controls and the input method of the platform.

Structs

AccessKeyEventArgs

Information pertaining to when the access key associated with an element is pressed.

AccessKeyHandler

Handles access keys for a window.

AccessKeyPressedEventArgs

The inputs to an access key pressed event: raised on an element to ask which element an access key should target.

AccessKeyRegistration

An access key registered for an element.

AsyncDataTransferItems

The items of an asynchronous data transfer that support a format, in order.

ContextRequestedEventArgs

Provides event data for the context requested event.

Cursor

Represents a mouse cursor.

DataFormat

Represents a format usable with the clipboard and drag-and-drop.

DataFormatOf

Represents a format usable with the clipboard and drag-and-drop, with a data type.

DataTransfer

A mutable implementation of IDataTransfer and IAsyncDataTransfer.

DataTransferItem

A mutable implementation of IDataTransferItem and IAsyncDataTransferItem. This type also provides several functions to easily create a DataTransferItem for common usages.

DataTransferItems

The items of a data transfer that support a format, in order.

DragDrop

Defines the attached property and the routed events of drag-and-drop, and starts drag-and-drop operations.

DragDropDevice

The input device that turns the raw drag events of the platform into the routed drag-and-drop events of DragDrop.

DragDropEffects

The effects of a drag-and-drop operation.

DragEventArgs

Provides data for the drag-and-drop events.

FindNextElementOptions

Provides options to customize the behavior when identifying the next element to focus during a navigation operation.

FocusChangedEventArgs

Holds arguments for the GotFocus and LostFocus events.

FocusChangingEventArgs

Provides data for focus changing: the GettingFocus and LosingFocus events, which can cancel or redirect a focus change.

FocusManager

Manages focus for the application.

Gestures

Synthesizes the tapped, double-tapped, right-tapped and holding gestures from pointer events.

HoldingRoutedEventArgs

Provides data for the holding event.

InputElement

Implements input-related functionality for a control.

InputElementVTable

The virtual table of the class.

InputManager

Receives input from the windowing subsystem and dispatches it to interested parties for processing.

InputMethod

Defines the attached property and the routed event that connect an input element to the input method of the platform.

KeyBinding

Binds a key gesture to a command.

KeyEventArgs

Provides information specific to a keyboard event.

KeyGesture

Defines a keyboard input combination.

KeyModifiers

Defines the keyboard modifier keys.

KeyStates

Defines the state of a key.

KeySymbolHelper

Helpers for key symbols reported by platform backends.

KeyboardDevice

Represents the keyboard: turns raw key and text input into routed events on the focused element, and is the source of truth about which element has keyboard focus.

KeyboardNavigation

Defines attached properties that control keyboard navigation behaviour for a container.

KeyboardNavigationHandler

Handles keyboard navigation for a window.

MouseDevice

Represents a mouse device: turns raw pointer events into routed pointer events on the element under the pointer or capturing it.

ParseCursorError

The error returned when a string does not name a standard cursor type.

ParseKeyError

The error returned when a string does not name a Key.

ParseKeyModifiersError

The error returned when a string does not name keyboard modifiers.

ParsePhysicalKeyError

The error returned when a string does not name a PhysicalKey.

PenDevice

Represents a pen/stylus device.

PinchEndedEventArgs

Provides data for the pinch ended event.

PinchEventArgs

Provides data for the pinch gesture event.

Pointer

Identifies a specific input pointer and tracks the element that captures it.

PointerCaptureChangingEventArgs

Provides data for the pointer capture changing event: raised before the capture of a pointer changes; marking it handled cancels the change.

PointerCaptureLostEventArgs

Provides data for the pointer capture lost event.

PointerDeltaEventArgs

Provides data for the touchpad gesture events (magnify, rotate, swipe).

PointerEventArgs

Provides data for pointer events.

PointerOverPreProcessor

Tracks which element the pointer is over for one input root, raising the pointer entered and exited events as it changes.

PointerPoint

Provides basic properties for the input pointer associated with a single mouse, pen/stylus, or touch contact.

PointerPointProperties

Provides extended properties for a pointer point.

PointerPressedEventArgs

Provides data for the pointer pressed event.

PointerReleasedEventArgs

Provides data for the pointer released event.

PointerWheelEventArgs

Provides data for the pointer wheel changed event.

PullGestureEndedEventArgs

Provides data for the pull gesture ended event.

PullGestureEventArgs

Provides data for the pull gesture event.

RawInputModifiers

The modifier keys and pointer buttons reported by the platform with a raw input event.

ScrollGestureEndedEventArgs

Provides data for the scroll gesture ended event.

ScrollGestureEventArgs

Provides data for the scroll gesture event.

ScrollGestureInertiaStartingEventArgs

Provides data for the scroll gesture inertia starting event.

SwipeGestureEndedEventArgs

Provides data for the swipe gesture ended event.

SwipeGestureEventArgs

Provides data for swipe gesture events.

TappedEventArgs

Provides data for the tapped, double-tapped and right-tapped events.

TextInputEventArgs

Provides information specific to a text input event.

TouchDevice

Handles raw touch events.

VectorEventArgs

Provides a vector with a routed event.

Enums

CaptureSource

What requested a change of pointer capture.

DataFormatKind

Represents the kind of a DataFormat.

HoldingState

The state of a holding gesture.

Key

Defines the keys available on a keyboard.

KeyDeviceType

Enumerates key device types.

KeyboardNavigationMode

Describes how focus should be moved by directional or tab keys.

MouseButton

Enumerates the mouse buttons.

NavigationDirection

Describes how focus should be moved by directional or tab keys.

NavigationMethod

Defines the method by which focus was changed.

PhysicalKey

Represents a keyboard physical key.

PointerType

Enumerates the types of pointer devices.

PointerUpdateKind

The kind of state change of a pointer.

PullDirection

The direction of a pull gesture.

StandardCursorType

Defines the standard cursor types.

SwipeDirection

Specifies the direction of a swipe gesture.

WindowDecorationsElementRole

Defines the cross-platform role of a visual element for non-client hit-testing. Used to mark elements as titlebar drag areas, resize grips, etc.

Traits

AsyncDataTransferExtensions

Contains extension methods for IAsyncDataTransfer.

AsyncDataTransferItemExtensions

Contains extension methods for IAsyncDataTransferItem.

DataTransferExtensions

Contains extension methods for IDataTransfer.

DataTransferItemExtensions

Contains extension methods for IDataTransferItem.

IAccessKeyHandler

Defines the interface for classes that handle access keys for a window.

IAsyncDataTransfer

Represents an object providing a list of IAsyncDataTransferItem usable by the clipboard.

IAsyncDataTransferItem

Represent an item inside a IAsyncDataTransfer. An item may support several formats and can return the value of a given format on demand.

IClickableControl

A control that can be clicked: what the access key and hot key handling needs from a button-like control.

ICloseable

Something that tells when it has been closed.

ICommand

Defines a command.

ICommandSource

An interface for classes that know how to invoke a command.

ICustomKeyboardNavigation

Designates a control as handling its own keyboard navigation.

IDataTransfer

Represents an object providing a list of IDataTransferItem usable during a drag and drop operation.

IDataTransferItem

Represent an item inside a IDataTransfer. An item may support several formats and can return the value of a given format on demand.

IFocusManager

Manages focus for the application.

IFocusScope

Marks an input element as a focus scope: an element that remembers which of its descendants was focused last.

IInputDevice

Represents an input device: the object that turns the raw input events of the platform into routed events.

IInputElement

Defines input-related functionality for a control.

IInputManager

Receives input from the windowing subsystem and dispatches it to interested parties for processing.

IInputRoot

Defines the interface for top-level input elements: the part of a presentation source that input is delivered through.

IKeyModifiersEventArgs

Implemented by event args that carry the state of the keyboard modifier keys at the time the event occurred.

IKeyboardDevice

Represents a keyboard device.

IKeyboardNavigationHandler

Defines the interface for classes that handle keyboard navigation for a window.

IMainMenu

Defines the interface for a top-level menu.

IMouseDevice

Represents a mouse device.

INavigableContainer

Defines a container in which the child controls can be navigated by keyboard.

IPenDevice

Represents a pen/stylus device.

IPointer

Identifies a specific input pointer, e.g. a mouse, a touch contact or a pen.

IPointerDevice

Represents a pointer device: a mouse, a touch surface or a pen.

IScrollable

Interface implemented by scrollable controls.

InputElementImpl

The overridable members introduced by the class.

InputElementImplExt

Access to the base implementations of the overridable members.

Type Aliases

IntermediatePoints

The lazily computed intermediate points of a pointer move: the positions the platform coalesced into one event.

LocalBoxFuture

The result of an asynchronous operation of the input system: a future that is polled on the dispatcher thread (for instance from a future started with Dispatcher::invoke_async_task_local).