Interface: GtkDropTargetAsyncProps

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

Props for the GtkDropTargetAsync controller element.

Extends

• EventControllerBaseProps

Properties

actions?

optional actions: DragAction

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

The GdkDragActions that this drop target supports.

---

children?

optional children: ReactNode

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

Inherited from

EventControllerBaseProps.children

---

formats?

optional formats: ContentFormats | null

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

The GdkContentFormats that determines the supported data formats.

---

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

---

onAccept()?

optional onAccept: (drop, self) => boolean | null

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

Emitted on the drop site when a drop operation is about to begin.

If the drop is not accepted, %FALSE will be returned and the drop target will ignore the drop. If %TRUE is returned, the drop is accepted for now but may be rejected later via a call to DropTargetAsync.reject_drop or ultimately by returning %FALSE from a DropTargetAsync.:drop handler.

The default handler for this signal decides whether to accept the drop based on the formats provided by the drop.

If the decision whether the drop will be accepted or rejected needs further processing, such as inspecting the data, this function should return %TRUE and proceed as is drop was accepted and if it decides to reject the drop later, it should call DropTargetAsync.reject_drop.

Parameters

Parameter	Type
drop	Drop
self	DropTargetAsync

Returns

boolean | null

---

onDragEnter()?

optional onDragEnter: (drop, x, y, self) => DragAction | null

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

Emitted on the drop site when the pointer enters the widget.

It can be used to set up custom highlighting.

Parameters

Parameter	Type
drop	Drop
x	number
y	number
self	DropTargetAsync

Returns

DragAction | null

---

onDragLeave()?

optional onDragLeave: (drop, self) => void | null

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

Emitted on the drop site when the pointer leaves the widget.

Its main purpose it to undo things done in GtkDropTargetAsync::drag-enter.

Parameters

Parameter	Type
drop	Drop
self	DropTargetAsync

Returns

void | null

---

onDragMotion()?

optional onDragMotion: (drop, x, y, self) => DragAction | null

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

Emitted while the pointer is moving over the drop target.

Parameters

Parameter	Type
drop	Drop
x	number
y	number
self	DropTargetAsync

Returns

DragAction | null

---

onDrop()?

optional onDrop: (drop, x, y, self) => boolean | null

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

Emitted on the drop site when the user drops the data onto the widget.

The signal handler must determine whether the pointer position is in a drop zone or not. If it is not in a drop zone, it returns %FALSE and no further processing is necessary.

Otherwise, the handler returns %TRUE. In this case, this handler will accept the drop. The handler must ensure that GdkDrop.finish is called to let the source know that the drop is done. The call to GdkDrop.finish must only be done when all data has been received.

To receive the data, use one of the read functions provided by GdkDrop such as GdkDrop.read_async or GdkDrop.read_value_async.

Parameters

Parameter	Type
drop	Drop
x	number
y	number
self	DropTargetAsync

Returns

boolean | 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

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

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