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.Structs.Knot

Contents

Exported types
Methods
Properties
- x
- y

Description

Point in a path behaviour.

Since: 0.2

Synopsis

newtype Knot = Knot (ManagedPtr Knot)
newZeroKnot :: MonadIO m => m Knot
knotCopy :: (HasCallStack, MonadIO m) => Knot -> m Knot
knotEqual :: (HasCallStack, MonadIO m) => Knot -> Knot -> m Bool
knotFree :: (HasCallStack, MonadIO m) => Knot -> m ()
getKnotX :: MonadIO m => Knot -> m Int32
setKnotX :: MonadIO m => Knot -> Int32 -> m ()
getKnotY :: MonadIO m => Knot -> m Int32
setKnotY :: MonadIO m => Knot -> Int32 -> m ()

Exported types

newtype Knot Source #

Memory-managed wrapper type.

Constructors

Knot (ManagedPtr Knot)

Instances

Instances details

Eq Knot Source #
Instance details Defined in GI.Clutter.Structs.Knot Methods (==) :: Knot -> Knot -> Bool # (/=) :: Knot -> Knot -> Bool #
GBoxed Knot Source #
Instance details Defined in GI.Clutter.Structs.Knot
ManagedPtrNewtype Knot Source #
Instance details Defined in GI.Clutter.Structs.Knot Methods toManagedPtr :: Knot -> ManagedPtr Knot
TypedObject Knot Source #
Instance details Defined in GI.Clutter.Structs.Knot Methods glibType :: IO GType
HasParentTypes Knot Source #
Instance details Defined in GI.Clutter.Structs.Knot
tag ~ 'AttrSet => Constructible Knot tag Source #
Instance details Defined in GI.Clutter.Structs.Knot Methods new :: MonadIO m => (ManagedPtr Knot -> Knot) -> [AttrOp Knot tag] -> m Knot
IsGValue (Maybe Knot) Source #	Convert `Knot` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Clutter.Structs.Knot Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Knot -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Knot)
type ParentTypes Knot Source #
Instance details Defined in GI.Clutter.Structs.Knot type ParentTypes Knot = '[] :: [Type]

newZeroKnot :: MonadIO m => m Knot Source #

Construct a Knot struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Expand

Methods

copy, equal, free.

Getters

None.

Setters

None.

copy

knotCopy Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Knot	`knot`: a `Knot`
-> m Knot	Returns: the copied knot.

Makes an allocated copy of a knot.

Since: 0.2

equal

knotEqual Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Knot	`knotA`: First knot
-> Knot	`knotB`: Second knot
-> m Bool	Returns: `True` if the knots point to the same location.

Compares to knot and checks if the point to the same location.

Since: 0.2

free

knotFree Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Knot	`knot`: a `Knot`
-> m ()

Frees the memory of an allocated knot.

Since: 0.2

Properties

x

X coordinate of the knot

getKnotX :: MonadIO m => Knot -> m Int32 Source #

Get the value of the “x” field. When overloading is enabled, this is equivalent to

get knot #x

setKnotX :: MonadIO m => Knot -> Int32 -> m () Source #

Set the value of the “x” field. When overloading is enabled, this is equivalent to

set knot [ #x := value ]

y

Y coordinate of the knot

getKnotY :: MonadIO m => Knot -> m Int32 Source #

Get the value of the “y” field. When overloading is enabled, this is equivalent to

get knot #y

setKnotY :: MonadIO m => Knot -> Int32 -> m () Source #

Set the value of the “y” field. When overloading is enabled, this is equivalent to

set knot [ #y := value ]