GI.Clutter.Objects.SnapConstraint

SnapConstraint is an opaque structure whose members cannot be directly accesses

Since: 1.6

Exported types

newtype SnapConstraint

Memory-managed wrapper type.

Constructors

SnapConstraint (ManagedPtr SnapConstraint)

Instances

Eq SnapConstraint

Defined in GI.Clutter.Objects.SnapConstraint

Methods

(==) :: SnapConstraint -> SnapConstraint -> Bool

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

GObject SnapConstraint

Defined in GI.Clutter.Objects.SnapConstraint

ManagedPtrNewtype SnapConstraint

Defined in GI.Clutter.Objects.SnapConstraint

Methods

toManagedPtr :: SnapConstraint -> ManagedPtr SnapConstraint

TypedObject SnapConstraint

Defined in GI.Clutter.Objects.SnapConstraint

Methods

glibType :: IO GType

HasParentTypes SnapConstraint

Defined in GI.Clutter.Objects.SnapConstraint

IsGValue (Maybe SnapConstraint)

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

Defined in GI.Clutter.Objects.SnapConstraint

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes SnapConstraint

Defined in GI.Clutter.Objects.SnapConstraint

type ParentTypes SnapConstraint = '[Constraint, ActorMeta, Object]

class (GObject o, IsDescendantOf SnapConstraint o) => IsSnapConstraint o

Type class for types which can be safely cast to SnapConstraint, for instance with toSnapConstraint.

Instances

(GObject o, IsDescendantOf SnapConstraint o) => IsSnapConstraint o

Defined in GI.Clutter.Objects.SnapConstraint

toSnapConstraint :: (MonadIO m, IsSnapConstraint o) => o -> m SnapConstraint

Cast to SnapConstraint, 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, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getActor, getData, getEdges, getEnabled, getName, getOffset, getProperty, getQdata, getSource.

Setters

setData, setDataFull, setEdges, setEnabled, setName, setOffset, setProperty, setSource.

getEdges

snapConstraintGetEdges

Arguments

:: (HasCallStack, MonadIO m, IsSnapConstraint a)

=> a

constraint: a SnapConstraint

-> m (SnapEdge, SnapEdge)

Retrieves the edges used by the constraint

Since: 1.6

getOffset

snapConstraintGetOffset

Arguments

:: (HasCallStack, MonadIO m, IsSnapConstraint a)

=> a

constraint: a SnapConstraint

-> m Float

Returns: the offset, in pixels

Retrieves the offset set using snapConstraintSetOffset

Since: 1.6

getSource

snapConstraintGetSource

Arguments

:: (HasCallStack, MonadIO m, IsSnapConstraint a)

=> a

constraint: a SnapConstraint

-> m Actor

Returns: a pointer to the source actor

Retrieves the Actor set using snapConstraintSetSource

Since: 1.6

new

snapConstraintNew

Arguments

:: (HasCallStack, MonadIO m, IsActor a)

=> Maybe a

source: the Actor to use as the source of the constraint, or Nothing

-> SnapEdge

fromEdge: the edge of the actor to use in the constraint

-> SnapEdge

toEdge: the edge of source to use in the constraint

-> Float

offset: the offset to apply to the constraint, in pixels

-> m SnapConstraint

Returns: the newly created SnapConstraint

Creates a new SnapConstraint that will snap a Actor to the edge of source, with the given offset.

Since: 1.6

setEdges

snapConstraintSetEdges

Arguments

:: (HasCallStack, MonadIO m, IsSnapConstraint a)

=> a

constraint: a SnapConstraint

-> SnapEdge

fromEdge: the edge on the actor

-> SnapEdge

toEdge: the edge on the source

-> m ()

Sets the edges to be used by the constraint

The fromEdge is the edge on the Actor to which constraint has been added. The toEdge is the edge of the Actor inside the SnapConstraint:source property.

Since: 1.6

setOffset

snapConstraintSetOffset

Arguments

:: (HasCallStack, MonadIO m, IsSnapConstraint a)

=> a

constraint: a SnapConstraint

-> Float

offset: the offset to apply, in pixels

-> m ()

Sets the offset to be applied to the constraint

Since: 1.6

setSource

snapConstraintSetSource

Arguments

:: (HasCallStack, MonadIO m, IsSnapConstraint a, IsActor b)

=> a

constraint: a SnapConstraint

-> Maybe b

source: a Actor, or Nothing to unset the source

-> m ()

Sets the source Actor for the constraint

Since: 1.6

Properties

fromEdge

The edge of the Actor that should be snapped

Since: 1.6

constructSnapConstraintFromEdge :: (IsSnapConstraint o, MonadIO m) => SnapEdge -> m (GValueConstruct o)

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

getSnapConstraintFromEdge :: (MonadIO m, IsSnapConstraint o) => o -> m SnapEdge

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

get snapConstraint #fromEdge

setSnapConstraintFromEdge :: (MonadIO m, IsSnapConstraint o) => o -> SnapEdge -> m ()

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

set snapConstraint [ #fromEdge := value ]

offset

The offset, in pixels, between SnapConstraint:fromEdge and SnapConstraint:toEdge

Since: 1.6

constructSnapConstraintOffset :: (IsSnapConstraint o, MonadIO m) => Float -> m (GValueConstruct o)

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

getSnapConstraintOffset :: (MonadIO m, IsSnapConstraint o) => o -> m Float

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

get snapConstraint #offset

setSnapConstraintOffset :: (MonadIO m, IsSnapConstraint o) => o -> Float -> m ()

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

set snapConstraint [ #offset := value ]

source

The Actor used as the source for the constraint

Since: 1.6

clearSnapConstraintSource :: (MonadIO m, IsSnapConstraint o) => o -> m ()

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

clear #source

constructSnapConstraintSource :: (IsSnapConstraint o, MonadIO m, IsActor a) => a -> m (GValueConstruct o)

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

getSnapConstraintSource :: (MonadIO m, IsSnapConstraint o) => o -> m Actor

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

get snapConstraint #source

setSnapConstraintSource :: (MonadIO m, IsSnapConstraint o, IsActor a) => o -> a -> m ()

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

set snapConstraint [ #source := value ]

toEdge

The edge of the SnapConstraint:source that should be snapped

Since: 1.6

constructSnapConstraintToEdge :: (IsSnapConstraint o, MonadIO m) => SnapEdge -> m (GValueConstruct o)

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

getSnapConstraintToEdge :: (MonadIO m, IsSnapConstraint o) => o -> m SnapEdge

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

get snapConstraint #toEdge

setSnapConstraintToEdge :: (MonadIO m, IsSnapConstraint o) => o -> SnapEdge -> m ()

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

set snapConstraint [ #toEdge := value ]