gtktreemodel.c 34.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
/* gtktreemodel.c
 * Copyright (C) 2000  Red Hat, Inc.,  Jonathan Blandford <jrb@redhat.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#include <stdlib.h>
#include <stdio.h>
#include <string.h>
23
#include <glib.h>
24
#include <gobject/gobject.h>
25
#include <gobject/gvaluecollector.h>
26
#include "gtkmarshal.h"
27
#include "gtktreemodel.h"
28 29 30
#include "gtktreeview.h"
#include "gtktreeprivate.h"

31 32 33 34 35 36 37

struct _GtkTreePath
{
  gint depth;
  gint *indices;
};

38 39 40
static void gtk_tree_model_base_init (gpointer g_class);


41 42 43 44 45 46 47 48 49
GtkType
gtk_tree_model_get_type (void)
{
  static GtkType tree_model_type = 0;

  if (!tree_model_type)
    {
      static const GTypeInfo tree_model_info =
      {
50
        sizeof (GtkTreeModelIface), /* class_size */
51
	gtk_tree_model_base_init,   /* base_init */
52
	NULL,		/* base_finalize */
53 54 55 56 57 58
	NULL,
	NULL,		/* class_finalize */
	NULL,		/* class_data */
	0,
	0,              /* n_preallocs */
	NULL
59 60
      };

61
      tree_model_type = g_type_register_static (G_TYPE_INTERFACE, "GtkTreeModel", &tree_model_info, 0);
62 63 64 65 66
    }

  return tree_model_type;
}

67 68 69 70 71

static void
gtk_tree_model_base_init (gpointer g_class)
{
  static gboolean initted = FALSE;
72

73 74 75 76
  if (! initted)
    {
      g_signal_newc ("changed",
		     GTK_TYPE_TREE_MODEL,
77
		     G_SIGNAL_RUN_LAST,
78 79 80 81 82 83 84 85
		     G_STRUCT_OFFSET (GtkTreeModelIface, changed),
		     NULL,
		     gtk_marshal_VOID__BOXED_BOXED,
		     G_TYPE_NONE, 2,
		     GTK_TYPE_TREE_PATH,
		     GTK_TYPE_TREE_ITER);
      g_signal_newc ("inserted",
		     GTK_TYPE_TREE_MODEL,
86
		     G_SIGNAL_RUN_LAST,
87 88 89 90 91 92 93 94
		     G_STRUCT_OFFSET (GtkTreeModelIface, inserted),
		     NULL,
		     gtk_marshal_VOID__BOXED_BOXED,
		     G_TYPE_NONE, 2,
		     GTK_TYPE_TREE_PATH,
		     GTK_TYPE_TREE_ITER);
      g_signal_newc ("child_toggled",
		     GTK_TYPE_TREE_MODEL,
95
		     G_SIGNAL_RUN_LAST,
96 97 98 99 100 101 102 103
		     G_STRUCT_OFFSET (GtkTreeModelIface, child_toggled),
		     NULL,
		     gtk_marshal_VOID__BOXED_BOXED,
		     G_TYPE_NONE, 2,
		     GTK_TYPE_TREE_PATH,
		     GTK_TYPE_TREE_ITER);
      g_signal_newc ("deleted",
		     GTK_TYPE_TREE_MODEL,
104
		     G_SIGNAL_RUN_LAST,
105 106
		     G_STRUCT_OFFSET (GtkTreeModelIface, deleted),
		     NULL,
107
		     gtk_marshal_VOID__BOXED,
108 109 110 111 112 113
		     G_TYPE_NONE, 1,
		     GTK_TYPE_TREE_PATH);
      initted = TRUE;
    }
}

7's avatar
7 committed
114 115
/**
 * gtk_tree_path_new:
116
 *
7's avatar
7 committed
117
 * Creates a new #GtkTreePath.
118
 *
7's avatar
7 committed
119 120
 * Return value: A newly created #GtkTreePath.
 **/
121 122 123 124 125 126 127 128 129 130 131 132
/* GtkTreePath Operations */
GtkTreePath *
gtk_tree_path_new (void)
{
  GtkTreePath *retval;
  retval = (GtkTreePath *) g_new (GtkTreePath, 1);
  retval->depth = 0;
  retval->indices = NULL;

  return retval;
}

7's avatar
7 committed
133 134 135
/**
 * gtk_tree_path_new_from_string:
 * @path: The string representation of a path.
136
 *
137 138 139 140 141
 * Creates a new #GtkTreePath initialized to @path.  @path is expected
 * to be a colon separated list of numbers.  For example, the string
 * "10:4:0" would create a path of depth 3 pointing to the 11th child
 * of the root node, the 5th child of that 11th child, and the 1st
 * child of that 5th child.
142
 *
7's avatar
7 committed
143 144
 * Return value: A newly created #GtkTreePath.
 **/
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
GtkTreePath *
gtk_tree_path_new_from_string (gchar *path)
{
  GtkTreePath *retval;
  gchar *ptr;
  gint i;

  g_return_val_if_fail (path != NULL, gtk_tree_path_new ());

  retval = gtk_tree_path_new ();

  while (1)
    {
      i = strtol (path, &ptr, 10);
      gtk_tree_path_append_index (retval, i);

      if (*ptr == '\000')
	break;
7's avatar
7 committed
163
      /* FIXME: should we error out if this is not a ':', or should we be tolerant? */
164 165 166 167 168 169
      path = ptr + 1;
    }

  return retval;
}

7's avatar
7 committed
170 171 172
/**
 * gtk_tree_path_to_string:
 * @path: A #GtkTreePath
173
 *
7's avatar
7 committed
174 175
 * Generates a string representation of the path.  This string is a ':'
 * separated list of numbers.  For example, "4:10:0:3" would be an acceptable return value for this string.
176
 *
7's avatar
7 committed
177 178
 * Return value: A newly allocated string.  Must be freed with #g_free.
 **/
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
gchar *
gtk_tree_path_to_string (GtkTreePath *path)
{
  gchar *retval, *ptr;
  gint i;

  if (path->depth == 0)
    return NULL;

  ptr = retval = (gchar *) g_new0 (char *, path->depth*8);
  sprintf (retval, "%d", path->indices[0]);
  while (*ptr != '\000')
    ptr++;

  for (i = 1; i < path->depth; i++)
    {
      sprintf (ptr, ":%d", path->indices[i]);
      while (*ptr != '\000')
	ptr++;
    }

  return retval;
}

7's avatar
7 committed
203 204
/**
 * gtk_tree_path_new_root:
205
 *
7's avatar
7 committed
206 207
 * Creates a new root #GtkTreePath.  The string representation of this path is
 * "0"
208
 *
7's avatar
7 committed
209 210
 * Return value: A new #GtkTreePath.
 **/
211 212 213 214 215 216 217 218 219 220 221
GtkTreePath *
gtk_tree_path_new_root (void)
{
  GtkTreePath *retval;

  retval = gtk_tree_path_new ();
  gtk_tree_path_append_index (retval, 0);

  return retval;
}

7's avatar
7 committed
222 223 224 225
/**
 * gtk_tree_path_append_index:
 * @path: A #GtkTreePath.
 * @index: The index.
226
 *
7's avatar
7 committed
227 228 229
 * Appends a new index to a path.  As a result, the depth of the path is
 * increased.
 **/
230 231 232 233
void
gtk_tree_path_append_index (GtkTreePath *path,
			    gint         index)
{
7's avatar
7 committed
234 235 236
  g_return_if_fail (path != NULL);
  g_return_if_fail (index >= 0);

237 238
  path->depth += 1;
  path->indices = g_realloc (path->indices, path->depth * sizeof(gint));
239 240 241
  path->indices[path->depth - 1] = index;
}

7's avatar
7 committed
242 243 244 245
/**
 * gtk_tree_path_prepend_index:
 * @path: A #GtkTreePath.
 * @index: The index.
246
 *
7's avatar
7 committed
247 248 249
 * Prepends a new index to a path.  As a result, the depth of the path is
 * increased.
 **/
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
void
gtk_tree_path_prepend_index (GtkTreePath *path,
			     gint       index)
{
  gint *new_indices = g_new (gint, ++path->depth);
  if (path->indices == NULL)
    {
      path->indices = new_indices;
      path->indices[0] = index;
      return;
    }
  memcpy (new_indices + 1, path->indices, (path->depth - 1)*sizeof (gint));
  g_free (path->indices);
  path->indices = new_indices;
  path->indices[0] = index;
}

7's avatar
7 committed
267 268 269
/**
 * gtk_tree_path_get_depth:
 * @path: A #GtkTreePath.
270
 *
7's avatar
7 committed
271
 * Returns the current depth of @path.
272
 *
7's avatar
7 committed
273 274
 * Return value: The depth of @path
 **/
275 276 277
gint
gtk_tree_path_get_depth (GtkTreePath *path)
{
7's avatar
7 committed
278 279
  g_return_val_if_fail (path != NULL, 0);

280 281 282
  return path->depth;
}

7's avatar
7 committed
283 284 285
/**
 * gtk_tree_path_get_indices:
 * @path: A #GtkTreePath.
286
 *
7's avatar
7 committed
287 288
 * Returns the current indices of @path.  This is an array of integers, each
 * representing a node in a tree.
289
 *
7's avatar
7 committed
290 291
 * Return value: The current indices, or NULL.
 **/
292 293 294
gint *
gtk_tree_path_get_indices (GtkTreePath *path)
{
7's avatar
7 committed
295 296
  g_return_val_if_fail (path != NULL, NULL);

297 298 299
  return path->indices;
}

7's avatar
7 committed
300 301 302
/**
 * gtk_tree_path_free:
 * @path: A #GtkTreePath.
303
 *
7's avatar
7 committed
304 305
 * Frees @path.
 **/
306 307 308
void
gtk_tree_path_free (GtkTreePath *path)
{
309 310
  g_return_if_fail (path != NULL);

311 312 313 314
  g_free (path->indices);
  g_free (path);
}

7's avatar
7 committed
315 316 317
/**
 * gtk_tree_path_copy:
 * @path: A #GtkTreePath.
318
 *
319
 * Creates a new #GtkTreePath as a copy of @path.
320
 *
7's avatar
7 committed
321 322
 * Return value: A new #GtkTreePath.
 **/
323 324 325 326 327
GtkTreePath *
gtk_tree_path_copy (GtkTreePath *path)
{
  GtkTreePath *retval;

328 329
  g_return_val_if_fail (path != NULL, NULL);

330 331 332 333 334 335 336
  retval = g_new (GtkTreePath, 1);
  retval->depth = path->depth;
  retval->indices = g_new (gint, path->depth);
  memcpy (retval->indices, path->indices, path->depth * sizeof (gint));
  return retval;
}

7's avatar
7 committed
337 338 339 340
/**
 * gtk_tree_path_compare:
 * @a: A #GtkTreePath.
 * @b: A #GtkTreePath to compare with.
341
 *
7's avatar
7 committed
342 343 344
 * Compares two paths.  If @a appears before @b in a tree, then 1, is returned.
 * If @b appears before @a, then -1 is returned.  If the two nodes are equal,
 * then 0 is returned.
345
 *
7's avatar
7 committed
346 347
 * Return value: The relative positions of @a and @b
 **/
348
gint
7's avatar
7 committed
349 350
gtk_tree_path_compare (const GtkTreePath *a,
		       const GtkTreePath *b)
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
{
  gint p = 0, q = 0;

  g_return_val_if_fail (a != NULL, 0);
  g_return_val_if_fail (b != NULL, 0);
  g_return_val_if_fail (a->depth > 0, 0);
  g_return_val_if_fail (b->depth > 0, 0);

  do
    {
      if (a->indices[p] == b->indices[q])
	continue;
      return (a->indices[p] < b->indices[q]?1:-1);
    }
  while (++p < a->depth && ++q < b->depth);
  if (a->depth == b->depth)
    return 0;
  return (a->depth < b->depth?1:-1);
}

371 372 373 374
/**
 * gtk_tree_path_is_ancestor:
 * @path: a #GtkTreePath
 * @descendant: another #GtkTreePath
375 376 377
 *
 *
 *
378 379 380 381 382 383 384
 * Return value: %TRUE if @descendant is contained inside @path
 **/
gboolean
gtk_tree_path_is_ancestor (GtkTreePath *path,
                           GtkTreePath *descendant)
{
  gint i;
385

386 387 388 389 390 391
  g_return_val_if_fail (path != NULL, FALSE);
  g_return_val_if_fail (descendant != NULL, FALSE);

  /* can't be an ancestor if we're deeper */
  if (path->depth >= descendant->depth)
    return FALSE;
392

393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
  i = 0;
  while (i < path->depth)
    {
      if (path->indices[i] != descendant->indices[i])
        return FALSE;
      ++i;
    }

  return TRUE;
}

/**
 * gtk_tree_path_is_descendant:
 * @path: a #GtkTreePath
 * @ancestor: another #GtkTreePath
408 409 410
 *
 *
 *
411 412 413 414 415 416 417
 * Return value: %TRUE if @ancestor contains @path somewhere below it
 **/
gboolean
gtk_tree_path_is_descendant (GtkTreePath *path,
                             GtkTreePath *ancestor)
{
  gint i;
418

419 420
  g_return_val_if_fail (path != NULL, FALSE);
  g_return_val_if_fail (ancestor != NULL, FALSE);
421

422 423 424
  /* can't be a descendant if we're shallower in the tree */
  if (path->depth <= ancestor->depth)
    return FALSE;
425

426 427 428 429 430 431 432 433 434 435 436 437
  i = 0;
  while (i < ancestor->depth)
    {
      if (path->indices[i] != ancestor->indices[i])
        return FALSE;
      ++i;
    }

  return TRUE;
}


7's avatar
7 committed
438 439 440
/**
 * gtk_tree_path_next:
 * @path: A #GtkTreePath.
441
 *
7's avatar
7 committed
442 443
 * Moves the @path to point to the next node at the current depth.
 **/
444 445 446 447
void
gtk_tree_path_next (GtkTreePath *path)
{
  g_return_if_fail (path != NULL);
7's avatar
7 committed
448
  g_return_if_fail (path->depth > 0);
449 450 451 452

  path->indices[path->depth - 1] ++;
}

7's avatar
7 committed
453 454 455
/**
 * gtk_tree_path_prev:
 * @path: A #GtkTreePath.
456
 *
7's avatar
7 committed
457
 * Moves the @path to point to the previous node at the current depth, if it exists.
458
 *
Jonathan Blandford's avatar
Jonathan Blandford committed
459
 * Return value: TRUE if @path has a previous node, and the move was made.
7's avatar
7 committed
460
 **/
461
gboolean
462 463 464 465
gtk_tree_path_prev (GtkTreePath *path)
{
  g_return_val_if_fail (path != NULL, FALSE);

466
  if (path->indices[path->depth - 1] == 0)
467 468
    return FALSE;

469
  path->indices[path->depth - 1] -= 1;
470 471 472 473

  return TRUE;
}

7's avatar
7 committed
474 475 476
/**
 * gtk_tree_path_up:
 * @path: A #GtkTreePath.
477
 *
7's avatar
7 committed
478
 * Moves the @path to point to it's parent node, if it has a parent.
479
 *
7's avatar
7 committed
480 481
 * Return value: TRUE if @path has a parent, and the move was made.
 **/
482
gboolean
483 484 485 486 487 488 489 490 491 492 493 494
gtk_tree_path_up (GtkTreePath *path)
{
  g_return_val_if_fail (path != NULL, FALSE);

  if (path->depth == 1)
    return FALSE;

  path->depth--;

  return TRUE;
}

7's avatar
7 committed
495 496 497
/**
 * gtk_tree_path_down:
 * @path: A #GtkTreePath.
498
 *
7's avatar
7 committed
499 500
 * Moves @path to point to the first child of the current path.
 **/
501 502 503 504 505 506 507 508
void
gtk_tree_path_down (GtkTreePath *path)
{
  g_return_if_fail (path != NULL);

  gtk_tree_path_append_index (path, 0);
}

509 510 511
/**
 * gtk_tree_iter_copy:
 * @iter: A #GtkTreeIter.
512
 *
513 514
 * Creates a dynamically allocated tree iterator as a copy of @iter.  This
 * function is not intended for use in applications, because you can just copy
515
 * the structs by value (GtkTreeIter new_iter = iter;).  You
516
 * must free this iter with gtk_tree_iter_free ().
517
 *
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
 * Return value: a newly allocated copy of @iter.
 **/
GtkTreeIter *
gtk_tree_iter_copy (GtkTreeIter *iter)
{
  GtkTreeIter *retval;

  g_return_val_if_fail (iter != NULL, NULL);

  retval = g_new (GtkTreeIter, 1);
  *retval = *iter;

  return retval;
}

/**
 * gtk_tree_iter_free:
 * @iter: A dynamically allocated tree iterator.
536
 *
537 538 539 540 541 542 543 544 545 546 547 548 549 550
 * Free an iterator that has been allocated on the heap.  This function is
 * mainly used for language bindings.
 **/
void
gtk_tree_iter_free (GtkTreeIter *iter)
{
  g_return_if_fail (iter != NULL);

  g_free (iter);
}

/**
 * gtk_tree_model_get_flags:
 * @tree_model: A #GtkTreeModel.
551
 *
552
 * Returns a set of flags supported by this interface.  The flags are a bitwise
553 554
 * combination of #GtkTreeModelFlags.  It is expected that the flags supported
 * do not change for an interface.
555
 *
556 557
 * Return value: The flags supported by this interface.
 **/
558
GtkTreeModelFlags
559 560 561 562 563 564 565 566 567 568 569
gtk_tree_model_get_flags (GtkTreeModel *tree_model)
{
  g_return_val_if_fail (tree_model != NULL, 0);
  g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), 0);

  if (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_flags)
    return (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_flags) (tree_model);

  return 0;
}

7's avatar
7 committed
570 571 572
/**
 * gtk_tree_model_get_n_columns:
 * @tree_model: A #GtkTreeModel.
573
 *
7's avatar
7 committed
574
 * Returns the number of columns supported by the #tree_model
575
 *
7's avatar
7 committed
576 577
 * Return value: The number of columns.
 **/
578 579 580
gint
gtk_tree_model_get_n_columns (GtkTreeModel *tree_model)
{
581 582
  g_return_val_if_fail (tree_model != NULL, 0);
  g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), 0);
583
  g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_n_columns != NULL, 0);
584

585
  return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->get_n_columns) (tree_model);
586 587
}

588 589 590 591
/**
 * gtk_tree_model_get_column_type:
 * @tree_model: A #GtkTreeModel.
 * @index: The column index.
592
 *
593
 * Returns the type of the column.
594
 *
595 596 597 598 599 600 601 602 603 604 605 606 607 608
 * Return value: The type of the column.
 **/
GType
gtk_tree_model_get_column_type (GtkTreeModel *tree_model,
				gint          index)
{
  g_return_val_if_fail (tree_model != NULL, G_TYPE_INVALID);
  g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), G_TYPE_INVALID);
  g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_column_type != NULL, G_TYPE_INVALID);
  g_return_val_if_fail (index >= 0, G_TYPE_INVALID);

  return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->get_column_type) (tree_model, index);
}

7's avatar
7 committed
609
/**
610
 * gtk_tree_model_get_iter:
7's avatar
7 committed
611
 * @tree_model: A #GtkTreeModel.
612 613
 * @iter: The uninitialized #GtkTreeIter.
 * @path: The #GtkTreePath.
614
 *
615 616 617
 * Sets @iter to a valid iterator pointing to @path.  If the model does not
 * provide an implementation of this function, it is implemented in terms of
 * @gtk_tree_model_iter_nth_child.
618
 *
619
 * Return value: TRUE, if @iter was set.
7's avatar
7 committed
620
 **/
621 622 623
gboolean
gtk_tree_model_get_iter (GtkTreeModel *tree_model,
			 GtkTreeIter  *iter,
624 625
			 GtkTreePath  *path)
{
626 627 628 629
  GtkTreeIter parent;
  gint *indices;
  gint depth, i;

630 631 632 633 634
  g_return_val_if_fail (tree_model != NULL, FALSE);
  g_return_val_if_fail (iter != NULL, FALSE);
  g_return_val_if_fail (path != NULL, FALSE);
  g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);

635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
  if (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_iter != NULL)
    return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->get_iter) (tree_model, iter, path);

  indices = gtk_tree_path_get_indices (path);
  depth = gtk_tree_path_get_depth (path);

  g_return_val_if_fail (depth > 0, FALSE);

  if (! gtk_tree_model_iter_nth_child (tree_model, iter, NULL, indices[0]))
    return FALSE;

  for (i = 1; i < depth; i++)
    {
      parent = *iter;
      if (! gtk_tree_model_iter_nth_child (tree_model, iter, &parent, indices[i]))
	return FALSE;
    }

  return TRUE;
}

656 657 658 659
/**
 * gtk_tree_model_get_first:
 * @tree_model: a #GtkTreeModel
 * @iter: iterator to initialize
660
 *
661 662 663
 * Initialized @iter with the first iterator in the tree (the one at the
 * root path) and returns %TRUE, or returns %FALSE if there are no
 * iterable locations in the model (i.e. the tree is empty).
664
 *
665 666 667 668 669 670 671 672
 * Return value: %TRUE if @iter was initialized
 **/
gboolean
gtk_tree_model_get_first (GtkTreeModel *tree_model,
                          GtkTreeIter  *iter)
{
  gboolean retval;
  GtkTreePath *path;
673

674 675 676 677 678 679 680 681 682 683 684 685
  g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
  g_return_val_if_fail (iter != NULL, FALSE);

  path = gtk_tree_path_new_root ();

  retval = gtk_tree_model_get_iter (tree_model, iter, path);

  gtk_tree_path_free (path);

  return retval;
}

7's avatar
7 committed
686 687 688
/**
 * gtk_tree_model_get_path:
 * @tree_model: A #GtkTreeModel.
689
 * @iter: The #GtkTreeIter.
690
 *
691
 * Returns a newly created #GtkTreePath referenced by @iter.  This path should
7's avatar
7 committed
692
 * be freed with #gtk_tree_path_free.
693
 *
7's avatar
7 committed
694 695
 * Return value: a newly created #GtkTreePath.
 **/
696 697
GtkTreePath *
gtk_tree_model_get_path (GtkTreeModel *tree_model,
698
			 GtkTreeIter  *iter)
699
{
700 701 702
  g_return_val_if_fail (tree_model != NULL, NULL);
  g_return_val_if_fail (iter != NULL, NULL);
  g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), NULL);
703
  g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_path != NULL, NULL);
704 705

  return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->get_path) (tree_model, iter);
706 707
}

7's avatar
7 committed
708
/**
709
 * gtk_tree_model_get_value:
7's avatar
7 committed
710
 * @tree_model: A #GtkTreeModel.
711 712
 * @iter: The #GtkTreeIter.
 * @column: The column to lookup the value at.
7's avatar
7 committed
713
 * @value: An empty #GValue to set.
714
 *
7's avatar
7 committed
715 716 717
 * Sets initializes and sets @value to that at @column.  When done with value,
 * #g_value_unset needs to be called on it.
 **/
718
void
719 720 721 722
gtk_tree_model_get_value (GtkTreeModel *tree_model,
			  GtkTreeIter  *iter,
			  gint          column,
			  GValue       *value)
723
{
724 725 726 727 728
  g_return_if_fail (tree_model != NULL);
  g_return_if_fail (iter != NULL);
  g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
  g_return_if_fail (value != NULL);
  g_return_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_value != NULL);
729

730
  (* GTK_TREE_MODEL_GET_IFACE (tree_model)->get_value) (tree_model, iter, column, value);
731 732
}

7's avatar
7 committed
733
/**
734
 * gtk_tree_model_iter_next:
7's avatar
7 committed
735
 * @tree_model: A #GtkTreeModel.
736
 * @iter: The #GtkTreeIter.
737
 *
738 739
 * Sets @iter to point to the node following it at the current level.  If there
 * is no next @iter, FALSE is returned and @iter is set to be invalid.
740
 *
741
 * Return value: TRUE if @iter has been changed to the next node.
7's avatar
7 committed
742
 **/
743
gboolean
744 745
gtk_tree_model_iter_next (GtkTreeModel  *tree_model,
			  GtkTreeIter   *iter)
746
{
747 748 749
  g_return_val_if_fail (tree_model != NULL, FALSE);
  g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
  g_return_val_if_fail (iter != NULL, FALSE);
750 751 752
  g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_next != NULL, FALSE);

  return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_next) (tree_model, iter);
753 754
}

7's avatar
7 committed
755
/**
756
 * gtk_tree_model_iter_children:
7's avatar
7 committed
757
 * @tree_model: A #GtkTreeModel.
Jonathan Blandford's avatar
Jonathan Blandford committed
758 759
 * @iter: The new #GtkTreeIter to be set to the child.
 * @parent: The #GtkTreeIter.
760
 *
761 762 763
 * Sets @iter to point to the first child of @parent.  If @parent has no children,
 * FALSE is returned and @iter is set to be invalid.  @parent will remain a valid
 * node after this function has been called.
764
 *
765
 * Return value: TRUE, if @child has been set to the first child.
7's avatar
7 committed
766
 **/
767 768 769 770
gboolean
gtk_tree_model_iter_children (GtkTreeModel *tree_model,
			      GtkTreeIter  *iter,
			      GtkTreeIter  *parent)
771
{
772 773 774
  g_return_val_if_fail (tree_model != NULL, FALSE);
  g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
  g_return_val_if_fail (iter != NULL, FALSE);
775 776 777
  g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_children != NULL, FALSE);

  return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_children) (tree_model, iter, parent);
778 779
}

7's avatar
7 committed
780
/**
781
 * gtk_tree_model_iter_has_child:
7's avatar
7 committed
782
 * @tree_model: A #GtkTreeModel.
783
 * @iter: The #GtkTreeIter to test for children.
784
 *
785
 * Returns TRUE if @iter has children, FALSE otherwise.
786
 *
787
 * Return value: TRUE if @iter has children.
7's avatar
7 committed
788
 **/
789
gboolean
790 791
gtk_tree_model_iter_has_child (GtkTreeModel *tree_model,
			       GtkTreeIter  *iter)
792
{
793 794 795
  g_return_val_if_fail (tree_model != NULL, FALSE);
  g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
  g_return_val_if_fail (iter != NULL, FALSE);
796 797 798
  g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_has_child != NULL, FALSE);

  return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_has_child) (tree_model, iter);
799 800
}

7's avatar
7 committed
801
/**
802
 * gtk_tree_model_iter_n_children:
7's avatar
7 committed
803
 * @tree_model: A #GtkTreeModel.
804
 * @iter: The #GtkTreeIter, or NULL.
805
 *
806 807
 * Returns the number of children that @iter has.  If @iter is NULL, then the
 * number of toplevel nodes is returned.
808
 *
809
 * Return value: The number of children of @iter.
7's avatar
7 committed
810
 **/
811
gint
812 813
gtk_tree_model_iter_n_children (GtkTreeModel *tree_model,
				GtkTreeIter  *iter)
814
{
815 816 817
  g_return_val_if_fail (tree_model != NULL, 0);
  g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), 0);
  g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_n_children != NULL, 0);
818 819

  return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_n_children) (tree_model, iter);
820 821
}

7's avatar
7 committed
822
/**
823
 * gtk_tree_model_iter_nth_child:
7's avatar
7 committed
824
 * @tree_model: A #GtkTreeModel.
825 826 827
 * @iter: The #GtkTreeIter to set to the nth child.
 * @parent: The #GtkTreeIter to get the child from, or NULL.
 * @n: Then index of the desired child.
828
 *
829 830 831 832 833
 * Sets @iter to be the child of @parent, using the given index.  The first
 * index is 0.  If the index is too big, or @parent has no children, @iter is
 * set to an invalid iterator and FALSE is returned.  @parent will remain a
 * valid node after this function has been called.  If @parent is NULL, then the
 * root node is assumed.
834
 *
835
 * Return value: TRUE, if @parent has an nth child.
7's avatar
7 committed
836
 **/
837 838 839 840
gboolean
gtk_tree_model_iter_nth_child (GtkTreeModel *tree_model,
			       GtkTreeIter  *iter,
			       GtkTreeIter  *parent,
7's avatar
7 committed
841
			       gint          n)
842
{
843 844 845 846
  g_return_val_if_fail (tree_model != NULL, FALSE);
  g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
  g_return_val_if_fail (iter != NULL, FALSE);
  g_return_val_if_fail (n >= 0, FALSE);
847 848 849
  g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_nth_child != NULL, FALSE);

  return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_nth_child) (tree_model, iter, parent, n);
850 851
}

7's avatar
7 committed
852
/**
853 854
 * gtk_tree_model_iter_parent:
 * @tree_model: A #GtkTreeModel
Jonathan Blandford's avatar
Jonathan Blandford committed
855 856
 * @iter: The new #GtkTreeIter to set to the parent.
 * @child: The #GtkTreeIter.
857
 *
858 859 860 861
 * Sets @iter to be the parent of @child.  If @child is at the toplevel, and
 * doesn't have a parent, then @iter is set to an invalid iterator and FALSE
 * is returned.  @child will remain a valid node after this function has been
 * called.
862
 *
863
 * Return value: TRUE, if @iter is set to the parent of @child.
7's avatar
7 committed
864
 **/
865 866 867 868
gboolean
gtk_tree_model_iter_parent (GtkTreeModel *tree_model,
			    GtkTreeIter  *iter,
			    GtkTreeIter  *child)
869
{
870 871 872 873
  g_return_val_if_fail (tree_model != NULL, FALSE);
  g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
  g_return_val_if_fail (iter != NULL, FALSE);
  g_return_val_if_fail (child != NULL, FALSE);
874 875 876
  g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_parent != NULL, FALSE);

  return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_parent) (tree_model, iter, child);
877 878
}

879
/* FIXME explain what the method is supposed to do! */
880 881 882 883
/**
 * gtk_tree_model_ref_iter:
 * @tree_model: A #GtkTreeModel.
 * @iter: The #GtkTreeIter.
884
 *
885 886 887 888 889 890 891 892 893 894 895 896 897 898 899
 * Ref's the iter.  This is an optional method for models to implement.  To be
 * more specific, models may ignore this call as it exists primarily for
 * performance reasons.
 **/
void
gtk_tree_model_ref_iter (GtkTreeModel *tree_model,
			 GtkTreeIter  *iter)
{
  g_return_if_fail (tree_model != NULL);
  g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));

  if (GTK_TREE_MODEL_GET_IFACE (tree_model)->ref_iter)
    (* GTK_TREE_MODEL_GET_IFACE (tree_model)->ref_iter) (tree_model, iter);
}

900
/* FIXME explain what the method is supposed to do! */
901 902 903 904
/**
 * gtk_tree_model_unref_iter:
 * @tree_model: A #GtkTreeModel.
 * @iter: The #GtkTreeIter.
905
 *
906 907 908 909 910 911 912 913 914 915 916 917 918 919
 * Unref's the iter.  This is an optional method for models to implement.  To be
 * more specific, models may ignore this call as it exists primarily for
 * performance reasons.
 **/
void
gtk_tree_model_unref_iter (GtkTreeModel *tree_model,
			   GtkTreeIter  *iter)
{
  g_return_if_fail (tree_model != NULL);
  g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));

  if (GTK_TREE_MODEL_GET_IFACE (tree_model)->unref_iter)
    (* GTK_TREE_MODEL_GET_IFACE (tree_model)->unref_iter) (tree_model, iter);
}
920 921 922 923 924 925 926 927 928 929 930 931 932 933 934

/**
 * gtk_tree_model_get:
 * @tree_model: a #GtkTreeModel
 * @iter: a row in @tree_model
 * @Varargs: pairs of column number and value return locations, terminated by -1
 *
 * Gets the value of one or more cells in the row referenced by @iter.
 * The variable argument list should contain integer column numbers,
 * each column number followed by a place to store the value being
 * retrieved.  The list is terminated by a -1. For example, to get a
 * value from column 0 with type %G_TYPE_STRING, you would
 * write: gtk_tree_model_set (model, iter, 0, &place_string_here, -1),
 * where place_string_here is a gchar* to be filled with the string.
 * If appropriate, the returned values have to be freed or unreferenced.
935
 *
936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958
 **/
void
gtk_tree_model_get (GtkTreeModel *tree_model,
		    GtkTreeIter  *iter,
		    ...)
{
  va_list var_args;

  g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));

  va_start (var_args, iter);
  gtk_tree_model_get_valist (tree_model, iter, var_args);
  va_end (var_args);
}

/**
 * gtk_tree_model_get_valist:
 * @tree_model: a #GtkTreeModel
 * @iter: a row in @tree_model
 * @var_args: va_list of column/return location pairs
 *
 * See gtk_tree_model_get(), this version takes a va_list for
 * language bindings to use.
959
 *
960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984
 **/
void
gtk_tree_model_get_valist (GtkTreeModel *tree_model,
                           GtkTreeIter  *iter,
                           va_list	var_args)
{
  gint column;

  g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));

  column = va_arg (var_args, gint);

  while (column != -1)
    {
      GValue value = { 0, };
      gchar *error = NULL;

      if (column >= gtk_tree_model_get_n_columns (tree_model))
	{
	  g_warning ("%s: Invalid column number %d accessed (remember to end your list of columns with a -1)", G_STRLOC, column);
	  break;
	}

      gtk_tree_model_get_value (GTK_TREE_MODEL (tree_model), iter, column, &value);

985
      G_VALUE_LCOPY (&value, var_args, 0, &error);
986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001
      if (error)
	{
	  g_warning ("%s: %s", G_STRLOC, error);
	  g_free (error);

 	  /* we purposely leak the value here, it might not be
	   * in a sane state if an error condition occoured
	   */
	  break;
	}

      g_value_unset (&value);

      column = va_arg (var_args, gint);
    }
}
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051

void
gtk_tree_model_changed (GtkTreeModel *tree_model,
			GtkTreePath  *path,
			GtkTreeIter  *iter)
{
  g_return_if_fail (tree_model != NULL);
  g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
  g_return_if_fail (path != NULL);
  g_return_if_fail (iter != NULL);

  g_signal_emit_by_name (tree_model, "changed", path, iter);
}

void
gtk_tree_model_inserted (GtkTreeModel *tree_model,
			 GtkTreePath  *path,
			 GtkTreeIter  *iter)
{
  g_return_if_fail (tree_model != NULL);
  g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
  g_return_if_fail (path != NULL);
  g_return_if_fail (iter != NULL);

  g_signal_emit_by_name (tree_model, "inserted", path, iter);
}

void
gtk_tree_model_child_toggled (GtkTreeModel *tree_model,
			      GtkTreePath  *path,
			      GtkTreeIter  *iter)
{
  g_return_if_fail (tree_model != NULL);
  g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
  g_return_if_fail (path != NULL);
  g_return_if_fail (iter != NULL);

  g_signal_emit_by_name (tree_model, "child_toggled", path, iter);
}

void
gtk_tree_model_deleted (GtkTreeModel *tree_model,
			GtkTreePath  *path)
{
  g_return_if_fail (tree_model != NULL);
  g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
  g_return_if_fail (path != NULL);

  g_signal_emit_by_name (tree_model, "deleted", path);
}
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279


/**
 ** GtkTreeRowReference
 **/

#define ROW_REF_DATA_STRING "gtk-tree-row-refs"

struct _GtkTreeRowReference
{
  GObject *proxy;
  GtkTreeModel *model;
  GtkTreePath *path;
};

typedef struct
{
  GSList *list;
} RowRefList;


static void
release_row_references (gpointer data)
{
  RowRefList *refs = data;
  GSList *tmp_list = NULL;

  tmp_list = refs->list;
  while (tmp_list != NULL)
    {
      GtkTreeRowReference *reference = tmp_list->data;

      if (reference->proxy == (GObject *)reference->model)
	reference->model = NULL;
      reference->proxy = NULL;

      /* we don't free the reference, users are responsible for that. */

      tmp_list = g_slist_next (tmp_list);
    }

  g_slist_free (refs->list);
  g_free (refs);
}

static void
gtk_tree_row_ref_inserted_callback (GObject     *object,
				    GtkTreePath *path,
				    GtkTreeIter *iter,
				    gpointer     data)
{
  RowRefList *refs = g_object_get_data (data, ROW_REF_DATA_STRING);

  GSList *tmp_list;

  if (refs == NULL)
    return;

  /* This function corrects the path stored in the reference to
   * account for an insertion. Note that it's called _after_ the insertion
   * with the path to the newly-inserted row. Which means that
   * the inserted path is in a different "coordinate system" than
   * the old path (e.g. if the inserted path was just before the old path,
   * then inserted path and old path will be the same, and old path must be
   * moved down one).
   */

  tmp_list = refs->list;

  while (tmp_list != NULL)
    {
      GtkTreeRowReference *reference = tmp_list->data;

      if (reference->path)
	{
	  gint depth = gtk_tree_path_get_depth (path);
	  gint ref_depth = gtk_tree_path_get_depth (reference->path);

	  if (ref_depth >= depth)
	    {
	      gint *indices = gtk_tree_path_get_indices (path);
	      gint *ref_indices = gtk_tree_path_get_indices (reference->path);
	      gint i;

	      /* This is the depth that might affect us. */
	      i = depth - 1;

	      if (indices[i] <= ref_indices[i])
		ref_indices[i] += 1;
	    }
	}

      tmp_list = g_slist_next (tmp_list);
    }
}

static void
gtk_tree_row_ref_deleted_callback (GObject     *object,
				   GtkTreePath *path,
				   gpointer     data)
{
  RowRefList *refs = g_object_get_data (data, ROW_REF_DATA_STRING);
  GSList *tmp_list;

  if (refs == NULL)
    return;

  /* This function corrects the path stored in the reference to
   * account for an deletion. Note that it's called _after_ the
   * deletion with the old path of the just-deleted row. Which means
   * that the deleted path is the same now-defunct "coordinate system"
   * as the path saved in the reference, which is what we want to fix.
   *
   * Note that this is different from the situation in "inserted," so
   * while you might think you can cut-and-paste between these
   * functions, it's not going to work. ;-)
   */

  tmp_list = refs->list;

  while (tmp_list != NULL)
    {
      GtkTreeRowReference *reference = tmp_list->data;

      if (reference->path)
	{
	  gint depth = gtk_tree_path_get_depth (path);
	  gint ref_depth = gtk_tree_path_get_depth (reference->path);

	  if (ref_depth >= depth)
	    {
	      /* Need to adjust path upward */
	      gint *indices = gtk_tree_path_get_indices (path);
	      gint *ref_indices = gtk_tree_path_get_indices (reference->path);
	      gint i;

	      i = depth - 1;
	      if (indices[i] < ref_indices[i])
		ref_indices[i] -= 1;
	      else if (indices[i] == ref_indices[i])
		{
		  /* the referenced node itself, or its parent, was
		   * deleted, mark invalid
		   */

		  gtk_tree_path_free (reference->path);
		  reference->path = NULL;
		}
	    }

	}
      tmp_list = g_slist_next (tmp_list);
    }
}

static void
connect_ref_callbacks (GtkTreeModel *model)
{
  g_signal_connect_data (G_OBJECT (model),
                         "inserted",
                         (GCallback) gtk_tree_row_ref_inserted_callback,
                         model,
                         NULL,
                         FALSE,
                         FALSE);

  g_signal_connect_data (G_OBJECT (model),
                         "deleted",
                         (GCallback) gtk_tree_row_ref_deleted_callback,
			 model,
                         NULL,
                         FALSE,
                         FALSE);
}

static void
disconnect_ref_callbacks (GtkTreeModel *model)
{
  g_signal_handlers_disconnect_matched (G_OBJECT (model),
                                        G_SIGNAL_MATCH_FUNC,
                                        0, 0, NULL,
					gtk_tree_row_ref_inserted_callback,
					NULL);
  g_signal_handlers_disconnect_matched (G_OBJECT (model),
                                        G_SIGNAL_MATCH_FUNC,
                                        0, 0, NULL,
					gtk_tree_row_ref_deleted_callback,
					NULL);
}

GtkTreeRowReference *
gtk_tree_row_reference_new (GtkTreeModel *model,
                            GtkTreePath  *path)
{
  g_return_val_if_fail (model != NULL, NULL);
  g_return_val_if_fail (GTK_IS_TREE_MODEL (model), NULL);
  g_return_val_if_fail (path != NULL, NULL);

  return gtk_tree_row_reference_new_proxy (G_OBJECT (model), model, path);
}

GtkTreeRowReference *
gtk_tree_row_reference_new_proxy (GObject      *proxy,
				  GtkTreeModel *model,
				  GtkTreePath  *path)
{
  GtkTreeRowReference *reference;
  RowRefList *refs;

  g_return_val_if_fail (proxy != NULL, NULL);
  g_return_val_if_fail (G_IS_OBJECT (proxy), NULL);
  g_return_val_if_fail (model != NULL, NULL);
  g_return_val_if_fail (GTK_IS_TREE_MODEL (model), NULL);
  g_return_val_if_fail (path != NULL, NULL);

  reference = g_new (GtkTreeRowReference, 1);

  reference->proxy = proxy;
  reference->model = model;
  reference->path = gtk_tree_path_copy (path);

  refs = g_object_get_data (G_OBJECT (proxy), ROW_REF_DATA_STRING);

  if (refs == NULL)
    {
      refs = g_new (RowRefList, 1);
      refs->list = NULL;

1280
      if (G_OBJECT (model) == proxy)
1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360
	connect_ref_callbacks (model);

      g_object_set_data_full (G_OBJECT (proxy),
			      ROW_REF_DATA_STRING,
                              refs, release_row_references);
    }

  refs->list = g_slist_prepend (refs->list, reference);

  return reference;
}

GtkTreePath *
gtk_tree_row_reference_get_path (GtkTreeRowReference *reference)
{
  g_return_val_if_fail (reference != NULL, NULL);

  if (reference->proxy == NULL)
    return NULL;

  if (reference->path == NULL)
    return NULL;

  return gtk_tree_path_copy (reference->path);
}

void
gtk_tree_row_reference_free (GtkTreeRowReference *reference)
{
  RowRefList *refs;

  g_return_if_fail (reference != NULL);

  if (reference->proxy)
    {
      refs = g_object_get_data (G_OBJECT (reference->proxy), ROW_REF_DATA_STRING);

      if (refs == NULL)
        {
          g_warning (G_STRLOC": bad row reference, proxy has no outstanding row references");
          return;
        }

      refs->list = g_slist_remove (refs->list, reference);

      if (refs->list == NULL)
        {
          disconnect_ref_callbacks (reference->model);
          g_object_set_data (G_OBJECT (reference->proxy),
                             ROW_REF_DATA_STRING,
                             NULL);
        }
    }

  if (reference->path)
    gtk_tree_path_free (reference->path);

  g_free (reference);
}

void
gtk_tree_row_reference_inserted (GObject     *proxy,
				 GtkTreePath *path)
{
  g_return_if_fail (proxy != NULL);
  g_return_if_fail (G_IS_OBJECT (proxy));

  gtk_tree_row_ref_inserted_callback (NULL, path, NULL, proxy);
  
}

void
gtk_tree_row_reference_deleted (GObject     *proxy,
				GtkTreePath *path)
{
  g_return_if_fail (proxy != NULL);
  g_return_if_fail (G_IS_OBJECT (proxy));

  gtk_tree_row_ref_deleted_callback (NULL, path, proxy);
}