Clutter.Box¶

Subclasses:: None

Methods¶

Inherited:: Clutter.Actor (238), GObject.Object (37), Clutter.Animatable (5), Clutter.Container (17), Clutter.Scriptable (4)
Structs:: GObject.ObjectClass (5)

class	`new` (manager)
	`get_color` ()
	`get_layout_manager` ()
	`packv` (actor, properties, values)
	`set_color` (color)
	`set_layout_manager` (manager)

Virtual Methods¶

Inherited:: Clutter.Actor (35), GObject.Object (7), Clutter.Animatable (5), Clutter.Container (13), Clutter.Scriptable (4)

Properties¶

Inherited:: Clutter.Actor (82)

Name	Type	Flags	Short Description
`color`	`Clutter.Color`	r/w	The background color of the box `deprecated`
`color-set`	`bool`	r/w	Whether the background color is set `deprecated`

Signals¶

Inherited:: Clutter.Actor (26), GObject.Object (1), Clutter.Container (3)

Fields¶

Inherited:: Clutter.Actor (26), GObject.Object (1), Clutter.Container (3)

Name	Type	Access	Description
parent_instance	`Clutter.Actor`	r

Class Details¶

class Clutter.Box(**kwargs)¶

Bases:: Clutter.Actor
Abstract:: No
Structure:: Clutter.BoxClass

The Clutter.Box structure contains only private data and should be accessed using the provided API

New in version 1.2.

classmethod new(manager)¶

Parameters:: manager (Clutter.LayoutManager) – a Clutter.LayoutManager
Returns:: the newly created Clutter.Box actor
Return type:: Clutter.Actor

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

New in version 1.2.

Deprecated since version 1.10: Use Clutter.Actor.new() instead.

get_color()¶

Returns:: return location for a Clutter.Color
Return type:: color: Clutter.Color

Retrieves the background color of self

If the Clutter.Box :color-set property is set to False the returned Clutter.Color is undefined

New in version 1.2.

Deprecated since version 1.10: Use Clutter.Actor.get_background_color() instead.

get_layout_manager()¶

Returns:: a Clutter.LayoutManager. The returned Clutter.LayoutManager is owned by the Clutter.Box and it should not be unreferenced
Return type:: Clutter.LayoutManager

Retrieves the Clutter.LayoutManager instance used by self

New in version 1.2.

Deprecated since version 1.10: Use Clutter.Actor.get_layout_manager() instead.

packv(actor, properties, values)¶

Parameters:

actor (Clutter.Actor) – a Clutter.Actor
properties ([str]) – a vector containing the property names to set
values ([GObject.Value]) – a vector containing the property values to set

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

New in version 1.2.

Deprecated since version 1.10: Use Clutter.Actor.add_child() instead. To set specific layout properties, use clutter_layout_manager_child_set()

set_color(color)¶

Parameters:: color (Clutter.Color or None) – the background color, or None to unset

Sets (or unsets) the background color for self

New in version 1.2.

Deprecated since version 1.10: Use Clutter.Actor.set_background_color() instead.

set_layout_manager(manager)¶

Parameters:: manager (Clutter.LayoutManager) – a Clutter.LayoutManager

Sets the Clutter.LayoutManager for self

A Clutter.LayoutManager is a delegate object that controls the layout of the children of self

New in version 1.2.

Deprecated since version 1.10: Use Clutter.Actor.set_layout_manager() instead.

Property Details¶

Clutter.Box.props.color¶

Name:: color
Type:: Clutter.Color
Default Value:: <Color structure at 0x000000000000 (ClutterColor at 0x00000000)>
Flags:: READABLE, WRITABLE

The color to be used to paint the background of the Clutter.Box. Setting this property will set the Clutter.Box :color-set property as a side effect

This property sets the Clutter.Actor :background-color property internally.

New in version 1.2.

Deprecated since version 1.10: Use the Clutter.Actor :background-color property

Clutter.Box.props.color_set¶

Name:: color-set
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Whether the Clutter.Box :color property has been set.

This property reads the Clutter.Actor :background-color-set property internally.

New in version 1.2.

Deprecated since version 1.10: Use the Clutter.Actor :background-color-set property