AdgContainer

AdgContainer

typedef struct _AdgContainer AdgContainer;

All fields are private and should not be used directly. Use its public methods instead.

adg_container_new ()

AdgContainer *      adg_container_new                   (void);

Creates a new container entity.

adg_container_children ()

GSList *            adg_container_children              (AdgContainer *container);

Gets the children list of container. This list must be manually freed with g_slist_free() when no longer user.

The returned list is ordered from the most recently added child to the oldest one.

adg_container_add ()

void                adg_container_add                   (AdgContainer *container,
                                                         AdgEntity *entity);

Emits a "add" signal on container passing entity as argument. entity must be added to only one container at a time, you can't place the same entity inside two different containers.

Once entity has been added, the floating reference will be removed and container will own a reference to entity. This means the only proper way to destroy entity is to call adg_container_remove().

adg_container_remove ()

void                adg_container_remove                (AdgContainer *container,
                                                         AdgEntity *entity);

Emits a "remove" signal on container passing entity as argument. entity must be inside container.

Note that container will own a reference to entity and it may be the last reference held: this means removing an entity from its container can destroy it.

If you want to use entity again, you need to add a reference to it, using g_object_ref(), before removing it from container. The following typical example shows you how to properly move entity from container1 to container2:

g_object_ref(entity);
adg_container_remove(container1, entity);
adg_container_add(container2, entity)
g_object_unref(entity);

adg_container_foreach ()

void                adg_container_foreach               (AdgContainer *container,
                                                         GCallback callback,
                                                         gpointer user_data);

Invokes callback on each child of container. The callback should be declared as:

void callback(AdgEntity *entity, gpointer user_data);

adg_container_propagate ()

void                adg_container_propagate             (AdgContainer *container,
                                                         guint signal_id,
                                                         GQuark detail,
                                                         ...);

Emits the specified signal to all the children of container using g_signal_emit_valist() calls.

adg_container_propagate_by_name ()

void                adg_container_propagate_by_name     (AdgContainer *container,
                                                         const gchar *detailed_signal,
                                                         ...);

Emits the specified signal to all the children of container using g_signal_emit_valist() calls.

adg_container_propagate_valist ()

void                adg_container_propagate_valist      (AdgContainer *container,
                                                         guint signal_id,
                                                         GQuark detail,
                                                         va_list var_args);

Emits the specified signal to all the children of container using g_signal_emit_valist() calls.

The "child" property

  "child"                    AdgEntity*            : Write

Can be used to add a new child to the container.

The "add" signal

void                user_function                      (AdgContainer *container,
                                                        AdgEntity    *entity,
                                                        gpointer      user_data)      : Run First

Adds entity to container. entity must not be inside another container or the operation will fail.

The "remove" signal

void                user_function                      (AdgContainer *container,
                                                        AdgEntity    *entity,
                                                        gpointer      user_data)      : Run First

Removes entity from container.