Clutter.Score¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
class |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
|
|
|
|
|
|
|
|
|
Properties¶
Name |
Type |
Flags |
Short Description |
|---|---|---|---|
r/w |
Whether the score should restart once finished |
Signals¶
- Inherited:
Name |
Short Description |
|---|---|
The |
|
The |
|
The |
|
The |
|
The |
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
|---|---|---|---|
parent |
r |
Class Details¶
- class Clutter.Score(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
The
Clutter.Scorestructure contains only private data and should be accessed using the provided APINew in version 0.6.
- classmethod new()¶
- Returns:
the newly created
Clutter.Score. UseGObject.Object.unref() when done.- Return type:
Creates a new
Clutter.Score. AClutter.Scoreis an object that can hold multipleClutter.Timelines in a sequential order.New in version 0.6.
Deprecated since version 1.8.
- append(parent, timeline)¶
- Parameters:
parent (
Clutter.TimelineorNone) – aClutter.Timelinein the score, orNonetimeline (
Clutter.Timeline) – aClutter.Timeline
- Returns:
the id of the
Clutter.Timelineinside the score, or 0 on failure. The returned id can be used withClutter.Score.remove() orClutter.Score.get_timeline().- Return type:
Appends a timeline to another one existing in the score; the newly appended timeline will be started when parent is complete.
If parent is
None, the newClutter.Timelinewill be started whenClutter.Score.start() is called.Clutter.Scorewill take a reference on timeline.New in version 0.6.
Deprecated since version 1.8.
- append_at_marker(parent, marker_name, timeline)¶
- Parameters:
parent (
Clutter.Timeline) – the parentClutter.Timelinemarker_name (
str) – the name of the marker to usetimeline (
Clutter.Timeline) – theClutter.Timelineto append
- Returns:
the id of the
Clutter.Timelineinside the score, or 0 on failure. The returned id can be used withClutter.Score.remove() orClutter.Score.get_timeline().- Return type:
Appends timeline at the given marker_name on the parent
Clutter.Timeline.If you want to append timeline at the end of parent, use
Clutter.Score.append().The
Clutter.Scorewill take a reference on timeline.New in version 0.8.
Deprecated since version 1.8.
- get_loop()¶
-
Gets whether self is looping
New in version 0.6.
Deprecated since version 1.8.
- get_timeline(id_)¶
- Parameters:
id (
int) – the id of the timeline- Returns:
the requested timeline, or
None. This function does not increase the reference count on the returnedClutter.Timeline- Return type:
Retrieves the
Clutter.Timelinefor id_ inside self.New in version 0.6.
Deprecated since version 1.8.
- is_playing()¶
-
Query state of a
Clutter.Scoreinstance.New in version 0.6.
Deprecated since version 1.8.
- list_timelines()¶
- Returns:
a
GLib.SListcontaining all the timelines in the score. This function does not increase the reference count of the returned timelines. Use g_slist_free() on the returned list to deallocate its resources.- Return type:
Retrieves a list of all the
Clutter.Timelinesmanaged by self.New in version 0.6.
Deprecated since version 1.8.
- pause()¶
Pauses a playing score self.
New in version 0.6.
Deprecated since version 1.8.
- remove(id_)¶
- Parameters:
id (
int) – the id of the timeline to remove
Removes the
Clutter.Timelinewith the given id inside self. If the timeline has other timelines attached to it, those are removed as well.New in version 0.6.
Deprecated since version 1.8.
- remove_all()¶
Removes all the timelines inside self.
New in version 0.6.
Deprecated since version 1.8.
- rewind()¶
Rewinds a
Clutter.Scoreto its initial state.New in version 0.6.
Deprecated since version 1.8.
- set_loop(loop)¶
-
Sets whether self should loop. A looping
Clutter.Scorewill start from its initial state after the::completesignal has been fired.New in version 0.6.
Deprecated since version 1.8.
- start()¶
Starts the score.
New in version 0.6.
Deprecated since version 1.8.
- stop()¶
Stops and rewinds a playing
Clutter.Scoreinstance.New in version 0.6.
Deprecated since version 1.8.
- do_completed() virtual¶
- do_paused() virtual¶
- do_started() virtual¶
- do_timeline_completed(timeline) virtual¶
- Parameters:
timeline (
Clutter.Timeline) –
- do_timeline_started(timeline) virtual¶
- Parameters:
timeline (
Clutter.Timeline) –
Signal Details¶
- Clutter.Score.signals.completed(score)¶
- Signal Name:
completed- Flags:
- Parameters:
score (
Clutter.Score) – The object which received the signal
The
::completedsignal is emitted each time aClutter.Scoreterminates.New in version 0.6.
Deprecated since version 1.8.
- Clutter.Score.signals.paused(score)¶
- Signal Name:
paused- Flags:
- Parameters:
score (
Clutter.Score) – The object which received the signal
The
::pausedsignal is emitted each time aClutter.Scoreis paused.New in version 0.6.
Deprecated since version 1.8.
- Clutter.Score.signals.started(score)¶
- Signal Name:
started- Flags:
- Parameters:
score (
Clutter.Score) – The object which received the signal
The
::startedsignal is emitted each time aClutter.Scorestarts playing.New in version 0.6.
Deprecated since version 1.8.
- Clutter.Score.signals.timeline_completed(score, timeline)¶
- Signal Name:
timeline-completed- Flags:
- Parameters:
score (
Clutter.Score) – The object which received the signaltimeline (
Clutter.Timeline) – the completed timeline
The
::timeline-completedsignal is emitted each time a timeline inside aClutter.Scoreterminates.New in version 0.6.
Deprecated since version 1.8.
- Clutter.Score.signals.timeline_started(score, timeline)¶
- Signal Name:
timeline-started- Flags:
- Parameters:
score (
Clutter.Score) – The object which received the signaltimeline (
Clutter.Timeline) – the current timeline
The
::timeline-startedsignal is emitted each time a new timeline inside aClutter.Scorestarts playing.New in version 0.6.
Deprecated since version 1.8.