clutter-container.c 44.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
/*
 * Clutter.
 *
 * An OpenGL based 'interactive canvas' library.
 *
 * Authored By Matthew Allum  <mallum@openedhand.com>
 *
 * Copyright (C) 2006 OpenedHand
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
21 22 23
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
 *
 *
24 25 26 27 28
 *
 * ClutterContainer: Generic actor container interface.
 * Author: Emmanuele Bassi <ebassi@openedhand.com>
 */

29
#ifdef HAVE_CONFIG_H
30
#include "config.h"
31
#endif
32 33 34

#include <stdarg.h>
#include <glib-object.h>
35
#include <gobject/gvaluecollector.h>
36

37 38 39
#define CLUTTER_DISABLE_DEPRECATION_WARNINGS
#include "deprecated/clutter-container.h"

40
#include "clutter-actor-private.h"
41
#include "clutter-child-meta.h"
42 43 44 45 46 47
#include "clutter-debug.h"
#include "clutter-main.h"
#include "clutter-marshal.h"
#include "clutter-private.h"
#include "clutter-enum-types.h"

48 49
#define CLUTTER_CONTAINER_WARN_NOT_IMPLEMENTED(container,vfunc) \
        G_STMT_START { \
50
          g_warning ("Container of type '%s' does not implement " \
51 52 53 54 55 56 57 58
                     "the required ClutterContainer::%s virtual " \
                     "function.",                                 \
                     G_OBJECT_TYPE_NAME ((container)),            \
                     (vfunc));                                    \
        } G_STMT_END

#define CLUTTER_CONTAINER_NOTE_NOT_IMPLEMENTED(container,vfunc) \
        G_STMT_START { \
59
          CLUTTER_NOTE (ACTOR, "Container of type '%s' does not "    \
60 61 62 63 64
                               "implement the ClutterContainer::%s " \
                               "virtual function.",                  \
                        G_OBJECT_TYPE_NAME ((container)),            \
                        (vfunc));                                    \
        } G_STMT_END
65

66 67
/**
 * SECTION:clutter-container
68
 * @short_description: An interface for container actors
69
 *
70 71 72 73 74 75 76 77 78 79 80
 * #ClutterContainer is an interface implemented by #ClutterActor, and
 * it provides some common API for notifying when a child actor is added
 * or removed, as well as the infrastructure for accessing child properties
 * through #ClutterChildMeta.
 *
 * Until Clutter 1.10, the #ClutterContainer interface was also the public
 * API for implementing container actors; this part of the interface has
 * been deprecated: #ClutterContainer has a default implementation which
 * defers to #ClutterActor the child addition and removal, as well as the
 * iteration. See the documentation of #ClutterContainerIface for the list
 * of virtual functions that should be overridden.
81 82 83 84 85 86
 */

enum
{
  ACTOR_ADDED,
  ACTOR_REMOVED,
87
  CHILD_NOTIFY,
88 89 90 91 92

  LAST_SIGNAL
};

static guint container_signals[LAST_SIGNAL] = { 0, };
93 94
static GQuark quark_child_meta = 0;

95 96 97 98 99 100
static ClutterChildMeta *get_child_meta     (ClutterContainer *container,
                                             ClutterActor     *actor);
static void              create_child_meta  (ClutterContainer *container,
                                             ClutterActor     *actor);
static void              destroy_child_meta (ClutterContainer *container,
                                             ClutterActor     *actor);
101 102 103
static void              child_notify       (ClutterContainer *container,
                                             ClutterActor     *child,
                                             GParamSpec       *pspec);
104

Emmanuele Bassi's avatar
Emmanuele Bassi committed
105
typedef ClutterContainerIface   ClutterContainerInterface;
106

107
G_DEFINE_INTERFACE (ClutterContainer, clutter_container, G_TYPE_OBJECT);
108

109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
static void
container_real_add (ClutterContainer *container,
                    ClutterActor     *actor)
{
  clutter_actor_add_child (CLUTTER_ACTOR (container), actor);
}

static void
container_real_remove (ClutterContainer *container,
                       ClutterActor     *actor)
{
  clutter_actor_remove_child (CLUTTER_ACTOR (container), actor);
}

typedef struct {
  ClutterCallback callback;
  gpointer data;
} ForeachClosure;

static gboolean
foreach_cb (ClutterActor *actor,
            gpointer      data)
{
  ForeachClosure *clos = data;

  clos->callback (actor, clos->data);

  return TRUE;
}

static void
container_real_foreach (ClutterContainer *container,
                        ClutterCallback   callback,
                        gpointer          user_data)
{
  ForeachClosure clos;

  clos.callback = callback;
  clos.data = user_data;

  _clutter_actor_foreach_child (CLUTTER_ACTOR (container),
                                foreach_cb,
                                &clos);
}

154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
static void
container_real_raise (ClutterContainer *container,
                      ClutterActor     *child,
                      ClutterActor     *sibling)
{
  ClutterActor *self = CLUTTER_ACTOR (container);

  clutter_actor_set_child_above_sibling (self, child, sibling);
}

static void
container_real_lower (ClutterContainer *container,
                      ClutterActor     *child,
                      ClutterActor     *sibling)
{
  ClutterActor *self = CLUTTER_ACTOR (container);

  clutter_actor_set_child_below_sibling (self, child, sibling);
}

static void
container_real_sort_depth_order (ClutterContainer *container)
{
}

Emmanuele Bassi's avatar
Emmanuele Bassi committed
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
static void
clutter_container_default_init (ClutterContainerInterface *iface)
{
  GType iface_type = G_TYPE_FROM_INTERFACE (iface);

  quark_child_meta =
    g_quark_from_static_string ("clutter-container-child-data");

  /**
   * ClutterContainer::actor-added:
   * @container: the actor which received the signal
   * @actor: the new child that has been added to @container
   *
   * The ::actor-added signal is emitted each time an actor
   * has been added to @container.
   *
   * Since: 0.4
   */
  container_signals[ACTOR_ADDED] =
    g_signal_new (I_("actor-added"),
                  iface_type,
                  G_SIGNAL_RUN_FIRST,
                  G_STRUCT_OFFSET (ClutterContainerIface, actor_added),
                  NULL, NULL,
                  _clutter_marshal_VOID__OBJECT,
                  G_TYPE_NONE, 1,
                  CLUTTER_TYPE_ACTOR);
  /**
   * ClutterContainer::actor-removed:
   * @container: the actor which received the signal
   * @actor: the child that has been removed from @container
   *
   * The ::actor-removed signal is emitted each time an actor
   * is removed from @container.
   *
   * Since: 0.4
   */
  container_signals[ACTOR_REMOVED] =
    g_signal_new (I_("actor-removed"),
                  iface_type,
                  G_SIGNAL_RUN_FIRST,
                  G_STRUCT_OFFSET (ClutterContainerIface, actor_removed),
                  NULL, NULL,
                  _clutter_marshal_VOID__OBJECT,
                  G_TYPE_NONE, 1,
                  CLUTTER_TYPE_ACTOR);

  /**
   * ClutterContainer::child-notify:
   * @container: the container which received the signal
   * @actor: the child that has had a property set
230
   * @pspec: (type GParamSpec): the #GParamSpec of the property set
Emmanuele Bassi's avatar
Emmanuele Bassi committed
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
   *
   * The ::child-notify signal is emitted each time a property is
   * being set through the clutter_container_child_set() and
   * clutter_container_child_set_property() calls.
   *
   * Since: 0.8
   */
  container_signals[CHILD_NOTIFY] =
    g_signal_new (I_("child-notify"),
                  iface_type,
                  G_SIGNAL_RUN_FIRST | G_SIGNAL_DETAILED,
                  G_STRUCT_OFFSET (ClutterContainerIface, child_notify),
                  NULL, NULL,
                  _clutter_marshal_VOID__OBJECT_PARAM,
                  G_TYPE_NONE, 2,
                  CLUTTER_TYPE_ACTOR, G_TYPE_PARAM);

248 249 250
  iface->add = container_real_add;
  iface->remove = container_real_remove;
  iface->foreach = container_real_foreach;
251 252 253
  iface->raise = container_real_raise;
  iface->lower = container_real_lower;
  iface->sort_depth_order = container_real_sort_depth_order;
254 255 256

  iface->child_meta_type = G_TYPE_INVALID;
  iface->create_child_meta = create_child_meta;
Emmanuele Bassi's avatar
Emmanuele Bassi committed
257
  iface->destroy_child_meta = destroy_child_meta;
258 259
  iface->get_child_meta = get_child_meta;
  iface->child_notify = child_notify;
260 261
}

262 263 264 265 266 267 268
static inline void
container_add_actor (ClutterContainer *container,
                     ClutterActor     *actor)
{
  ClutterActor *parent;

  parent = clutter_actor_get_parent (actor);
269
  if (G_UNLIKELY (parent != NULL))
270 271 272 273 274 275 276 277 278 279 280 281
    {
      g_warning ("Attempting to add actor of type '%s' to a "
		 "container of type '%s', but the actor has "
                 "already a parent of type '%s'.",
		 g_type_name (G_OBJECT_TYPE (actor)),
		 g_type_name (G_OBJECT_TYPE (container)),
		 g_type_name (G_OBJECT_TYPE (parent)));
      return;
    }

  clutter_container_create_child_meta (container, actor);

282 283 284 285 286 287 288 289 290 291 292 293 294
#ifdef CLUTTER_ENABLE_DEBUG
  if (G_UNLIKELY (_clutter_diagnostic_enabled ()))
    {
      ClutterContainerIface *iface = CLUTTER_CONTAINER_GET_IFACE (container);

      if (iface->add != container_real_add)
        _clutter_diagnostic_message ("The ClutterContainer::add() virtual "
                                     "function has been deprecated and it "
                                     "should not be overridden by newly "
                                     "written code");
    }
#endif /* CLUTTER_ENABLE_DEBUG */

295
  CLUTTER_CONTAINER_GET_IFACE (container)->add (container, actor);
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
}

static inline void
container_remove_actor (ClutterContainer *container,
                        ClutterActor     *actor)
{
  ClutterActor *parent;

  parent = clutter_actor_get_parent (actor);
  if (parent != CLUTTER_ACTOR (container))
    {
      g_warning ("Attempting to remove actor of type '%s' from "
		 "group of class '%s', but the container is not "
                 "the actor's parent.",
		 g_type_name (G_OBJECT_TYPE (actor)),
		 g_type_name (G_OBJECT_TYPE (container)));
      return;
    }

  clutter_container_destroy_child_meta (container, actor);

317 318 319 320 321 322 323 324 325 326 327 328 329
#ifdef CLUTTER_ENABLE_DEBUG
  if (G_UNLIKELY (_clutter_diagnostic_enabled ()))
    {
      ClutterContainerIface *iface = CLUTTER_CONTAINER_GET_IFACE (container);

      if (iface->remove != container_real_remove)
        _clutter_diagnostic_message ("The ClutterContainer::remove() virtual "
                                     "function has been deprecated and it "
                                     "should not be overridden by newly "
                                     "written code");
    }
#endif /* CLUTTER_ENABLE_DEBUG */

330
  CLUTTER_CONTAINER_GET_IFACE (container)->remove (container, actor);
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
}

static inline void
container_add_valist (ClutterContainer *container,
                      ClutterActor     *first_actor,
                      va_list           args)
{
  ClutterActor *actor = first_actor;

  while (actor != NULL)
    {
      container_add_actor (container, actor);
      actor = va_arg (args, ClutterActor *);
    }
}

static inline void
container_remove_valist (ClutterContainer *container,
                         ClutterActor     *first_actor,
                         va_list           args)
{
  ClutterActor *actor = first_actor;

  while (actor != NULL)
    {
      container_remove_actor (container, actor);
      actor = va_arg (args, ClutterActor *);
    }
}

361
/**
362
 * clutter_container_add: (skip)
363 364
 * @container: a #ClutterContainer
 * @first_actor: the first #ClutterActor to add
365
 * @...: %NULL terminated list of actors to add
366 367 368 369 370 371
 *
 * Adds a list of #ClutterActor<!-- -->s to @container. Each time and
 * actor is added, the "actor-added" signal is emitted. Each actor should
 * be parented to @container, which takes a reference on the actor. You
 * cannot add a #ClutterActor to more than one #ClutterContainer.
 *
372 373 374 375
 * This function will call #ClutterContainerIface.add(), which is a
 * deprecated virtual function. The default implementation will
 * call clutter_actor_add_child().
 *
376
 * Since: 0.4
377 378
 *
 * Deprecated: 1.10: Use clutter_actor_add_child() instead.
379 380 381 382 383 384
 */
void
clutter_container_add (ClutterContainer *container,
                       ClutterActor     *first_actor,
                       ...)
{
385
  va_list args;
386 387 388 389

  g_return_if_fail (CLUTTER_IS_CONTAINER (container));
  g_return_if_fail (CLUTTER_IS_ACTOR (first_actor));

390
  va_start (args, first_actor);
391
  container_add_valist (container, first_actor, args);
392
  va_end (args);
393 394 395
}

/**
396
 * clutter_container_add_actor: (virtual add)
397 398 399 400
 * @container: a #ClutterContainer
 * @actor: the first #ClutterActor to add
 *
 * Adds a #ClutterActor to @container. This function will emit the
401
 * "actor-added" signal. The actor should be parented to
402 403 404
 * @container. You cannot add a #ClutterActor to more than one
 * #ClutterContainer.
 *
405 406 407 408
 * This function will call #ClutterContainerIface.add(), which is a
 * deprecated virtual function. The default implementation will
 * call clutter_actor_add_child().
 *
409
 * Since: 0.4
410 411
 *
 * Deprecated: 1.10: Use clutter_actor_add_child() instead.
412 413 414 415 416 417 418 419
 */
void
clutter_container_add_actor (ClutterContainer *container,
                             ClutterActor     *actor)
{
  g_return_if_fail (CLUTTER_IS_CONTAINER (container));
  g_return_if_fail (CLUTTER_IS_ACTOR (actor));

420
  container_add_actor (container, actor);
421 422 423
}

/**
424
 * clutter_container_add_valist: (skip)
425 426 427 428 429 430
 * @container: a #ClutterContainer
 * @first_actor: the first #ClutterActor to add
 * @var_args: list of actors to add, followed by %NULL
 *
 * Alternative va_list version of clutter_container_add().
 *
431 432 433 434
 * This function will call #ClutterContainerIface.add(), which is a
 * deprecated virtual function. The default implementation will
 * call clutter_actor_add_child().
 *
435
 * Since: 0.4
436 437
 *
 * Deprecated: 1.10: Use clutter_actor_add_child() instead.
438 439 440 441 442 443 444 445 446
 */
void
clutter_container_add_valist (ClutterContainer *container,
                              ClutterActor     *first_actor,
                              va_list           var_args)
{
  g_return_if_fail (CLUTTER_IS_CONTAINER (container));
  g_return_if_fail (CLUTTER_IS_ACTOR (first_actor));

447
  container_add_valist (container, first_actor, var_args);
448 449 450
}

/**
451
 * clutter_container_remove: (skip)
452 453
 * @container: a #ClutterContainer
 * @first_actor: first #ClutterActor to remove
454
 * @...: a %NULL-terminated list of actors to remove
455 456 457 458 459 460 461
 *
 * Removes a %NULL terminated list of #ClutterActor<!-- -->s from
 * @container. Each actor should be unparented, so if you want to keep it
 * around you must hold a reference to it yourself, using g_object_ref().
 * Each time an actor is removed, the "actor-removed" signal is
 * emitted by @container.
 *
462 463 464 465
 * This function will call #ClutterContainerIface.remove(), which is a
 * deprecated virtual function. The default implementation will call
 * clutter_actor_remove_child().
 *
466
 * Since: 0.4
467 468
 *
 * Deprecated: 1.10: Use clutter_actor_remove_child() instead.
469 470 471 472 473 474 475 476 477 478 479 480
 */
void
clutter_container_remove (ClutterContainer *container,
                          ClutterActor     *first_actor,
                          ...)
{
  va_list var_args;

  g_return_if_fail (CLUTTER_IS_CONTAINER (container));
  g_return_if_fail (CLUTTER_IS_ACTOR (first_actor));

  va_start (var_args, first_actor);
481
  container_remove_valist (container, first_actor, var_args);
482 483 484 485
  va_end (var_args);
}

/**
486
 * clutter_container_remove_actor: (virtual remove)
487 488 489 490 491 492 493 494
 * @container: a #ClutterContainer
 * @actor: a #ClutterActor
 *
 * Removes @actor from @container. The actor should be unparented, so
 * if you want to keep it around you must hold a reference to it
 * yourself, using g_object_ref(). When the actor has been removed,
 * the "actor-removed" signal is emitted by @container.
 *
495 496 497 498
 * This function will call #ClutterContainerIface.remove(), which is a
 * deprecated virtual function. The default implementation will call
 * clutter_actor_remove_child().
 *
499
 * Since: 0.4
500 501
 *
 * Deprecated: 1.10: Use clutter_actor_remove_child() instead.
502 503 504 505 506 507 508 509
 */
void
clutter_container_remove_actor (ClutterContainer *container,
                                ClutterActor     *actor)
{
  g_return_if_fail (CLUTTER_IS_CONTAINER (container));
  g_return_if_fail (CLUTTER_IS_ACTOR (actor));

510
  container_remove_actor (container, actor);
511 512 513
}

/**
514
 * clutter_container_remove_valist: (skip)
515 516 517 518 519 520
 * @container: a #ClutterContainer
 * @first_actor: the first #ClutterActor to add
 * @var_args: list of actors to remove, followed by %NULL
 *
 * Alternative va_list version of clutter_container_remove().
 *
521 522 523 524
 * This function will call #ClutterContainerIface.remove(), which is a
 * deprecated virtual function. The default implementation will call
 * clutter_actor_remove_child().
 *
525
 * Since: 0.4
526 527
 *
 * Deprecated: 1.10: Use clutter_actor_remove_child() instead.
528 529 530 531 532 533 534 535 536
 */
void
clutter_container_remove_valist (ClutterContainer *container,
                                 ClutterActor     *first_actor,
                                 va_list           var_args)
{
  g_return_if_fail (CLUTTER_IS_CONTAINER (container));
  g_return_if_fail (CLUTTER_IS_ACTOR (first_actor));

537
  container_remove_valist (container, first_actor, var_args);
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554
}

static void
get_children_cb (ClutterActor *child,
                 gpointer      data)
{
  GList **children = data;

  *children = g_list_prepend (*children, child);
}

/**
 * clutter_container_get_children:
 * @container: a #ClutterContainer
 *
 * Retrieves all the children of @container.
 *
555
 * Return value: (element-type Clutter.Actor) (transfer container): a list
556 557
 *   of #ClutterActor<!-- -->s. Use g_list_free() on the returned
 *   list when done.
558 559
 *
 * Since: 0.4
560 561
 *
 * Deprecated: 1.10: Use clutter_actor_get_children() instead.
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578
 */
GList *
clutter_container_get_children (ClutterContainer *container)
{
  GList *retval;

  g_return_val_if_fail (CLUTTER_IS_CONTAINER (container), NULL);

  retval = NULL;
  clutter_container_foreach (container, get_children_cb, &retval);

  return g_list_reverse (retval);
}

/**
 * clutter_container_foreach:
 * @container: a #ClutterContainer
579
 * @callback: (scope call): a function to be called for each child
580 581
 * @user_data: data to be passed to the function, or %NULL
 *
582 583 584 585
 * Calls @callback for each child of @container that was added
 * by the application (with clutter_container_add_actor()). Does
 * not iterate over "internal" children that are part of the
 * container's own implementation, if any.
586
 *
587 588 589
 * This function calls the #ClutterContainerIface.foreach()
 * virtual function, which has been deprecated.
 *
590
 * Since: 0.4
591 592 593 594
 *
 * Deprecated: 1.10: Use clutter_actor_get_first_child() or
 *   clutter_actor_get_last_child() to retrieve the beginning of
 *   the list of children, and clutter_actor_get_next_sibling()
595 596
 *   and clutter_actor_get_previous_sibling() to iterate over it;
 *   alternatively, use the #ClutterActorIter API.
597 598 599 600 601 602 603 604 605
 */
void
clutter_container_foreach (ClutterContainer *container,
                           ClutterCallback   callback,
                           gpointer          user_data)
{
  g_return_if_fail (CLUTTER_IS_CONTAINER (container));
  g_return_if_fail (callback != NULL);

606 607 608 609 610 611 612 613 614 615 616 617 618
#ifdef CLUTTER_ENABLE_DEBUG
  if (G_UNLIKELY (_clutter_diagnostic_enabled ()))
    {
      ClutterContainerIface *iface = CLUTTER_CONTAINER_GET_IFACE (container);

      if (iface->foreach != container_real_foreach)
        _clutter_diagnostic_message ("The ClutterContainer::foreach() "
                                     "virtual function has been deprecated "
                                     "and it should not be overridden by "
                                     "newly written code");
    }
#endif /* CLUTTER_ENABLE_DEBUG */

619 620 621
  CLUTTER_CONTAINER_GET_IFACE (container)->foreach (container,
                                                    callback,
                                                    user_data);
622 623
}

624 625 626
/**
 * clutter_container_foreach_with_internals:
 * @container: a #ClutterContainer
627
 * @callback: (scope call): a function to be called for each child
628 629 630 631 632 633
 * @user_data: data to be passed to the function, or %NULL
 *
 * Calls @callback for each child of @container, including "internal"
 * children built in to the container itself that were never added
 * by the application.
 *
634 635 636
 * This function calls the #ClutterContainerIface.foreach_with_internals()
 * virtual function, which has been deprecated.
 *
637
 * Since: 1.0
638 639
 *
 * Deprecated: 1.10: See clutter_container_foreach().
640 641 642 643 644 645 646 647 648 649 650 651
 */
void
clutter_container_foreach_with_internals (ClutterContainer *container,
                                          ClutterCallback   callback,
                                          gpointer          user_data)
{
  ClutterContainerIface *iface;

  g_return_if_fail (CLUTTER_IS_CONTAINER (container));
  g_return_if_fail (callback != NULL);

  iface = CLUTTER_CONTAINER_GET_IFACE (container);
652 653 654

#ifdef CLUTTER_ENABLE_DEBUG
  if (G_UNLIKELY (_clutter_diagnostic_enabled ()))
655
    {
656 657 658 659 660
      if (iface->foreach_with_internals != NULL)
        _clutter_diagnostic_message ("The ClutterContainer::foreach_with_internals() "
                                     "virtual function has been deprecated "
                                     "and it should not be overridden by "
                                     "newly written code");
661
    }
662
#endif /* CLUTTER_ENABLE_DEBUG */
663 664 665 666 667 668 669

  if (iface->foreach_with_internals != NULL)
    iface->foreach_with_internals (container, callback, user_data);
  else
    iface->foreach (container, callback, user_data);
}

670
/**
671
 * clutter_container_raise_child: (virtual raise)
672 673
 * @container: a #ClutterContainer
 * @actor: the actor to raise
674 675
 * @sibling: (allow-none): the sibling to raise to, or %NULL to raise
 *   to the top
676
 *
677
 * Raises @actor to @sibling level, in the depth ordering.
678
 *
679 680 681 682
 * This function calls the #ClutterContainerIface.raise() virtual function,
 * which has been deprecated. The default implementation will call
 * clutter_actor_set_child_above_sibling().
 *
683
 * Since: 0.6
684 685
 *
 * Deprecated: 1.10: Use clutter_actor_set_child_above_sibling() instead.
686 687
 */
void
688 689
clutter_container_raise_child (ClutterContainer *container,
                               ClutterActor     *actor,
690
                               ClutterActor     *sibling)
691
{
692
  ClutterContainerIface *iface;
693
  ClutterActor *self;
694

695 696 697 698 699 700 701
  g_return_if_fail (CLUTTER_IS_CONTAINER (container));
  g_return_if_fail (CLUTTER_IS_ACTOR (actor));
  g_return_if_fail (sibling == NULL || CLUTTER_IS_ACTOR (sibling));

  if (actor == sibling)
    return;

702 703 704
  self = CLUTTER_ACTOR (container);

  if (clutter_actor_get_parent (actor) != self)
705
    {
706 707
      g_warning ("Actor of type '%s' is not a child of the container "
                 "of type '%s'",
708 709 710 711 712
                 g_type_name (G_OBJECT_TYPE (actor)),
                 g_type_name (G_OBJECT_TYPE (container)));
      return;
    }

713 714
  if (sibling != NULL &&
      clutter_actor_get_parent (sibling) != self)
715
    {
716 717
      g_warning ("Actor of type '%s' is not a child of the container "
                 "of type '%s'",
718 719 720 721
                 g_type_name (G_OBJECT_TYPE (sibling)),
                 g_type_name (G_OBJECT_TYPE (container)));
      return;
    }
722

723 724 725 726 727 728 729 730 731 732 733 734 735
  iface = CLUTTER_CONTAINER_GET_IFACE (container);

#ifdef CLUTTER_ENABLE_DEBUG
  if (G_UNLIKELY (_clutter_diagnostic_enabled ()))
    {
      if (iface->raise != container_real_raise)
        _clutter_diagnostic_message ("The ClutterContainer::raise() "
                                     "virtual function has been deprecated "
                                     "and it should not be overridden by "
                                     "newly written code");
    }
#endif /* CLUTTER_ENABLE_DEBUG */

736
  iface->raise (container, actor, sibling);
737 738 739
}

/**
740
 * clutter_container_lower_child: (virtual lower)
741 742
 * @container: a #ClutterContainer
 * @actor: the actor to raise
743 744
 * @sibling: (allow-none): the sibling to lower to, or %NULL to lower
 *   to the bottom
745
 *
746
 * Lowers @actor to @sibling level, in the depth ordering.
747
 *
748 749 750 751
 * This function calls the #ClutterContainerIface.lower() virtual function,
 * which has been deprecated. The default implementation will call
 * clutter_actor_set_child_below_sibling().
 *
752
 * Since: 0.6
753 754
 *
 * Deprecated: 1.10: Use clutter_actor_set_child_below_sibling() instead.
755 756
 */
void
757 758
clutter_container_lower_child (ClutterContainer *container,
                               ClutterActor     *actor,
759
                               ClutterActor     *sibling)
760
{
761
  ClutterContainerIface *iface;
762
  ClutterActor *self;
763

764 765 766 767 768 769 770
  g_return_if_fail (CLUTTER_IS_CONTAINER (container));
  g_return_if_fail (CLUTTER_IS_ACTOR (actor));
  g_return_if_fail (sibling == NULL || CLUTTER_IS_ACTOR (sibling));

  if (actor == sibling)
    return;

771 772 773
  self = CLUTTER_ACTOR (container);

  if (clutter_actor_get_parent (actor) != self)
774
    {
775 776
      g_warning ("Actor of type '%s' is not a child of the container "
                 "of type '%s'",
777 778 779 780 781
                 g_type_name (G_OBJECT_TYPE (actor)),
                 g_type_name (G_OBJECT_TYPE (container)));
      return;
    }

782 783
  if (sibling != NULL&&
      clutter_actor_get_parent (sibling) != self)
784
    {
785 786
      g_warning ("Actor of type '%s' is not a child of the container "
                 "of type '%s'",
787 788 789 790
                 g_type_name (G_OBJECT_TYPE (sibling)),
                 g_type_name (G_OBJECT_TYPE (container)));
      return;
    }
791

792 793 794 795 796 797 798 799 800 801 802 803 804
  iface = CLUTTER_CONTAINER_GET_IFACE (container);

#ifdef CLUTTER_ENABLE_DEBUG
  if (G_UNLIKELY (_clutter_diagnostic_enabled ()))
    {
      if (iface->lower != container_real_lower)
        _clutter_diagnostic_message ("The ClutterContainer::lower() "
                                     "virtual function has been deprecated "
                                     "and it should not be overridden by "
                                     "newly written code");
    }
#endif /* CLUTTER_ENABLE_DEBUG */

805
  iface->lower (container, actor, sibling);
806 807 808 809 810 811
}

/**
 * clutter_container_sort_depth_order:
 * @container: a #ClutterContainer
 *
812
 * Sorts a container's children using their depth. This function should not
813 814 815
 * be normally used by applications.
 *
 * Since: 0.6
816 817 818 819
 *
 * Deprecated: 1.10: The #ClutterContainerIface.sort_depth_order() virtual
 *   function should not be used any more; the default implementation in
 *   #ClutterContainer does not do anything.
820 821 822 823
 */
void
clutter_container_sort_depth_order (ClutterContainer *container)
{
824 825
  ClutterContainerIface *iface;

826 827
  g_return_if_fail (CLUTTER_IS_CONTAINER (container));

828
  iface = CLUTTER_CONTAINER_GET_IFACE (container);
829 830 831 832 833 834 835 836 837 838 839 840 841

#ifdef CLUTTER_ENABLE_DEBUG
  if (G_UNLIKELY (_clutter_diagnostic_enabled ()))
    {
      if (iface->sort_depth_order != container_real_sort_depth_order)
        _clutter_diagnostic_message ("The ClutterContainer::sort_depth_order() "
                                     "virtual function has been deprecated "
                                     "and it should not be overridden by "
                                     "newly written code");
    }
#endif /* CLUTTER_ENABLE_DEBUG */

  iface->sort_depth_order (container);
842
}
843 844 845 846

/**
 * clutter_container_find_child_by_name:
 * @container: a #ClutterContainer
847
 * @child_name: the name of the requested child.
848 849 850 851
 *
 * Finds a child actor of a container by its name. Search recurses
 * into any child container.
 *
852 853
 * Return value: (transfer none): The child actor with the requested name,
 *   or %NULL if no actor with that name was found.
854 855 856 857 858 859 860 861 862 863 864 865
 *
 * Since: 0.6
 */
ClutterActor *
clutter_container_find_child_by_name (ClutterContainer *container,
                                      const gchar      *child_name)
{
  GList        *children;
  GList        *iter;
  ClutterActor *actor = NULL;

  g_return_val_if_fail (CLUTTER_IS_CONTAINER (container), NULL);
866
  g_return_val_if_fail (child_name != NULL, NULL);
867 868 869

  children = clutter_container_get_children (container);

870
  for (iter = children; iter; iter = g_list_next (iter))
871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892
    {
      ClutterActor *a;
      const gchar  *iter_name;

      a = CLUTTER_ACTOR (iter->data);
      iter_name = clutter_actor_get_name (a);

      if (iter_name && !strcmp (iter_name, child_name))
        {
          actor = a;
          break;
        }

      if (CLUTTER_IS_CONTAINER (a))
        {
          ClutterContainer *c = CLUTTER_CONTAINER (a);

          actor = clutter_container_find_child_by_name (c, child_name);
          if (actor)
            break;
	}
    }
893

894
  g_list_free (children);
895

896 897
  return actor;
}
898 899 900 901 902 903

static ClutterChildMeta *
get_child_meta (ClutterContainer *container,
                ClutterActor     *actor)
{
  ClutterContainerIface *iface = CLUTTER_CONTAINER_GET_IFACE (container);
904
  ClutterChildMeta *meta;
905 906 907 908

  if (iface->child_meta_type == G_TYPE_INVALID)
    return NULL;

909 910 911
  meta = g_object_get_qdata (G_OBJECT (actor), quark_child_meta);
  if (meta != NULL && meta->actor == actor)
    return meta;
912 913 914 915 916 917 918 919 920

  return NULL;
}

static void
create_child_meta (ClutterContainer *container,
                   ClutterActor     *actor)
{
  ClutterContainerIface *iface = CLUTTER_CONTAINER_GET_IFACE (container);
921
  ClutterChildMeta *child_meta = NULL;
922 923 924 925 926 927

  if (iface->child_meta_type == G_TYPE_INVALID)
    return;

  if (!g_type_is_a (iface->child_meta_type, CLUTTER_TYPE_CHILD_META))
    {
928
      g_warning ("%s: Child data of type '%s' is not a ClutterChildMeta",
929 930 931 932
                 G_STRLOC, g_type_name (iface->child_meta_type));
      return;
    }

933 934 935 936
  child_meta = g_object_new (iface->child_meta_type,
                             "container", container,
                             "actor", actor,
                             NULL);
937

938
  g_object_set_qdata_full (G_OBJECT (actor), quark_child_meta,
939 940
                           child_meta,
                           (GDestroyNotify) g_object_unref);
941 942 943 944 945 946 947 948 949 950 951
}

static void
destroy_child_meta (ClutterContainer *container,
                    ClutterActor     *actor)
{
  ClutterContainerIface *iface  = CLUTTER_CONTAINER_GET_IFACE (container);

  if (iface->child_meta_type == G_TYPE_INVALID)
    return;

952
  g_object_set_qdata (G_OBJECT (actor), quark_child_meta, NULL);
953 954 955 956 957 958 959 960 961 962
}

/**
 * clutter_container_get_child_meta:
 * @container: a #ClutterContainer
 * @actor: a #ClutterActor that is a child of @container.
 *
 * Retrieves the #ClutterChildMeta which contains the data about the
 * @container specific state for @actor.
 *
963 964 965
 * Return value: (transfer none): the #ClutterChildMeta for the @actor child
 *   of @container or %NULL if the specifiec actor does not exist or the
 *   container is not configured to provide #ClutterChildMeta<!-- -->s
966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983
 *
 * Since: 0.8
 */
ClutterChildMeta *
clutter_container_get_child_meta (ClutterContainer *container,
                                  ClutterActor     *actor)
{
  ClutterContainerIface *iface = CLUTTER_CONTAINER_GET_IFACE (container);

  if (iface->child_meta_type == G_TYPE_INVALID)
    return NULL;

  if (G_LIKELY (iface->get_child_meta))
    return iface->get_child_meta (container, actor);

  return NULL;
}

984
/**
985 986 987 988 989 990 991
 * clutter_container_create_child_meta:
 * @container: a #ClutterContainer
 * @actor: a #ClutterActor
 *
 * Creates the #ClutterChildMeta wrapping @actor inside the
 * @container, if the #ClutterContainerIface::child_meta_type
 * class member is not set to %G_TYPE_INVALID.
992 993 994 995 996 997 998 999
 *
 * This function is only useful when adding a #ClutterActor to
 * a #ClutterContainer implementation outside of the
 * #ClutterContainer::add() virtual function implementation.
 *
 * Applications should not call this function.
 *
 * Since: 1.2
1000
 */
1001
void
1002 1003 1004
clutter_container_create_child_meta (ClutterContainer *container,
                                     ClutterActor     *actor)
{
1005 1006 1007
  ClutterContainerIface *iface;

  g_return_if_fail (CLUTTER_IS_CONTAINER (container));
1008
  g_return_if_fail (CLUTTER_IS_ACTOR (actor));
1009 1010

  iface = CLUTTER_CONTAINER_GET_IFACE (container);
1011 1012 1013 1014 1015 1016 1017 1018 1019 1020

  if (iface->child_meta_type == G_TYPE_INVALID)
    return;

  g_assert (g_type_is_a (iface->child_meta_type, CLUTTER_TYPE_CHILD_META));

  if (G_LIKELY (iface->create_child_meta))
    iface->create_child_meta (container, actor);
}

1021
/**
1022 1023 1024 1025 1026 1027
 * clutter_container_destroy_child_meta:
 * @container: a #ClutterContainer
 * @actor: a #ClutterActor
 *
 * Destroys the #ClutterChildMeta wrapping @actor inside the
 * @container, if any.
1028 1029 1030 1031 1032 1033 1034 1035
 *
 * This function is only useful when removing a #ClutterActor to
 * a #ClutterContainer implementation outside of the
 * #ClutterContainer::add() virtual function implementation.
 *
 * Applications should not call this function.
 *
 * Since: 1.2
1036
 */
1037
void
1038 1039 1040
clutter_container_destroy_child_meta (ClutterContainer *container,
                                      ClutterActor     *actor)
{
1041 1042 1043 1044 1045 1046
  ClutterContainerIface *iface;

  g_return_if_fail (CLUTTER_IS_CONTAINER (container));
  g_return_if_fail (CLUTTER_IS_ACTOR (actor));

  iface = CLUTTER_CONTAINER_GET_IFACE (container);
1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061

  if (iface->child_meta_type == G_TYPE_INVALID)
    return;

  if (G_LIKELY (iface->destroy_child_meta))
    iface->destroy_child_meta (container, actor);
}

/**
 * clutter_container_class_find_child_property:
 * @klass: a #GObjectClass implementing the #ClutterContainer interface.
 * @property_name: a property name.
 *
 * Looks up the #GParamSpec for a child property of @klass.
 *
1062 1063
 * Return value: (transfer none): The #GParamSpec for the property or %NULL
 *   if no such property exist.
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
 *
 * Since: 0.8
 */
GParamSpec *
clutter_container_class_find_child_property (GObjectClass *klass,
                                             const gchar  *property_name)
{
  ClutterContainerIface *iface;
  GObjectClass          *child_class;
  GParamSpec            *pspec;

  g_return_val_if_fail (G_IS_OBJECT_CLASS (klass), NULL);
  g_return_val_if_fail (property_name != NULL, NULL);
  g_return_val_if_fail (g_type_is_a (G_TYPE_FROM_CLASS (klass),
                                     CLUTTER_TYPE_CONTAINER),
                        NULL);

  iface = g_type_interface_peek (klass, CLUTTER_TYPE_CONTAINER);
  g_return_val_if_fail (iface != NULL, NULL);

  if (iface->child_meta_type == G_TYPE_INVALID)
    return NULL;

  child_class = g_type_class_ref (iface->child_meta_type);
  pspec = g_object_class_find_property (child_class, property_name);
  g_type_class_unref (child_class);

  return pspec;
}

/**
 * clutter_container_class_list_child_properties:
 * @klass: a #GObjectClass implementing the #ClutterContainer interface.
 * @n_properties: return location for length of returned array.
 *
 * Returns an array of #GParamSpec for all child properties.
 *
1101
 * Return value: (array length=n_properties) (transfer full): an array
1102
 *   of #GParamSpec<!-- -->s which should be freed after use.
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
 *
 * Since: 0.8
 */
GParamSpec **
clutter_container_class_list_child_properties (GObjectClass *klass,
                                               guint        *n_properties)
{
  ClutterContainerIface *iface;
  GObjectClass          *child_class;
  GParamSpec           **retval;

  g_return_val_if_fail (G_IS_OBJECT_CLASS (klass), NULL);
  g_return_val_if_fail (g_type_is_a (G_TYPE_FROM_CLASS (klass),
                                     CLUTTER_TYPE_CONTAINER),
                        NULL);

  iface = g_type_interface_peek (klass, CLUTTER_TYPE_CONTAINER);
  g_return_val_if_fail (iface != NULL, NULL);

  if (iface->child_meta_type == G_TYPE_INVALID)
    return NULL;

  child_class = g_type_class_ref (iface->child_meta_type);
  retval = g_object_class_list_properties (child_class, n_properties);
  g_type_class_unref (child_class);

  return retval;
}

1132 1133 1134 1135 1136 1137 1138
static void
child_notify (ClutterContainer *container,
              ClutterActor     *actor,
              GParamSpec       *pspec)
{
}

1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
static inline void
container_set_child_property (ClutterContainer *container,
                              ClutterActor     *actor,
                              const GValue     *value,
                              GParamSpec       *pspec)
{
  ClutterChildMeta *data;

  data = clutter_container_get_child_meta (container, actor);
  g_object_set_property (G_OBJECT (data), pspec->name, value);

1150 1151 1152 1153 1154
  g_signal_emit (container, container_signals[CHILD_NOTIFY],
                 (pspec->flags & G_PARAM_STATIC_NAME)
                   ? g_quark_from_static_string (pspec->name)
                   : g_quark_from_string (pspec->name),
                 actor, pspec);
1155 1156 1157 1158 1159
}

/**
 * clutter_container_child_set_property:
 * @container: a #ClutterContainer
1160
 * @child: a #ClutterActor that is a child of @container.
1161 1162 1163 1164 1165 1166 1167 1168 1169
 * @property: the name of the property to set.
 * @value: the value.
 *
 * Sets a container-specific property on a child of @container.
 *
 * Since: 0.8
 */
void
clutter_container_child_set_property (ClutterContainer *container,
1170
                                      ClutterActor     *child,
1171 1172 1173 1174 1175 1176 1177
                                      const gchar      *property,
                                      const GValue     *value)
{
  GObjectClass *klass;
  GParamSpec   *pspec;

  g_return_if_fail (CLUTTER_IS_CONTAINER (container));
1178
  g_return_if_fail (CLUTTER_IS_ACTOR (child));
1179 1180 1181 1182 1183 1184 1185 1186
  g_return_if_fail (property != NULL);
  g_return_if_fail (value != NULL);

  klass = G_OBJECT_GET_CLASS (container);

  pspec = clutter_container_class_find_child_property (klass, property);
  if (!pspec)
    {
1187 1188
      g_warning ("%s: Containers of type '%s' have no child "
                 "property named '%s'",
1189 1190 1191 1192 1193 1194
                 G_STRLOC, G_OBJECT_TYPE_NAME (container), property);
      return;
    }

  if (!(pspec->flags & G_PARAM_WRITABLE))
    {
1195
      g_warning ("%s: Child property '%s' of the container '%s' "
1196 1197 1198 1199 1200
                 "is not writable",
                 G_STRLOC, pspec->name, G_OBJECT_TYPE_NAME (container));
      return;
    }

1201
  container_set_child_property (container, child, value, pspec);
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
}

/**
 * clutter_container_child_set:
 * @container: a #ClutterContainer
 * @actor: a #ClutterActor that is a child of @container.
 * @first_prop: name of the first property to be set.
 * @...: value for the first property, followed optionally by more name/value
 * pairs terminated with NULL.
 *
 * Sets container specific properties on the child of a container.
 *
 * Since: 0.8
 */
void
clutter_container_child_set (ClutterContainer *container,
                             ClutterActor     *actor,
                             const gchar      *first_prop,
                             ...)
{
  GObjectClass *klass;
  const gchar *name;
  va_list var_args;
  
  g_return_if_fail (CLUTTER_IS_CONTAINER (container));
  g_return_if_fail (CLUTTER_IS_ACTOR (actor));

  klass = G_OBJECT_GET_CLASS (container);

  va_start (var_args, first_prop);

  name = first_prop;
  while (name)
    {
1236
      GValue value = G_VALUE_INIT;
1237 1238 1239 1240 1241 1242
      gchar *error = NULL;
      GParamSpec *pspec;
    
      pspec = clutter_container_class_find_child_property (klass, name);
      if (!pspec)
        {
1243 1244
          g_warning ("%s: Containers of type '%s' have no child "
                     "property named '%s'",
1245 1246 1247 1248 1249 1250
                     G_STRLOC, G_OBJECT_TYPE_NAME (container), name);
          break;
        }

      if (!(pspec->flags & G_PARAM_WRITABLE))
        {
1251
          g_warning ("%s: Child property '%s' of the container '%s' "
1252 1253 1254 1255 1256
                     "is not writable",
                     G_STRLOC, pspec->name, G_OBJECT_TYPE_NAME (container));
          break;
        }

1257 1258 1259 1260
      G_VALUE_COLLECT_INIT (&value, G_PARAM_SPEC_VALUE_TYPE (pspec),
                            var_args, 0,
                            &error);

1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290
      if (error)
        {
          /* we intentionally leak the GValue because it might
           * be in an undefined state and calling g_value_unset()
           * on it might crash
           */
          g_warning ("%s: %s", G_STRLOC, error);
          g_free (error);
          break;
        }

      container_set_child_property (container, actor, &value, pspec);

      g_value_unset (&value);

      name = va_arg (var_args, gchar*);
    }

  va_end (var_args);
}

static inline void
container_get_child_property (ClutterContainer *container,
                              ClutterActor     *actor,
                              GValue           *value,
                              GParamSpec       *pspec)
{
  ClutterChildMeta *data;

  data = clutter_container_get_child_meta (container, actor);
1291
  g_object_get_property (G_OBJECT (data), pspec->name, value);
1292 1293 1294 1295 1296
}

/**
 * clutter_container_child_get_property:
 * @container: a #ClutterContainer
1297
 * @child: a #ClutterActor that is a child of @container.
1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312
 * @property: the name of the property to set.
 * @value: the value.
 *
 * Gets a container specific property of a child of @container, In general,
 * a copy is made of the property contents and the caller is responsible for
 * freeing the memory by calling g_value_unset().
 *
 * Note that clutter_container_child_set_property() is really intended for
 * language bindings, clutter_container_child_set() is much more convenient
 * for C programming.
 *
 * Since: 0.8
 */
void
clutter_container_child_get_property (ClutterContainer *container,
1313
                                      ClutterActor     *child,
1314 1315 1316 1317 1318 1319 1320
                                      const gchar      *property,
                                      GValue           *value)
{
  GObjectClass *klass;
  GParamSpec   *pspec;

  g_return_if_fail (CLUTTER_IS_CONTAINER (container));
1321
  g_return_if_fail (CLUTTER_IS_ACTOR (child));
1322 1323 1324 1325 1326 1327 1328 1329
  g_return_if_fail (property != NULL);
  g_return_if_fail (value != NULL);

  klass = G_OBJECT_GET_CLASS (container);

  pspec = clutter_container_class_find_child_property (klass, property);
  if (!pspec)
    {
1330 1331
      g_warning ("%s: Containers of type '%s' have no child "
                 "property named '%s'",
1332 1333 1334 1335 1336 1337
                 G_STRLOC, G_OBJECT_TYPE_NAME (container), property);
      return;
    }

  if (!(pspec->flags & G_PARAM_READABLE))
    {
1338
      g_warning ("%s: Child property '%s' of the container '%s' "
1339 1340 1341 1342 1343
                 "is not writable",
                 G_STRLOC, pspec->name, G_OBJECT_TYPE_NAME (container));
      return;
    }

1344
  container_get_child_property (container, child, value, pspec);
1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383
}


/**
 * clutter_container_child_get:
 * @container: a #ClutterContainer
 * @actor: a #ClutterActor that is a child of @container.
 * @first_prop: name of the first property to be set.
 * @...: value for the first property, followed optionally by more name/value
 * pairs terminated with NULL.
 *
 * Gets @container specific properties of an actor.
 *
 * In general, a copy is made of the property contents and the caller is
 * responsible for freeing the memory in the appropriate manner for the type, for
 * instance by calling g_free() or g_object_unref(). 
 *
 * Since: 0.8
 */
void
clutter_container_child_get (ClutterContainer *container,
                             ClutterActor     *actor,
                             const gchar      *first_prop,
                             ...)
{
  GObjectClass *klass;
  const gchar *name;
  va_list var_args;
  
  g_return_if_fail (CLUTTER_IS_CONTAINER (container));
  g_return_if_fail (CLUTTER_IS_ACTOR (actor));

  klass = G_OBJECT_GET_CLASS (container);

  va_start (var_args, first_prop);

  name = first_prop;
  while (name)
    {
1384
      GValue value = G_VALUE_INIT;
1385 1386 1387 1388 1389 1390
      gchar *error = NULL;
      GParamSpec *pspec;
    
      pspec = clutter_container_class_find_child_property (klass, name);
      if (!pspec)
        {
1391
          g_warning ("%s: container '%s' has no child property named '%s'",
1392 1393 1394 1395 1396 1397
                     G_STRLOC, G_OBJECT_TYPE_NAME (container), name);
          break;
        }

      if (!(pspec->flags & G_PARAM_READABLE))
        {
1398
          g_warning ("%s: child property '%s' of container '%s' is not readable",
1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422
                     G_STRLOC, pspec->name, G_OBJECT_TYPE_NAME (container));
          break;
        }

      g_value_init (&value, G_PARAM_SPEC_VALUE_TYPE (pspec));

      container_get_child_property (container, actor, &value, pspec);

      G_VALUE_LCOPY (&value, var_args, 0, &error);
      if (error)
        {
          g_warning ("%s: %s", G_STRLOC, error);
          g_free (error);
          g_value_unset (&value);
          break;
        }

      g_value_unset (&value);

      name = va_arg (var_args, gchar*);
    }

  va_end (var_args);
}
1423 1424 1425 1426 1427 1428 1429

/**
 * clutter_container_child_notify:
 * @container: a #ClutterContainer
 * @child: a #ClutterActor
 * @pspec: a #GParamSpec
 *
1430 1431
 * Calls the #ClutterContainerIface.child_notify() virtual function
 * of #ClutterContainer. The default implementation will emit the
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450
 * #ClutterContainer::child-notify signal.
 *
 * Since: 1.6
 */
void
clutter_container_child_notify (ClutterContainer *container,
                                ClutterActor     *child,
                                GParamSpec       *pspec)
{
  g_return_if_fail (CLUTTER_IS_CONTAINER (container));
  g_return_if_fail (CLUTTER_IS_ACTOR (child));
  g_return_if_fail (pspec != NULL);

  g_return_if_fail (clutter_actor_get_parent (child) == CLUTTER_ACTOR (container));

  CLUTTER_CONTAINER_GET_IFACE (container)->child_notify (container,
                                                         child,
                                                         pspec);
}