@gtkx/react / GtkEventControllerKeyProps

Interface: GtkEventControllerKeyProps

Defined in: packages/react/src/generated/jsx.ts:10023

Props for the GtkEventControllerKey controller element.

Extends

• EventControllerBaseProps

Properties

children?

optional children?: ReactNode

Defined in: packages/react/src/generated/jsx.ts:9797

Inherited from

EventControllerBaseProps.children

---

name?

optional name?: string | null

Defined in: packages/react/src/generated/jsx.ts:9764

The name for this controller, typically used for debugging purposes.

Inherited from

EventControllerBaseProps.name

---

onImUpdate?

optional onImUpdate?: (self) => void | null

Defined in: packages/react/src/generated/jsx.ts:10031

Emitted whenever the input method context filters away a keypress and prevents the controller receiving it.

See EventControllerKey.set_im_context and IMContext.filter_keypress.

Parameters

Parameter	Type
self	EventControllerKey

Returns

void | null

---

onKeyPressed?

optional onKeyPressed?: (keyval, keycode, state, self) => boolean | null

Defined in: packages/react/src/generated/jsx.ts:10033

Emitted whenever a key is pressed.

Parameters

Parameter	Type
keyval	number
keycode	number
state	ModifierType
self	EventControllerKey

Returns

boolean | null

---

onKeyReleased?

optional onKeyReleased?: (keyval, keycode, state, self) => void | null

Defined in: packages/react/src/generated/jsx.ts:10035

Emitted whenever a key is released.

Parameters

Parameter	Type
keyval	number
keycode	number
state	ModifierType
self	EventControllerKey

Returns

void | null

---

onModifiers?

optional onModifiers?: (state, self) => boolean | null

Defined in: packages/react/src/generated/jsx.ts:10037

Emitted whenever the state of modifier keys and pointer buttons change.

Parameters

Parameter	Type
state	ModifierType
self	EventControllerKey

Returns

boolean | null

---

onNotify?

optional onNotify?: (pspec, self) => void | null

Defined in: packages/react/src/generated/jsx.ts:9796

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with %G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in ::notify being emitted, even if the new value is the same as the old. If they did pass %G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

|[ g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view) ]|

It is important to note that you must use [canonical parameter names]GObjectParamSpec#parameter-names as detail strings for the notify signal.

Parameters

Parameter	Type
pspec	ParamSpec
self	EventController

Returns

void | null

Inherited from

EventControllerBaseProps.onNotify

---

propagationLimit?

optional propagationLimit?: PropagationLimit

Defined in: packages/react/src/generated/jsx.ts:9766

The limit for which events this controller will handle.

Inherited from

EventControllerBaseProps.propagationLimit

---

propagationPhase?

optional propagationPhase?: PropagationPhase

Defined in: packages/react/src/generated/jsx.ts:9768

The propagation phase at which this controller will handle events.

Inherited from

EventControllerBaseProps.propagationPhase

---

ref?

optional ref?: Ref<EventControllerKey>

Defined in: packages/react/src/generated/jsx.ts:10038