summaryrefslogtreecommitdiff
path: root/gtk/gtkdnd.h
diff options
context:
space:
mode:
authorJavier Jardón <jjardon@gnome.org>2011-04-18 01:10:14 +0100
committerJavier Jardón <jjardon@gnome.org>2011-04-18 02:08:37 +0100
commitf7b7e8a6b833f8a8ff5aa39f49ef75c71de887ec (patch)
tree50cf681345190e9ab23deb2964b9d298a47d30e8 /gtk/gtkdnd.h
parent911ae509566346a568d24ff913635c0b91a6ab75 (diff)
downloadgtk+-f7b7e8a6b833f8a8ff5aa39f49ef75c71de887ec.tar.gz
Move documentation to inline comments: GtkDnd
Diffstat (limited to 'gtk/gtkdnd.h')
-rw-r--r--gtk/gtkdnd.h36
1 files changed, 35 insertions, 1 deletions
diff --git a/gtk/gtkdnd.h b/gtk/gtkdnd.h
index bb2336df9b..a2dcab6a33 100644
--- a/gtk/gtkdnd.h
+++ b/gtk/gtkdnd.h
@@ -39,6 +39,28 @@
G_BEGIN_DECLS
+/**
+ * GtkDestDefaults:
+ * @GTK_DEST_DEFAULT_MOTION: If set for a widget, GTK+, during a drag over this
+ * widget will check if the drag matches this widget's list of possible targets
+ * and actions.
+ * GTK+ will then call gdk_drag_status() as appropriate.
+ * @GTK_DEST_DEFAULT_HIGHLIGHT: If set for a widget, GTK+ will draw a highlight on
+ * this widget as long as a drag is over this widget and the widget drag format
+ * and action are acceptable.
+ * @GTK_DEST_DEFAULT_DROP: If set for a widget, when a drop occurs, GTK+ will
+ * will check if the drag matches this widget's list of possible targets and
+ * actions. If so, GTK+ will call gtk_drag_get_data() on behalf of the widget.
+ * Whether or not the drop is successful, GTK+ will call gtk_drag_finish(). If
+ * the action was a move, then if the drag was successful, then %TRUE will be
+ * passed for the @delete parameter to gtk_drag_finish().
+ * @GTK_DEST_DEFAULT_ALL: If set, specifies that all default actions should
+ * be taken.
+ *
+ * The #GtkDestDefaults enumeration specifies the various
+ * types of action that will be taken on behalf
+ * of the user for a drag destination site.
+ */
typedef enum {
GTK_DEST_DEFAULT_MOTION = 1 << 0, /* respond to "drag_motion" */
GTK_DEST_DEFAULT_HIGHLIGHT = 1 << 1, /* auto-highlight */
@@ -46,7 +68,19 @@ typedef enum {
GTK_DEST_DEFAULT_ALL = 0x07
} GtkDestDefaults;
-/* Flags for the GtkTargetEntry on the destination side
+/**
+ * GtkTargetFlags:
+ * @GTK_TARGET_SAME_APP: If this is set, the target will only be selected
+ * for drags within a single application.
+ * @GTK_TARGET_SAME_WIDGET: If this is set, the target will only be selected
+ * for drags within a single widget.
+ * @GTK_TARGET_OTHER_APP: If this is set, the target will not be selected
+ * for drags within a single application.
+ * @GTK_TARGET_OTHER_WIDGET: If this is set, the target will not be selected
+ * for drags withing a single widget.
+ *
+ * The #GtkTargetFlags enumeration is used to specify
+ * constraints on an entry in a #GtkTargetTable.
*/
typedef enum {
GTK_TARGET_SAME_APP = 1 << 0, /*< nick=same-app >*/