Type Alias: GtkDropTargetProps
GtkDropTargetProps =
EventControllerBaseProps&object
Defined in: generated/jsx.ts:10053
Props for the GtkDropTarget controller element.
Type Declaration
| Name | Type | Description | Defined in |
|---|---|---|---|
actions? | Gdk.DragAction | The GdkDragActions that this drop target supports. | generated/jsx.ts:10055 |
onAccept()? | (drop, self) => boolean | null | 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 DropTarget.reject or ultimately by returning %FALSE from a DropTarget.: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 depends on the data, this function should return %TRUE, the DropTarget.preload property should be set and the value should be inspected via the ::notify:value signal, calling DropTarget.reject if required. | generated/jsx.ts:10095 |
onDrop()? | (value, x, y, self) => boolean | null | 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 is responsible for using the given value and performing the drop operation. | generated/jsx.ts:10107 |
onEnter()? | (x, y, self) => Gdk.DragAction | null | Emitted on the drop site when the pointer enters the widget. It can be used to set up custom highlighting. | generated/jsx.ts:10113 |
onLeave()? | (self) => void | null | Emitted on the drop site when the pointer leaves the widget. Its main purpose it to undo things done in DropTarget.:enter. | generated/jsx.ts:10120 |
onMotion()? | (x, y, self) => Gdk.DragAction | null | Emitted while the pointer is moving over the drop target. | generated/jsx.ts:10122 |
preload? | boolean | Whether the drop data should be preloaded when the pointer is only hovering over the widget but has not been released. Setting this property allows finer grained reaction to an ongoing drop at the cost of loading more data. The default value for this property is %FALSE to avoid downloading huge amounts of data by accident. For example, if somebody drags a full document of gigabytes of text from a text editor across a widget with a preloading drop target, this data will be downloaded, even if the data is ultimately dropped elsewhere. For a lot of data formats, the amount of data is very small (like %GDK_TYPE_RGBA), so enabling this property does not hurt at all. And for local-only Drag-and-Drop operations, no data transfer is done, so enabling it there is free. | generated/jsx.ts:10076 |
ref? | Ref<Gtk.DropTarget> | - | generated/jsx.ts:10125 |
types? | number[] | Array of GTypes that this drop target accepts. Use typeFromName() to get GType values. | generated/jsx.ts:10124 |