Skip to main content

Type Alias: GtkDragSourceProps

GtkDragSourceProps = GtkGestureSingleProps & object

Defined in: generated/jsx.ts:9992

Props for the GtkDragSource controller element.

Type Declaration

NameTypeDescriptionDefined in
actions?Gdk.DragActionThe actions that are supported by drag operations from the source. Note that you must handle the DragSource.:drag-end signal if the actions include %GDK_ACTION_MOVE.generated/jsx.ts:9999
content?Gdk.ContentProvider | nullThe data that is offered by drag operations from this source.generated/jsx.ts:10001
icon?Gdk.Paintable | nullPaintable to use as the drag icon during DND operations.generated/jsx.ts:10035
iconHotX?numberX coordinate of the hotspot relative to the drag icon's top-left corner.generated/jsx.ts:10037
iconHotY?numberY coordinate of the hotspot relative to the drag icon's top-left corner.generated/jsx.ts:10039
onDragBegin()?(drag, self) => void | nullEmitted on the drag source when a drag is started. It can be used to e.g. set a custom drag icon with DragSource.set_icon.generated/jsx.ts:10008
onDragCancel()?(drag, reason, self) => boolean | nullEmitted on the drag source when a drag has failed. The signal handler may handle a failed drag operation based on the type of error. It should return %TRUE if the failure has been handled and the default "drag operation failed" animation should not be shown.generated/jsx.ts:10016
onDragEnd()?(drag, deleteData, self) => void | nullEmitted on the drag source when a drag is finished. A typical reason to connect to this signal is to undo things done in DragSource.:prepare or DragSource.:drag-begin handlers.generated/jsx.ts:10024
onPrepare()?(x, y, self) => Gdk.ContentProvider | nullEmitted when a drag is about to be initiated. It returns the GdkContentProvider to use for the drag that is about to start. The default handler for this signal returns the value of the DragSource.content property, so if you set up that property ahead of time, you don't need to connect to this signal.generated/jsx.ts:10033
ref?Ref<Gtk.DragSource>-generated/jsx.ts:10040