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 G_BEGIN_DECLS
  36
  37 typedef enum {
  38   GTK_DEST_DEFAULT_MOTION     = 1 << 0, /* respond to "drag_motion" */
  39   GTK_DEST_DEFAULT_HIGHLIGHT  = 1 << 1, /* auto-highlight */
  40   GTK_DEST_DEFAULT_DROP       = 1 << 2, /* respond to "drag_drop" */
  41   GTK_DEST_DEFAULT_ALL        = 0x07
  42 } GtkDestDefaults;
  43
  44 /* Flags for the GtkTargetEntry on the destination side
  45  */
  46 typedef enum {
  47   GTK_TARGET_SAME_APP = 1 << 0,    /*< nick=same-app >*/
  48   GTK_TARGET_SAME_WIDGET = 1 << 1  /*< nick=same-widget >*/
  49 } GtkTargetFlags;
  50
  51 /* Destination side */
  52
  53 void gtk_drag_get_data (GtkWidget      *widget,
  54                         GdkDragContext *context,
  55                         GdkAtom         target,
  56                         guint32         time_);
  57 void gtk_drag_finish   (GdkDragContext *context,
  58                         gboolean        success,
  59                         gboolean        del,
  60                         guint32         time_);
  61
  62 GtkWidget *gtk_drag_get_source_widget (GdkDragContext *context);
  63
  64 void gtk_drag_highlight   (GtkWidget  *widget);
  65 void gtk_drag_unhighlight (GtkWidget  *widget);
  66
  67 void gtk_drag_dest_set   (GtkWidget            *widget,
  68                           GtkDestDefaults       flags,
  69                           const GtkTargetEntry *targets,
  70                           gint                  n_targets,
  71                           GdkDragAction         actions);
  72
  73 void gtk_drag_dest_set_proxy (GtkWidget      *widget,
  74                               GdkWindow      *proxy_window,
  75                               GdkDragProtocol protocol,
  76                               gboolean        use_coordinates);
  77
  78 void gtk_drag_dest_unset (GtkWidget          *widget);
  79
  80 GdkAtom        gtk_drag_dest_find_target     (GtkWidget      *widget,
  81                                               GdkDragContext *context,
  82                                               GtkTargetList  *target_list);
  83 GtkTargetList* gtk_drag_dest_get_target_list (GtkWidget      *widget);
  84 void           gtk_drag_dest_set_target_list (GtkWidget      *widget,
  85                                               GtkTargetList  *target_list);
  86 void           gtk_drag_dest_add_text_targets  (GtkWidget    *widget);
  87 void           gtk_drag_dest_add_image_targets (GtkWidget    *widget);
  88 void           gtk_drag_dest_add_uri_targets   (GtkWidget    *widget);
  89
  90 /* Source side */
  91
  92 void gtk_drag_source_set  (GtkWidget            *widget,
  93                            GdkModifierType       start_button_mask,
  94                            const GtkTargetEntry *targets,
  95                            gint                  n_targets,
  96                            GdkDragAction         actions);
  97
  98 void gtk_drag_source_unset (GtkWidget        *widget);
  99
 100 GtkTargetList* gtk_drag_source_get_target_list (GtkWidget     *widget);
 101 void           gtk_drag_source_set_target_list (GtkWidget     *widget,
 102                                                 GtkTargetList *target_list);
 103 void           gtk_drag_source_add_text_targets  (GtkWidget     *widget);
 104 void           gtk_drag_source_add_image_targets (GtkWidget    *widget);
 105 void           gtk_drag_source_add_uri_targets   (GtkWidget    *widget);
 106
 107 void gtk_drag_source_set_icon        (GtkWidget   *widget,
 108                                       GdkColormap *colormap,
 109                                       GdkPixmap   *pixmap,
 110                                       GdkBitmap   *mask);
 111 void gtk_drag_source_set_icon_pixbuf (GtkWidget   *widget,
 112                                       GdkPixbuf   *pixbuf);
 113 void gtk_drag_source_set_icon_stock  (GtkWidget   *widget,
 114                                       const gchar *stock_id);
 115
 116 /* There probably should be functions for setting the targets
 117  * as a GtkTargetList
 118  */
 119
 120 GdkDragContext *gtk_drag_begin (GtkWidget         *widget,
 121                                 GtkTargetList     *targets,
 122                                 GdkDragAction      actions,
 123                                 gint               button,
 124                                 GdkEvent          *event);
 125
 126 /* Set the image being dragged around
 127  */
 128 void gtk_drag_set_icon_widget (GdkDragContext *context,
 129                                GtkWidget      *widget,
 130                                gint            hot_x,
 131                                gint            hot_y);
 132 void gtk_drag_set_icon_pixmap (GdkDragContext *context,
 133                                GdkColormap    *colormap,
 134                                GdkPixmap      *pixmap,
 135                                GdkBitmap      *mask,
 136                                gint            hot_x,
 137                                gint            hot_y);
 138 void gtk_drag_set_icon_pixbuf (GdkDragContext *context,
 139                                GdkPixbuf      *pixbuf,
 140                                gint            hot_x,
 141                                gint            hot_y);
 142 void gtk_drag_set_icon_stock  (GdkDragContext *context,
 143                                const gchar    *stock_id,
 144                                gint            hot_x,
 145                                gint            hot_y);
 146
 147 void gtk_drag_set_icon_default (GdkDragContext    *context);
 148
 149 gboolean gtk_drag_check_threshold (GtkWidget *widget,
 150                                    gint       start_x,
 151                                    gint       start_y,
 152                                    gint       current_x,
 153                                    gint       current_y);
 154
 155 /* Internal functions */
 156 void _gtk_drag_source_handle_event (GtkWidget *widget,
 157                                     GdkEvent  *event);
 158 void _gtk_drag_dest_handle_event (GtkWidget *toplevel,
 159                                   GdkEvent  *event);
 160
 161 #ifndef GTK_DISABLE_DEPRECATED
 162 void gtk_drag_set_default_icon (GdkColormap   *colormap,
 163                                 GdkPixmap     *pixmap,
 164                                 GdkBitmap     *mask,
 165                                 gint           hot_x,
 166                                 gint           hot_y);
 167 #endif /* !GTK_DISABLE_DEPRECATED */
 168
 169 G_END_DECLS
 170
 171 #endif /* __GTK_DND_H__ */
 172
 173
 174