cluttermm: Clutter::Score Class Reference

Inheritance diagram for Clutter::Score:

Collaboration diagram for Clutter::Score:

Public Member Functions
virtual	~Score ()

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

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

ClutterScore*	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_loop (bool loop=true)
	Sets whether score should loop. More...

bool	get_loop () const
	Gets whether score is looping. More...

gulong	append (const Glib::RefPtr< Timeline >& parent, const Glib::RefPtr< Timeline >& timeline)
	Appends a timeline to another one existing in the score; the newly appended timeline will be started when parent is complete. More...

gulong	append (const Glib::RefPtr< Timeline >& timeline)
	Appends a timeline to another one existing in the score. More...

void	append_at_marker (const Glib::RefPtr< Timeline >& parent, const Glib::ustring& marker_name, const Glib::RefPtr< Timeline >& timeline)
	Appends timeline at the given marker_name on the parent Clutter::Timeline. More...

void	remove (gulong id)
	Removes the Clutter::Timeline with the given id inside score. More...

void	remove_all ()
	Removes all the timelines inside score. More...

Glib::RefPtr< Timeline >	get_timeline (gulong id)
	Retrieves the Clutter::Timeline for id inside score. More...

Glib::RefPtr< const Timeline >	get_timeline (gulong id) const
	Retrieves the Clutter::Timeline for id inside score. More...

std::vector< Glib::RefPtr < Timeline > >	list_timelines ()

std::vector< Glib::RefPtr < const Timeline > >	list_timelines () const

void	start ()
	Starts the score. More...

void	pause ()
	Pauses a playing score score. More...

void	stop ()
	Stops and rewinds a playing Clutter::Score instance. More...

void	rewind ()
	Rewinds a Clutter::Score to its initial state. More...

bool	is_playing () const
	Query state of a Clutter::Score instance. More...

Glib::PropertyProxy< bool >	property_loop ()
	Whether the score should restart once finished. More...

Glib::PropertyProxy_ReadOnly < bool >	property_loop () const
	Whether the score should restart once finished. More...

Glib::SignalProxy0< void >	signal_completed ()

Glib::SignalProxy0< void >	signal_paused ()

Glib::SignalProxy0< void >	signal_started ()

Glib::SignalProxy1< void, const Glib::RefPtr< Timeline >& >	signal_timeline_completed ()

Glib::SignalProxy1< void, const Glib::RefPtr< Timeline >& >	signal_timeline_started ()

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< Score >	create ()

Protected Member Functions
	Score ()

virtual void	on_completed ()
	This is a default handler for the signal signal_completed(). More...

virtual void	on_paused ()
	This is a default handler for the signal signal_paused(). More...

virtual void	on_started ()
	This is a default handler for the signal signal_started(). More...

virtual void	on_timeline_completed (const Glib::RefPtr< Timeline >& timeline)
	This is a default handler for the signal signal_timeline_completed(). More...

virtual void	on_timeline_started (const Glib::RefPtr< Timeline >& timeline)
	This is a default handler for the signal signal_timeline_started(). More...

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

Detailed Description

Deprecated:: Use KeyFrameTransition instead.

Constructor & Destructor Documentation

virtual Clutter::Score::~Score ( )

virtual

Clutter::Score::Score ( )

protected

Member Function Documentation

gulong Clutter::Score::append	(	const Glib::RefPtr< Timeline >&	parent,
		const Glib::RefPtr< Timeline >&	timeline
	)

Appends a timeline to another one existing in the score; the newly appended timeline will be started when parent is complete.

Parameters

parent	A Clutter::Timeline in the score.
timeline	A Clutter::Timeline.

Returns: The id of the newly added timeline, to be used with get_timeline() and remove().

Since cluttermm 0.6:

gulong Clutter::Score::append ( const Glib::RefPtr< Timeline >& timeline)

Appends a timeline to another one existing in the score.

The new timeline will be started when start() is called.

Parameters

timeline the Timeline to append

Returns: the id of the newly added timeline, to be used with get_timeline() and remove().

void Clutter::Score::append_at_marker	(	const Glib::RefPtr< Timeline >&	parent,
		const Glib::ustring &	marker_name,
		const Glib::RefPtr< Timeline >&	timeline
	)

Appends timeline at the given marker_name on the parent Clutter::Timeline.

If you want to append timeline at the end of parent, use append().

The Clutter::Score will take a reference on timeline.

Since cluttermm 0.8:: Deprecated: 1.8

Parameters

parent	The parent Clutter::Timeline.
marker_name	The name of the marker to use.
timeline	The Clutter::Timeline to append.

Returns: The id of the Clutter::Timeline inside the score, or 0 on failure. The returned id can be used with remove() or get_timeline().

static Glib::RefPtr<Score> Clutter::Score::create ( )

static

bool Clutter::Score::get_loop ( ) const

Gets whether score is looping.

Since cluttermm 0.6:: Deprecated: 1.8

Returns: true if the score is looping.

Glib::RefPtr<Timeline> Clutter::Score::get_timeline ( gulong id)

Retrieves the Clutter::Timeline for id inside score.

Since cluttermm 0.6:: Deprecated: 1.8

Parameters

id	The id of the timeline.

Returns: The requested timeline, or 0. This function does not increase the reference count on the returned Clutter::Timeline.

Glib::RefPtr<const Timeline> Clutter::Score::get_timeline ( gulong id) const

Retrieves the Clutter::Timeline for id inside score.

Since cluttermm 0.6:: Deprecated: 1.8

Parameters

id	The id of the timeline.

Returns: The requested timeline, or 0. This function does not increase the reference count on the returned Clutter::Timeline.

static GType Clutter::Score::get_type ( )

static

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

ClutterScore* Clutter::Score::gobj ( )

inline

Provides access to the underlying C GObject.

const ClutterScore* Clutter::Score::gobj ( ) const

inline

Provides access to the underlying C GObject.

ClutterScore* Clutter::Score::gobj_copy ( )

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

bool Clutter::Score::is_playing ( ) const

Query state of a Clutter::Score instance.

Since cluttermm 0.6:: Deprecated: 1.8

Returns: true if score is currently playing.

std::vector<Glib::RefPtr<Timeline> > Clutter::Score::list_timelines ( )

std::vector<Glib::RefPtr<const Timeline> > Clutter::Score::list_timelines ( ) const

virtual void Clutter::Score::on_completed ( )

protectedvirtual

This is a default handler for the signal signal_completed().

virtual void Clutter::Score::on_paused ( )

protectedvirtual

This is a default handler for the signal signal_paused().

virtual void Clutter::Score::on_started ( )

protectedvirtual

This is a default handler for the signal signal_started().

virtual void Clutter::Score::on_timeline_completed ( const Glib::RefPtr< Timeline >& timeline)

protectedvirtual

This is a default handler for the signal signal_timeline_completed().

virtual void Clutter::Score::on_timeline_started ( const Glib::RefPtr< Timeline >& timeline)

protectedvirtual

This is a default handler for the signal signal_timeline_started().

void Clutter::Score::pause ( )

Pauses a playing score score.

Since cluttermm 0.6:: Deprecated: 1.8

Glib::PropertyProxy< bool > Clutter::Score::property_loop ( )

Whether the score should restart once finished.

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< bool > Clutter::Score::property_loop ( ) const

Whether the score should restart once finished.

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::Score::remove ( gulong id)

Removes the Clutter::Timeline with the given id inside score.

If the timeline has other timelines attached to it, those are removed as well.

Since cluttermm 0.6:: Deprecated: 1.8

Parameters

id	The id of the timeline to remove.

void Clutter::Score::remove_all ( )

Removes all the timelines inside score.

Since cluttermm 0.6:: Deprecated: 1.8

void Clutter::Score::rewind ( )

Rewinds a Clutter::Score to its initial state.

Since cluttermm 0.6:: Deprecated: 1.8

void Clutter::Score::set_loop ( bool loop = true)

Sets whether score should loop.

A looping Clutter::Score will start from its initial state after the signal_complete() signal has been fired.

Since cluttermm 0.6:: Deprecated: 1.8

Parameters

loop	`true` for enable looping.

Glib::SignalProxy0< void > Clutter::Score::signal_completed ( )

Slot Prototype:: void on_my_completed()

The signal_completed() signal is emitted each time a Clutter::Score terminates.

Since cluttermm 0.6:: Deprecated: 1.8

Glib::SignalProxy0< void > Clutter::Score::signal_paused ( )

Slot Prototype:: void on_my_paused()

The signal_paused() signal is emitted each time a Clutter::Score is paused.

Since cluttermm 0.6:: Deprecated: 1.8

Glib::SignalProxy0< void > Clutter::Score::signal_started ( )

Slot Prototype:: void on_my_started()

The signal_started() signal is emitted each time a Clutter::Score starts playing.

Since cluttermm 0.6:: Deprecated: 1.8

Glib::SignalProxy1< void,const Glib::RefPtr<Timeline>& > Clutter::Score::signal_timeline_completed ( )

Slot Prototype:: void on_my_timeline_completed(const Glib::RefPtr<Timeline>& timeline)

The signal_timeline_completed() signal is emitted each time a timeline inside a Clutter::Score terminates.

Since cluttermm 0.6:: Deprecated: 1.8

Parameters

timeline The completed timeline.

Glib::SignalProxy1< void,const Glib::RefPtr<Timeline>& > Clutter::Score::signal_timeline_started ( )

Slot Prototype:: void on_my_timeline_started(const Glib::RefPtr<Timeline>& timeline)

The signal_timeline_started() signal is emitted each time a new timeline inside a Clutter::Score starts playing.

Since cluttermm 0.6:: Deprecated: 1.8

Parameters

timeline The current timeline.

void Clutter::Score::start ( )

Starts the score.

Since cluttermm 0.6:: Deprecated: 1.8

void Clutter::Score::stop ( )

Stops and rewinds a playing Clutter::Score instance.

Since cluttermm 0.6:: Deprecated: 1.8

Friends And Related Function Documentation

Glib::RefPtr< Clutter::Score > wrap	(	ClutterScore *	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/score.h

cluttermm: Clutter::Score Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation