Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
The Score
structure contains only private data
and should be accessed using the provided API
Since: 0.6
Synopsis
- newtype Score = Score (ManagedPtr Score)
- class (GObject o, IsDescendantOf Score o) => IsScore o
- toScore :: (MonadIO m, IsScore o) => o -> m Score
- scoreAppend :: (HasCallStack, MonadIO m, IsScore a, IsTimeline b, IsTimeline c) => a -> Maybe b -> c -> m CULong
- scoreAppendAtMarker :: (HasCallStack, MonadIO m, IsScore a, IsTimeline b, IsTimeline c) => a -> b -> Text -> c -> m CULong
- scoreGetLoop :: (HasCallStack, MonadIO m, IsScore a) => a -> m Bool
- scoreGetTimeline :: (HasCallStack, MonadIO m, IsScore a) => a -> CULong -> m Timeline
- scoreIsPlaying :: (HasCallStack, MonadIO m, IsScore a) => a -> m Bool
- scoreListTimelines :: (HasCallStack, MonadIO m, IsScore a) => a -> m [Timeline]
- scoreNew :: (HasCallStack, MonadIO m) => m Score
- scorePause :: (HasCallStack, MonadIO m, IsScore a) => a -> m ()
- scoreRemove :: (HasCallStack, MonadIO m, IsScore a) => a -> CULong -> m ()
- scoreRemoveAll :: (HasCallStack, MonadIO m, IsScore a) => a -> m ()
- scoreRewind :: (HasCallStack, MonadIO m, IsScore a) => a -> m ()
- scoreSetLoop :: (HasCallStack, MonadIO m, IsScore a) => a -> Bool -> m ()
- scoreStart :: (HasCallStack, MonadIO m, IsScore a) => a -> m ()
- scoreStop :: (HasCallStack, MonadIO m, IsScore a) => a -> m ()
- constructScoreLoop :: (IsScore o, MonadIO m) => Bool -> m (GValueConstruct o)
- getScoreLoop :: (MonadIO m, IsScore o) => o -> m Bool
- setScoreLoop :: (MonadIO m, IsScore o) => o -> Bool -> m ()
- type ScoreCompletedCallback = IO ()
- afterScoreCompleted :: (IsScore a, MonadIO m) => a -> ((?self :: a) => ScoreCompletedCallback) -> m SignalHandlerId
- onScoreCompleted :: (IsScore a, MonadIO m) => a -> ((?self :: a) => ScoreCompletedCallback) -> m SignalHandlerId
- type ScorePausedCallback = IO ()
- afterScorePaused :: (IsScore a, MonadIO m) => a -> ((?self :: a) => ScorePausedCallback) -> m SignalHandlerId
- onScorePaused :: (IsScore a, MonadIO m) => a -> ((?self :: a) => ScorePausedCallback) -> m SignalHandlerId
- type ScoreStartedCallback = IO ()
- afterScoreStarted :: (IsScore a, MonadIO m) => a -> ((?self :: a) => ScoreStartedCallback) -> m SignalHandlerId
- onScoreStarted :: (IsScore a, MonadIO m) => a -> ((?self :: a) => ScoreStartedCallback) -> m SignalHandlerId
- type ScoreTimelineCompletedCallback = Timeline -> IO ()
- afterScoreTimelineCompleted :: (IsScore a, MonadIO m) => a -> ((?self :: a) => ScoreTimelineCompletedCallback) -> m SignalHandlerId
- onScoreTimelineCompleted :: (IsScore a, MonadIO m) => a -> ((?self :: a) => ScoreTimelineCompletedCallback) -> m SignalHandlerId
- type ScoreTimelineStartedCallback = Timeline -> IO ()
- afterScoreTimelineStarted :: (IsScore a, MonadIO m) => a -> ((?self :: a) => ScoreTimelineStartedCallback) -> m SignalHandlerId
- onScoreTimelineStarted :: (IsScore a, MonadIO m) => a -> ((?self :: a) => ScoreTimelineStartedCallback) -> m SignalHandlerId
Exported types
Memory-managed wrapper type.
Instances
Eq Score Source # | |
GObject Score Source # | |
Defined in GI.Clutter.Objects.Score | |
ManagedPtrNewtype Score Source # | |
Defined in GI.Clutter.Objects.Score toManagedPtr :: Score -> ManagedPtr Score | |
TypedObject Score Source # | |
Defined in GI.Clutter.Objects.Score | |
HasParentTypes Score Source # | |
Defined in GI.Clutter.Objects.Score | |
IsGValue (Maybe Score) Source # | Convert |
Defined in GI.Clutter.Objects.Score gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Score -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Score) | |
type ParentTypes Score Source # | |
Defined in GI.Clutter.Objects.Score type ParentTypes Score = '[Object] |
class (GObject o, IsDescendantOf Score o) => IsScore o Source #
Instances
(GObject o, IsDescendantOf Score o) => IsScore o Source # | |
Defined in GI.Clutter.Objects.Score |
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
append
:: (HasCallStack, MonadIO m, IsScore a, IsTimeline b, IsTimeline c) | |
=> a |
|
-> Maybe b | |
-> c |
|
-> m CULong | Returns: the id of the |
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
:: (HasCallStack, MonadIO m, IsScore a, IsTimeline b, IsTimeline c) | |
=> a |
|
-> b |
|
-> Text |
|
-> c |
|
-> m CULong | Returns: the id of the |
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
:: (HasCallStack, MonadIO m, IsScore a) | |
=> a |
|
-> m Bool | Returns: |
Deprecated: (Since version 1.8)
Gets whether score
is looping
Since: 0.6
getTimeline
isPlaying
listTimelines
:: (HasCallStack, MonadIO m, IsScore a) | |
=> a |
|
-> m [Timeline] | Returns: a
|
Deprecated: (Since version 1.8)
Retrieves a list of all the ClutterTimelines
managed by score
.
Since: 0.6
new
:: (HasCallStack, MonadIO m) | |
=> m Score | Returns: the newly created |
pause
:: (HasCallStack, MonadIO m, IsScore a) | |
=> a |
|
-> m () |
Deprecated: (Since version 1.8)
Pauses a playing score score
.
Since: 0.6
remove
:: (HasCallStack, MonadIO m, IsScore a) | |
=> a |
|
-> CULong |
|
-> 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
:: (HasCallStack, MonadIO m, IsScore a) | |
=> a |
|
-> m () |
Deprecated: (Since version 1.8)
Removes all the timelines inside score
.
Since: 0.6
rewind
:: (HasCallStack, MonadIO m, IsScore a) | |
=> a |
|
-> m () |
setLoop
start
:: (HasCallStack, MonadIO m, IsScore a) | |
=> a |
|
-> m () |
Deprecated: (Since version 1.8)
Starts the score.
Since: 0.6
stop
:: (HasCallStack, MonadIO m, IsScore a) | |
=> a |
|
-> m () |
Properties
loop
Whether the Score
should restart once finished.
Since: 0.6
constructScoreLoop :: (IsScore o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
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 Source #
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 () Source #
Set the value of the “loop
” property.
When overloading is enabled, this is equivalent to
set
score [ #loop:=
value ]
Signals
completed
type ScoreCompletedCallback = IO () Source #
afterScoreCompleted :: (IsScore a, MonadIO m) => a -> ((?self :: a) => ScoreCompletedCallback) -> m SignalHandlerId Source #
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 Source #
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 () Source #
afterScorePaused :: (IsScore a, MonadIO m) => a -> ((?self :: a) => ScorePausedCallback) -> m SignalHandlerId Source #
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 Source #
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 () Source #
afterScoreStarted :: (IsScore a, MonadIO m) => a -> ((?self :: a) => ScoreStartedCallback) -> m SignalHandlerId Source #
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 Source #
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 Source #
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 Source #
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 Source #
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 Source #
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 Source #
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 Source #
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