Namespaces

Enumerations

enum class KeyEventType : uint32_t
Name Value Comments
kPressed 1u

Key is actuated.

Receiving this event type means that a key has been actuated
at the timestamp when the event is received, and while the event
recipient is focused.

For example, if the key is a keyboard key, then it was just
pressed.

kReleased 2u

Key is no longer actuated.

Receiving this event type means that a key has been de-actuated
at the timestamp when the event is received, and while the event
recipient is focused.

For example, if the key is a keyboard key, then it was just
released.

kSync 3u

Key was actuated while the client wasn't able to receive it,
and is still actuated now that the client is able to receive
key events.

This may happen in a few ways:

- A new device was connected while its key was actuated.
- The key was actuated while the event recipient did not
have focus.

Therefore, this is not a "regular" key actuation. It reports
now that the key has been actuated in the unknown past. Some
event recipients may therefore decide that this is not an
actionable key event, while some others may decide that it is.

For example, recipients that trigger some user action may
decide to ignore `SYNC` events, to avoid spurious actions. In
contrast, recipients that keep track of the keyboard
state may want to consider a `SYNC` event as a signal
to update the key's state to actuated.

kCancel 4u

Key may have been actuated, but its actuation has
become invalid due to an event other than a key
de-actuation.

This may happen in a few ways:

- A device was disconnected while its key was actuated.
- The event recipient just lost focus.

Therefore, this is not a "regular" key de-actuation. It reports
the key is no longer validly actuated due to an event other than
a key release. Some event recipients may therefore decide that
this is not an actionable key event, while some others may
decide that it is.

For example, recipients which trigger some user action may
decide to ignore `CANCEL` events, to avoid spurious actions. In
contrast, recipients that keep track of the keyboard
state may want to consider a `CANCEL` event as a signal to update
the key's state to being de-actuated.

Type of the keyboard key input event.

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

Defined at line 303 of file fidling/gen/sdk/fidl/fuchsia.ui.input3/fuchsia.ui.input3/cpp/fidl/fuchsia.ui.input3/cpp/common_types.h

enum class KeyEventStatus : uint32_t
Name Value Comments
kHandled 1u

The key event was handled and its further propagation should be stopped.

kNotHandled 2u

The key event wasn't handled and should be delivered to other clients or listeners.

Return type for clients key events listener.

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

Defined at line 1118 of file fidling/gen/sdk/fidl/fuchsia.ui.input3/fuchsia.ui.input3/cpp/fidl/fuchsia.ui.input3/cpp/common_types.h

Records

Functions

  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_input3::KeyEventType & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_input3::NonPrintableKey & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_input3::KeyMeaning & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_input3::KeyboardAddListenerRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_input3::KeyEventStatus & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_input3::KeyboardListenerOnKeyEventResponse & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_input3::KeyEventInjectorInjectResponse & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_input3::Modifiers & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_input3::LockState & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_input3::KeyEvent & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_input3::KeyboardListenerOnKeyEventRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_input3::KeyEventInjectorInjectRequest & value)