gi-clutter-1.0.5: clutter GObject bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Clutter.Objects.ZoomAction

Description

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

Since: 1.12

Synopsis

Exported types

newtype ZoomAction Source #

Memory-managed wrapper type.

Constructors

ZoomAction (ManagedPtr ZoomAction) 

Instances

Instances details
Eq ZoomAction Source # 
Instance details

Defined in GI.Clutter.Objects.ZoomAction

GObject ZoomAction Source # 
Instance details

Defined in GI.Clutter.Objects.ZoomAction

ManagedPtrNewtype ZoomAction Source # 
Instance details

Defined in GI.Clutter.Objects.ZoomAction

Methods

toManagedPtr :: ZoomAction -> ManagedPtr ZoomAction

TypedObject ZoomAction Source # 
Instance details

Defined in GI.Clutter.Objects.ZoomAction

Methods

glibType :: IO GType

HasParentTypes ZoomAction Source # 
Instance details

Defined in GI.Clutter.Objects.ZoomAction

IsGValue (Maybe ZoomAction) Source #

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

Instance details

Defined in GI.Clutter.Objects.ZoomAction

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes ZoomAction Source # 
Instance details

Defined in GI.Clutter.Objects.ZoomAction

type ParentTypes ZoomAction = '[GestureAction, Action, ActorMeta, Object]

class (GObject o, IsDescendantOf ZoomAction o) => IsZoomAction o Source #

Type class for types which can be safely cast to ZoomAction, for instance with toZoomAction.

Instances

Instances details
(GObject o, IsDescendantOf ZoomAction o) => IsZoomAction o Source # 
Instance details

Defined in GI.Clutter.Objects.ZoomAction

toZoomAction :: (MonadIO m, IsZoomAction o) => o -> m ZoomAction Source #

Cast to ZoomAction, for types for which this is known to be safe. For general casts, use castTo.

Methods

getFocalPoint

zoomActionGetFocalPoint Source #

Arguments

:: (HasCallStack, MonadIO m, IsZoomAction a) 
=> a

action: a ZoomAction

-> m Point 

Retrieves the focal point of the current zoom

Since: 1.12

getTransformedFocalPoint

zoomActionGetTransformedFocalPoint Source #

Arguments

:: (HasCallStack, MonadIO m, IsZoomAction a) 
=> a

action: a ZoomAction

-> m Point 

Retrieves the focal point relative to the actor's coordinates of the current zoom

Since: 1.12

getZoomAxis

zoomActionGetZoomAxis Source #

Arguments

:: (HasCallStack, MonadIO m, IsZoomAction a) 
=> a

action: a ZoomAction

-> m ZoomAxis

Returns: the axis constraint

Retrieves the axis constraint set by zoomActionSetZoomAxis

Since: 1.12

new

zoomActionNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m ZoomAction

Returns: the newly created ZoomAction

Creates a new ZoomAction instance

Since: 1.12

setZoomAxis

zoomActionSetZoomAxis Source #

Arguments

:: (HasCallStack, MonadIO m, IsZoomAction a) 
=> a

action: a ZoomAction

-> ZoomAxis

axis: the axis to constraint the zooming to

-> m () 

Restricts the zooming action to a specific axis

Since: 1.12

Properties

zoomAxis

Constraints the zooming action to the specified axis

Since: 1.12

constructZoomActionZoomAxis :: (IsZoomAction o, MonadIO m) => ZoomAxis -> m (GValueConstruct o) Source #

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

getZoomActionZoomAxis :: (MonadIO m, IsZoomAction o) => o -> m ZoomAxis Source #

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

get zoomAction #zoomAxis

setZoomActionZoomAxis :: (MonadIO m, IsZoomAction o) => o -> ZoomAxis -> m () Source #

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

set zoomAction [ #zoomAxis := value ]

Signals

zoom

type ZoomActionZoomCallback Source #

Arguments

 = Actor

actor: the Actor attached to the action

-> Point

focalPoint: the focal point of the zoom

-> Double

factor: the initial distance between the 2 touch points

-> IO Bool

Returns: True if the zoom should continue, and False if the zoom should be cancelled.

The zoom signal is emitted for each series of touch events that change the distance and focal point between the touch points.

The default handler of the signal will call actorSetScale on actor using the ratio of the first distance between the touch points and the current distance. To override the default behaviour, connect to this signal and return False.

Since: 1.12

afterZoomActionZoom :: (IsZoomAction a, MonadIO m) => a -> ((?self :: a) => ZoomActionZoomCallback) -> m SignalHandlerId Source #

Connect a signal handler for the zoom signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after zoomAction #zoom callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onZoomActionZoom :: (IsZoomAction a, MonadIO m) => a -> ((?self :: a) => ZoomActionZoomCallback) -> m SignalHandlerId Source #

Connect a signal handler for the zoom signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on zoomAction #zoom callback