Drag

The gdk.drag.Drag object represents the source of an ongoing DND operation.

A gdk.drag.Drag is created when a drag is started, and stays alive for duration of the DND operation. After a drag has been started with gdk.drag.Drag.begin, the caller gets informed about the status of the ongoing drag operation with signals on the gdk.drag.Drag object.

GTK provides a higher level abstraction based on top of these functions, and so they are not normally needed in GTK applications. See the "Drag and Drop" section of the GTK documentation for more information.

class Drag : ObjectG {

static gdk.drag.Drag begin(gdk.surface.Surface surface, gdk.device.Device device, gdk.content_provider.ContentProvider content, gdk.types.DragAction actions, double dx, double dy);

void dropDone(bool success);

gdk.types.DragAction getActions();

gdk.content_provider.ContentProvider getContent();

gdk.device.Device getDevice();

gdk.display.Display getDisplay();

gdk.surface.Surface getDragSurface();

gdk.content_formats.ContentFormats getFormats();

gdk.types.DragAction getSelectedAction();

gdk.surface.Surface getSurface();

void setHotspot(int hotX, int hotY);

ulong connectCancel(T callback, Flag!"After" after);

ulong connectDndFinished(T callback, Flag!"After" after);

ulong connectDropPerformed(T callback, Flag!"After" after);

}

Members

Functions

connectCancel ulong connectCancel(T callback, Flag!"After" after): Connect to Cancel signal.
connectDndFinished ulong connectDndFinished(T callback, Flag!"After" after): Connect to DndFinished signal.
connectDropPerformed ulong connectDropPerformed(T callback, Flag!"After" after): Connect to DropPerformed signal.
dropDone void dropDone(bool success): Informs GDK that the drop ended.
getActions gdk.types.DragAction getActions(): Determines the bitmask of possible actions proposed by the source.
getContent gdk.content_provider.ContentProvider getContent(): Returns the gdk.content_provider.ContentProvider associated to the gdk.drag.Drag object.
getDevice gdk.device.Device getDevice(): Returns the gdk.device.Device associated to the gdk.drag.Drag object.
getDisplay gdk.display.Display getDisplay(): Gets the gdk.display.Display that the drag object was created for.
getDragSurface gdk.surface.Surface getDragSurface(): Returns the surface on which the drag icon should be rendered during the drag operation.
getFormats gdk.content_formats.ContentFormats getFormats(): Retrieves the formats supported by this gdk.drag.Drag object.
getSelectedAction gdk.types.DragAction getSelectedAction(): Determines the action chosen by the drag destination.
getSurface gdk.surface.Surface getSurface(): Returns the gdk.surface.Surface where the drag originates.
setHotspot void setHotspot(int hotX, int hotY): Sets the position of the drag surface that will be kept under the cursor hotspot.

Static functions

begin gdk.drag.Drag begin(gdk.surface.Surface surface, gdk.device.Device device, gdk.content_provider.ContentProvider content, gdk.types.DragAction actions, double dx, double dy): Starts a drag and creates a new drag context for it.

Inherited Members

From ObjectG

setGObject void setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectG wrapper.
cPtr void* cPtr(Flag!"Dup" dup): Get a pointer to the underlying C object.
ref_ void* ref_(void* gObj): Calls g_object_ref() on a GObject.
unref unref(void* gObj): Calls g_object_unref() on a GObject.
getType GType getType(): Get the GType of an object.
gType GType gType [@property getter]: GObject GType property.
self ObjectG self(): Convenience method to return this cast to a type. For use in D with statements.
getDObject T getDObject(void* cptr, Flag!"Take" take): Template to get the D object from a C GObject and cast it to the given D object type.
connectSignalClosure ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after): Connect a D closure to an object signal.
setProperty void setProperty(string propertyName, T val): Template for setting a GObject property.
getProperty T getProperty(string propertyName): Template for getting a GObject property.
compatControl size_t compatControl(size_t what, void* data)
bindProperty gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags): Creates a binding between source_property on source and target_property on target.
bindPropertyFull gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom): Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.
forceFloating void forceFloating(): This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectG.refSink.
freezeNotify void freezeNotify(): Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.
getData void* getData(string key): Gets a named field from the objects table of associations (see gobject.object.ObjectG.setData).
getProperty void getProperty(string propertyName, gobject.value.Value value): Gets a property of an object.
getQdata void* getQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.
getv void getv(string[] names, gobject.value.Value[] values): Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
isFloating bool isFloating(): Checks whether object has a floating[floating-ref] reference.
notify void notify(string propertyName): Emits a "notify" signal for the property property_name on object.
notifyByPspec void notifyByPspec(gobject.param_spec.ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
refSink gobject.object.ObjectG refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
runDispose void runDispose(): Releases all references to other objects. This can be used to break reference cycles.
setData void setData(string key, void* data): Each object carries around a table of associations from strings to pointers. This function lets you set an association.
setProperty void setProperty(string propertyName, gobject.value.Value value): Sets a property on an object.
stealData void* stealData(string key): Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
stealQdata void* stealQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:
thawNotify void thawNotify(): Reverts the effect of a previous call to gobject.object.ObjectG.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
watchClosure void watchClosure(gobject.closure.Closure closure): This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectG.ref_ and gobject.object.ObjectG.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.
connectNotify ulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.

gdk drag classes

Drag