Top | ![]() |
![]() |
![]() |
![]() |
ClutterLayoutManager * | clutter_box_layout_new () |
void | clutter_box_layout_set_pack_start () |
gboolean | clutter_box_layout_get_pack_start () |
void | clutter_box_layout_set_spacing () |
guint | clutter_box_layout_get_spacing () |
void | clutter_box_layout_set_vertical () |
gboolean | clutter_box_layout_get_vertical () |
void | clutter_box_layout_set_homogeneous () |
gboolean | clutter_box_layout_get_homogeneous () |
void | clutter_box_layout_pack () |
void | clutter_box_layout_set_alignment () |
void | clutter_box_layout_get_alignment () |
void | clutter_box_layout_set_expand () |
gboolean | clutter_box_layout_get_expand () |
void | clutter_box_layout_set_fill () |
void | clutter_box_layout_get_fill () |
void | clutter_box_layout_set_use_animations () |
gboolean | clutter_box_layout_get_use_animations () |
void | clutter_box_layout_set_easing_duration () |
guint | clutter_box_layout_get_easing_duration () |
void | clutter_box_layout_set_easing_mode () |
gulong | clutter_box_layout_get_easing_mode () |
guint | easing-duration | Read / Write |
gulong | easing-mode | Read / Write |
gboolean | homogeneous | Read / Write |
gboolean | pack-start | Read / Write |
guint | spacing | Read / Write |
gboolean | use-animations | Read / Write |
gboolean | vertical | Read / Write |
The ClutterBoxLayout is a ClutterLayoutManager implementing the following layout policy:
all children are arranged on a single line;
the axis used is controlled by the “vertical” boolean property;
the order of the packing is determined by the “pack-start” boolean property;
each child will be allocated to its natural size or, if set to expand, the available size;
if a child is set to fill on either (or both) axis, its allocation will match all the available size; the fill layout property only makes sense if the expand property is also set;
if a child is set to expand but not to fill then it is possible to control the alignment using the X and Y alignment layout properties.
if the “homogeneous” boolean property is set, then all widgets will get the same size, ignoring expand settings and the preferred sizes
It is possible to control the spacing between children of a
ClutterBoxLayout by using clutter_box_layout_set_spacing()
.
In order to set the layout properties when packing an actor inside a
ClutterBoxLayout you should use the clutter_box_layout_pack()
function.
ClutterBoxLayout is available since Clutter 1.2
ClutterLayoutManager *
clutter_box_layout_new (void
);
Creates a new ClutterBoxLayout layout manager
Since 1.2
void clutter_box_layout_set_pack_start (ClutterBoxLayout *layout
,gboolean pack_start
);
Sets whether children of layout
should be layed out by appending
them or by prepending them
Since 1.2
gboolean
clutter_box_layout_get_pack_start (ClutterBoxLayout *layout
);
Retrieves the value set using clutter_box_layout_set_pack_start()
TRUE
if the ClutterBoxLayout should pack children
at the beginning of the layout, and FALSE
otherwise
Since 1.2
void clutter_box_layout_set_spacing (ClutterBoxLayout *layout
,guint spacing
);
Sets the spacing between children of layout
Since 1.2
guint
clutter_box_layout_get_spacing (ClutterBoxLayout *layout
);
Retrieves the spacing set using clutter_box_layout_set_spacing()
Since 1.2
void clutter_box_layout_set_vertical (ClutterBoxLayout *layout
,gboolean vertical
);
Sets whether layout
should arrange its children vertically alongside
the Y axis, instead of horizontally alongside the X axis
Since 1.2
gboolean
clutter_box_layout_get_vertical (ClutterBoxLayout *layout
);
Retrieves the orientation of the layout
as set using the
clutter_box_layout_set_vertical()
function
Since 1.2
void clutter_box_layout_set_homogeneous (ClutterBoxLayout *layout
,gboolean homogeneous
);
Sets whether the size of layout
children should be
homogeneous
Since 1.4
gboolean
clutter_box_layout_get_homogeneous (ClutterBoxLayout *layout
);
Retrieves if the children sizes are allocated homogeneously.
Since 1.4
void clutter_box_layout_pack (ClutterBoxLayout *layout
,ClutterActor *actor
,gboolean expand
,gboolean x_fill
,gboolean y_fill
,ClutterBoxAlignment x_align
,ClutterBoxAlignment y_align
);
Packs actor
inside the ClutterContainer associated to layout
and sets the layout properties
layout |
||
actor |
||
expand |
whether the |
|
x_fill |
whether the |
|
y_fill |
whether the |
|
x_align |
the horizontal alignment policy for |
|
y_align |
the vertical alignment policy for |
Since 1.2
void clutter_box_layout_set_alignment (ClutterBoxLayout *layout
,ClutterActor *actor
,ClutterBoxAlignment x_align
,ClutterBoxAlignment y_align
);
Sets the horizontal and vertical alignment policies for actor
inside layout
layout |
||
actor |
a ClutterActor child of |
|
x_align |
Horizontal alignment policy for |
|
y_align |
Vertical alignment policy for |
Since 1.2
void clutter_box_layout_get_alignment (ClutterBoxLayout *layout
,ClutterActor *actor
,ClutterBoxAlignment *x_align
,ClutterBoxAlignment *y_align
);
Retrieves the horizontal and vertical alignment policies for actor
as set using clutter_box_layout_pack()
or clutter_box_layout_set_alignment()
layout |
||
actor |
a ClutterActor child of |
|
x_align |
return location for the horizontal alignment policy. |
[out] |
y_align |
return location for the vertical alignment policy. |
[out] |
Since 1.2
void clutter_box_layout_set_expand (ClutterBoxLayout *layout
,ClutterActor *actor
,gboolean expand
);
Sets whether actor
should expand inside layout
Since 1.2
gboolean clutter_box_layout_get_expand (ClutterBoxLayout *layout
,ClutterActor *actor
);
Retrieves whether actor
should expand inside layout
Since 1.2
void clutter_box_layout_set_fill (ClutterBoxLayout *layout
,ClutterActor *actor
,gboolean x_fill
,gboolean y_fill
);
Sets the horizontal and vertical fill policies for actor
inside layout
layout |
||
actor |
a ClutterActor child of |
|
x_fill |
whether |
|
y_fill |
whether |
Since 1.2
void clutter_box_layout_get_fill (ClutterBoxLayout *layout
,ClutterActor *actor
,gboolean *x_fill
,gboolean *y_fill
);
Retrieves the horizontal and vertical fill policies for actor
as set using clutter_box_layout_pack()
or clutter_box_layout_set_fill()
layout |
||
actor |
a ClutterActor child of |
|
x_fill |
return location for the horizontal fill policy. |
[out] |
y_fill |
return location for the vertical fill policy. |
[out] |
Since 1.2
void clutter_box_layout_set_use_animations (ClutterBoxLayout *layout
,gboolean animate
);
Sets whether layout
should animate changes in the layout properties
The duration of the animations is controlled by
clutter_box_layout_set_easing_duration()
; the easing mode to be used
by the animations is controlled by clutter_box_layout_set_easing_mode()
Since 1.2
gboolean
clutter_box_layout_get_use_animations (ClutterBoxLayout *layout
);
Retrieves whether layout
should animate changes in the layout properties
Since clutter_box_layout_set_use_animations()
Since 1.2
void clutter_box_layout_set_easing_duration (ClutterBoxLayout *layout
,guint msecs
);
Sets the duration of the animations used by layout
when animating changes
in the layout properties
Use clutter_box_layout_set_use_animations()
to enable and disable the
animations
Since 1.2
guint
clutter_box_layout_get_easing_duration
(ClutterBoxLayout *layout
);
Retrieves the duration set using clutter_box_layout_set_easing_duration()
Since 1.2
void clutter_box_layout_set_easing_mode (ClutterBoxLayout *layout
,gulong mode
);
Sets the easing mode to be used by layout
when animating changes in layout
properties
Use clutter_box_layout_set_use_animations()
to enable and disable the
animations
layout |
||
mode |
an easing mode, either from ClutterAnimationMode or a logical id
from |
Since 1.2
gulong
clutter_box_layout_get_easing_mode (ClutterBoxLayout *layout
);
Retrieves the easing mode set using clutter_box_layout_set_easing_mode()
Since 1.2
The alignment policies available on each axis of the ClutterBoxLayout
Since 1.2
struct ClutterBoxLayout;
The ClutterBoxLayout structure contains only private data and should be accessed using the provided API
Since 1.2
struct ClutterBoxLayoutClass { };
The ClutterBoxLayoutClass structure contains only private data and should be accessed using the provided API
Since 1.2
“easing-duration”
property “easing-duration” guint
The duration of the animations, in case “use-animations”
is set to TRUE
The duration is expressed in milliseconds
Flags: Read / Write
Default value: 500
Since 1.2
“easing-mode”
property “easing-mode” gulong
The easing mode for the animations, in case
“use-animations” is set to TRUE
The easing mode has the same semantics of “mode”: it can
either be a value from the ClutterAnimationMode enumeration, like
CLUTTER_EASE_OUT_CUBIC
, or a logical id as returned by
clutter_alpha_register_func()
The default value is CLUTTER_EASE_OUT_CUBIC
Flags: Read / Write
Since 1.2
“homogeneous”
property “homogeneous” gboolean
Whether the ClutterBoxLayout should arrange its children homogeneously, i.e. all childs get the same size
Flags: Read / Write
Default value: FALSE
Since 1.4
“pack-start”
property “pack-start” gboolean
Whether the ClutterBoxLayout should pack items at the start or append them at the end
Flags: Read / Write
Default value: FALSE
Since 1.2
“spacing”
property “spacing” guint
The spacing between children of the ClutterBoxLayout, in pixels
Flags: Read / Write
Default value: 0
Since 1.2
“use-animations”
property “use-animations” gboolean
Whether the ClutterBoxLayout should animate changes in the layout properties
Flags: Read / Write
Default value: FALSE
Since 1.2
“vertical”
property “vertical” gboolean
Whether the ClutterBoxLayout should arrange its children alongside the Y axis, instead of alongside the X axis
Flags: Read / Write
Default value: FALSE
Since 1.2