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 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  28 #error "Only <gtk/gtk.h> can be included directly."
  29 #endif
  30
  31 #ifndef __GTK_SELECTION_H__
  32 #define __GTK_SELECTION_H__
  33
  34
  35 #include <gtk/gtkwidget.h>
  36 #include <gtk/gtktextiter.h>
  37
  38
  39 G_BEGIN_DECLS
  40
  41 typedef struct _GtkTargetList    GtkTargetList;
  42 typedef struct _GtkTargetEntry   GtkTargetEntry;
  43
  44 #define GTK_TYPE_SELECTION_DATA (gtk_selection_data_get_type ())
  45 #define GTK_TYPE_TARGET_LIST    (gtk_target_list_get_type ())
  46
  47 /* The contents of a selection are returned in a GtkSelectionData
  48  * structure. selection/target identify the request.  type specifies
  49  * the type of the return; if length < 0, and the data should be
  50  * ignored. This structure has object semantics - no fields should be
  51  * modified directly, they should not be created directly, and
  52  * pointers to them should not be stored beyond the duration of a
  53  * callback. (If the last is changed, we'll need to add reference
  54  * counting.) The time field gives the timestamp at which the data was
  55  * sent.
  56  */
  57
  58 struct _GtkSelectionData
  59 {
  60   GdkAtom       GSEAL (selection);
  61   GdkAtom       GSEAL (target);
  62   GdkAtom       GSEAL (type);
  63   gint          GSEAL (format);
  64   guchar       *GSEAL (data);
  65   gint          GSEAL (length);
  66   GdkDisplay   *GSEAL (display);
  67 };
  68
  69 struct _GtkTargetEntry {
  70   gchar *target;
  71   guint  flags;
  72   guint  info;
  73 };
  74
  75 /* These structures not public, and are here only for the convenience of
  76  * gtkdnd.c
  77  */
  78
  79 typedef struct _GtkTargetPair GtkTargetPair;
  80
  81 /* This structure is a list of destinations, and associated guint id's */
  82 struct _GtkTargetList {
  83   GList *list;
  84   guint ref_count;
  85 };
  86
  87 struct _GtkTargetPair {
  88   GdkAtom   target;
  89   guint     flags;
  90   guint     info;
  91 };
  92
  93 GtkTargetList *gtk_target_list_new       (const GtkTargetEntry *targets,
  94                                           guint                 ntargets);
  95 GtkTargetList *gtk_target_list_ref       (GtkTargetList  *list);
  96 void           gtk_target_list_unref     (GtkTargetList  *list);
  97 void           gtk_target_list_add       (GtkTargetList  *list,
  98                                           GdkAtom         target,
  99                                           guint           flags,
 100                                           guint           info);
 101 void           gtk_target_list_add_text_targets      (GtkTargetList  *list,
 102                                                       guint           info);
 103 void           gtk_target_list_add_rich_text_targets (GtkTargetList  *list,
 104                                                       guint           info,
 105                                                       gboolean        deserializable,
 106                                                       GtkTextBuffer  *buffer);
 107 void           gtk_target_list_add_image_targets     (GtkTargetList  *list,
 108                                                       guint           info,
 109                                                       gboolean        writable);
 110 void           gtk_target_list_add_uri_targets       (GtkTargetList  *list,
 111                                                       guint           info);
 112 void           gtk_target_list_add_table (GtkTargetList        *list,
 113                                           const GtkTargetEntry *targets,
 114                                           guint                 ntargets);
 115 void           gtk_target_list_remove    (GtkTargetList  *list,
 116                                           GdkAtom         target);
 117 gboolean       gtk_target_list_find      (GtkTargetList  *list,
 118                                           GdkAtom         target,
 119                                           guint          *info);
 120
 121 GtkTargetEntry * gtk_target_table_new_from_list (GtkTargetList  *list,
 122                                                  gint           *n_targets);
 123 void             gtk_target_table_free          (GtkTargetEntry *targets,
 124                                                  gint            n_targets);
 125
 126 /* Public interface */
 127
 128 gboolean gtk_selection_owner_set             (GtkWidget  *widget,
 129                                               GdkAtom     selection,
 130                                               guint32     time_);
 131 gboolean gtk_selection_owner_set_for_display (GdkDisplay *display,
 132                                               GtkWidget  *widget,
 133                                               GdkAtom     selection,
 134                                               guint32     time_);
 135
 136 void     gtk_selection_add_target    (GtkWidget            *widget,
 137                                       GdkAtom               selection,
 138                                       GdkAtom               target,
 139                                       guint                 info);
 140 void     gtk_selection_add_targets   (GtkWidget            *widget,
 141                                       GdkAtom               selection,
 142                                       const GtkTargetEntry *targets,
 143                                       guint                 ntargets);
 144 void     gtk_selection_clear_targets (GtkWidget            *widget,
 145                                       GdkAtom               selection);
 146 gboolean gtk_selection_convert       (GtkWidget            *widget,
 147                                       GdkAtom               selection,
 148                                       GdkAtom               target,
 149                                       guint32               time_);
 150
 151 GdkAtom       gtk_selection_data_get_selection (GtkSelectionData *selection_data);
 152 GdkAtom       gtk_selection_data_get_target    (GtkSelectionData *selection_data);
 153 GdkAtom       gtk_selection_data_get_data_type (GtkSelectionData *selection_data);
 154 gint          gtk_selection_data_get_format    (GtkSelectionData *selection_data);
 155 const guchar *gtk_selection_data_get_data      (GtkSelectionData *selection_data);
 156 gint          gtk_selection_data_get_length    (GtkSelectionData *selection_data);
 157 GdkDisplay   *gtk_selection_data_get_display   (GtkSelectionData *selection_data);
 158
 159 void     gtk_selection_data_set      (GtkSelectionData     *selection_data,
 160                                       GdkAtom               type,
 161                                       gint                  format,
 162                                       const guchar         *data,
 163                                       gint                  length);
 164 gboolean gtk_selection_data_set_text (GtkSelectionData     *selection_data,
 165                                       const gchar          *str,
 166                                       gint                  len);
 167 guchar * gtk_selection_data_get_text (GtkSelectionData     *selection_data);
 168 gboolean gtk_selection_data_set_pixbuf   (GtkSelectionData  *selection_data,
 169                                           GdkPixbuf         *pixbuf);
 170 GdkPixbuf *gtk_selection_data_get_pixbuf (GtkSelectionData  *selection_data);
 171 gboolean gtk_selection_data_set_uris (GtkSelectionData     *selection_data,
 172                                       gchar               **uris);
 173 gchar  **gtk_selection_data_get_uris (GtkSelectionData     *selection_data);
 174
 175 gboolean gtk_selection_data_get_targets          (GtkSelectionData  *selection_data,
 176                                                   GdkAtom          **targets,
 177                                                   gint              *n_atoms);
 178 gboolean gtk_selection_data_targets_include_text (GtkSelectionData  *selection_data);
 179 gboolean gtk_selection_data_targets_include_rich_text (GtkSelectionData *selection_data,
 180                                                        GtkTextBuffer    *buffer);
 181 gboolean gtk_selection_data_targets_include_image (GtkSelectionData  *selection_data,
 182                                                    gboolean           writable);
 183 gboolean gtk_selection_data_targets_include_uri  (GtkSelectionData  *selection_data);
 184 gboolean gtk_targets_include_text                (GdkAtom       *targets,
 185                                                   gint           n_targets);
 186 gboolean gtk_targets_include_rich_text           (GdkAtom       *targets,
 187                                                   gint           n_targets,
 188                                                   GtkTextBuffer *buffer);
 189 gboolean gtk_targets_include_image               (GdkAtom       *targets,
 190                                                   gint           n_targets,
 191                                                   gboolean       writable);
 192 gboolean gtk_targets_include_uri                 (GdkAtom       *targets,
 193                                                   gint           n_targets);
 194
 195 /* Called when a widget is destroyed */
 196
 197 void gtk_selection_remove_all      (GtkWidget *widget);
 198
 199 /* Event handlers */
 200 gboolean _gtk_selection_clear             (GtkWidget         *widget,
 201                                            GdkEventSelection *event);
 202 gboolean _gtk_selection_request           (GtkWidget         *widget,
 203                                            GdkEventSelection *event);
 204 gboolean _gtk_selection_incr_event        (GdkWindow         *window,
 205                                            GdkEventProperty  *event);
 206 gboolean _gtk_selection_notify            (GtkWidget         *widget,
 207                                            GdkEventSelection *event);
 208 gboolean _gtk_selection_property_notify   (GtkWidget         *widget,
 209                                            GdkEventProperty  *event);
 210
 211 GType             gtk_selection_data_get_type (void) G_GNUC_CONST;
 212 GtkSelectionData *gtk_selection_data_copy     (GtkSelectionData *data);
 213 void              gtk_selection_data_free     (GtkSelectionData *data);
 214
 215 GType             gtk_target_entry_get_type    (void) G_GNUC_CONST;
 216
 217 GtkTargetEntry   *gtk_target_entry_new        (const char *target, guint flags, guint info);
 218 GtkTargetEntry   *gtk_target_entry_copy       (GtkTargetEntry *data);
 219 void              gtk_target_entry_free       (GtkTargetEntry *data);
 220
 221 GType             gtk_target_list_get_type    (void) G_GNUC_CONST;
 222
 223 G_END_DECLS
 224
 225 #endif /* __GTK_SELECTION_H__ */