fuchsia.ui.input

A interface for interacting with a text input control.

DispatchKey3

Deprecated: 8

Request

Name	Type
`event`	`fuchsia.ui.input3/KeyEvent`

Response

Name	Type
`handled`	`bool`

Hide

Request

<EMPTY>

InjectInput

Deprecated: 8

Request

Name	Type
`event`	`InputEvent`

SetKeyboardType

Request

Name	Type
`keyboard_type`	`KeyboardType`

SetState

Request

Name	Type
`state`	`TextInputState`

Show

Request

<EMPTY>

InputMethodEditorClient

An interface to receive information from TextInputService.

DidUpdateState

Request

Name	Type
`state`	`TextInputState`
`event`	`InputEvent?`

OnAction

Request

Name	Type
`action`	`InputMethodAction`

PointerCaptureListener

Defined in fuchsia.ui.input/pointer_capture.fidl

A method of obtaining global pointer events, regardless of view focus. DEPRECATED: Do not add new uses of this protocol.

OnPointerEvent

Request

Name	Type
`event`	`PointerEvent`

Response

<EMPTY>

PointerCaptureListenerRegistry

Defined in fuchsia.ui.input/pointer_capture.fidl

Injects a listener protocol, along with a ViewRef that defines the coordinate space of the captured pointer events. DEPRECATED: Do not add new uses of this protocol.

RegisterListener

This protocol will be subsumed by gesture disambiguation.

Request

Name	Type
`listener`	`PointerCaptureListener`
`view_ref`	`fuchsia.ui.views/ViewRef`

Response

Name	Type
`success`	`bool`

STRUCTS

Axis

Field	Type	Default
`range`	`Range`	No default
`resolution`	`int32`	1
`scale`	`AxisScale`	AxisScale.LINEAR

AxisF

Field	Type	Default
`range`	`RangeF`	No default
`resolution`	`float32`	1
`scale`	`AxisScale`	AxisScale.LINEAR

DeviceDescriptor

Field	Type	Default
`device_info`	`DeviceInfo?`	No default
`keyboard`	`KeyboardDescriptor?`	No default
`media_buttons`	`MediaButtonsDescriptor?`	No default
`mouse`	`MouseDescriptor?`	No default
`stylus`	`StylusDescriptor?`	No default
`touchscreen`	`TouchscreenDescriptor?`	No default
`sensor`	`SensorDescriptor?`	No default

DeviceInfo

Field	Type	Default
`vendor_id`	`uint32`	No default
`product_id`	`uint32`	No default
`version`	`uint32`	No default
`name`	`string`	No default

FocusEvent

Field	Type	Description	Default
`event_time`	`uint64`	Time the event was delivered. The time is in nanoseconds and corresponds to the monotonic time as determined by the zx_clock_get_monotonic syscall.	No default
`focused`	`bool`	Whether the view has gained input focused or not.	No default

InputReport

Field	Type	Default
`event_time`	`uint64`	No default
`keyboard`	`KeyboardReport?`	No default
`media_buttons`	`MediaButtonsReport?`	No default
`mouse`	`MouseReport?`	No default
`stylus`	`StylusReport?`	No default
`touchscreen`	`TouchscreenReport?`	No default
`sensor`	`SensorReport?`	No default
`trace_id`	`uint64`	0

KeyboardDescriptor

Field	Type	Description	Default
`keys`	`vector<uint32>`		No default

KeyboardEvent

KeyboardEvent represents event generated by a user's interaction with a keyboard.

Those events are triggered by distinct pressed state changes of the keys.

The state transitions should be as follows: PRESSED -> (REPEAT ->) RELEASED or PRESSED -> (REPEAT ->) CANCELLED

The input system will repeat those events automatically when a code_point is available.

DEPRECATED: Will be removed in favor of fuchsia.ui.input.KeyEvent.

Field	Type	Description	Default
`event_time`	`uint64`	Time the event was delivered. The time is in nanoseconds and corresponds to the monotonic time as determined by the zx_clock_get_monotonic syscall.	No default
`device_id`	`uint32`		No default
`phase`	`KeyboardEventPhase`		No default
`hid_usage`	`uint32`	Keyboard HID Usage See https://www.usb.org/sites/default/files/documents/hut1_12v2.pdf	No default
`code_point`	`uint32`	The unicode code point represented by this key event, if any. Dead keys are represented as Unicode combining characters. If there is no unicode code point, this value is zero.	No default
`modifiers`	`uint32`	Key modifiers as defined by the different kModifier constants such as `kModifierCapsLock` currently pressed	No default

KeyboardReport

Field	Type	Description	Default
`pressed_keys`	`vector<uint32>`		No default

MediaButtonsDescriptor

Field	Type	Description	Default
`buttons`	`uint32`		No default

MediaButtonsReport

MediaButtonsReport describes the media buttons event delivered from the event stream. Each bool in the report represents a single button where true means the button is being pressed. A single report should be sent on every state change.

Field	Type	Default
`volume_up`	`bool`	No default
`volume_down`	`bool`	No default
`mic_mute`	`bool`	No default
`reset`	`bool`	No default
`pause`	`bool`	No default
`camera_disable`	`bool`	No default

MouseDescriptor

Field	Type	Default
`rel_x`	`Axis`	No default
`rel_y`	`Axis`	No default
`vscroll`	`Axis?`	No default
`hscroll`	`Axis?`	No default
`buttons`	`uint32`	No default

MouseReport

Field	Type	Default
`rel_x`	`int32`	No default
`rel_y`	`int32`	No default
`rel_hscroll`	`int32`	No default
`rel_vscroll`	`int32`	No default
`pressed_buttons`	`uint32`	No default

PointerEvent

Pointers represent raw data about the user's interaction with the screen.

The state transitions should be as follows: ADD (-> HOVER) -> DOWN -> MOVE -> UP (-> HOVER) -> REMOVE

At any point after the initial ADD, a transition to CANCEL is also possible.

Field	Type	Description	Default
`event_time`	`uint64`	Time the event was delivered. The time is in nanoseconds and corresponds to the monotonic time as determined by the zx_clock_get_monotonic syscall.	No default
`device_id`	`uint32`		No default
`pointer_id`	`uint32`		No default
`type`	`PointerEventType`		No default
`phase`	`PointerEventPhase`		No default
`x`	`float32`	`x` and `y` are in the coordinate system of the View.	No default
`y`	`float32`		No default
`radius_major`	`float32`		0
`radius_minor`	`float32`		0
`buttons`	`uint32`	Currently pressed buttons as defined the kButton constants such as `kMousePrimaryButton`	No default

Range

Field	Type	Description	Default
`min`	`int32`		No default
`max`	`int32`		No default

RangeF

Field	Type	Description	Default
`min`	`float32`		No default
`max`	`float32`		No default

SendKeyboardInputCmd

Defined in fuchsia.ui.input/commands.fidl

Field	Type	Description	Default
`compositor_id`	`uint32`		No default
`keyboard_event`	`KeyboardEvent`		No default

SendPointerInputCmd

Defined in fuchsia.ui.input/commands.fidl

Field	Type	Description	Default
`compositor_id`	`uint32`		No default
`pointer_event`	`PointerEvent`		No default

SensorDescriptor

Field	Type	Default
`type`	`SensorType`	No default
`loc`	`SensorLocation`	No default
`min_sampling_freq`	`uint32`	No default
`max_sampling_freq`	`uint32`	No default
`fifo_max_event_count`	`uint32`	No default
`phys_min`	`int32`	No default
`phys_max`	`int32`	No default

SetHardKeyboardDeliveryCmd

Defined in fuchsia.ui.input/commands.fidl

Typically, clients should receive text inputs from an IME.

For cases where no IME mediation is desired (such as a game application), this command requests Scenic to deliver hard keyboard events to the client.

By default, Scenic will not deliver hard keyboard events to a client.

Field	Type	Description	Default
`delivery_request`	`bool`		No default

SetParallelDispatchCmd

Defined in fuchsia.ui.input/commands.fidl

Obsolete. This command is a no-op.

Field	Type	Description	Default
`parallel_dispatch`	`bool`		No default

StylusDescriptor

Field	Type	Default
`x`	`Axis`	No default
`y`	`Axis`	No default
`pressure`	`Axis?`	No default
`is_invertible`	`bool`	false
`buttons`	`uint32`	No default

StylusReport

Field	Type	Default
`x`	`int32`	No default
`y`	`int32`	No default
`pressure`	`uint32`	No default
`is_in_contact`	`bool`	No default
`in_range`	`bool`	No default
`is_inverted`	`bool`	No default
`pressed_buttons`	`uint32`	No default

TextInputState

The current text, selection, and composing state for editing a run of text.

Field	Type	Description	Default
`revision`	`uint32`	Current state revision to avoid race conditions.	No default
`text`	`string`	The current text being edited.	No default
`selection`	`TextSelection`	The range of text that is currently selected.	No default
`composing`	`TextRange`	The range of text that is still being composed.	No default

TextRange

Defined in fuchsia.ui.input/text_editing.fidl

A range of characters in a string of text. Although strings in FIDL's wire format are UTF-8 encoded, these indices are measured in UTF-16 code units for legacy reasons. These text input APIs will eventually be replaced by fuchsia.ui.text, which uses code points instead.

Field Type Description Default

Field	Type	Description	Default
`start`	`int64`	The index of the first UTF-16 code unit in the range. If `start` and `end` are both -1, the text range is empty.	-1
`end`	`int64`	The next index after the last UTF-16 code unit in this range. If `start` and `end` are both -1, the text range is empty.	-1

start

int64

The index of the first UTF-16 code unit in the range.

If start and end are both -1, the text range is empty.

-1

end

int64

The next index after the last UTF-16 code unit in this range.

If start and end are both -1, the text range is empty.

-1

TextSelection

Defined in fuchsia.ui.input/text_editing.fidl

A range of text that represents a selection. Although strings in FIDL's wire format are UTF-8 encoded, these indices are measured in UTF-16 code units for legacy reasons. These text input APIs will eventually be replaced by fuchsia.ui.text, which uses code points instead.

Text selection is always directional. Direction should be determined by comparing base and extent.

Field Type Description Default

Field	Type	Description	Default
`base`	`int64`	The offset at which the selection originates, as measured in UTF-16 code units. Might be larger than, smaller than, or equal to extent.	No default
`extent`	`int64`	The offset at which the selection terminates, as measured in UTF-16 code units. When the user uses the arrow keys to adjust the selection, this is the value that changes. Similarly, if the current theme paints a caret on one side of the selection, this is the location at which to paint the caret. Might be larger than, smaller than, or equal to base.	No default
`affinity`	`TextAffinity`	If the text range is collapsed and has more than one visual location (e.g., occurs at a line break), which of the two locations to use when painting the caret.	No default

base

int64

The offset at which the selection originates, as measured in UTF-16 code units.

Might be larger than, smaller than, or equal to extent.

No default

extent

int64

The offset at which the selection terminates, as measured in UTF-16 code units.

When the user uses the arrow keys to adjust the selection, this is the value that changes. Similarly, if the current theme paints a caret on one side of the selection, this is the location at which to paint the caret.

Might be larger than, smaller than, or equal to base.

No default

affinity

TextAffinity

If the text range is collapsed and has more than one visual location (e.g., occurs at a line break), which of the two locations to use when painting the caret.

No default

Touch

Field	Type	Default
`finger_id`	`uint32`	No default
`x`	`int32`	No default
`y`	`int32`	No default
`width`	`uint32`	No default
`height`	`uint32`	No default

TouchscreenDescriptor

Field	Type	Default
`x`	`Axis`	No default
`y`	`Axis`	No default
`max_finger_id`	`uint32`	No default

TouchscreenReport

Field	Type	Description	Default
`touches`	`vector<Touch>`		No default

ENUMS

AxisScale flexible

Type: uint32

Name	Value	Description
LINEAR	`0`
LOGARITHMIC	`1`

InputMethodAction flexible

Type: uint32

Determines what happens if the "action" key is pressed on the keyboard, typically would either be the "Enter" key on a physical keyboard, or an action button on a virtual keyboard, which is usually placed where Enter would be, but with a custom label.

Name	Value	Description
UNSPECIFIED	`0`	The method action was not specified at all.
NONE	`1`	No special action is requested.
GO	`2`	The action is "Go", e.g. execute a command.
SEARCH	`3`	The action is to invoke a search.
SEND	`4`	The action is to invoke "send", e.g. if this is an email or a SMS message.
NEXT	`5`	The action is to move to the next field in the focus sequence.
DONE	`6`	The action is to end the text editing.
PREVIOUS	`7`	The action is to move to the previous field in the focus sequence.
NEWLINE	`8`	Pressing the action key inserts a new line into the text field. In contrast to other values, which all stop editing and invoke a specific action. Added: 8

KeyboardEventPhase flexible

Type: uint32

Name	Value	Description
PRESSED	`0`	When key is pressed down.
RELEASED	`1`	When key is released.
CANCELLED	`2`	This key `PRESSED` is not directed to this input client anymore.
REPEAT	`3`	Whether this is an automatically generated key repeat

KeyboardType flexible

Type: uint32

Requests a specific keyboard type from the text editing subsystem.

This is most relevant for virtual keyboards which have some leeway in how the keyboard is presented to the user, as well as which input is acceptable.

For example, a NUMBER keyboard type may only allow decimal numbers to be entered. In addition, a virtual keyboard might only show a numeric keypad for text entry.

Name	Value	Description
TEXT	`0`	Single-line text fields only. Use MULTILINE below for multiline text.
NUMBER	`1`	A text field intended for entering numbers only.
PHONE	`2`	A text field for entering phone numbers only (e.g. digits, limited punctuation, perhaps some validation).
DATETIME	`3`	A text field for entering date and time. For example, may have a calendar widget on the side, to aid in date time entry.
MULTILINE	`4`	Multi-line text. Added: 8

PointerEventPhase strict

Type: uint32

Name	Value	Description
ADD	`0`	The device has started tracking the pointer. For example, the pointer might be hovering above the device, having not yet made contact with the surface of the device.
HOVER	`1`	The pointer has moved with respect to the device while not in contact with the device.
DOWN	`2`	The pointer has made contact with the device. For `MOUSE` devices, this is triggered when the primary button is pressed down to emulate a touch on the screen.
MOVE	`3`	The pointer has moved with respect to the device while in contact with the device.
UP	`4`	The pointer has stopped making contact with the device. For `MOUSE` devices, this is triggered when the primary button is released.
REMOVE	`5`	The device is no longer tracking the pointer. For example, the pointer might have drifted out of the device's hover detection range or might have been disconnected from the system entirely.
CANCEL	`6`	The input from the pointer is no longer directed towards this receiver.

PointerEventType strict

Type: uint32

Name	Value	Description
TOUCH	`0`	A touch-based pointer device.
STYLUS	`1`	A pointer device with a stylus.
INVERTED_STYLUS	`2`	A pointer device with a stylus that has been inverted.
MOUSE	`3`	A pointer device without a stylus.

SensorLocation flexible

Type: uint32

Name	Value	Description
UNKNOWN	`0`
BASE	`1`
LID	`2`

SensorType flexible

Type: uint32

Name	Value	Description
ACCELEROMETER	`0`
GYROSCOPE	`1`
MAGNETOMETER	`2`
LIGHTMETER	`3`

TextAffinity strict

Type: uint32

Defined in fuchsia.ui.input/text_editing.fidl

Whether a TextPosition is visually upstream or downstream of its offset.

For example, when a text position exists at a line break, a single offset has two visual positions, one prior to the line break (at the end of the first line) and one after the line break (at the start of the second line). A text affinity disambiguates between those cases. (Something similar happens with between runs of bidirectional text.)

We do not expect new values to be added to this enum.

Name Value Description

UPSTREAM

0

The position has affinity for the upstream side of the text position.

For example, if the offset of the text position is a line break, the position represents the end of the first line.

DOWNSTREAM

1

The position has affinity for the downstream side of the text position.

For example, if the offset of the text position is a line break, the position represents the start of the second line.

TABLES

MediaButtonsEvent

Ordinal	Field	Type
1	`volume`	`int8`
2	`mic_mute`	`bool`
3	`pause`	`bool`
4	`camera_disable`	`bool`

UNIONS

Command strict

Defined in fuchsia.ui.input/commands.fidl

Ordinal	Variant	Type	Description
1	`send_keyboard_input`	`SendKeyboardInputCmd`	Commands for conveying input events to a `Session`. Structs defined in input_events.fidl.
2	`send_pointer_input`	`SendPointerInputCmd`
3	`set_hard_keyboard_delivery`	`SetHardKeyboardDeliveryCmd`	Command to enable/disable delivery of hard keyboard events.
4	`set_parallel_dispatch`	`SetParallelDispatchCmd`	Obsolete. This command is a no-op.

InputEvent strict

This union does not include MediaButtonsEvent because it's processed differently.

Ordinal	Variant	Type
1	`pointer`	`PointerEvent`
2	`keyboard`	`KeyboardEvent`
3	`focus`	`FocusEvent`

SensorReport strict