GI.Clutter.Objects.Interval

The Interval structure contains only private data and should be accessed using the provided functions.

Since: 1.0

Exported types

newtype Interval

Memory-managed wrapper type.

Constructors

Interval (ManagedPtr Interval)

Instances

Eq Interval

Defined in GI.Clutter.Objects.Interval

Methods

(==) :: Interval -> Interval -> Bool

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

GObject Interval

Defined in GI.Clutter.Objects.Interval

ManagedPtrNewtype Interval

Defined in GI.Clutter.Objects.Interval

Methods

toManagedPtr :: Interval -> ManagedPtr Interval

TypedObject Interval

Defined in GI.Clutter.Objects.Interval

Methods

glibType :: IO GType

HasParentTypes Interval

Defined in GI.Clutter.Objects.Interval

IsGValue (Maybe Interval)

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

Defined in GI.Clutter.Objects.Interval

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes Interval

Defined in GI.Clutter.Objects.Interval

type ParentTypes Interval = '[Object, Scriptable]

class (GObject o, IsDescendantOf Interval o) => IsInterval o

Type class for types which can be safely cast to Interval, for instance with toInterval.

Instances

(GObject o, IsDescendantOf Interval o) => IsInterval o

Defined in GI.Clutter.Objects.Interval

toInterval :: (MonadIO m, IsInterval o) => o -> m Interval

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

bindProperty, bindPropertyFull, clone, compute, computeValue, forceFloating, freezeNotify, getv, isFloating, isValid, notify, notifyByPspec, parseCustomNode, peekFinalValue, peekInitialValue, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, validate, watchClosure.

Getters

getData, getFinalValue, getId, getInitialValue, getProperty, getQdata, getValueType.

Setters

setCustomProperty, setData, setDataFull, setFinal, setId, setInitial, setProperty.

clone

intervalClone

Arguments

:: (HasCallStack, MonadIO m, IsInterval a)

=> a

interval: a Interval

-> m Interval

Returns: the newly created Interval

Creates a copy of interval.

Since: 1.0

compute

intervalCompute

Arguments

:: (HasCallStack, MonadIO m, IsInterval a)

=> a

interval: a Interval

-> Double

factor: the progress factor, between 0 and 1

-> m GValue

Returns: a pointer to the computed value, or Nothing if the computation was not successfull

Computes the value between the interval boundaries given the progress factor

Unlike intervalComputeValue, this function will return a const pointer to the computed value

You should use this function if you immediately pass the computed value to another function that makes a copy of it, like objectSetProperty

Since: 1.4

computeValue

intervalComputeValue

Arguments

:: (HasCallStack, MonadIO m, IsInterval a)

=> a

interval: a Interval

-> Double

factor: the progress factor, between 0 and 1

-> m (Bool, GValue)

Returns: True if the operation was successful

Computes the value between the interval boundaries given the progress factor and copies it into value.

Since: 1.0

getFinalValue

intervalGetFinalValue

Arguments

:: (HasCallStack, MonadIO m, IsInterval a)

=> a

interval: a Interval

-> m GValue

Retrieves the final value of interval and copies it into value.

The passed Value must be initialized to the value held by the Interval.

Since: 1.0

getInitialValue

intervalGetInitialValue

Arguments

:: (HasCallStack, MonadIO m, IsInterval a)

=> a

interval: a Interval

-> m GValue

Retrieves the initial value of interval and copies it into value.

The passed Value must be initialized to the value held by the Interval.

Since: 1.0

getValueType

intervalGetValueType

Arguments

:: (HasCallStack, MonadIO m, IsInterval a)

=> a

interval: a Interval

-> m GType

Returns: the type of the value, or G_TYPE_INVALID

Retrieves the GType of the values inside interval.

Since: 1.0

isValid

intervalIsValid

Arguments

:: (HasCallStack, MonadIO m, IsInterval a)

=> a

interval: a Interval

-> m Bool

Returns: True if the Interval has an initial and final values, and False otherwise

Checks if the interval has a valid initial and final values.

Since: 1.12

newWithValues

intervalNewWithValues

Arguments

:: (HasCallStack, MonadIO m)

=> GType

gtype: the type of the values in the interval

-> Maybe GValue

initial: a Value holding the initial value of the interval

-> Maybe GValue

final: a Value holding the final value of the interval

-> m Interval

Returns: the newly created Interval

Creates a new Interval of type gtype, between initial and final.

This function is useful for language bindings.

Since: 1.0

peekFinalValue

intervalPeekFinalValue

Arguments

:: (HasCallStack, MonadIO m, IsInterval a)

=> a

interval: a Interval

-> m GValue

Returns: the final value of the interval. The value is owned by the Interval and it should not be modified or freed

Gets the pointer to the final value of interval

Since: 1.0

peekInitialValue

intervalPeekInitialValue

Arguments

:: (HasCallStack, MonadIO m, IsInterval a)

=> a

interval: a Interval

-> m GValue

Returns: the initial value of the interval. The value is owned by the Interval and it should not be modified or freed

Gets the pointer to the initial value of interval

Since: 1.0

setFinal

intervalSetFinal

Arguments

:: (HasCallStack, MonadIO m, IsInterval a)

=> a

interval: a Interval

-> GValue

value: a Value

-> m ()

Sets the final value of interval to value. The value is copied inside the Interval.

Since: 1.0

setInitial

intervalSetInitial

Arguments

:: (HasCallStack, MonadIO m, IsInterval a)

=> a

interval: a Interval

-> GValue

value: a Value

-> m ()

Sets the initial value of interval to value. The value is copied inside the Interval.

Since: 1.0

validate

intervalValidate

Arguments

:: (HasCallStack, MonadIO m, IsInterval a)

=> a

interval: a Interval

-> GParamSpec

pspec: a ParamSpec

-> m Bool

Returns: True if the Interval is valid, False otherwise

Validates the initial and final values of interval against a ParamSpec.

Since: 1.0

Properties

final

The final value of the interval.

Since: 1.12

constructIntervalFinal :: (IsInterval o, MonadIO m) => GValue -> m (GValueConstruct o)

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

getIntervalFinal :: (MonadIO m, IsInterval o) => o -> m (Maybe GValue)

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

get interval #final

setIntervalFinal :: (MonadIO m, IsInterval o) => o -> GValue -> m ()

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

set interval [ #final := value ]

initial

The initial value of the interval.

Since: 1.12

constructIntervalInitial :: (IsInterval o, MonadIO m) => GValue -> m (GValueConstruct o)

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

getIntervalInitial :: (MonadIO m, IsInterval o) => o -> m (Maybe GValue)

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

get interval #initial

setIntervalInitial :: (MonadIO m, IsInterval o) => o -> GValue -> m ()

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

set interval [ #initial := value ]

valueType

The type of the values in the interval.

Since: 1.0

constructIntervalValueType :: (IsInterval o, MonadIO m) => GType -> m (GValueConstruct o)

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

getIntervalValueType :: (MonadIO m, IsInterval o) => o -> m GType

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

get interval #valueType