GI.Clutter.Objects.BehaviourDepth

The BehaviourDepth structure contains only private data and should be accessed using the provided API

Since: 0.2

Exported types

newtype BehaviourDepth

Memory-managed wrapper type.

Constructors

BehaviourDepth (ManagedPtr BehaviourDepth)

Instances

Eq BehaviourDepth

Defined in GI.Clutter.Objects.BehaviourDepth

Methods

(==) :: BehaviourDepth -> BehaviourDepth -> Bool

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

GObject BehaviourDepth

Defined in GI.Clutter.Objects.BehaviourDepth

ManagedPtrNewtype BehaviourDepth

Defined in GI.Clutter.Objects.BehaviourDepth

Methods

toManagedPtr :: BehaviourDepth -> ManagedPtr BehaviourDepth

TypedObject BehaviourDepth

Defined in GI.Clutter.Objects.BehaviourDepth

Methods

glibType :: IO GType

HasParentTypes BehaviourDepth

Defined in GI.Clutter.Objects.BehaviourDepth

IsGValue (Maybe BehaviourDepth)

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

Defined in GI.Clutter.Objects.BehaviourDepth

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes BehaviourDepth

Defined in GI.Clutter.Objects.BehaviourDepth

type ParentTypes BehaviourDepth = '[Behaviour, Object, Scriptable]

class (GObject o, IsDescendantOf BehaviourDepth o) => IsBehaviourDepth o

Type class for types which can be safely cast to BehaviourDepth, for instance with toBehaviourDepth.

Instances

(GObject o, IsDescendantOf BehaviourDepth o) => IsBehaviourDepth o

Defined in GI.Clutter.Objects.BehaviourDepth

toBehaviourDepth :: (MonadIO m, IsBehaviourDepth o) => o -> m BehaviourDepth

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

actorsForeach, apply, bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isApplied, isFloating, notify, notifyByPspec, parseCustomNode, ref, refSink, remove, removeAll, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getActors, getAlpha, getBounds, getData, getId, getNActors, getNthActor, getProperty, getQdata.

Setters

setAlpha, setBounds, setCustomProperty, setData, setDataFull, setId, setProperty.

getBounds

behaviourDepthGetBounds

Arguments

:: (HasCallStack, MonadIO m, IsBehaviourDepth a)

=> a

behaviour: a BehaviourDepth

-> m (Int32, Int32)

Deprecated: (Since version 1.6)

Gets the boundaries of the behaviour

Since: 0.6

new

behaviourDepthNew

Arguments

:: (HasCallStack, MonadIO m, IsAlpha a)

=> Maybe a

alpha: a Alpha instance, or Nothing

-> Int32

depthStart: initial value of the depth

-> Int32

depthEnd: final value of the depth

-> m BehaviourDepth

Returns: the newly created behaviour

Deprecated: (Since version 1.6)

Creates a new BehaviourDepth which can be used to control the ClutterActor:depth property of a set of Actors.

If alpha is not Nothing, the Behaviour will take ownership of the Alpha instance. In the case when alpha is Nothing, it can be set later with behaviourSetAlpha.

Since: 0.4

setBounds

behaviourDepthSetBounds

Arguments

:: (HasCallStack, MonadIO m, IsBehaviourDepth a)

=> a

behaviour: a BehaviourDepth

-> Int32

depthStart: initial value of the depth

-> Int32

depthEnd: final value of the depth

-> m ()

Deprecated: (Since version 1.6)

Sets the boundaries of the behaviour.

Since: 0.6

Properties

depthEnd

End depth level to apply to the actors.

Since: 0.4

constructBehaviourDepthDepthEnd :: (IsBehaviourDepth o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getBehaviourDepthDepthEnd :: (MonadIO m, IsBehaviourDepth o) => o -> m Int32

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

get behaviourDepth #depthEnd

setBehaviourDepthDepthEnd :: (MonadIO m, IsBehaviourDepth o) => o -> Int32 -> m ()

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

set behaviourDepth [ #depthEnd := value ]

depthStart

Start depth level to apply to the actors.

Since: 0.4

constructBehaviourDepthDepthStart :: (IsBehaviourDepth o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getBehaviourDepthDepthStart :: (MonadIO m, IsBehaviourDepth o) => o -> m Int32

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

get behaviourDepth #depthStart

setBehaviourDepthDepthStart :: (MonadIO m, IsBehaviourDepth o) => o -> Int32 -> m ()

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

set behaviourDepth [ #depthStart := value ]