Clutter.Box

g Atk.ImplementorIface Atk.ImplementorIface Clutter.Actor Clutter.Actor Atk.ImplementorIface->Clutter.Actor Clutter.Box Clutter.Box Clutter.Actor->Clutter.Box Clutter.Animatable Clutter.Animatable Clutter.Animatable->Clutter.Actor Clutter.Container Clutter.Container Clutter.Container->Clutter.Actor Clutter.Scriptable Clutter.Scriptable Clutter.Scriptable->Clutter.Actor GObject.GInterface GObject.GInterface GObject.GInterface->Atk.ImplementorIface GObject.GInterface->Clutter.Animatable GObject.GInterface->Clutter.Container GObject.GInterface->Clutter.Scriptable GObject.InitiallyUnowned GObject.InitiallyUnowned GObject.InitiallyUnowned->Clutter.Actor GObject.Object GObject.Object GObject.Object->GObject.InitiallyUnowned

Subclasses:None

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

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:

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 0x0000000)>
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