]> Pileus Git - ~andy/gtk/blob - gtk/gtkdnd.h
sync to tree changes
[~andy/gtk] / gtk / gtkdnd.h
1 /* GTK - The GIMP Toolkit
2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA 02111-1307, USA.
18  */
19
20 /*
21  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22  * file for a list of people on the GTK+ Team.  See the ChangeLog
23  * files for a list of changes.  These files are distributed with
24  * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
25  */
26
27 #ifndef __GTK_DND_H__
28 #define __GTK_DND_H__
29
30 #include <gdk/gdk.h>
31 #include <gtk/gtkenums.h>
32 #include <gtk/gtkwidget.h>
33 #include <gtk/gtkselection.h>
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif /* __cplusplus */
38
39 typedef enum {
40   GTK_DEST_DEFAULT_MOTION     = 1 << 0, /* respond to "drag_motion" */
41   GTK_DEST_DEFAULT_HIGHLIGHT  = 1 << 1, /* auto-highlight */
42   GTK_DEST_DEFAULT_DROP       = 1 << 2, /* respond to "drag_drop" */
43   GTK_DEST_DEFAULT_ALL        = 0x07
44 } GtkDestDefaults;
45
46 /* Flags for the GtkTargetEntry on the destination side 
47  */
48 typedef enum {
49   GTK_TARGET_SAME_APP = 1 << 0,    /*< nick=same-app >*/
50   GTK_TARGET_SAME_WIDGET = 1 << 1  /*< nick=same-widget >*/
51 } GtkTargetFlags;
52
53 /* Destination side */
54
55 void gtk_drag_get_data (GtkWidget      *widget,
56                         GdkDragContext *context,
57                         GdkAtom         target,
58                         guint32         time);
59 void gtk_drag_finish   (GdkDragContext *context,
60                         gboolean        success,
61                         gboolean        del,
62                         guint32         time);
63
64 GtkWidget *gtk_drag_get_source_widget (GdkDragContext *context);
65
66 void gtk_drag_highlight   (GtkWidget  *widget);
67 void gtk_drag_unhighlight (GtkWidget  *widget);
68
69 void gtk_drag_dest_set   (GtkWidget            *widget,
70                           GtkDestDefaults       flags,
71                           const GtkTargetEntry *targets,
72                           gint                  n_targets,
73                           GdkDragAction         actions);
74
75 void gtk_drag_dest_set_proxy (GtkWidget      *widget,
76                               GdkWindow      *proxy_window,
77                               GdkDragProtocol protocol,
78                               gboolean        use_coordinates);
79
80 void gtk_drag_dest_unset (GtkWidget          *widget);
81
82 GdkAtom        gtk_drag_dest_find_target     (GtkWidget      *widget,
83                                               GdkDragContext *context,
84                                               GtkTargetList  *target_list);
85 GtkTargetList* gtk_drag_dest_get_target_list (GtkWidget      *widget);
86 void           gtk_drag_dest_set_target_list (GtkWidget      *widget,
87                                               GtkTargetList  *target_list);
88
89 /* Source side */
90
91 void gtk_drag_source_set  (GtkWidget            *widget,
92                            GdkModifierType       start_button_mask,
93                            const GtkTargetEntry *targets,
94                            gint                  n_targets,
95                            GdkDragAction         actions);
96
97 void gtk_drag_source_unset (GtkWidget        *widget);
98
99 void gtk_drag_source_set_icon (GtkWidget     *widget,
100                                GdkColormap   *colormap,
101                                GdkPixmap     *pixmap,
102                                GdkBitmap     *mask);
103
104 /* There probably should be functions for setting the targets
105  * as a GtkTargetList
106  */
107
108 GdkDragContext *gtk_drag_begin (GtkWidget         *widget,
109                                 GtkTargetList     *targets,
110                                 GdkDragAction      actions,
111                                 gint               button,
112                                 GdkEvent          *event);
113
114 /* Set the image being dragged around
115  */
116 void gtk_drag_set_icon_widget  (GdkDragContext    *context,
117                                 GtkWidget         *widget,
118                                 gint               hot_x,
119                                 gint               hot_y);
120
121 void gtk_drag_set_icon_pixmap  (GdkDragContext    *context,
122                                 GdkColormap       *colormap,
123                                 GdkPixmap         *pixmap,
124                                 GdkBitmap         *mask,
125                                 gint               hot_x,
126                                 gint               hot_y);
127
128 void gtk_drag_set_icon_default (GdkDragContext    *context);
129
130 void gtk_drag_set_default_icon (GdkColormap   *colormap,
131                                 GdkPixmap     *pixmap,
132                                 GdkBitmap     *mask,
133                                 gint           hot_x,
134                                 gint           hot_y);
135
136
137 gboolean gtk_drag_check_threshold (GtkWidget *widget,
138                                    gint       start_x,
139                                    gint       start_y,
140                                    gint       current_x,
141                                    gint       current_y);
142
143 /* Internal functions */
144 void gtk_drag_source_handle_event (GtkWidget *widget,
145                                    GdkEvent  *event);
146 void gtk_drag_dest_handle_event (GtkWidget *toplevel,
147                                  GdkEvent  *event);
148
149 #ifdef __cplusplus
150 }
151 #endif /* __cplusplus */
152
153 #endif /* __GTK_DND_H__ */
154
155
156