Skip to main content

Interface: GtkShortcutControllerProps

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

Props for the GtkShortcutController controller element.

Extends

Properties

children?

optional children: ReactNode

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

Inherited from

EventControllerBaseProps.children


mnemonicModifiers?

optional mnemonicModifiers: ModifierType

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

The modifiers that need to be pressed to allow mnemonics activation.


model?

optional model: ListModel

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

A list model to take shortcuts from.


name?

optional name: string | null

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

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

Inherited from

EventControllerBaseProps.name


onItemsChanged()?

optional onItemsChanged: (position, removed, added, self) => void | null

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

This signal is emitted whenever items were added to or removed from list. At position, removed items were removed and added items were added in their place.

Note: If removed != added, the positions of all later items in the model change.

Parameters

ParameterType
positionnumber
removednumber
addednumber
selfShortcutController

Returns

void | null


onNotify()?

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

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

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

ParameterType
pspecParamSpec
selfEventController

Returns

void | null

Inherited from

EventControllerBaseProps.onNotify


propagationLimit?

optional propagationLimit: PropagationLimit

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

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:9813

The propagation phase at which this controller will handle events.

Inherited from

EventControllerBaseProps.propagationPhase


ref?

optional ref: Ref<ShortcutController>

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


scope?

optional scope: ShortcutScope

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

What scope the shortcuts will be handled in.