BindConstraint is a Constraint that binds the position or the size of the Actor to which it is applied to the the position or the size of another Actor, or "source". More...

Inheritance diagram for Clutter::BindConstraint:

Collaboration diagram for Clutter::BindConstraint:

Public Member Functions
virtual	~BindConstraint ()
ClutterBindConstraint*	gobj ()
	Provides access to the underlying C GObject. More...
const ClutterBindConstraint*	gobj () const
	Provides access to the underlying C GObject. More...
ClutterBindConstraint*	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_source (const Glib::RefPtr< Actor >& source)
	Sets the source Clutter::Actor for the constraint. More...
Glib::RefPtr< Actor >	get_source ()
	Retrieves the Clutter::Actor set using set_source() More...
Glib::RefPtr< const Actor >	get_source () const
	Retrieves the Clutter::Actor set using set_source() More...
void	set_coordinate (BindCoordinate coordinate)
	Sets the coordinate to bind in the constraint. More...
BindCoordinate	get_coordinate () const
	Retrieves the bound coordinate of the constraint. More...
void	set_offset (float offset)
	Sets the offset to be applied to the constraint. More...
float	get_offset () const
	Retrieves the offset set using set_offset() More...
Public Member Functions inherited from Clutter::Constraint
virtual	~Constraint ()
ClutterConstraint*	gobj ()
	Provides access to the underlying C GObject. More...
const ClutterConstraint*	gobj () const
	Provides access to the underlying C GObject. More...
ClutterConstraint*	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
Public Member Functions inherited from Clutter::ActorMeta
virtual	~ActorMeta ()
ClutterActorMeta*	gobj ()
	Provides access to the underlying C GObject. More...
const ClutterActorMeta*	gobj () const
	Provides access to the underlying C GObject. More...
ClutterActorMeta*	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_name (const Glib::ustring& name)
	Sets the name of meta. More...
Glib::ustring	get_name () const
	Retrieves the name set using set_name() More...
void	set_enabled (bool is_enabled=true)
	Sets whether meta should be enabled or not. More...
bool	get_enabled () const
	Retrieves whether meta is enabled. More...
Glib::RefPtr< Actor >	get_actor ()
	Retrieves a pointer to the Clutter::Actor that owns meta. More...
Glib::RefPtr< const Actor >	get_actor () const
	Retrieves a pointer to the Clutter::Actor that owns meta. More...

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 < BindConstraint >	create (const Glib::RefPtr< Actor >& source, BindCoordinate coordinate, float offset)
Static Public Member Functions inherited from Clutter::Constraint
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...
Static Public Member Functions inherited from Clutter::ActorMeta
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

Protected Member Functions
	BindConstraint (const Glib::RefPtr< Actor >& source, BindCoordinate coordinate, float offset)
Glib::PropertyProxy < BindCoordinate >	property_coordinate ()
	The coordinate to bind. More...
Glib::PropertyProxy_ReadOnly < BindCoordinate >	property_coordinate () const
	The coordinate to bind. More...
Glib::PropertyProxy< float >	property_offset ()
	The offset in pixels to apply to the binding. More...
Glib::PropertyProxy_ReadOnly < float >	property_offset () const
	The offset in pixels to apply to the binding. More...
Glib::PropertyProxy < Glib::RefPtr< Actor > >	property_source ()
	The source of the binding. More...
Glib::PropertyProxy_ReadOnly < Glib::RefPtr< Actor > >	property_source () const
	The source of the binding. More...
Protected Member Functions inherited from Clutter::Constraint
	Constraint ()
Protected Member Functions inherited from Clutter::ActorMeta
	ActorMeta ()
virtual void	set_actor_vfunc (const Glib::RefPtr< const Actor >& actor)
Glib::PropertyProxy_ReadOnly < Glib::RefPtr< Actor > >	property_actor () const
	The actor attached to the meta. More...
Glib::PropertyProxy< bool >	property_enabled ()
	Whether the meta is enabled. More...
Glib::PropertyProxy_ReadOnly < bool >	property_enabled () const
	Whether the meta is enabled. More...
Glib::PropertyProxy < Glib::ustring >	property_name ()
	The name of the meta. More...
Glib::PropertyProxy_ReadOnly < Glib::ustring >	property_name () const
	The name of the meta. More...

Related Functions
(Note that these are not member functions.)
Glib::RefPtr < Clutter::BindConstraint >	wrap (ClutterBindConstraint* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...
Related Functions inherited from Clutter::Constraint
Glib::RefPtr< Clutter::Constraint >	wrap (ClutterConstraint* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...
Related Functions inherited from Clutter::ActorMeta
Glib::RefPtr< Clutter::ActorMeta >	wrap (ClutterActorMeta* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Detailed Description

BindConstraint is a Constraint that binds the position or the size of the Actor to which it is applied to the the position or the size of another Actor, or "source".

An offset can be applied to the constraint, to avoid overlapping. The offset can also be animated.

Constructor & Destructor Documentation

virtual Clutter::BindConstraint::~BindConstraint ( )

virtual

Clutter::BindConstraint::BindConstraint ( const Glib::RefPtr< Actor >&  source, BindCoordinate  coordinate, float  offset  )

explicitprotected

Member Function Documentation

static Glib::RefPtr<BindConstraint> Clutter::BindConstraint::create ( const Glib::RefPtr< Actor >&  source, BindCoordinate  coordinate, float  offset  )

static

BindCoordinate Clutter::BindConstraint::get_coordinate

(

)

const

Retrieves the bound coordinate of the constraint.

Since cluttermm 1.4:

Returns

The bound coordinate.

float Clutter::BindConstraint::get_offset

(

)

const

Retrieves the offset set using set_offset()

Since cluttermm 1.4:

Returns

The offset, in pixels.

Glib::RefPtr<Actor> Clutter::BindConstraint::get_source

(

)

Retrieves the Clutter::Actor set using set_source()

Since cluttermm 1.4:

Returns

A pointer to the source actor.

Glib::RefPtr<const Actor> Clutter::BindConstraint::get_source

(

)

const

Retrieves the Clutter::Actor set using set_source()

Since cluttermm 1.4:

Returns

A pointer to the source actor.

static GType Clutter::BindConstraint::get_type ( )

static

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

ClutterBindConstraint* Clutter::BindConstraint::gobj ( )

inline

Provides access to the underlying C GObject.

const ClutterBindConstraint* Clutter::BindConstraint::gobj ( ) const

inline

Provides access to the underlying C GObject.

ClutterBindConstraint* Clutter::BindConstraint::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< BindCoordinate > Clutter::BindConstraint::property_coordinate ( )

protected

The coordinate to bind.

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< BindCoordinate > Clutter::BindConstraint::property_coordinate ( ) const

protected

The coordinate to bind.

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< float > Clutter::BindConstraint::property_offset ( )

protected

The offset in pixels to apply to the binding.

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< float > Clutter::BindConstraint::property_offset ( ) const

protected

The offset in pixels to apply to the binding.

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< Glib::RefPtr<Actor> > Clutter::BindConstraint::property_source ( )

protected

The source of the binding.

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< Glib::RefPtr<Actor> > Clutter::BindConstraint::property_source ( ) const

protected

The source of the binding.

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::BindConstraint::set_coordinate

(

BindCoordinate

coordinate)

Sets the coordinate to bind in the constraint.

Since cluttermm 1.4:

Parameters

coordinate

The coordinate to bind.

void Clutter::BindConstraint::set_offset

(

float

offset)

Sets the offset to be applied to the constraint.

Since cluttermm 1.4:

Parameters

offset

The offset to apply, in pixels.

void Clutter::BindConstraint::set_source

(

const Glib::RefPtr< Actor >&

source)

Sets the source Clutter::Actor for the constraint.

Since cluttermm 1.4:

Parameters

source

A Clutter::Actor, or 0 to unset the source.

Friends And Related Function Documentation

Glib::RefPtr< Clutter::BindConstraint > wrap ( ClutterBindConstraint *  object, bool  take_copy = false  )

related

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/bind-constraint.h