cluttermm: Clutter::BehaviourDepth Class Reference

Inheritance diagram for Clutter::BehaviourDepth:

Collaboration diagram for Clutter::BehaviourDepth:

Public Member Functions
virtual	~BehaviourDepth ()

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

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

ClutterBehaviourDepth*	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_bounds (int depth_start, int depth_end)
	Sets the boundaries of the behaviour. More...

void	get_bounds (int& depth_start, int& depth_end)
	Gets the boundaries of the behaviour. More...

Glib::PropertyProxy< int >	property_depth_end ()
	Final depth to apply. More...

Glib::PropertyProxy_ReadOnly< int >	property_depth_end () const
	Final depth to apply. More...

Glib::PropertyProxy< int >	property_depth_start ()
	Initial depth to apply. More...

Glib::PropertyProxy_ReadOnly< int >	property_depth_start () const
	Initial depth to apply. More...

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

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

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

ClutterBehaviour*	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	apply (const Glib::RefPtr< Actor >& actor)
	Applies behave to actor. More...

void	remove (const Glib::RefPtr< Actor >& actor)
	Removes actor from the list of Clutter::Actors to which behave applies. More...

void	remove_all ()
	Removes every actor from the list that behave holds. More...

bool	is_applied (const Glib::RefPtr< Actor >& actor)
	Check if behave applied to actor. More...

std::vector< Glib::RefPtr < Actor > >	get_actors ()

std::vector< Glib::RefPtr < Actor const > >	get_actors () const

int	get_n_actors () const
	Gets the number of actors this behaviour is applied too. More...

Glib::RefPtr< Actor >	get_nth_actor (int index)
	Gets an actor the behaviour was applied to referenced by index num. More...

Glib::RefPtr< const Actor >	get_nth_actor (int index) const
	Gets an actor the behaviour was applied to referenced by index num. More...

Glib::RefPtr< Alpha >	get_alpha ()
	Retrieves the Clutter::Alpha object bound to behave. More...

Glib::RefPtr< const Alpha >	get_alpha () const
	Retrieves the Clutter::Alpha object bound to behave. More...

void	set_alpha (const Glib::RefPtr< Alpha >& alpha)
	Binds alpha to a Clutter::Behaviour. More...

void	actors_foreach (const SlotForEach& slot)

Glib::SignalProxy1< void, const Glib::RefPtr< Actor >& >	signal_applied ()

Glib::SignalProxy1< void, const Glib::RefPtr< Actor >& >	signal_removed ()

Glib::PropertyProxy < Glib::RefPtr< Alpha > >	property_alpha ()
	Alpha Object to drive the behaviour. More...

Glib::PropertyProxy_ReadOnly < Glib::RefPtr< Alpha > >	property_alpha () const
	Alpha Object to drive the behaviour. 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 < BehaviourDepth >	create (const Glib::RefPtr< Alpha >& alpha, int start_depth, int end_depth)

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

Protected Member Functions
	BehaviourDepth (const Glib::RefPtr< Alpha >& alpha, int depth_start, int depth_end)

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

virtual void	alpha_notify_vfunc (double alpha_value)

virtual void	on_applied (const Glib::RefPtr< Actor >& actor)
	This is a default handler for the signal signal_applied(). More...

virtual void	on_removed (const Glib::RefPtr< Actor >& actor)
	This is a default handler for the signal signal_removed(). More...

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

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

Additional Inherited Members
Public Types inherited from Clutter::Behaviour
typedef sigc::slot< void, const Glib::RefPtr< Behaviour > &, const Glib::RefPtr< Actor >& >	SlotForEach
	For instance, void on_foreach(const Glib::RefPtr<Behaviour>& behaviour, const Glib::RefPtr<Actor>& actor) More...

Detailed Description

Deprecated:: Use Actor::animate() with the Actor's depth property instead.

Constructor & Destructor Documentation

virtual Clutter::BehaviourDepth::~BehaviourDepth ( )

virtual

Clutter::BehaviourDepth::BehaviourDepth	(	const Glib::RefPtr< Alpha >&	alpha,
		int	depth_start,
		int	depth_end
	)

explicitprotected

Member Function Documentation

static Glib::RefPtr<BehaviourDepth> Clutter::BehaviourDepth::create	(	const Glib::RefPtr< Alpha >&	alpha,
		int	start_depth,
		int	end_depth
	)

static

void Clutter::BehaviourDepth::get_bounds	(	int &	depth_start,
		int &	depth_end
	)

Gets the boundaries of the behaviour.

Since cluttermm 0.6:

Deprecated: 1.6

Parameters

depth_start	Return location for the initial depth value, or `0`.
depth_end	Return location for the final depth value, or `0`.

static GType Clutter::BehaviourDepth::get_type ( )

static

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

ClutterBehaviourDepth* Clutter::BehaviourDepth::gobj ( )

inline

Provides access to the underlying C GObject.

const ClutterBehaviourDepth* Clutter::BehaviourDepth::gobj ( ) const

inline

Provides access to the underlying C GObject.

ClutterBehaviourDepth* Clutter::BehaviourDepth::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< int > Clutter::BehaviourDepth::property_depth_end ( )

Final depth to apply.

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< int > Clutter::BehaviourDepth::property_depth_end ( ) const

Final depth to apply.

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< int > Clutter::BehaviourDepth::property_depth_start ( )

Initial depth to apply.

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< int > Clutter::BehaviourDepth::property_depth_start ( ) const

Initial depth to apply.

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::BehaviourDepth::set_bounds	(	int	depth_start,
		int	depth_end
	)

Sets the boundaries of the behaviour.

Since cluttermm 0.6:

Deprecated: 1.6

Parameters

depth_start	Initial value of the depth.
depth_end	Final value of the depth.

Friends And Related Function Documentation

Glib::RefPtr< Clutter::BehaviourDepth > wrap	(	ClutterBehaviourDepth *	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/behaviour-depth.h

cluttermm: Clutter::BehaviourDepth Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation