GI.GES.Objects.MarkerList

A Marker can be colored by setting the META_MARKER_COLOR meta.

Since: 1.18

Exported types

newtype MarkerList

Memory-managed wrapper type.

Constructors

MarkerList (ManagedPtr MarkerList)

Instances

Eq MarkerList

Defined in GI.GES.Objects.MarkerList

Methods

(==) :: MarkerList -> MarkerList -> Bool

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

GObject MarkerList

Defined in GI.GES.Objects.MarkerList

ManagedPtrNewtype MarkerList

Defined in GI.GES.Objects.MarkerList

Methods

toManagedPtr :: MarkerList -> ManagedPtr MarkerList

TypedObject MarkerList

Defined in GI.GES.Objects.MarkerList

Methods

glibType :: IO GType

HasParentTypes MarkerList

Defined in GI.GES.Objects.MarkerList

IsGValue (Maybe MarkerList)

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

Defined in GI.GES.Objects.MarkerList

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes MarkerList

Defined in GI.GES.Objects.MarkerList

type ParentTypes MarkerList = '[Object]

class (GObject o, IsDescendantOf MarkerList o) => IsMarkerList o

Type class for types which can be safely cast to MarkerList, for instance with toMarkerList.

Instances

(GObject o, IsDescendantOf MarkerList o) => IsMarkerList o

Defined in GI.GES.Objects.MarkerList

toMarkerList :: (MonadIO m, IsMarkerList o) => o -> m MarkerList

Cast to MarkerList, 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

add, bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, move, notify, notifyByPspec, ref, refSink, remove, runDispose, size, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getData, getMarkers, getProperty, getQdata.

Setters

setData, setDataFull, setProperty.

add

markerListAdd

Arguments

:: (HasCallStack, MonadIO m, IsMarkerList a)

=> a

-> Word64

position: The position of the new marker

-> m Marker

Returns: The newly-added marker, the list keeps ownership of the marker

No description available in the introspection data.

Since: 1.18

getMarkers

markerListGetMarkers

Arguments

:: (HasCallStack, MonadIO m, IsMarkerList a)

=> a

-> m [Marker]

Returns: a List of the Marker within the GESMarkerList. The user will have to unref each Marker and free the List.

No description available in the introspection data.

Since: 1.18

move

markerListMove

Arguments

:: (HasCallStack, MonadIO m, IsMarkerList a, IsMarker b)

=> a

-> b

-> Word64

-> m Bool

Returns: True if the marker could be moved, False otherwise (if the marker was not present in the list for example)

Moves a marker in a list to a new position

Since: 1.18

new

markerListNew

Arguments

:: (HasCallStack, MonadIO m)

=> m MarkerList

Returns: A new MarkerList

Creates a new MarkerList.

Since: 1.18

remove

markerListRemove

Arguments

:: (HasCallStack, MonadIO m, IsMarkerList a, IsMarker b)

=> a

-> b

-> m Bool

Returns: True if the marker could be removed, False otherwise (if the marker was not present in the list for example)

Removes marker from list, this decreases the refcount of the marker by 1.

Since: 1.18

size

markerListSize

Arguments

:: (HasCallStack, MonadIO m, IsMarkerList a)

=> a

-> m Word32

Returns: The number of markers in list

No description available in the introspection data.

Since: 1.18

Properties

flags

Flags indicating how markers on the list should be treated.

Since: 1.20

constructMarkerListFlags :: (IsMarkerList o, MonadIO m) => [MarkerFlags] -> m (GValueConstruct o)

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

getMarkerListFlags :: (MonadIO m, IsMarkerList o) => o -> m [MarkerFlags]

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

get markerList #flags

setMarkerListFlags :: (MonadIO m, IsMarkerList o) => o -> [MarkerFlags] -> m ()

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

set markerList [ #flags := value ]

Signals

markerAdded

type MarkerListMarkerAddedCallback

Arguments

 = Word64

position: the position of the added marker

-> Marker

marker: the Marker that was added.

-> IO ()

Will be emitted after the marker was added to the marker-list.

Since: 1.18

afterMarkerListMarkerAdded :: (IsMarkerList a, MonadIO m) => a -> ((?self :: a) => MarkerListMarkerAddedCallback) -> m SignalHandlerId

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

after markerList #markerAdded 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.

onMarkerListMarkerAdded :: (IsMarkerList a, MonadIO m) => a -> ((?self :: a) => MarkerListMarkerAddedCallback) -> m SignalHandlerId

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

on markerList #markerAdded callback

markerMoved

type MarkerListMarkerMovedCallback

Arguments

 = Word64

previousPosition: the previous position of the marker

-> Word64

newPosition: the new position of the marker

-> Marker

marker: the Marker that was moved.

-> IO ()

Will be emitted after the marker was moved to.

Since: 1.18

afterMarkerListMarkerMoved :: (IsMarkerList a, MonadIO m) => a -> ((?self :: a) => MarkerListMarkerMovedCallback) -> m SignalHandlerId

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

after markerList #markerMoved 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.

onMarkerListMarkerMoved :: (IsMarkerList a, MonadIO m) => a -> ((?self :: a) => MarkerListMarkerMovedCallback) -> m SignalHandlerId

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

on markerList #markerMoved callback

markerRemoved

type MarkerListMarkerRemovedCallback

Arguments

 = Marker

marker: the Marker that was removed.

-> IO ()

Will be emitted after the marker was removed the marker-list.

Since: 1.18

afterMarkerListMarkerRemoved :: (IsMarkerList a, MonadIO m) => a -> ((?self :: a) => MarkerListMarkerRemovedCallback) -> m SignalHandlerId

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

after markerList #markerRemoved 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.

onMarkerListMarkerRemoved :: (IsMarkerList a, MonadIO m) => a -> ((?self :: a) => MarkerListMarkerRemovedCallback) -> m SignalHandlerId

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

on markerList #markerRemoved callback