drag_begin_with_coordinates

Description:


[ Version ( since = "3.10" ) ]
public unowned DragContext drag_begin_with_coordinates (Widget widget, TargetList targets, DragAction actions, int button, Event? event, int x, int y)

Initiates a drag on the source side.

The function only needs to be used when the application is starting drags itself, and is not needed when drag_source_set is used.

The event is used to retrieve the timestamp that will be used internally to grab the pointer. If event is null, then gdk_current_time will be used. However, you should try to pass a real event in all cases, since that can be used to get information about the drag.

Generally there are three cases when you want to start a drag by hand by calling this function:

  1. During a button_press_event handler, if you want to start a drag immediately when the user presses the mouse button. Pass the event that you have in your button_press_event handler.
  2. During a motion_notify_event handler, if you want to start a drag when the mouse moves past a certain threshold distance after a button-press. Pass the event that you have in your motion_notify_event handler.
  3. During a timeout handler, if you want to start a drag after the mouse button is held down for some time. Try to save the last event that you got from the mouse, using copy, and pass it to this function (remember to free the event with free when you are done). If you really cannot pass a real event, pass null instead.

Parameters:

this

the source widget
targets

The targets (data formats) in which the source can provide the data
actions

A bitmask of the allowed drag actions for this drag
button

The button the user clicked to start the drag
event

The event that triggered the start of the drag, or null if none can be obtained.
x

The initial x coordinate to start dragging from, in the coordinate space of this. If -1 is passed, the coordinates are retrieved from event or the current pointer position
y

The initial y coordinate to start dragging from, in the coordinate space of this. If -1 is passed, the coordinates are retrieved from event or the current pointer position

Returns:

the context for this drag

Namespace: Gtk
Package: gtk+-3.0