Pileus Git - ~andy/gtk/blob - gdk/gdkdnd.h

   1 /* GDK - The GIMP Drawing Kit
   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 #if !defined (__GDK_H_INSIDE__) && !defined (GDK_COMPILATION)
  28 #error "Only <gdk/gdk.h> can be included directly."
  29 #endif
  30
  31 #ifndef __GDK_DND_H__
  32 #define __GDK_DND_H__
  33
  34 #include <gdk/gdktypes.h>
  35 #include <gdk/gdkdevice.h>
  36
  37 G_BEGIN_DECLS
  38
  39 /* Object that holds information about a drag in progress.
  40  * this is used on both source and destination sides.
  41  */
  42 typedef struct _GdkDragContext        GdkDragContext;
  43 typedef struct _GdkDragContextClass GdkDragContextClass;
  44
  45 /**
  46  * GdkDragAction:
  47  * @GDK_ACTION_DEFAULT: Means nothing, and should not be used.
  48  * @GDK_ACTION_COPY: Copy the data.
  49  * @GDK_ACTION_MOVE: Move the data, i.e. first copy it, then delete
  50  *  it from the source using the DELETE target of the X selection protocol.
  51  * @GDK_ACTION_LINK: Add a link to the data. Note that this is only
  52  *  useful if source and destination agree on what it means.
  53  * @GDK_ACTION_PRIVATE: Special action which tells the source that the
  54  *  destination will do something that the source doesn't understand.
  55  * @GDK_ACTION_ASK: Ask the user what to do with the data.
  56  *
  57  * Used in #GdkDragContext to indicate what the destination
  58  * should do with the dropped data.
  59  */
  60 typedef enum
  61 {
  62   GDK_ACTION_DEFAULT = 1 << 0,
  63   GDK_ACTION_COPY    = 1 << 1,
  64   GDK_ACTION_MOVE    = 1 << 2,
  65   GDK_ACTION_LINK    = 1 << 3,
  66   GDK_ACTION_PRIVATE = 1 << 4,
  67   GDK_ACTION_ASK     = 1 << 5
  68 } GdkDragAction;
  69
  70 /**
  71  * GdkDragProtocol:
  72  * @GDK_DRAG_PROTO_MOTIF: The Motif DND protocol.
  73  * @GDK_DRAG_PROTO_XDND: The Xdnd protocol.
  74  * @GDK_DRAG_PROTO_ROOTWIN: An extension to the Xdnd protocol for
  75  *  unclaimed root window drops.
  76  * @GDK_DRAG_PROTO_NONE: no protocol.
  77  * @GDK_DRAG_PROTO_WIN32_DROPFILES: The simple WM_DROPFILES protocol.
  78  * @GDK_DRAG_PROTO_OLE2: The complex OLE2 DND protocol (not implemented).
  79  * @GDK_DRAG_PROTO_LOCAL: Intra-application DND.
  80  *
  81  * Used in #GdkDragContext to indicate the protocol according to
  82  * which DND is done.
  83  */
  84 typedef enum
  85 {
  86   GDK_DRAG_PROTO_MOTIF,
  87   GDK_DRAG_PROTO_XDND,
  88   GDK_DRAG_PROTO_ROOTWIN,
  89   GDK_DRAG_PROTO_NONE,
  90   GDK_DRAG_PROTO_WIN32_DROPFILES,
  91   GDK_DRAG_PROTO_OLE2,
  92   GDK_DRAG_PROTO_LOCAL
  93 } GdkDragProtocol;
  94
  95
  96 #define GDK_TYPE_DRAG_CONTEXT              (gdk_drag_context_get_type ())
  97 #define GDK_DRAG_CONTEXT(object)           (G_TYPE_CHECK_INSTANCE_CAST ((object), GDK_TYPE_DRAG_CONTEXT, GdkDragContext))
  98 #define GDK_DRAG_CONTEXT_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GDK_TYPE_DRAG_CONTEXT, GdkDragContextClass))
  99 #define GDK_IS_DRAG_CONTEXT(object)        (G_TYPE_CHECK_INSTANCE_TYPE ((object), GDK_TYPE_DRAG_CONTEXT))
 100 #define GDK_IS_DRAG_CONTEXT_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GDK_TYPE_DRAG_CONTEXT))
 101 #define GDK_DRAG_CONTEXT_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GDK_TYPE_DRAG_CONTEXT, GdkDragContextClass))
 102
 103
 104 GType            gdk_drag_context_get_type             (void) G_GNUC_CONST;
 105
 106 void             gdk_drag_context_set_device           (GdkDragContext *context,
 107                                                         GdkDevice      *device);
 108 GdkDevice *      gdk_drag_context_get_device           (GdkDragContext *context);
 109
 110 GList           *gdk_drag_context_list_targets         (GdkDragContext *context);
 111 GdkDragAction    gdk_drag_context_get_actions          (GdkDragContext *context);
 112 GdkDragAction    gdk_drag_context_get_suggested_action (GdkDragContext *context);
 113 GdkDragAction    gdk_drag_context_get_selected_action  (GdkDragContext *context);
 114
 115 GdkWindow       *gdk_drag_context_get_source_window    (GdkDragContext *context);
 116 GdkWindow       *gdk_drag_context_get_dest_window      (GdkDragContext *context);
 117 GdkDragProtocol  gdk_drag_context_get_protocol         (GdkDragContext *context);
 118
 119 /* Destination side */
 120
 121 void             gdk_drag_status        (GdkDragContext   *context,
 122                                          GdkDragAction     action,
 123                                          guint32           time_);
 124 void             gdk_drop_reply         (GdkDragContext   *context,
 125                                          gboolean          ok,
 126                                          guint32           time_);
 127 void             gdk_drop_finish        (GdkDragContext   *context,
 128                                          gboolean          success,
 129                                          guint32           time_);
 130 GdkAtom          gdk_drag_get_selection (GdkDragContext   *context);
 131
 132 /* Source side */
 133
 134 GdkDragContext * gdk_drag_begin            (GdkWindow      *window,
 135                                             GList          *targets);
 136
 137 GdkDragContext * gdk_drag_begin_for_device (GdkWindow      *window,
 138                                             GdkDevice      *device,
 139                                             GList          *targets);
 140
 141 GdkNativeWindow gdk_drag_get_protocol_for_display (GdkDisplay       *display,
 142                                                    GdkNativeWindow   xid,
 143                                                    GdkDragProtocol  *protocol);
 144
 145 void    gdk_drag_find_window_for_screen   (GdkDragContext   *context,
 146                                            GdkWindow        *drag_window,
 147                                            GdkScreen        *screen,
 148                                            gint              x_root,
 149                                            gint              y_root,
 150                                            GdkWindow       **dest_window,
 151                                            GdkDragProtocol  *protocol);
 152
 153 gboolean        gdk_drag_motion      (GdkDragContext *context,
 154                                       GdkWindow      *dest_window,
 155                                       GdkDragProtocol protocol,
 156                                       gint            x_root,
 157                                       gint            y_root,
 158                                       GdkDragAction   suggested_action,
 159                                       GdkDragAction   possible_actions,
 160                                       guint32         time_);
 161 void            gdk_drag_drop        (GdkDragContext *context,
 162                                       guint32         time_);
 163 void            gdk_drag_abort       (GdkDragContext *context,
 164                                       guint32         time_);
 165 gboolean        gdk_drag_drop_succeeded (GdkDragContext *context);
 166
 167 G_END_DECLS
 168
 169 #endif /* __GDK_DND_H__ */