GI.Gtk.Objects.GesturePan

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.

Exported types

newtype GesturePan

Memory-managed wrapper type.

Constructors

GesturePan (ManagedPtr GesturePan)

Instances

Eq GesturePan

Defined in GI.Gtk.Objects.GesturePan

Methods

(==) :: GesturePan -> GesturePan -> Bool

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

IsGValue GesturePan

Convert GesturePan to and from GValue with toGValue and fromGValue.

Defined in GI.Gtk.Objects.GesturePan

Methods

toGValue :: GesturePan -> IO GValue

fromGValue :: GValue -> IO GesturePan

GObject GesturePan

Defined in GI.Gtk.Objects.GesturePan

Methods

gobjectType :: IO GType

HasParentTypes GesturePan

Defined in GI.Gtk.Objects.GesturePan

type ParentTypes GesturePan

Defined in GI.Gtk.Objects.GesturePan

type ParentTypes GesturePan = '[GestureDrag, GestureSingle, Gesture, EventController, Object]

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

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

Instances

(GObject o, IsDescendantOf GesturePan o) => IsGesturePan o

Defined in GI.Gtk.Objects.GesturePan

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

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

noGesturePan :: Maybe GesturePan

A convenience alias for Nothing :: Maybe GesturePan.

Methods

Overloaded methods

getOrientation

gesturePanGetOrientation

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

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

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 => Orientation -> IO (GValueConstruct o)

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

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 ()

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 ()

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

type GesturePanPanCallback

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

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)

Wrap the callback into a GClosure.

mk_GesturePanPanCallback :: C_GesturePanPanCallback -> IO (FunPtr C_GesturePanPanCallback)

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

noGesturePanPanCallback :: Maybe GesturePanPanCallback

A convenience synonym for Nothing :: Maybe GesturePanPanCallback.

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

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

Wrap a GesturePanPanCallback into a C_GesturePanPanCallback.