gi-ges-1.0.4: libges bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.GES.Objects.Formatter

Description

Base class for timeline data serialization and deserialization.

Synopsis

Exported types

newtype Formatter Source #

Memory-managed wrapper type.

Constructors

Formatter (ManagedPtr Formatter) 

Instances

Instances details
Eq Formatter Source # 
Instance details

Defined in GI.GES.Objects.Formatter

GObject Formatter Source # 
Instance details

Defined in GI.GES.Objects.Formatter

ManagedPtrNewtype Formatter Source # 
Instance details

Defined in GI.GES.Objects.Formatter

Methods

toManagedPtr :: Formatter -> ManagedPtr Formatter

TypedObject Formatter Source # 
Instance details

Defined in GI.GES.Objects.Formatter

Methods

glibType :: IO GType

HasParentTypes Formatter Source # 
Instance details

Defined in GI.GES.Objects.Formatter

IsGValue (Maybe Formatter) Source #

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

Instance details

Defined in GI.GES.Objects.Formatter

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes Formatter Source # 
Instance details

Defined in GI.GES.Objects.Formatter

type ParentTypes Formatter = '[Object, Extractable]

class (GObject o, IsDescendantOf Formatter o) => IsFormatter o Source #

Type class for types which can be safely cast to Formatter, for instance with toFormatter.

Instances

Instances details
(GObject o, IsDescendantOf Formatter o) => IsFormatter o Source # 
Instance details

Defined in GI.GES.Objects.Formatter

toFormatter :: (MonadIO m, IsFormatter o) => o -> m Formatter Source #

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

Methods

canLoadUri

formatterCanLoadUri Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Text

uri: a gchar * pointing to the URI

-> m ()

(Can throw GError)

Checks if there is a Formatter available which can load a Timeline from the given URI.

canSaveUri

formatterCanSaveUri Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Text

uri: a gchar * pointing to a URI

-> m ()

(Can throw GError)

Returns TRUE if there is a Formatter available which can save a Timeline to the given URI.

getDefault

formatterGetDefault Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m Asset

Returns: The Asset for the formatter with highest rank

Get the default Asset to use as formatter. It will return the asset for the Formatter that has the highest rank

loadFromUri

formatterLoadFromUri Source #

Arguments

:: (HasCallStack, MonadIO m, IsFormatter a, IsTimeline b) 
=> a

formatter: a Formatter

-> b

timeline: a Timeline

-> Text

uri: a gchar * pointing to a URI

-> m ()

(Can throw GError)

Deprecated: (Since version 1.18)Use gesTimelineLoadFromUri

Load data from the given URI into timeline.

saveToUri

formatterSaveToUri Source #

Arguments

:: (HasCallStack, MonadIO m, IsFormatter a, IsTimeline b) 
=> a

formatter: a Formatter

-> b

timeline: a Timeline

-> Text

uri: a gchar * pointing to a URI

-> Bool

overwrite: True to overwrite file if it exists

-> m ()

(Can throw GError)

Deprecated: (Since version 1.18)Use gesTimelineSaveToUri

Save data from timeline to the given URI.