Pileus Git - ~andy/gtk/blob - gtk/gtktreednd.c

   1 /* gtktreednd.c
   2  * Copyright (C) 2001  Red Hat, Inc.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library 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  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library 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 #include <string.h>
  21 #include "gtktreednd.h"
  22
  23 GType
  24 gtk_tree_drag_source_get_type (void)
  25 {
  26   static GType our_type = 0;
  27
  28   if (!our_type)
  29     {
  30       static const GTypeInfo our_info =
  31       {
  32         sizeof (GtkTreeDragSourceIface), /* class_size */
  33         NULL,           /* base_init */
  34         NULL,           /* base_finalize */
  35         NULL,
  36         NULL,           /* class_finalize */
  37         NULL,           /* class_data */
  38         0,
  39         0,              /* n_preallocs */
  40         NULL
  41       };
  42
  43       our_type = g_type_register_static (G_TYPE_INTERFACE, "GtkTreeDragSource", &our_info, 0);
  44     }
  45
  46   return our_type;
  47 }
  48
  49
  50 GType
  51 gtk_tree_drag_dest_get_type (void)
  52 {
  53   static GType our_type = 0;
  54
  55   if (!our_type)
  56     {
  57       static const GTypeInfo our_info =
  58       {
  59         sizeof (GtkTreeDragDestIface), /* class_size */
  60         NULL,           /* base_init */
  61         NULL,           /* base_finalize */
  62         NULL,
  63         NULL,           /* class_finalize */
  64         NULL,           /* class_data */
  65         0,
  66         0,              /* n_preallocs */
  67         NULL
  68       };
  69
  70       our_type = g_type_register_static (G_TYPE_INTERFACE, "GtkTreeDragDest", &our_info, 0);
  71     }
  72
  73   return our_type;
  74 }
  75
  76
  77 /**
  78  * gtk_tree_drag_source_drag_data_delete:
  79  * @drag_source: a #GtkTreeDragSource
  80  * @path: row that was being dragged
  81  *
  82  * Asks the #GtkTreeDragSource to delete the row at @path, because
  83  * it was moved somewhere else via drag-and-drop. Returns %FALSE
  84  * if the deletion fails because @path no longer exists, or for
  85  * some model-specific reason. Should robustly handle a @path no
  86  * longer found in the model!
  87  *
  88  * Return value: %TRUE if the row was successfully deleted
  89  **/
  90 gboolean
  91 gtk_tree_drag_source_drag_data_delete (GtkTreeDragSource *drag_source,
  92                                        GtkTreePath       *path)
  93 {
  94   GtkTreeDragSourceIface *iface = GTK_TREE_DRAG_SOURCE_GET_IFACE (drag_source);
  95
  96   g_return_val_if_fail (iface->drag_data_delete != NULL, FALSE);
  97   g_return_val_if_fail (path != NULL, FALSE);
  98
  99   return (* iface->drag_data_delete) (drag_source, path);
 100 }
 101
 102 /**
 103  * gtk_tree_drag_source_drag_data_get:
 104  * @drag_source: a #GtkTreeDragSource
 105  * @path: row that was dragged
 106  * @selection_data: a #GtkSelectionData to fill with data from the dragged row
 107  *
 108  * Asks the #GtkTreeDragSource to fill in @selection_data with a
 109  * representation of the row at @path. @selection_data->target gives
 110  * the required type of the data.  Should robustly handle a @path no
 111  * longer found in the model!
 112  *
 113  * Return value: %TRUE if data of the required type was provided
 114  **/
 115 gboolean
 116 gtk_tree_drag_source_drag_data_get    (GtkTreeDragSource *drag_source,
 117                                        GtkTreePath       *path,
 118                                        GtkSelectionData  *selection_data)
 119 {
 120   GtkTreeDragSourceIface *iface = GTK_TREE_DRAG_SOURCE_GET_IFACE (drag_source);
 121
 122   g_return_val_if_fail (iface->drag_data_get != NULL, FALSE);
 123   g_return_val_if_fail (path != NULL, FALSE);
 124   g_return_val_if_fail (selection_data != NULL, FALSE);
 125
 126   return (* iface->drag_data_get) (drag_source, path, selection_data);
 127 }
 128
 129 /**
 130  * gtk_tree_drag_dest_drag_data_received:
 131  * @drag_dest: a #GtkTreeDragDest
 132  * @dest: row to drop in front of
 133  * @selection_data: data to drop
 134  *
 135  * Asks the #GtkTreeDragDest to insert a row before the path @dest,
 136  * deriving the contents of the row from @selection_data. If @dest is
 137  * outside the tree so that inserting before it is impossible, %FALSE
 138  * will be returned. Also, %FALSE may be returned if the new row is
 139  * not created for some model-specific reason.  Should robustly handle
 140  * a @dest no longer found in the model!
 141  *
 142  * Return value: whether a new row was created before position @dest
 143  **/
 144 gboolean
 145 gtk_tree_drag_dest_drag_data_received (GtkTreeDragDest  *drag_dest,
 146                                        GtkTreePath      *dest,
 147                                        GtkSelectionData *selection_data)
 148 {
 149   GtkTreeDragDestIface *iface = GTK_TREE_DRAG_DEST_GET_IFACE (drag_dest);
 150
 151   g_return_val_if_fail (iface->drag_data_received != NULL, FALSE);
 152   g_return_val_if_fail (dest != NULL, FALSE);
 153   g_return_val_if_fail (selection_data != NULL, FALSE);
 154
 155   return (* iface->drag_data_received) (drag_dest, dest, selection_data);
 156 }
 157
 158
 159 /**
 160  * gtk_tree_drag_dest_drop_possible:
 161  * @drag_dest: a #GtkTreeDragDest
 162  * @src_model: #GtkTreeModel being dragged from
 163  * @src_path: row being dragged
 164  * @dest_path: destination row
 165  *
 166  * Determines whether a drop is possible before the given @dest_path,
 167  * at the same depth as @dest_path. i.e., can we drop @src_model such
 168  * that it now resides at @dest_path. @dest_path does not have to
 169  * exist; the return value will almost certainly be %FALSE if the
 170  * parent of @dest_path doesn't exist, though.
 171  *
 172  * Return value: %TRUE if a drop is possible before @dest_path
 173  **/
 174 gboolean
 175 gtk_tree_drag_dest_row_drop_possible (GtkTreeDragDest   *drag_dest,
 176                                       GtkTreeModel      *src_model,
 177                                       GtkTreePath       *src_path,
 178                                       GtkTreePath       *dest_path)
 179 {
 180   GtkTreeDragDestIface *iface = GTK_TREE_DRAG_DEST_GET_IFACE (drag_dest);
 181
 182   g_return_val_if_fail (iface->row_drop_possible != NULL, FALSE);
 183   g_return_val_if_fail (GTK_IS_TREE_MODEL (src_model), FALSE);
 184   g_return_val_if_fail (src_path != NULL, FALSE);
 185   g_return_val_if_fail (dest_path != NULL, FALSE);
 186
 187   return (* iface->row_drop_possible) (drag_dest, src_model, src_path, dest_path);
 188 }
 189
 190 typedef struct _TreeRowData TreeRowData;
 191
 192 struct _TreeRowData
 193 {
 194   GtkTreeModel *model;
 195   gchar path[4];
 196 };
 197
 198 /**
 199  * gtk_selection_data_set_tree_row:
 200  * @selection_data: some #GtkSelectionData
 201  * @tree_model: a #GtkTreeModel
 202  * @path: a row in @tree_model
 203  *
 204  * Sets selection data of target type %GTK_TREE_MODEL_ROW. Normally used
 205  * in a drag_data_get handler.
 206  *
 207  * Return value: %TRUE if the #GtkSelectionData had the proper target type to allow us to set a tree row
 208  **/
 209 gboolean
 210 gtk_selection_data_set_tree_row (GtkSelectionData *selection_data,
 211                                  GtkTreeModel     *tree_model,
 212                                  GtkTreePath      *path)
 213 {
 214   TreeRowData *trd;
 215   gchar *path_str;
 216   gint len;
 217   gint struct_size;
 218
 219   g_return_val_if_fail (selection_data != NULL, FALSE);
 220   g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
 221   g_return_val_if_fail (path != NULL, FALSE);
 222
 223   if (selection_data->target != gdk_atom_intern ("GTK_TREE_MODEL_ROW", FALSE))
 224     return FALSE;
 225
 226   path_str = gtk_tree_path_to_string (path);
 227
 228   len = strlen (path_str);
 229
 230   /* the old allocate-end-of-struct-to-hold-string trick */
 231   struct_size = sizeof (TreeRowData) + len + 1 -
 232     (sizeof (TreeRowData) - G_STRUCT_OFFSET (TreeRowData, path));
 233
 234   trd = g_malloc (struct_size);
 235
 236   strcpy (trd->path, path_str);
 237
 238   trd->model = tree_model;
 239
 240   gtk_selection_data_set (selection_data,
 241                           gdk_atom_intern ("GTK_TREE_MODEL_ROW", FALSE),
 242                           8, /* bytes */
 243                           (void*)trd,
 244                           struct_size);
 245
 246   g_free (trd);
 247
 248   return TRUE;
 249 }
 250
 251 /**
 252  * gtk_selection_data_get_tree_row:
 253  * @selection_data: a #GtkSelectionData
 254  * @tree_model: a #GtkTreeModel
 255  * @path: row in @tree_model
 256  *
 257  * Obtains a @tree_model and @path from selection data of target type
 258  * %GTK_TREE_MODEL_ROW. Normally called from a drag_data_received handler.
 259  * This function can only be used if @selection_data originates from the same
 260  * process that's calling this function, because a pointer to the tree model
 261  * is being passed around. If you aren't in the same process, then you'll
 262  * get memory corruption. In the #GtkTreeDragDest drag_data_received handler,
 263  * you can assume that selection data of type %GTK_TREE_MODEL_ROW is
 264  * in from the current process. The returned path must be freed with
 265  * gtk_tree_path_free().
 266  *
 267  * Return value: %TRUE if @selection_data had target type %GTK_TREE_MODEL_ROW and
 268  *  is otherwise valid
 269  **/
 270 gboolean
 271 gtk_selection_data_get_tree_row (GtkSelectionData *selection_data,
 272                                  GtkTreeModel    **tree_model,
 273                                  GtkTreePath     **path)
 274 {
 275   TreeRowData *trd;
 276
 277   g_return_val_if_fail (selection_data != NULL, FALSE);
 278
 279   if (tree_model)
 280     *tree_model = NULL;
 281
 282   if (path)
 283     *path = NULL;
 284
 285   if (selection_data->target != gdk_atom_intern ("GTK_TREE_MODEL_ROW", FALSE))
 286     return FALSE;
 287
 288   trd = (void*) selection_data->data;
 289
 290   if (tree_model)
 291     *tree_model = trd->model;
 292
 293   if (path)
 294     *path = gtk_tree_path_new_from_string (trd->path);
 295
 296   return TRUE;
 297 }