GI.Clutter.Structs.StateKey

StateKey is an opaque structure whose members cannot be accessed directly

Since: 1.4

Exported types

newtype StateKey

Memory-managed wrapper type.

Constructors

StateKey (ManagedPtr StateKey)

Instances

Eq StateKey

Defined in GI.Clutter.Structs.StateKey

Methods

(==) :: StateKey -> StateKey -> Bool

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

GBoxed StateKey

Defined in GI.Clutter.Structs.StateKey

ManagedPtrNewtype StateKey

Defined in GI.Clutter.Structs.StateKey

Methods

toManagedPtr :: StateKey -> ManagedPtr StateKey

TypedObject StateKey

Defined in GI.Clutter.Structs.StateKey

Methods

glibType :: IO GType

HasParentTypes StateKey

Defined in GI.Clutter.Structs.StateKey

IsGValue (Maybe StateKey)

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

Defined in GI.Clutter.Structs.StateKey

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes StateKey

Defined in GI.Clutter.Structs.StateKey

type ParentTypes StateKey = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Methods

None.

Getters

getMode, getObject, getPostDelay, getPreDelay, getPropertyName, getPropertyType, getSourceStateName, getTargetStateName, getValue.

Setters

None.

getMode

stateKeyGetMode

Arguments

:: (HasCallStack, MonadIO m)

=> StateKey

stateKey: a StateKey

-> m CULong

Returns: the mode of a StateKey

Deprecated: (Since version 1.12)Use KeyframeTransition and TransitionGroup instead

Retrieves the easing mode used for stateKey.

Since: 1.4

getObject

stateKeyGetObject

Arguments

:: (HasCallStack, MonadIO m)

=> StateKey

stateKey: a StateKey

-> m Object

Returns: the object this state key applies to.

Deprecated: (Since version 1.12)Use KeyframeTransition and TransitionGroup instead

Retrieves the object instance this StateKey applies to.

Since: 1.4

getPostDelay

stateKeyGetPostDelay

Arguments

:: (HasCallStack, MonadIO m)

=> StateKey

stateKey: a StateKey

-> m Double

Returns: the post delay, used after doing the transition.

Deprecated: (Since version 1.12)Use KeyframeTransition and TransitionGroup instead

Retrieves the duration of the pause after transitioning is complete as a fraction of the total transition time.

Since: 1.4

getPreDelay

stateKeyGetPreDelay

Arguments

:: (HasCallStack, MonadIO m)

=> StateKey

stateKey: a StateKey

-> m Double

Returns: the pre delay used before starting the transition.

Deprecated: (Since version 1.12)Use KeyframeTransition and TransitionGroup instead

Retrieves the pause before transitioning starts as a fraction of the total transition time.

Since: 1.4

getPropertyName

stateKeyGetPropertyName

Arguments

:: (HasCallStack, MonadIO m)

=> StateKey

stateKey: a StateKey

-> m Text

Returns: the name of the property. The returned string is owned by the StateKey and should never be modified or freed

Deprecated: (Since version 1.12)Use KeyframeTransition and TransitionGroup instead

Retrieves the name of the property this StateKey applies to

Since: 1.4

getPropertyType

stateKeyGetPropertyType

Arguments

:: (HasCallStack, MonadIO m)

=> StateKey

key: a StateKey

-> m GType

Returns: the GType of the property

Deprecated: (Since version 1.12)Use KeyframeTransition and TransitionGroup instead

Retrieves the GType of the property a key applies to

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

Since: 1.4

getSourceStateName

stateKeyGetSourceStateName

Arguments

:: (HasCallStack, MonadIO m)

=> StateKey

stateKey: a StateKey

-> m Text

Returns: the name of the source state for this key, or Nothing if this is the generic state key for the given property when transitioning to the target state. The returned string is owned by the StateKey and should never be modified or freed

Deprecated: (Since version 1.12)Use KeyframeTransition and TransitionGroup instead

Retrieves the name of the source state of the stateKey

Since: 1.4

getTargetStateName

stateKeyGetTargetStateName

Arguments

:: (HasCallStack, MonadIO m)

=> StateKey

stateKey: a StateKey

-> m Text

Returns: the name of the source state for this key, or NULL if the key is generic

Deprecated: (Since version 1.12)Use KeyframeTransition and TransitionGroup instead

Get the name of the source state this StateKey contains, or NULL if this is the generic state key for the given property when transitioning to the target state.

Since: 1.4

getValue

stateKeyGetValue

Arguments

:: (HasCallStack, MonadIO m)

=> StateKey

stateKey: a StateKey

-> GValue

value: a Value initialized with the correct type for the stateKey

-> m Bool

Returns: True if the value was successfully retrieved, and False otherwise

Deprecated: (Since version 1.12)Use KeyframeTransition and TransitionGroup instead

Retrieves a copy of the value for a StateKey.

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

Use valueUnset when done.

Since: 1.4