gtkmm
4.4.0
|
A Gdk::Drag holds information about a drag in progress. More...
#include <gdkmm/drag.h>
Inherits Object.
Public Member Functions | |
Drag (Drag&& src) noexcept | |
Drag& | operator= (Drag&& src) noexcept |
~Drag () noexcept override | |
GdkDrag* | gobj () |
Provides access to the underlying C GObject. More... | |
const GdkDrag* | gobj () const |
Provides access to the underlying C GObject. More... | |
GdkDrag* | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More... | |
Glib::RefPtr< Display > | get_display () |
Gets the GdkDisplay that the drag object was created for. More... | |
Glib::RefPtr< const Display > | get_display () const |
Gets the GdkDisplay that the drag object was created for. More... | |
Glib::RefPtr< Device > | get_device () |
Returns the GdkDevice associated to the GdkDrag object. More... | |
Glib::RefPtr< const Device > | get_device () const |
Returns the GdkDevice associated to the GdkDrag object. More... | |
Glib::RefPtr< ContentFormats > | get_formats () |
Retrieves the formats supported by this GdkDrag object. More... | |
Glib::RefPtr< const ContentFormats > | get_formats () const |
Retrieves the formats supported by this GdkDrag object. More... | |
DragAction | get_actions () const |
Determines the bitmask of possible actions proposed by the source. More... | |
DragAction | get_selected_action () const |
Determines the action chosen by the drag destination. More... | |
void | drag_drop_done (bool success) |
Informs GDK that the drop ended. More... | |
Glib::RefPtr< Surface > | get_drag_surface () |
Returns the surface on which the drag icon should be rendered during the drag operation. More... | |
Glib::RefPtr< const Surface > | get_drag_surface () const |
See the non-const version. More... | |
void | set_hotspot (int hot_x, int hot_y) |
Sets the position of the drag surface that will be kept under the cursor hotspot. More... | |
Glib::RefPtr< ContentProvider > | get_content () |
Returns the GdkContentProvider associated to the GdkDrag object. More... | |
Glib::RefPtr< const ContentProvider > | get_content () const |
Returns the GdkContentProvider associated to the GdkDrag object. More... | |
Glib::RefPtr< Surface > | get_surface () |
Returns the GdkSurface where the drag originates. More... | |
Glib::RefPtr< const Surface > | get_surface () const |
Returns the GdkSurface where the drag originates. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< ContentProvider > > | property_content () const |
The GdkContentProvider . More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Device > > | property_device () const |
The GdkDevice that is performing the drag. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Display > > | property_display () const |
The GdkDisplay that the drag belongs to. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< ContentFormats > > | property_formats () const |
The possible formats that the drag can provide its data in. More... | |
Glib::PropertyProxy< DragAction > | property_selected_action () |
The currently selected action of the drag. More... | |
Glib::PropertyProxy_ReadOnly< DragAction > | property_selected_action () const |
The currently selected action of the drag. More... | |
Glib::PropertyProxy< DragAction > | property_actions () |
The possible actions of this drag. More... | |
Glib::PropertyProxy_ReadOnly< DragAction > | property_actions () const |
The possible actions of this drag. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Surface > > | property_surface () const |
The surface where the drag originates. More... | |
Glib::SignalProxy< void(DragCancelReason)> | signal_cancel () |
Glib::SignalProxy< void()> | signal_drop_performed () |
Glib::SignalProxy< void()> | signal_dnd_finished () |
Static Public Member Functions | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
static bool | action_is_unique (DragAction action) |
Checks if action represents a single action or includes multiple actions. More... | |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Gdk::Drag > | wrap (GdkDrag* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
A Gdk::Drag holds information about a drag in progress.
It is used on both source and destination sides.
|
noexcept |
|
overridenoexcept |
|
static |
Checks if action represents a single action or includes multiple actions.
When action is 0 - ie no action was given, true
is returned.
action | A GdkDragAction . |
true
if exactly one action was given. void Gdk::Drag::drag_drop_done | ( | bool | success | ) |
Informs GDK that the drop ended.
Passing false
for success may trigger a drag cancellation animation.
This function is called by the drag source, and should be the last call before dropping the reference to the drag.
The GdkDrag
will only take the first [method Gdk.Drag.drop_done] call as effective, if this function is called multiple times, all subsequent calls will be ignored.
success | Whether the drag was ultimatively successful. |
DragAction Gdk::Drag::get_actions | ( | ) | const |
Determines the bitmask of possible actions proposed by the source.
GdkDragAction
flags. Glib::RefPtr<ContentProvider> Gdk::Drag::get_content | ( | ) |
Returns the GdkContentProvider
associated to the GdkDrag
object.
GdkContentProvider
associated to drag. Glib::RefPtr<const ContentProvider> Gdk::Drag::get_content | ( | ) | const |
Returns the GdkContentProvider
associated to the GdkDrag
object.
GdkContentProvider
associated to drag. Glib::RefPtr<Device> Gdk::Drag::get_device | ( | ) |
Returns the GdkDevice
associated to the GdkDrag
object.
GdkDevice
associated to drag. Glib::RefPtr<const Device> Gdk::Drag::get_device | ( | ) | const |
Returns the GdkDevice
associated to the GdkDrag
object.
GdkDevice
associated to drag. Glib::RefPtr<Display> Gdk::Drag::get_display | ( | ) |
Gets the GdkDisplay
that the drag object was created for.
GdkDisplay
. Glib::RefPtr<const Display> Gdk::Drag::get_display | ( | ) | const |
Gets the GdkDisplay
that the drag object was created for.
GdkDisplay
. Glib::RefPtr<Surface> Gdk::Drag::get_drag_surface | ( | ) |
Returns the surface on which the drag icon should be rendered during the drag operation.
Note that the surface may not be available until the drag operation has begun. GDK will move the surface in accordance with the ongoing drag operation. The surface will be destroyed when the drag operation is over.
The returned surface is usually a subclass of Gdk::Surface that implements the Gdk::DragSurface interface. To use drag surface API, do something like
Glib::RefPtr<const Surface> Gdk::Drag::get_drag_surface | ( | ) | const |
See the non-const version.
Glib::RefPtr<ContentFormats> Gdk::Drag::get_formats | ( | ) |
Retrieves the formats supported by this GdkDrag
object.
GdkContentFormats
. Glib::RefPtr<const ContentFormats> Gdk::Drag::get_formats | ( | ) | const |
Retrieves the formats supported by this GdkDrag
object.
GdkContentFormats
. DragAction Gdk::Drag::get_selected_action | ( | ) | const |
Determines the action chosen by the drag destination.
GdkDragAction
value. Glib::RefPtr<Surface> Gdk::Drag::get_surface | ( | ) |
Returns the GdkSurface
where the drag originates.
GdkSurface
where the drag originates. Glib::RefPtr<const Surface> Gdk::Drag::get_surface | ( | ) | const |
Returns the GdkSurface
where the drag originates.
GdkSurface
where the drag originates.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
GdkDrag* Gdk::Drag::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Glib::PropertyProxy< DragAction > Gdk::Drag::property_actions | ( | ) |
The possible actions of this drag.
Default value: 0
Glib::PropertyProxy_ReadOnly< DragAction > Gdk::Drag::property_actions | ( | ) | const |
The possible actions of this drag.
Default value: 0
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<ContentProvider> > Gdk::Drag::property_content | ( | ) | const |
The GdkContentProvider
.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Device> > Gdk::Drag::property_device | ( | ) | const |
The GdkDevice
that is performing the drag.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Display> > Gdk::Drag::property_display | ( | ) | const |
The GdkDisplay
that the drag belongs to.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<ContentFormats> > Gdk::Drag::property_formats | ( | ) | const |
The possible formats that the drag can provide its data in.
Glib::PropertyProxy< DragAction > Gdk::Drag::property_selected_action | ( | ) |
The currently selected action of the drag.
Default value: 0
Glib::PropertyProxy_ReadOnly< DragAction > Gdk::Drag::property_selected_action | ( | ) | const |
The currently selected action of the drag.
Default value: 0
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Surface> > Gdk::Drag::property_surface | ( | ) | const |
The surface where the drag originates.
void Gdk::Drag::set_hotspot | ( | int | hot_x, |
int | hot_y | ||
) |
Sets the position of the drag surface that will be kept under the cursor hotspot.
Initially, the hotspot is at the top left corner of the drag surface.
hot_x | X coordinate of the drag surface hotspot. |
hot_y | Y coordinate of the drag surface hotspot. |
Glib::SignalProxy<void(DragCancelReason)> Gdk::Drag::signal_cancel | ( | ) |
void on_my_cancel(DragCancelReason reason)
Flags: Run Last
Emitted when the drag operation is cancelled.
reason | The reason the drag was cancelled. |
Glib::SignalProxy<void()> Gdk::Drag::signal_dnd_finished | ( | ) |
void on_my_dnd_finished()
Flags: Run Last
Emitted when the destination side has finished reading all data.
The drag object can now free all miscellaneous data.
Glib::SignalProxy<void()> Gdk::Drag::signal_drop_performed | ( | ) |
void on_my_drop_performed()
Flags: Run Last
Emitted when the drop operation is performed on an accepting client.
|
related |
A Glib::wrap() method for this object.
object | The C instance. |
take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |