Using ClutterBox

The following code shows how to create a ClutterBox with a ClutterLayoutManager sub-class, and how to add children to it via clutter_box_pack().

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

ClutterActor *box;
ClutterLayoutManager *layout;

// Create the layout manager first
layout = clutter_box_layout_new ();
clutter_box_layout_set_homogeneous (CLUTTER_BOX_LAYOUT (layout), TRUE);
clutter_box_layout_set_spacing (CLUTTER_BOX_LAYOUT (layout), 12);

// Then create the ClutterBox actor. The Box will take
// ownership of the ClutterLayoutManager instance by sinking
// its floating reference
box = clutter_box_new (layout);

// Now add children to the Box using the variadic arguments
// function clutter_box_pack() to set layout properties
clutter_box_pack (CLUTTER_BOX (box), actor,
                  "x-align", CLUTTER_BOX_ALIGNMENT_CENTER,
                  "y-align", CLUTTER_BOX_ALIGNMENT_END,
                  "expand", TRUE,
                  NULL);

ClutterBox's clutter_box_pack() wraps the generic clutter_container_add_actor() function, but it also allows setting layout properties while adding the new child to the box.

clutter_box_new ()

ClutterActor *
clutter_box_new (ClutterLayoutManager *manager);

Creates a new ClutterBox. The children of the box will be layed out by the passed manager

Since: 1.2

clutter_box_set_layout_manager ()

void
clutter_box_set_layout_manager (ClutterBox *box,
                                ClutterLayoutManager *manager);

Sets the ClutterLayoutManager for box

A ClutterLayoutManager is a delegate object that controls the layout of the children of box

Since: 1.2

clutter_box_get_layout_manager ()

ClutterLayoutManager *
clutter_box_get_layout_manager (ClutterBox *box);

Retrieves the ClutterLayoutManager instance used by box

Since: 1.2

clutter_box_set_color ()

void
clutter_box_set_color (ClutterBox *box,
                       const ClutterColor *color);

Sets (or unsets) the background color for box

Since: 1.2

clutter_box_get_color ()

void
clutter_box_get_color (ClutterBox *box,
                       ClutterColor *color);

Retrieves the background color of box

If the “color-set” property is set to FALSE the returned ClutterColor is undefined

Since: 1.2

clutter_box_pack ()

void
clutter_box_pack (ClutterBox *box,
                  ClutterActor *actor,
                  const gchar *first_property,
                  ...);

Adds actor to box and sets layout properties at the same time, if the ClutterLayoutManager used by box has them

This function is a wrapper around clutter_container_add_actor() and clutter_layout_manager_child_set()

Language bindings should use the vector-based clutter_box_packv() variant instead

Since: 1.2

clutter_box_packv ()

void
clutter_box_packv (ClutterBox *box,
                   ClutterActor *actor,
                   guint n_properties,
                   const gchar * const properties[],
                   const GValue *values);

Vector-based variant of clutter_box_pack(), intended for language bindings to use

Since: 1.2

clutter_box_pack_after ()

void
clutter_box_pack_after (ClutterBox *box,
                        ClutterActor *actor,
                        ClutterActor *sibling,
                        const gchar *first_property,
                        ...);

Adds actor to box , placing it after sibling , and sets layout properties at the same time, if the ClutterLayoutManager used by box supports them

If sibling is NULL then actor is placed at the end of the list of children, to be allocated and painted after every other child

This function is a wrapper around clutter_container_add_actor(), clutter_container_raise_child() and clutter_layout_manager_child_set()

Since: 1.2

clutter_box_pack_before ()

void
clutter_box_pack_before (ClutterBox *box,
                         ClutterActor *actor,
                         ClutterActor *sibling,
                         const gchar *first_property,
                         ...);

Adds actor to box , placing it before sibling , and sets layout properties at the same time, if the ClutterLayoutManager used by box supports them

If sibling is NULL then actor is placed at the beginning of the list of children, to be allocated and painted below every other child

This function is a wrapper around clutter_container_add_actor(), clutter_container_lower_child() and clutter_layout_manager_child_set()

Since: 1.2

clutter_box_pack_at ()

void
clutter_box_pack_at (ClutterBox *box,
                     ClutterActor *actor,
                     gint position,
                     const gchar *first_property,
                     ...);

Adds actor to box , placing it at position , and sets layout properties at the same time, if the ClutterLayoutManager used by box supports them

If position is a negative number, or is larger than the number of children of box , the new child is added at the end of the list of children

Since: 1.2

struct ClutterBox

struct ClutterBox;

The ClutterBox structure contains only private data and should be accessed using the provided API

Since: 1.2

struct ClutterBoxClass

struct ClutterBoxClass {
};

The ClutterBoxClass structure contains only private data

Since: 1.2

The “color” property

  “color”                    ClutterColor *

The color to be used to paint the background of the ClutterBox. Setting this property will set the “color-set” property as a side effect

This property sets the “background-color” property internally.

Flags: Read / Write

Since: 1.2

The “color-set” property

  “color-set”                gboolean

Whether the “color” property has been set.

This property reads the “background-color-set” property internally.

Flags: Read / Write

Default value: FALSE

Since: 1.2