Gjsify LogoGjsify Logo

An iterator structure that allows to efficiently iterate over a section of the scene graph.

The contents of the #ClutterActorIter structure are private and should only be accessed using the provided API.

record

Hierarchy

  • ActorIter

Index

Constructors

Properties

name: string

Methods

  • destroy(): void
  • Safely destroys the #ClutterActor currently pointer to by the iterator from its parent.

    This function can only be called after clutter_actor_iter_next() or clutter_actor_iter_prev() returned %TRUE, and cannot be called more than once for the same actor.

    This function will call clutter_actor_destroy() internally.

    Returns void

  • Initializes a #ClutterActorIter, which can then be used to iterate efficiently over a section of the scene graph, and associates it with root.

    Modifying the scene graph section that contains root will invalidate the iterator.

      ClutterActorIter iter;
    ClutterActor *child;

    clutter_actor_iter_init (&iter, container);
    while (clutter_actor_iter_next (&iter, &child))
    {
    // do something with child
    }

    Parameters

    Returns void

  • is_valid(): boolean
  • Checks whether a #ClutterActorIter is still valid.

    An iterator is considered valid if it has been initialized, and if the #ClutterActor that it refers to hasn't been modified after the initialization.

    Returns boolean

  • Advances the iter and retrieves the next child of the root #ClutterActor that was used to initialize the #ClutterActorIterator.

    If the iterator can advance, this function returns %TRUE and sets the child argument.

    If the iterator cannot advance, this function returns %FALSE, and the contents of child are undefined.

    Returns [boolean, Clutter.Actor]

  • Advances the iter and retrieves the previous child of the root #ClutterActor that was used to initialize the #ClutterActorIterator.

    If the iterator can advance, this function returns %TRUE and sets the child argument.

    If the iterator cannot advance, this function returns %FALSE, and the contents of child are undefined.

    Returns [boolean, Clutter.Actor]

  • remove(): void
  • Safely removes the #ClutterActor currently pointer to by the iterator from its parent.

    This function can only be called after clutter_actor_iter_next() or clutter_actor_iter_prev() returned %TRUE, and cannot be called more than once for the same actor.

    This function will call clutter_actor_remove_child() internally.

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method