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

GI.Clutter.Structs.AnimatorKey

Contents

Exported types
Methods

Description

A key frame inside a Animator

Since: 1.2

Synopsis

newtype AnimatorKey = AnimatorKey (ManagedPtr AnimatorKey)
animatorKeyGetMode :: (HasCallStack, MonadIO m) => AnimatorKey -> m CULong
animatorKeyGetObject :: (HasCallStack, MonadIO m) => AnimatorKey -> m Object
animatorKeyGetProgress :: (HasCallStack, MonadIO m) => AnimatorKey -> m Double
animatorKeyGetPropertyName :: (HasCallStack, MonadIO m) => AnimatorKey -> m Text
animatorKeyGetPropertyType :: (HasCallStack, MonadIO m) => AnimatorKey -> m GType
animatorKeyGetValue :: (HasCallStack, MonadIO m) => AnimatorKey -> GValue -> m Bool

Exported types

newtype AnimatorKey Source #

Memory-managed wrapper type.

Constructors

AnimatorKey (ManagedPtr AnimatorKey)

Instances

Instances details

Eq AnimatorKey Source #
Instance details Defined in GI.Clutter.Structs.AnimatorKey Methods (==) :: AnimatorKey -> AnimatorKey -> Bool # (/=) :: AnimatorKey -> AnimatorKey -> Bool #
GBoxed AnimatorKey Source #
Instance details Defined in GI.Clutter.Structs.AnimatorKey
ManagedPtrNewtype AnimatorKey Source #
Instance details Defined in GI.Clutter.Structs.AnimatorKey Methods toManagedPtr :: AnimatorKey -> ManagedPtr AnimatorKey
TypedObject AnimatorKey Source #
Instance details Defined in GI.Clutter.Structs.AnimatorKey Methods glibType :: IO GType
HasParentTypes AnimatorKey Source #
Instance details Defined in GI.Clutter.Structs.AnimatorKey
IsGValue (Maybe AnimatorKey) Source #	Convert `AnimatorKey` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Clutter.Structs.AnimatorKey Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe AnimatorKey -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe AnimatorKey)
type ParentTypes AnimatorKey Source #
Instance details Defined in GI.Clutter.Structs.AnimatorKey type ParentTypes AnimatorKey = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Expand

Methods

None.

Getters

getMode, getObject, getProgress, getPropertyName, getPropertyType, getValue.

Setters

None.

getMode

animatorKeyGetMode Source #

Arguments

:: (HasCallStack, MonadIO m)
=> AnimatorKey	`key`: a `AnimatorKey`
-> m CULong	Returns: the mode of a `AnimatorKey`

Deprecated: (Since version 1.12)Use KeyframeTransition instead

Retrieves the mode of a Animator key, for the first key of a property for an object this represents the whether the animation is open ended and or curved for the remainding keys for the property it represents the easing mode.

Since: 1.2

getObject

animatorKeyGetObject Source #

Arguments

:: (HasCallStack, MonadIO m)
=> AnimatorKey	`key`: a `AnimatorKey`
-> m Object	Returns: the object an animator_key exist for.

Deprecated: (Since version 1.12)Use KeyframeTransition instead

Retrieves the object a key applies to.

Since: 1.2

getProgress

animatorKeyGetProgress Source #

Arguments

:: (HasCallStack, MonadIO m)
=> AnimatorKey	`key`: a `AnimatorKey`
-> m Double	Returns: the progress defined for a `Animator` key.

Deprecated: (Since version 1.12)Use KeyframeTransition instead

Retrieves the progress of an clutter_animator_key

Since: 1.2

getPropertyName

animatorKeyGetPropertyName Source #

Arguments

:: (HasCallStack, MonadIO m)
=> AnimatorKey	`key`: a `AnimatorKey`
-> m Text	Returns: the name of the property an animator_key exist for.

Deprecated: (Since version 1.12)Use KeyframeTransition instead

Retrieves the name of the property a key applies to.

Since: 1.2

getPropertyType

animatorKeyGetPropertyType Source #

Arguments

:: (HasCallStack, MonadIO m)
=> AnimatorKey	`key`: a `AnimatorKey`
-> m GType	Returns: the `GType` of the property

Deprecated: (Since version 1.12)Use KeyframeTransition instead

Retrieves the GType of the property a key applies to

You can use this type to initialize the Value to pass to animatorKeyGetValue

Since: 1.2

getValue

animatorKeyGetValue Source #

Arguments

:: (HasCallStack, MonadIO m)
=> AnimatorKey	`key`: a `AnimatorKey`
-> GValue	`value`: a `Value` initialized with the correct type for the animator key
-> m Bool	Returns: `True` if the passed `Value` was successfully set, and `False` otherwise

Deprecated: (Since version 1.12)Use KeyframeTransition instead

Retrieves a copy of the value for a AnimatorKey.

The passed in Value needs to be already initialized for the value type of the key or to a type that allow transformation from the value type of the key.

Use valueUnset when done.

Since: 1.2