Clutter::Score Class Reference

#include <score.h>

Inheritance diagram for Clutter::Score:

Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ~Score ()
ClutterScore * gobj ()
 Provides access to the underlying C GObject.
const ClutterScore * gobj () const
 Provides access to the underlying C GObject.
ClutterScore * gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
void set_loop (bool loop=true)
 Sets whether score should loop.
bool get_loop () const
 Gets whether score is looping.
guint 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.
guint append (const Glib::RefPtr< Timeline > &timeline)
 Appends a timeline to another one existing in the score.
void remove (guint id)
 Removes the Clutter::Timeline with the given id inside score.
void remove_all ()
 Removes all the timelines inside score.
Glib::RefPtr< Timelineget_timeline (guint id)
 Retrieves the Clutter::Timeline for id inside score.
Glib::RefPtr< const Timelineget_timeline (guint id) const
 Retrieves the Clutter::Timeline for id inside score.
void start ()
 Starts the score.
void pause ()
 Pauses a playing score score.
void stop ()
 Stops and rewinds a playing Clutter::Score instance.
void rewind ()
 Rewinds a Clutter::Score to its initial state.
bool is_playing () const
 Query state of a Clutter::Score instance.

Static Public Member Functions

static Glib::RefPtr< Scorecreate ()

Protected Member Functions

 Score ()

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Clutter::Scorewrap (ClutterScore *object, bool take_copy=false)
 A Glib::wrap() method for this object.


Constructor & Destructor Documentation

virtual Clutter::Score::~Score (  )  [virtual]

Clutter::Score::Score (  )  [protected]


Member Function Documentation

guint 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().

guint 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: 0.6.

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

bool Clutter::Score::get_loop (  )  const

Gets whether score is looping.

Returns:
true if the score is looping
Since: 0.6.

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

Retrieves the Clutter::Timeline for id inside score.

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
Since: 0.6.

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

Retrieves the Clutter::Timeline for id inside score.

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
Since: 0.6.

const ClutterScore* Clutter::Score::gobj (  )  const [inline]

Provides access to the underlying C GObject.

ClutterScore* Clutter::Score::gobj (  )  [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.

Returns:
true if score is currently playing
Since: 0.6.

void Clutter::Score::pause (  ) 

Pauses a playing score score.

Since: 0.6

void Clutter::Score::remove ( guint  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: 0.6

Parameters:
id The id of the timeline to remove.

void Clutter::Score::remove_all (  ) 

Removes all the timelines inside score.

Since: 0.6

void Clutter::Score::rewind (  ) 

Rewinds a Clutter::Score to its initial state.

Since: 0.6

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 complete signal has been fired.

Since: 0.6

Parameters:
loop true for enable looping.

void Clutter::Score::start (  ) 

Starts the score.

Since: 0.6

void Clutter::Score::stop (  ) 

Stops and rewinds a playing Clutter::Score instance.

Since: 0.6


Friends And Related Function Documentation

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

Generated on Sun Feb 15 18:55:42 2009 for cluttermm by  doxygen 1.5.7.1