cluttermm: Clutter::BinLayout Class Reference

Inheritance diagram for Clutter::BinLayout:

Collaboration diagram for Clutter::BinLayout:

Public Member Functions
virtual	~BinLayout ()

ClutterBinLayout*	gobj ()
	Provides access to the underlying C GObject. More...

const ClutterBinLayout*	gobj () const
	Provides access to the underlying C GObject. More...

ClutterBinLayout*	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

void	set_alignment (const Glib::RefPtr< Actor >& child, BinAlignment x_align, BinAlignment y_align)
	Sets the horizontal and vertical alignment policies to be applied to a child of self. More...

void	get_alignment (const Glib::RefPtr< Actor >& child, BinAlignment& x_align, BinAlignment& y_align) const
	Retrieves the horizontal and vertical alignment policies for a child of self. More...

void	add (const Glib::RefPtr< Actor >& child, BinAlignment x_align, BinAlignment y_align)
	Adds a Clutter::Actor to the container using self and sets the alignment policies for it. More...

Glib::PropertyProxy< BinAlignment >	property_x_align ()
	Default horizontal alignment for the actors inside the layout manager. More...

Glib::PropertyProxy_ReadOnly < BinAlignment >	property_x_align () const
	Default horizontal alignment for the actors inside the layout manager. More...

Glib::PropertyProxy< BinAlignment >	property_y_align ()
	Default vertical alignment for the actors inside the layout manager. More...

Glib::PropertyProxy_ReadOnly < BinAlignment >	property_y_align () const
	Default vertical alignment for the actors inside the layout manager. More...

Public Member Functions inherited from Clutter::LayoutManager
virtual	~LayoutManager ()

ClutterLayoutManager*	gobj ()
	Provides access to the underlying C GObject. More...

const ClutterLayoutManager*	gobj () const
	Provides access to the underlying C GObject. More...

ClutterLayoutManager*	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

template<class PropertyType >
void	set_child_property (const Glib::RefPtr< Container >& container, const Glib::RefPtr< Actor >& child, const Glib::ustring& property_name, const PropertyType& value)

void	set_child_property_value (const Glib::RefPtr< Container >& container, const Glib::RefPtr< Actor >& child, const Glib::ustring& property_name, const Glib::ValueBase& value)
	Sets a property on the Clutter::LayoutMeta created by manager and attached to a child of container. More...

template<class PropertyType >
void	get_child_property (const Glib::RefPtr< Container >& container, const Glib::RefPtr< const Actor >& actor, const Glib::ustring& property_name, PropertyType& value) const

void	get_child_property_value (const Glib::RefPtr< Container >& container, const Glib::RefPtr< const Actor >& actor, const Glib::ustring& property_name, Glib::ValueBase& value) const

void	get_preferred_width (const Glib::RefPtr< Container >& container, float for_height, float& min_width_p, float& natural_width_p) const
	Computes the minimum and natural widths of the container according to manager. More...

void	get_preferred_height (const Glib::RefPtr< Container >& container, float for_width, float& min_height_p, float& natural_height_p) const
	Computes the minimum and natural heights of the container according to manager. More...

void	allocate (const Glib::RefPtr< Container >& container, const ActorBox& box, AllocationFlags absolute_origin_changed)
	Allocates the children of container given an area. More...

void	set_container (const Glib::RefPtr< Container >& container)
	If the Clutter::LayoutManager sub-class allows it, allow adding a weak reference of the container using manager from within the layout manager. More...

void	layout_changed ()
	Emits the Clutter::LayoutManager::signal_layout_changed() signal on manager. More...

Glib::RefPtr< LayoutMeta >	get_child_meta (const Glib::RefPtr< Container >& container, const Glib::RefPtr< Actor >& actor)
	Retrieves the Clutter::LayoutMeta that the layout manager associated to the actor child of container, eventually by creating one if the Clutter::LayoutManager supports layout properties. More...

Glib::RefPtr< const LayoutMeta >	get_child_meta (const Glib::RefPtr< Container >& container, const Glib::RefPtr< Actor >& actor) const
	Retrieves the Clutter::LayoutMeta that the layout manager associated to the actor child of container, eventually by creating one if the Clutter::LayoutManager supports layout properties. More...

Glib::RefPtr< Alpha >	begin_animation (guint duration, gulong mode)
	Begins an animation of duration milliseconds, using the provided easing mode. More...

Glib::RefPtr< const Alpha >	begin_animation (guint duration, gulong mode) const
	Begins an animation of duration milliseconds, using the provided easing mode. More...

double	get_animation_progress ()
	Retrieves the progress of the animation, if one has been started by begin_animation() More...

void	end_animation ()
	Ends an animation started by begin_animation() More...

virtual void	get_preferred_width_vfunc (const Glib::RefPtr< Container >& container, float for_height, float& min_width_p, float& natural_width_p) const

virtual void	get_preferred_height_vfunc (const Glib::RefPtr< Container >& container, float for_width, float& min_height_p, float& natural_height_p) const

virtual void	allocate_vfunc (const Glib::RefPtr< Container >& container, const ActorBox& box, AllocationFlags absolute_origin_changed)

virtual void	set_container_vfunc (const Glib::RefPtr< Container >& container)

virtual GType	get_child_meta_type_vfunc () const

virtual Glib::RefPtr< LayoutMeta >	create_child_meta_vfunc (const Glib::RefPtr< Container >& container, const Glib::RefPtr< Actor >& actor)

virtual Glib::RefPtr< Alpha >	begin_animation_vfunc (guint duration, gulong mode)

virtual double	get_animation_progress_vfunc ()

virtual void	end_animation_vfunc ()

Glib::SignalProxy0< void >	signal_layout_changed ()

Static Public Member Functions
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

static Glib::RefPtr< BinLayout >	create (BinAlignment x_align, BinAlignment y_align)

Static Public Member Functions inherited from Clutter::LayoutManager
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

Protected Member Functions
	BinLayout (BinAlignment x_align, BinAlignment y_align)

Protected Member Functions inherited from Clutter::LayoutManager
	LayoutManager ()

virtual void	on_layout_changed ()
	This is a default handler for the signal signal_layout_changed(). More...

Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Clutter::BinLayout >	wrap (ClutterBinLayout* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Related Functions inherited from Clutter::LayoutManager
Glib::RefPtr < Clutter::LayoutManager >	wrap (ClutterLayoutManager* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Constructor & Destructor Documentation

virtual Clutter::BinLayout::~BinLayout ( )

virtual

Clutter::BinLayout::BinLayout	(	BinAlignment	x_align,
		BinAlignment	y_align
	)

explicitprotected

Member Function Documentation

void Clutter::BinLayout::add	(	const Glib::RefPtr< Actor >&	child,
		BinAlignment	x_align,
		BinAlignment	y_align
	)

Adds a Clutter::Actor to the container using self and sets the alignment policies for it.

This function is equivalent to Clutter::Container::add_actor() and Clutter::LayoutManager::child_set_property() but it does not require a pointer to the Clutter::Container associated to the Clutter::BinLayout

Since cluttermm 1.2:

Deprecated: 1.12: Use Clutter::Actor::add_child() instead.

Deprecated:: Use Actor::add_child() instead.

Parameters

child	A Clutter::Actor.
x_align	Horizontal alignment policy for child.
y_align	Vertical alignment policy for child.

static Glib::RefPtr<BinLayout> Clutter::BinLayout::create	(	BinAlignment	x_align,
		BinAlignment	y_align
	)

static

void Clutter::BinLayout::get_alignment	(	const Glib::RefPtr< Actor >&	child,
		BinAlignment&	x_align,
		BinAlignment&	y_align
	)		const

Retrieves the horizontal and vertical alignment policies for a child of self.

If child is 0 the default alignment policies will be returned instead

Since cluttermm 1.2:

Deprecated: 1.12: Use the Clutter::Actor::property_x_align() and the Clutter::Actor::property_y_align() properties of Clutter::Actor instead.

Deprecated:: Use the x-align and y-align properties of Actor instead.

Parameters

child	A child of container.
x_align	Return location for the horizontal alignment policy.
y_align	Return location for the vertical alignment policy.

static GType Clutter::BinLayout::get_type ( )

static

Get the GType for this class, for use with the underlying GObject type system.

ClutterBinLayout* Clutter::BinLayout::gobj ( )

inline

Provides access to the underlying C GObject.

const ClutterBinLayout* Clutter::BinLayout::gobj ( ) const

inline

Provides access to the underlying C GObject.

ClutterBinLayout* Clutter::BinLayout::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

Glib::PropertyProxy< BinAlignment > Clutter::BinLayout::property_x_align ( )

Default horizontal alignment for the actors inside the layout manager.

Deprecated:: Use the x-align and y-align properties of Actor instead.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns: A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly< BinAlignment > Clutter::BinLayout::property_x_align ( ) const

Default horizontal alignment for the actors inside the layout manager.

Deprecated:: Use the x-align and y-align properties of Actor instead.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns: A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

Glib::PropertyProxy< BinAlignment > Clutter::BinLayout::property_y_align ( )

Default vertical alignment for the actors inside the layout manager.

Deprecated:: Use the x-align and y-align properties of Actor instead.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns: A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly< BinAlignment > Clutter::BinLayout::property_y_align ( ) const

Default vertical alignment for the actors inside the layout manager.

Deprecated:: Use the x-align and y-align properties of Actor instead.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns: A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

void Clutter::BinLayout::set_alignment	(	const Glib::RefPtr< Actor >&	child,
		BinAlignment	x_align,
		BinAlignment	y_align
	)

Sets the horizontal and vertical alignment policies to be applied to a child of self.

If child is 0 then the x_align and y_align values will be set as the default alignment policies

Since cluttermm 1.2:

Deprecated: 1.12: Use the Clutter::Actor::property_x_align() and Clutter::Actor::property_y_align() properties of Clutter::Actor instead.

Deprecated:: Use the x-align and y-align properties of Actor instead.

Parameters

child	A child of container.
x_align	The horizontal alignment policy to be used for the child inside container.
y_align	The vertical aligment policy to be used on the child inside container.

Friends And Related Function Documentation

Glib::RefPtr< Clutter::BinLayout > wrap	(	ClutterBinLayout *	object,
		bool	take_copy = `false`
	)

A Glib::wrap() method for this object.

Parameters

object	The C instance.
take_copy	False if the result should take ownership of the C instance. True if it should take a new copy or ref.

Returns: A C++ instance that wraps this C instance.

The documentation for this class was generated from the following file:

cluttermm/bin-layout.h

cluttermm: Clutter::BinLayout Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Functions

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation