GI.Clutter.Objects.Score

The Score structure contains only private data and should be accessed using the provided API

Since: 0.6

Exported types

newtype Score

Memory-managed wrapper type.

Constructors

Score (ManagedPtr Score)

Instances

Eq Score

Defined in GI.Clutter.Objects.Score

Methods

(==) :: Score -> Score -> Bool

(/=) :: Score -> Score -> Bool

GObject Score

Defined in GI.Clutter.Objects.Score

ManagedPtrNewtype Score

Defined in GI.Clutter.Objects.Score

Methods

toManagedPtr :: Score -> ManagedPtr Score

TypedObject Score

Defined in GI.Clutter.Objects.Score

Methods

glibType :: IO GType

HasParentTypes Score

Defined in GI.Clutter.Objects.Score

IsGValue (Maybe Score)

Convert Score to and from GValue. See toGValue and fromGValue.

Defined in GI.Clutter.Objects.Score

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Score -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Score)

type ParentTypes Score

Defined in GI.Clutter.Objects.Score

type ParentTypes Score = '[Object]

class (GObject o, IsDescendantOf Score o) => IsScore o

Type class for types which can be safely cast to Score, for instance with toScore.

Instances

(GObject o, IsDescendantOf Score o) => IsScore o

Defined in GI.Clutter.Objects.Score

toScore :: (MonadIO m, IsScore o) => o -> m Score

Cast to Score, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

append, appendAtMarker, bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, isPlaying, listTimelines, notify, notifyByPspec, pause, ref, refSink, remove, removeAll, rewind, runDispose, start, stealData, stealQdata, stop, thawNotify, unref, watchClosure.

Getters

getData, getLoop, getProperty, getQdata, getTimeline.

Setters

setData, setDataFull, setLoop, setProperty.

append

scoreAppend

Arguments

:: (HasCallStack, MonadIO m, IsScore a, IsTimeline b, IsTimeline c)

=> a

score: a Score

-> Maybe b

parent: a Timeline in the score, or Nothing

-> c

timeline: a Timeline

-> m CULong

Returns: the id of the Timeline inside the score, or 0 on failure. The returned id can be used with scoreRemove or scoreGetTimeline.

Deprecated: (Since version 1.8)

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

If parent is Nothing, the new Timeline will be started when scoreStart is called.

Score will take a reference on timeline.

Since: 0.6

appendAtMarker

scoreAppendAtMarker

Arguments

:: (HasCallStack, MonadIO m, IsScore a, IsTimeline b, IsTimeline c)

=> a

score: a Score

-> b

parent: the parent Timeline

-> Text

markerName: the name of the marker to use

-> c

timeline: the Timeline to append

-> m CULong

Returns: the id of the Timeline inside the score, or 0 on failure. The returned id can be used with scoreRemove or scoreGetTimeline.

Deprecated: (Since version 1.8)

Appends timeline at the given markerName on the parent Timeline.

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

The Score will take a reference on timeline.

Since: 0.8

getLoop

scoreGetLoop

Arguments

:: (HasCallStack, MonadIO m, IsScore a)

=> a

score: a Score

-> m Bool

Returns: True if the score is looping

Deprecated: (Since version 1.8)

Gets whether score is looping

Since: 0.6

getTimeline

scoreGetTimeline

Arguments

:: (HasCallStack, MonadIO m, IsScore a)

=> a

score: a Score

-> CULong

id_: the id of the timeline

-> m Timeline

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

Deprecated: (Since version 1.8)

Retrieves the Timeline for id_ inside score.

Since: 0.6

isPlaying

scoreIsPlaying

Arguments

:: (HasCallStack, MonadIO m, IsScore a)

=> a

score: A Score

-> m Bool

Returns: True if score is currently playing

Deprecated: (Since version 1.8)

Query state of a Score instance.

Since: 0.6

listTimelines

scoreListTimelines

Arguments

:: (HasCallStack, MonadIO m, IsScore a)

=> a

score: a Score

-> m [Timeline]

Returns: a SList containing 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.

Deprecated: (Since version 1.8)

Retrieves a list of all the ClutterTimelines managed by score.

Since: 0.6

new

scoreNew

Arguments

:: (HasCallStack, MonadIO m)

=> m Score

Returns: the newly created Score. Use objectUnref when done.

Deprecated: (Since version 1.8)

Creates a new Score. A Score is an object that can hold multiple Timelines in a sequential order.

Since: 0.6

pause

scorePause

Arguments

:: (HasCallStack, MonadIO m, IsScore a)

=> a

score: a Score

-> m ()

Deprecated: (Since version 1.8)

Pauses a playing score score.

Since: 0.6

remove

scoreRemove

Arguments

:: (HasCallStack, MonadIO m, IsScore a)

=> a

score: a Score

-> CULong

id_: the id of the timeline to remove

-> m ()

Deprecated: (Since version 1.8)

Removes the Timeline with the given id inside score. If the timeline has other timelines attached to it, those are removed as well.

Since: 0.6

removeAll

scoreRemoveAll

Arguments

:: (HasCallStack, MonadIO m, IsScore a)

=> a

score: a Score

-> m ()

Deprecated: (Since version 1.8)

Removes all the timelines inside score.

Since: 0.6

rewind

scoreRewind

Arguments

:: (HasCallStack, MonadIO m, IsScore a)

=> a

score: A Score

-> m ()

Deprecated: (Since version 1.8)

Rewinds a Score to its initial state.

Since: 0.6

setLoop

scoreSetLoop

Arguments

:: (HasCallStack, MonadIO m, IsScore a)

=> a

score: a Score

-> Bool

loop: True for enable looping

-> m ()

Deprecated: (Since version 1.8)

Sets whether score should loop. A looping Score will start from its initial state after the complete signal has been fired.

Since: 0.6

start

scoreStart

Arguments

:: (HasCallStack, MonadIO m, IsScore a)

=> a

score: A Score

-> m ()

Deprecated: (Since version 1.8)

Starts the score.

Since: 0.6

stop

scoreStop

Arguments

:: (HasCallStack, MonadIO m, IsScore a)

=> a

score: A Score

-> m ()

Deprecated: (Since version 1.8)

Stops and rewinds a playing Score instance.

Since: 0.6

Properties

loop

Whether the Score should restart once finished.

Since: 0.6

constructScoreLoop :: (IsScore o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “loop” property. This is rarely needed directly, but it is used by new.

getScoreLoop :: (MonadIO m, IsScore o) => o -> m Bool

Get the value of the “loop” property. When overloading is enabled, this is equivalent to

get score #loop

setScoreLoop :: (MonadIO m, IsScore o) => o -> Bool -> m ()

Set the value of the “loop” property. When overloading is enabled, this is equivalent to

set score [ #loop := value ]

Signals

completed

type ScoreCompletedCallback = IO ()

Deprecated: (Since version 1.8)

The completed signal is emitted each time a Score terminates.

Since: 0.6

afterScoreCompleted :: (IsScore a, MonadIO m) => a -> ((?self :: a) => ScoreCompletedCallback) -> m SignalHandlerId

Connect a signal handler for the completed signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after score #completed callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onScoreCompleted :: (IsScore a, MonadIO m) => a -> ((?self :: a) => ScoreCompletedCallback) -> m SignalHandlerId

Connect a signal handler for the completed signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on score #completed callback

paused

type ScorePausedCallback = IO ()

Deprecated: (Since version 1.8)

The paused signal is emitted each time a Score is paused.

Since: 0.6

afterScorePaused :: (IsScore a, MonadIO m) => a -> ((?self :: a) => ScorePausedCallback) -> m SignalHandlerId

Connect a signal handler for the paused signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after score #paused callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onScorePaused :: (IsScore a, MonadIO m) => a -> ((?self :: a) => ScorePausedCallback) -> m SignalHandlerId

Connect a signal handler for the paused signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on score #paused callback

started

type ScoreStartedCallback = IO ()

Deprecated: (Since version 1.8)

The started signal is emitted each time a Score starts playing.

Since: 0.6

afterScoreStarted :: (IsScore a, MonadIO m) => a -> ((?self :: a) => ScoreStartedCallback) -> m SignalHandlerId

Connect a signal handler for the started signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after score #started callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onScoreStarted :: (IsScore a, MonadIO m) => a -> ((?self :: a) => ScoreStartedCallback) -> m SignalHandlerId

Connect a signal handler for the started signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on score #started callback

timelineCompleted

type ScoreTimelineCompletedCallback

Arguments

 = Timeline

timeline: the completed timeline

-> IO ()

Deprecated: (Since version 1.8)

The timelineCompleted signal is emitted each time a timeline inside a Score terminates.

Since: 0.6

afterScoreTimelineCompleted :: (IsScore a, MonadIO m) => a -> ((?self :: a) => ScoreTimelineCompletedCallback) -> m SignalHandlerId

Connect a signal handler for the timelineCompleted signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after score #timelineCompleted callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onScoreTimelineCompleted :: (IsScore a, MonadIO m) => a -> ((?self :: a) => ScoreTimelineCompletedCallback) -> m SignalHandlerId

Connect a signal handler for the timelineCompleted signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on score #timelineCompleted callback

timelineStarted

type ScoreTimelineStartedCallback

Arguments

 = Timeline

timeline: the current timeline

-> IO ()

Deprecated: (Since version 1.8)

The timelineStarted signal is emitted each time a new timeline inside a Score starts playing.

Since: 0.6

afterScoreTimelineStarted :: (IsScore a, MonadIO m) => a -> ((?self :: a) => ScoreTimelineStartedCallback) -> m SignalHandlerId

Connect a signal handler for the timelineStarted signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after score #timelineStarted callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onScoreTimelineStarted :: (IsScore a, MonadIO m) => a -> ((?self :: a) => ScoreTimelineStartedCallback) -> m SignalHandlerId

Connect a signal handler for the timelineStarted signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on score #timelineStarted callback