Pileus Git - ~andy/gtk/blob - 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 void gtk_drag_source_set_icon_pixbuf (GtkWidget   *widget,
 104                                       GdkPixbuf   *pixbuf);
 105 void gtk_drag_source_set_icon_stock  (GtkWidget   *widget,
 106                                       const gchar *stock_id);
 107
 108 /* There probably should be functions for setting the targets
 109  * as a GtkTargetList
 110  */
 111
 112 GdkDragContext *gtk_drag_begin (GtkWidget         *widget,
 113                                 GtkTargetList     *targets,
 114                                 GdkDragAction      actions,
 115                                 gint               button,
 116                                 GdkEvent          *event);
 117
 118 /* Set the image being dragged around
 119  */
 120 void gtk_drag_set_icon_widget (GdkDragContext *context,
 121                                GtkWidget      *widget,
 122                                gint            hot_x,
 123                                gint            hot_y);
 124 void gtk_drag_set_icon_pixmap (GdkDragContext *context,
 125                                GdkColormap    *colormap,
 126                                GdkPixmap      *pixmap,
 127                                GdkBitmap      *mask,
 128                                gint            hot_x,
 129                                gint            hot_y);
 130 void gtk_drag_set_icon_pixbuf (GdkDragContext *context,
 131                                GdkPixbuf      *pixbuf,
 132                                gint            hot_x,
 133                                gint            hot_y);
 134 void gtk_drag_set_icon_stock  (GdkDragContext *context,
 135                                const gchar    *stock_id,
 136                                gint            hot_x,
 137                                gint            hot_y);
 138
 139 void gtk_drag_set_icon_default (GdkDragContext    *context);
 140
 141 gboolean gtk_drag_check_threshold (GtkWidget *widget,
 142                                    gint       start_x,
 143                                    gint       start_y,
 144                                    gint       current_x,
 145                                    gint       current_y);
 146
 147 /* Internal functions */
 148 void _gtk_drag_source_handle_event (GtkWidget *widget,
 149                                     GdkEvent  *event);
 150 void _gtk_drag_dest_handle_event (GtkWidget *toplevel,
 151                                   GdkEvent  *event);
 152
 153 #ifndef GTK_DISABLE_DEPRECATED
 154 void gtk_drag_set_default_icon (GdkColormap   *colormap,
 155                                 GdkPixmap     *pixmap,
 156                                 GdkBitmap     *mask,
 157                                 gint           hot_x,
 158                                 gint           hot_y);
 159 #endif /* !GTK_DISABLE_DEPRECATED */
 160
 161 #ifdef __cplusplus
 162 }
 163 #endif /* __cplusplus */
 164
 165 #endif /* __GTK_DND_H__ */
 166
 167
 168