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.Objects.Interval

Contents

Exported types
Methods
Properties

Description

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

Since: 1.0

Synopsis

newtype Interval = Interval (ManagedPtr Interval)
class (GObject o, IsDescendantOf Interval o) => IsInterval o
toInterval :: (MonadIO m, IsInterval o) => o -> m Interval
intervalClone :: (HasCallStack, MonadIO m, IsInterval a) => a -> m Interval
intervalCompute :: (HasCallStack, MonadIO m, IsInterval a) => a -> Double -> m GValue
intervalComputeValue :: (HasCallStack, MonadIO m, IsInterval a) => a -> Double -> m (Bool, GValue)
intervalGetFinalValue :: (HasCallStack, MonadIO m, IsInterval a) => a -> m GValue
intervalGetInitialValue :: (HasCallStack, MonadIO m, IsInterval a) => a -> m GValue
intervalGetValueType :: (HasCallStack, MonadIO m, IsInterval a) => a -> m GType
intervalIsValid :: (HasCallStack, MonadIO m, IsInterval a) => a -> m Bool
intervalNewWithValues :: (HasCallStack, MonadIO m) => GType -> Maybe GValue -> Maybe GValue -> m Interval
intervalPeekFinalValue :: (HasCallStack, MonadIO m, IsInterval a) => a -> m GValue
intervalPeekInitialValue :: (HasCallStack, MonadIO m, IsInterval a) => a -> m GValue
intervalSetFinal :: (HasCallStack, MonadIO m, IsInterval a) => a -> GValue -> m ()
intervalSetInitial :: (HasCallStack, MonadIO m, IsInterval a) => a -> GValue -> m ()
intervalValidate :: (HasCallStack, MonadIO m, IsInterval a) => a -> GParamSpec -> m Bool
constructIntervalFinal :: (IsInterval o, MonadIO m) => GValue -> m (GValueConstruct o)
getIntervalFinal :: (MonadIO m, IsInterval o) => o -> m (Maybe GValue)
setIntervalFinal :: (MonadIO m, IsInterval o) => o -> GValue -> m ()
constructIntervalInitial :: (IsInterval o, MonadIO m) => GValue -> m (GValueConstruct o)
getIntervalInitial :: (MonadIO m, IsInterval o) => o -> m (Maybe GValue)
setIntervalInitial :: (MonadIO m, IsInterval o) => o -> GValue -> m ()
constructIntervalValueType :: (IsInterval o, MonadIO m) => GType -> m (GValueConstruct o)
getIntervalValueType :: (MonadIO m, IsInterval o) => o -> m GType

Exported types

newtype Interval Source #

Memory-managed wrapper type.

Constructors

Interval (ManagedPtr Interval)

Instances

Instances details

Eq Interval Source #
Instance details Defined in GI.Clutter.Objects.Interval Methods (==) :: Interval -> Interval -> Bool # (/=) :: Interval -> Interval -> Bool #
GObject Interval Source #
Instance details Defined in GI.Clutter.Objects.Interval
ManagedPtrNewtype Interval Source #
Instance details Defined in GI.Clutter.Objects.Interval Methods toManagedPtr :: Interval -> ManagedPtr Interval
TypedObject Interval Source #
Instance details Defined in GI.Clutter.Objects.Interval Methods glibType :: IO GType
HasParentTypes Interval Source #
Instance details Defined in GI.Clutter.Objects.Interval
IsGValue (Maybe Interval) Source #	Convert `Interval` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details 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 Source #
Instance details Defined in GI.Clutter.Objects.Interval type ParentTypes Interval = '[Object, Scriptable]

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

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

Instances

Instances details

(GObject o, IsDescendantOf Interval o) => IsInterval o Source #
Instance details Defined in GI.Clutter.Objects.Interval

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

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

Expand

clone

intervalClone Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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) Source #

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) Source #

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 () Source #

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) Source #

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) Source #

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 () Source #

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) Source #

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 Source #

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

get interval #valueType

Exported types

Instances

Instances

Methods

Click to display all available methods, including inherited ones

Methods

Getters

Setters

clone

compute

computeValue

getFinalValue

getInitialValue

getValueType

isValid

newWithValues

peekFinalValue

peekInitialValue

setFinal

setInitial

validate

Properties

final

initial

valueType