![]() |
![]() |
![]() |
Clutter Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Properties |
ClutterBox; ClutterBoxClass; ClutterActor * clutter_box_new (ClutterLayoutManager *manager); void clutter_box_set_layout_manager (ClutterBox *box, ClutterLayoutManager *manager); ClutterLayoutManager * clutter_box_get_layout_manager (ClutterBox *box); void clutter_box_set_color (ClutterBox *box, const ClutterColor *color); void clutter_box_get_color (ClutterBox *box, ClutterColor *color); void clutter_box_pack (ClutterBox *box, ClutterActor *actor, const gchar *first_property, ...); void clutter_box_packv (ClutterBox *box, ClutterActor *actor, guint n_properties, const gchar * const properties[], const GValue *values);
"color" ClutterColor* : Read / Write "color-set" gboolean : Read / Write "layout-manager" ClutterLayoutManager* : Read / Write / Construct
ClutterBox is a ClutterActor sub-class implementing the ClutterContainer interface. A Box delegates the whole size requisition and size allocation to a ClutterLayoutManager instance.
Example 1. 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()
.
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.
ClutterBox is available since Clutter 1.2
ClutterActor * clutter_box_new (ClutterLayoutManager *manager);
Creates a new ClutterBox. The children of the box will be layed
out by the passed manager
|
a ClutterLayoutManager |
Returns : |
the newly created ClutterBox actor |
Since 1.0
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
|
a ClutterBox |
|
a ClutterLayoutManager |
Since 1.2
ClutterLayoutManager * clutter_box_get_layout_manager (ClutterBox *box);
Retrieves the ClutterLayoutManager instance used by box
|
a ClutterBox |
Returns : |
a ClutterLayoutManager |
Since 1.2
void clutter_box_set_color (ClutterBox *box, const ClutterColor *color);
Sets (or unsets) the background color for box
|
a ClutterBox |
|
the background color, or NULL to unset. allow-none. |
Since 1.2
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
|
a ClutterBox |
|
return location for a ClutterColor. out. |
Since 1.2
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_addv()
variant instead
|
a ClutterBox |
|
a ClutterActor |
|
the name of the first property to set, or NULL
|
|
a list of property name and value pairs, terminated by NULL
|
Since 1.2
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
|
a ClutterBox |
|
a ClutterActor |
|
the number of properties to set |
|
array length=n_properties) (element-type utf8. array length=n_properties. element-type utf8. |
|
array length=n_properties. array length=n_properties. |
Since 1.2
"color"
property"color" ClutterColor* : Read / Write
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
Since 1.2
"color-set"
property"color-set" gboolean : Read / Write
Whether the "color" property has been set
Default value: FALSE
Since 1.2
"layout-manager"
property"layout-manager" ClutterLayoutManager* : Read / Write / Construct
The ClutterLayoutManager used by the ClutterBox
Since 1.2