GI.Clutter.Objects.PageTurnEffect

PageTurnEffect is an opaque structure whose members can only be accessed using the provided API

Since: 1.4

Exported types

newtype PageTurnEffect

Memory-managed wrapper type.

Constructors

PageTurnEffect (ManagedPtr PageTurnEffect)

Instances

Eq PageTurnEffect

Defined in GI.Clutter.Objects.PageTurnEffect

Methods

(==) :: PageTurnEffect -> PageTurnEffect -> Bool

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

GObject PageTurnEffect

Defined in GI.Clutter.Objects.PageTurnEffect

ManagedPtrNewtype PageTurnEffect

Defined in GI.Clutter.Objects.PageTurnEffect

Methods

toManagedPtr :: PageTurnEffect -> ManagedPtr PageTurnEffect

TypedObject PageTurnEffect

Defined in GI.Clutter.Objects.PageTurnEffect

Methods

glibType :: IO GType

HasParentTypes PageTurnEffect

Defined in GI.Clutter.Objects.PageTurnEffect

IsGValue (Maybe PageTurnEffect)

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

Defined in GI.Clutter.Objects.PageTurnEffect

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes PageTurnEffect

Defined in GI.Clutter.Objects.PageTurnEffect

type ParentTypes PageTurnEffect = '[DeformEffect, OffscreenEffect, Effect, ActorMeta, Object]

class (GObject o, IsDescendantOf PageTurnEffect o) => IsPageTurnEffect o

Type class for types which can be safely cast to PageTurnEffect, for instance with toPageTurnEffect.

Instances

(GObject o, IsDescendantOf PageTurnEffect o) => IsPageTurnEffect o

Defined in GI.Clutter.Objects.PageTurnEffect

toPageTurnEffect :: (MonadIO m, IsPageTurnEffect o) => o -> m PageTurnEffect

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

Getters

getActor, getAngle, getBackMaterial, getData, getEnabled, getNTiles, getName, getPeriod, getProperty, getQdata, getRadius, getTarget, getTargetRect, getTargetSize, getTexture.

Setters

setAngle, setBackMaterial, setData, setDataFull, setEnabled, setNTiles, setName, setPeriod, setProperty, setRadius.

getAngle

pageTurnEffectGetAngle

Arguments

:: (HasCallStack, MonadIO m, IsPageTurnEffect a)

=> a

effect: a PageTurnEffect:

-> m Double

Returns: the angle of the page curling

Retrieves the value set using pageTurnEffectGetAngle

Since: 1.4

getPeriod

pageTurnEffectGetPeriod

Arguments

:: (HasCallStack, MonadIO m, IsPageTurnEffect a)

=> a

effect: a PageTurnEffect

-> m Double

Returns: the period of the page curling

Retrieves the value set using pageTurnEffectGetPeriod

Since: 1.4

getRadius

pageTurnEffectGetRadius

Arguments

:: (HasCallStack, MonadIO m, IsPageTurnEffect a)

=> a

effect: a PageTurnEffect

-> m Float

Returns: the radius of the page curling

Retrieves the value set using pageTurnEffectSetRadius

Since: 1.4

new

pageTurnEffectNew

Arguments

:: (HasCallStack, MonadIO m)

=> Double

period: the period of the page curl, between 0.0 and 1.0

-> Double

angle: the angle of the page curl, between 0.0 and 360.0

-> Float

radius: the radius of the page curl, in pixels

-> m PageTurnEffect

Returns: the newly created PageTurnEffect

Creates a new PageTurnEffect instance with the given parameters

Since: 1.4

setAngle

pageTurnEffectSetAngle

Arguments

:: (HasCallStack, MonadIO m, IsPageTurnEffect a)

=> a

effect: PageTurnEffect

-> Double

angle: the angle of the page curl, in degrees

-> m ()

Sets the angle of the page curling, in degrees

Since: 1.4

setPeriod

pageTurnEffectSetPeriod

Arguments

:: (HasCallStack, MonadIO m, IsPageTurnEffect a)

=> a

effect: a PageTurnEffect

-> Double

period: the period of the page curl, between 0.0 and 1.0

-> m ()

Sets the period of the page curling, between 0.0 (no curling) and 1.0 (fully curled)

Since: 1.4

setRadius

pageTurnEffectSetRadius

Arguments

:: (HasCallStack, MonadIO m, IsPageTurnEffect a)

=> a

effect: a PageTurnEffect:

-> Float

radius: the radius of the page curling, in pixels

-> m ()

Sets the radius of the page curling

Since: 1.4

Properties

angle

The angle of the page rotation, in degrees, between 0.0 and 360.0

Since: 1.4

constructPageTurnEffectAngle :: (IsPageTurnEffect o, MonadIO m) => Double -> m (GValueConstruct o)

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

getPageTurnEffectAngle :: (MonadIO m, IsPageTurnEffect o) => o -> m Double

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

get pageTurnEffect #angle

setPageTurnEffectAngle :: (MonadIO m, IsPageTurnEffect o) => o -> Double -> m ()

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

set pageTurnEffect [ #angle := value ]

period

The period of the page turn, between 0.0 (no curling) and 1.0 (fully curled)

Since: 1.4

constructPageTurnEffectPeriod :: (IsPageTurnEffect o, MonadIO m) => Double -> m (GValueConstruct o)

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

getPageTurnEffectPeriod :: (MonadIO m, IsPageTurnEffect o) => o -> m Double

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

get pageTurnEffect #period

setPageTurnEffectPeriod :: (MonadIO m, IsPageTurnEffect o) => o -> Double -> m ()

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

set pageTurnEffect [ #period := value ]

radius

The radius of the page curl, in pixels

Since: 1.4

constructPageTurnEffectRadius :: (IsPageTurnEffect o, MonadIO m) => Float -> m (GValueConstruct o)

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

getPageTurnEffectRadius :: (MonadIO m, IsPageTurnEffect o) => o -> m Float

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

get pageTurnEffect #radius

setPageTurnEffectRadius :: (MonadIO m, IsPageTurnEffect o) => o -> Float -> m ()

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

set pageTurnEffect [ #radius := value ]