Pileus Git - ~andy/gtk/blob - gtk/gtkselection.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_SELECTION_H__
  28 #define __GTK_SELECTION_H__
  29
  30
  31 #include <gdk/gdk.h>
  32 #include <gtk/gtkenums.h>
  33 #include <gtk/gtkwidget.h>
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif /* __cplusplus */
  38
  39 typedef struct _GtkTargetList    GtkTargetList;
  40 typedef struct _GtkTargetEntry   GtkTargetEntry;
  41
  42 #define GTK_TYPE_SELECTION_DATA (gtk_selection_data_get_type ())
  43
  44 /* The contents of a selection are returned in a GtkSelectionData
  45  * structure. selection/target identify the request.  type specifies
  46  * the type of the return; if length < 0, and the data should be
  47  * ignored. This structure has object semantics - no fields should be
  48  * modified directly, they should not be created directly, and
  49  * pointers to them should not be stored beyond the duration of a
  50  * callback. (If the last is changed, we'll need to add reference
  51  * counting.) The time field gives the timestamp at which the data was
  52  * sent.
  53  */
  54
  55 struct _GtkSelectionData
  56 {
  57   GdkAtom       selection;
  58   GdkAtom       target;
  59   GdkAtom       type;
  60   gint          format;
  61   guchar       *data;
  62   gint          length;
  63   GdkDisplay   *display;
  64 };
  65
  66 struct _GtkTargetEntry {
  67   gchar *target;
  68   guint  flags;
  69   guint  info;
  70 };
  71
  72 /* These structures not public, and are here only for the convenience of
  73  * gtkdnd.c
  74  */
  75
  76 typedef struct _GtkTargetPair GtkTargetPair;
  77
  78 /* This structure is a list of destinations, and associated guint id's */
  79 struct _GtkTargetList {
  80   GList *list;
  81   guint ref_count;
  82 };
  83
  84 struct _GtkTargetPair {
  85   GdkAtom   target;
  86   guint     flags;
  87   guint     info;
  88 };
  89
  90 GtkTargetList *gtk_target_list_new       (const GtkTargetEntry *targets,
  91                                           guint                 ntargets);
  92 void           gtk_target_list_ref       (GtkTargetList  *list);
  93 void           gtk_target_list_unref     (GtkTargetList  *list);
  94 void           gtk_target_list_add       (GtkTargetList  *list,
  95                                           GdkAtom         target,
  96                                           guint           flags,
  97                                           guint           info);
  98 void           gtk_target_list_add_text_targets (GtkTargetList  *list);
  99 void           gtk_target_list_add_image_targets (GtkTargetList  *list,
 100                                                   gboolean        writable);
 101 void           gtk_target_list_add_table (GtkTargetList        *list,
 102                                           const GtkTargetEntry *targets,
 103                                           guint                 ntargets);
 104 void           gtk_target_list_remove    (GtkTargetList  *list,
 105                                           GdkAtom         target);
 106 gboolean       gtk_target_list_find      (GtkTargetList  *list,
 107                                           GdkAtom         target,
 108                                           guint          *info);
 109
 110 /* Public interface */
 111
 112 gboolean gtk_selection_owner_set             (GtkWidget  *widget,
 113                                               GdkAtom     selection,
 114                                               guint32     time_);
 115 gboolean gtk_selection_owner_set_for_display (GdkDisplay *display,
 116                                               GtkWidget  *widget,
 117                                               GdkAtom     selection,
 118                                               guint32     time_);
 119
 120 void     gtk_selection_add_target    (GtkWidget            *widget,
 121                                       GdkAtom               selection,
 122                                       GdkAtom               target,
 123                                       guint                 info);
 124 void     gtk_selection_add_targets   (GtkWidget            *widget,
 125                                       GdkAtom               selection,
 126                                       const GtkTargetEntry *targets,
 127                                       guint                 ntargets);
 128 void     gtk_selection_clear_targets (GtkWidget            *widget,
 129                                       GdkAtom               selection);
 130 gboolean gtk_selection_convert       (GtkWidget            *widget,
 131                                       GdkAtom               selection,
 132                                       GdkAtom               target,
 133                                       guint32               time_);
 134 void     gtk_selection_data_set      (GtkSelectionData     *selection_data,
 135                                       GdkAtom               type,
 136                                       gint                  format,
 137                                       const guchar         *data,
 138                                       gint                  length);
 139 gboolean gtk_selection_data_set_text (GtkSelectionData     *selection_data,
 140                                       const gchar          *str,
 141                                       gint                  len);
 142 guchar * gtk_selection_data_get_text (GtkSelectionData     *selection_data);
 143 gboolean gtk_selection_data_set_pixbuf (GtkSelectionData   *selection_data,
 144                                         GdkPixbuf          *pixbuf);
 145 GdkPixbuf *gtk_selection_data_get_pixbuf (GtkSelectionData *selection_data);
 146
 147 gboolean gtk_selection_data_get_targets          (GtkSelectionData  *selection_data,
 148                                                   GdkAtom          **targets,
 149                                                   gint              *n_atoms);
 150 gboolean gtk_selection_data_targets_include_text (GtkSelectionData  *selection_data);
 151
 152 /* Called when a widget is destroyed */
 153
 154 void gtk_selection_remove_all      (GtkWidget *widget);
 155
 156 /* Event handlers */
 157 #if !defined(GTK_DISABLE_DEPRECATED) || defined (GTK_COMPILATION)
 158 gboolean gtk_selection_clear              (GtkWidget         *widget,
 159                                            GdkEventSelection *event);
 160 #endif
 161 gboolean _gtk_selection_request           (GtkWidget         *widget,
 162                                            GdkEventSelection *event);
 163 gboolean _gtk_selection_incr_event        (GdkWindow         *window,
 164                                            GdkEventProperty  *event);
 165 gboolean _gtk_selection_notify            (GtkWidget         *widget,
 166                                            GdkEventSelection *event);
 167 gboolean _gtk_selection_property_notify   (GtkWidget         *widget,
 168                                            GdkEventProperty  *event);
 169
 170 GType             gtk_selection_data_get_type (void);
 171 GtkSelectionData *gtk_selection_data_copy     (GtkSelectionData *data);
 172 void              gtk_selection_data_free     (GtkSelectionData *data);
 173
 174
 175
 176 #ifdef __cplusplus
 177 }
 178 #endif /* __cplusplus */
 179
 180
 181 #endif /* __GTK_SELECTION_H__ */