Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	None
Language	Haskell2010

GI.Gtk.Objects.GesturePan

Contents

Exported types
Methods
Properties
- orientation
Signals
- pan

Description

GesturePan is a Gesture implementation able to recognize pan gestures, those are drags that are locked to happen along one axis. The axis that a GesturePan handles is defined at construct time, and can be changed through gesturePanSetOrientation.

When the gesture starts to be recognized, GesturePan will attempt to determine as early as possible whether the sequence is moving in the expected direction, and denying the sequence if this does not happen.

Once a panning gesture along the expected axis is recognized, the pan signal will be emitted as input events are received, containing the offset in the given axis.

Synopsis

newtype GesturePan = GesturePan (ManagedPtr GesturePan)
class (GObject o, IsDescendantOf GesturePan o) => IsGesturePan o
toGesturePan :: (MonadIO m, IsGesturePan o) => o -> m GesturePan
gesturePanGetOrientation :: (HasCallStack, MonadIO m, IsGesturePan a) => a -> m Orientation
gesturePanNew :: (HasCallStack, MonadIO m, IsWidget a) => a -> Orientation -> m GesturePan
gesturePanSetOrientation :: (HasCallStack, MonadIO m, IsGesturePan a) => a -> Orientation -> m ()
constructGesturePanOrientation :: (IsGesturePan o, MonadIO m) => Orientation -> m (GValueConstruct o)
getGesturePanOrientation :: (MonadIO m, IsGesturePan o) => o -> m Orientation
setGesturePanOrientation :: (MonadIO m, IsGesturePan o) => o -> Orientation -> m ()
type C_GesturePanPanCallback = Ptr () -> CUInt -> CDouble -> Ptr () -> IO ()
type GesturePanPanCallback = PanDirection -> Double -> IO ()
afterGesturePanPan :: (IsGesturePan a, MonadIO m) => a -> GesturePanPanCallback -> m SignalHandlerId
genClosure_GesturePanPan :: MonadIO m => GesturePanPanCallback -> m (GClosure C_GesturePanPanCallback)
mk_GesturePanPanCallback :: C_GesturePanPanCallback -> IO (FunPtr C_GesturePanPanCallback)
noGesturePanPanCallback :: Maybe GesturePanPanCallback
onGesturePanPan :: (IsGesturePan a, MonadIO m) => a -> GesturePanPanCallback -> m SignalHandlerId
wrap_GesturePanPanCallback :: GesturePanPanCallback -> C_GesturePanPanCallback

Exported types

newtype GesturePan Source #

Memory-managed wrapper type.

Constructors

GesturePan (ManagedPtr GesturePan)

Instances

Instances details

Eq GesturePan Source #
Instance details Defined in GI.Gtk.Objects.GesturePan Methods (==) :: GesturePan -> GesturePan -> Bool # (/=) :: GesturePan -> GesturePan -> Bool #
IsGValue GesturePan Source #	Convert `GesturePan` to and from `GValue` with `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Objects.GesturePan Methods toGValue :: GesturePan -> IO GValue # fromGValue :: GValue -> IO GesturePan #
ManagedPtrNewtype GesturePan Source #
Instance details Defined in GI.Gtk.Objects.GesturePan Methods toManagedPtr :: GesturePan -> ManagedPtr GesturePan #
TypedObject GesturePan Source #
Instance details Defined in GI.Gtk.Objects.GesturePan Methods glibType :: IO GType #
GObject GesturePan Source #
Instance details Defined in GI.Gtk.Objects.GesturePan
HasParentTypes GesturePan Source #
Instance details Defined in GI.Gtk.Objects.GesturePan
type ParentTypes GesturePan Source #
Instance details Defined in GI.Gtk.Objects.GesturePan type ParentTypes GesturePan = '[GestureDrag, GestureSingle, Gesture, EventController, Object]

class (GObject o, IsDescendantOf GesturePan o) => IsGesturePan o Source #

Type class for types which can be safely cast to GesturePan, for instance with toGesturePan.

Instances

Instances details

(GObject o, IsDescendantOf GesturePan o) => IsGesturePan o Source #
Instance details Defined in GI.Gtk.Objects.GesturePan

toGesturePan :: (MonadIO m, IsGesturePan o) => o -> m GesturePan Source #

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

Methods

Overloaded methods

getOrientation

gesturePanGetOrientation Source #

Arguments

:: (HasCallStack, MonadIO m, IsGesturePan a)
=> a	`gesture`: A `GesturePan`
-> m Orientation	Returns: the expected orientation for pan gestures

Returns the orientation of the pan gestures that this gesture expects.

Since: 3.14

new

gesturePanNew Source #

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)
=> a	`widget`: a `Widget`
-> Orientation	`orientation`: expected orientation
-> m GesturePan	Returns: a newly created `GesturePan`

Returns a newly created Gesture that recognizes pan gestures.

Since: 3.14

setOrientation

gesturePanSetOrientation Source #

Arguments

:: (HasCallStack, MonadIO m, IsGesturePan a)
=> a	`gesture`: A `GesturePan`
-> Orientation	`orientation`: expected orientation
-> m ()

Sets the orientation to be expected on pan gestures.

Since: 3.14

Properties

orientation

The expected orientation of pan gestures.

Since: 3.14

constructGesturePanOrientation :: (IsGesturePan o, MonadIO m) => Orientation -> m (GValueConstruct o) Source #

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

getGesturePanOrientation :: (MonadIO m, IsGesturePan o) => o -> m Orientation Source #

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

get gesturePan #orientation

setGesturePanOrientation :: (MonadIO m, IsGesturePan o) => o -> Orientation -> m () Source #

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

set gesturePan [ #orientation := value ]

Signals

pan

type C_GesturePanPanCallback = Ptr () -> CUInt -> CDouble -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type GesturePanPanCallback Source #

Arguments

= PanDirection	`direction`: current direction of the pan gesture
-> Double	`offset`: Offset along the gesture orientation
-> IO ()

This signal is emitted once a panning gesture along the expected axis is detected.

Since: 3.14

afterGesturePanPan :: (IsGesturePan a, MonadIO m) => a -> GesturePanPanCallback -> m SignalHandlerId Source #

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

after gesturePan #pan callback

genClosure_GesturePanPan :: MonadIO m => GesturePanPanCallback -> m (GClosure C_GesturePanPanCallback) Source #

Wrap the callback into a GClosure.

mk_GesturePanPanCallback :: C_GesturePanPanCallback -> IO (FunPtr C_GesturePanPanCallback) Source #

Generate a function pointer callable from C code, from a C_GesturePanPanCallback.

noGesturePanPanCallback :: Maybe GesturePanPanCallback Source #

A convenience synonym for Nothing :: Maybe GesturePanPanCallback.

onGesturePanPan :: (IsGesturePan a, MonadIO m) => a -> GesturePanPanCallback -> m SignalHandlerId Source #

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

on gesturePan #pan callback

wrap_GesturePanPanCallback :: GesturePanPanCallback -> C_GesturePanPanCallback Source #

Wrap a GesturePanPanCallback into a C_GesturePanPanCallback.