diff options
author | Matthias Clasen <mclasen@redhat.com> | 2020-01-09 00:50:33 -0500 |
---|---|---|
committer | Matthias Clasen <mclasen@redhat.com> | 2020-01-09 00:50:33 -0500 |
commit | a51ee20ed9700c4632ad3abfa2f311624ea18b14 (patch) | |
tree | 4e8d8c5683160b3a2a83546f5b84a05a42a99692 /gtk/gtkdragicon.c | |
parent | 8d3e1eb3144af4a0769c76239dcf806d9d33bd82 (diff) | |
download | gtk+-a51ee20ed9700c4632ad3abfa2f311624ea18b14.tar.gz |
dragicon: Add docs
Diffstat (limited to 'gtk/gtkdragicon.c')
-rw-r--r-- | gtk/gtkdragicon.c | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/gtk/gtkdragicon.c b/gtk/gtkdragicon.c index 48ac83d3a1..ae36e1e1dc 100644 --- a/gtk/gtkdragicon.c +++ b/gtk/gtkdragicon.c @@ -27,6 +27,21 @@ #include "gtkpicture.h" +/** + * SECTION:gtkdragicon + * @Short_description: A toplevel to use as drag icon + * @Title: GtkDragIcon + * + * GtkDragIcon is a #GtkNative implementation with the sole purpose + * to serve as a drag icon during DND operations. A drag icon moves + * with the pointer during a drag operation and is destroyed when + * the drag ends. + * + * To set up a drag icon and associate it with an ongoing drag operation, + * use gtk_drag_icon_set_from_paintable(). It is also possible to create + * a GtkDragIcon with gtk_drag_icon_new_for_drag(() and populate it + * with widgets yourself. + */ struct _GtkDragIcon { GtkWidget parent_instance; @@ -376,6 +391,14 @@ gtk_drag_icon_new (void) return g_object_new (GTK_TYPE_DRAG_ICON, NULL); } +/** + * gtk_drag_icon_new_for_drag: + * @drag: a #GtkDrag + * + * Creates a #GtkDragIcon and associates it with the drag operation. + * + * Returns: the new #GtkDragIcon + */ GtkWidget * gtk_drag_icon_new_for_drag (GdkDrag *drag) { @@ -390,6 +413,17 @@ gtk_drag_icon_new_for_drag (GdkDrag *drag) return icon; } +/** + * gtk_drag_icon_set_from_paintable: + * @drag: a #GdkDrag + * @paintable: a #GdkPaintable to display + * @hot_x: X coordinate of the hotspot + * @hot_y: Y coordinate of the hotspot + * + * Creates a #GtkDragIcon that shows @paintable, and associates + * it with the drag operation. The hotspot position on the paintable + * is aligned with the hotspot of the cursor. + */ void gtk_drag_icon_set_from_paintable (GdkDrag *drag, GdkPaintable *paintable, |