GI.Gtk.Objects.GestureSingle

GestureSingle is a subclass of Gesture, optimized (although not restricted) for dealing with mouse and single-touch gestures. Under interaction, these gestures stick to the first interacting sequence, which is accessible through gestureSingleGetCurrentSequence while the gesture is being interacted with.

By default gestures react to both BUTTON_PRIMARY and touch events, gestureSingleSetTouchOnly can be used to change the touch behavior. Callers may also specify a different mouse button number to interact with through gestureSingleSetButton, or react to any mouse button by setting 0. While the gesture is active, the button being currently pressed can be known through gestureSingleGetCurrentButton.

Exported types

newtype GestureSingle

Constructors

GestureSingle (ManagedPtr GestureSingle)

Instances

GObject GestureSingle

Methods

gobjectType :: GestureSingle -> IO GType

IsObject GestureSingle

IsGestureSingle GestureSingle

IsGesture GestureSingle

IsEventController GestureSingle

((~) * info (ResolveGestureSingleMethod t GestureSingle), MethodInfo * info GestureSingle p) => IsLabel t (GestureSingle -> p)

Methods

fromLabel :: Proxy# Symbol t -> GestureSingle -> p

((~) * info (ResolveGestureSingleMethod t GestureSingle), MethodInfo * info GestureSingle p) => IsLabelProxy t (GestureSingle -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> GestureSingle -> p

HasAttributeList * GestureSingle

type AttributeList GestureSingle

type AttributeList GestureSingle

type SignalList GestureSingle

type SignalList GestureSingle

class GObject o => IsGestureSingle o

Instances

(GObject a, UnknownAncestorError Constraint GestureSingle a) => IsGestureSingle a

IsGestureSingle GestureSingle

IsGestureSingle GestureDrag

IsGestureSingle GestureLongPress

IsGestureSingle GestureMultiPress

IsGestureSingle GestureSwipe

IsGestureSingle GesturePan

toGestureSingle :: IsGestureSingle o => o -> IO GestureSingle

noGestureSingle :: Maybe GestureSingle

Methods

getButton

data GestureSingleGetButtonMethodInfo

Instances

((~) * signature (m Word32), MonadIO m, IsGestureSingle a) => MethodInfo * GestureSingleGetButtonMethodInfo a signature

Methods

overloadedMethod :: MethodProxy GestureSingleGetButtonMethodInfo a -> signature -> s

gestureSingleGetButton

Arguments

:: (HasCallStack, MonadIO m, IsGestureSingle a)

=> a

gesture: a GestureSingle

-> m Word32

Returns: The button number, or 0 for any button

Returns the button number gesture listens for, or 0 if gesture reacts to any button press.

Since: 3.14

getCurrentButton

data GestureSingleGetCurrentButtonMethodInfo

Instances

((~) * signature (m Word32), MonadIO m, IsGestureSingle a) => MethodInfo * GestureSingleGetCurrentButtonMethodInfo a signature

Methods

overloadedMethod :: MethodProxy GestureSingleGetCurrentButtonMethodInfo a -> signature -> s

gestureSingleGetCurrentButton

Arguments

:: (HasCallStack, MonadIO m, IsGestureSingle a)

=> a

gesture: a GestureSingle

-> m Word32

Returns: The current button number

Returns the button number currently interacting with gesture, or 0 if there is none.

Since: 3.14

getCurrentSequence

data GestureSingleGetCurrentSequenceMethodInfo

Instances

((~) * signature (m (Maybe EventSequence)), MonadIO m, IsGestureSingle a) => MethodInfo * GestureSingleGetCurrentSequenceMethodInfo a signature

Methods

overloadedMethod :: MethodProxy GestureSingleGetCurrentSequenceMethodInfo a -> signature -> s

gestureSingleGetCurrentSequence

Arguments

:: (HasCallStack, MonadIO m, IsGestureSingle a)

=> a

gesture: a GestureSingle

-> m (Maybe EventSequence)

Returns: the current sequence

Returns the event sequence currently interacting with gesture. This is only meaningful if gestureIsActive returns True.

Since: 3.14

getExclusive

data GestureSingleGetExclusiveMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsGestureSingle a) => MethodInfo * GestureSingleGetExclusiveMethodInfo a signature

Methods

overloadedMethod :: MethodProxy GestureSingleGetExclusiveMethodInfo a -> signature -> s

gestureSingleGetExclusive

Arguments

:: (HasCallStack, MonadIO m, IsGestureSingle a)

=> a

gesture: a GestureSingle

-> m Bool

Returns: Whether the gesture is exclusive

Gets whether a gesture is exclusive. For more information, see gestureSingleSetExclusive.

Since: 3.14

getTouchOnly

data GestureSingleGetTouchOnlyMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsGestureSingle a) => MethodInfo * GestureSingleGetTouchOnlyMethodInfo a signature

Methods

overloadedMethod :: MethodProxy GestureSingleGetTouchOnlyMethodInfo a -> signature -> s

gestureSingleGetTouchOnly

Arguments

:: (HasCallStack, MonadIO m, IsGestureSingle a)

=> a

gesture: a GestureSingle

-> m Bool

Returns: True if the gesture only handles touch events

Returns True if the gesture is only triggered by touch events.

Since: 3.14

setButton

data GestureSingleSetButtonMethodInfo

Instances

((~) * signature (Word32 -> m ()), MonadIO m, IsGestureSingle a) => MethodInfo * GestureSingleSetButtonMethodInfo a signature

Methods

overloadedMethod :: MethodProxy GestureSingleSetButtonMethodInfo a -> signature -> s

gestureSingleSetButton

Arguments

:: (HasCallStack, MonadIO m, IsGestureSingle a)

=> a

gesture: a GestureSingle

-> Word32

button: button number to listen to, or 0 for any button

-> m ()

Sets the button number gesture listens to. If non-0, every button press from a different button number will be ignored. Touch events implicitly match with button 1.

Since: 3.14

setExclusive

data GestureSingleSetExclusiveMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsGestureSingle a) => MethodInfo * GestureSingleSetExclusiveMethodInfo a signature

Methods

overloadedMethod :: MethodProxy GestureSingleSetExclusiveMethodInfo a -> signature -> s

gestureSingleSetExclusive

Arguments

:: (HasCallStack, MonadIO m, IsGestureSingle a)

=> a

gesture: a GestureSingle

-> Bool

exclusive: True to make gesture exclusive

-> m ()

Sets whether gesture is exclusive. An exclusive gesture will only handle pointer and "pointer emulated" touch events, so at any given time, there is only one sequence able to interact with those.

Since: 3.14

setTouchOnly

data GestureSingleSetTouchOnlyMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsGestureSingle a) => MethodInfo * GestureSingleSetTouchOnlyMethodInfo a signature

Methods

overloadedMethod :: MethodProxy GestureSingleSetTouchOnlyMethodInfo a -> signature -> s

gestureSingleSetTouchOnly

Arguments

:: (HasCallStack, MonadIO m, IsGestureSingle a)

=> a

gesture: a GestureSingle

-> Bool

touchOnly: whether gesture handles only touch events

-> m ()

If touchOnly is True, gesture will only handle events of type GDK_TOUCH_BEGIN, GDK_TOUCH_UPDATE or GDK_TOUCH_END. If False, mouse events will be handled too.

Since: 3.14

Properties

button

data GestureSingleButtonPropertyInfo

Instances

AttrInfo GestureSingleButtonPropertyInfo

Associated Types

type AttrAllowedOps GestureSingleButtonPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint GestureSingleButtonPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint GestureSingleButtonPropertyInfo :: * -> Constraint

type AttrGetType GestureSingleButtonPropertyInfo :: *

type AttrLabel GestureSingleButtonPropertyInfo :: Symbol

type AttrOrigin GestureSingleButtonPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint GestureSingleButtonPropertyInfo o => Proxy * GestureSingleButtonPropertyInfo -> o -> IO (AttrGetType GestureSingleButtonPropertyInfo)

attrSet :: (AttrBaseTypeConstraint GestureSingleButtonPropertyInfo o, AttrSetTypeConstraint GestureSingleButtonPropertyInfo b) => Proxy * GestureSingleButtonPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint GestureSingleButtonPropertyInfo o => Proxy * GestureSingleButtonPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint GestureSingleButtonPropertyInfo o, AttrSetTypeConstraint GestureSingleButtonPropertyInfo b) => Proxy * GestureSingleButtonPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin GestureSingleButtonPropertyInfo

type AttrOrigin GestureSingleButtonPropertyInfo = GestureSingle

type AttrLabel GestureSingleButtonPropertyInfo

type AttrLabel GestureSingleButtonPropertyInfo = "button"

type AttrGetType GestureSingleButtonPropertyInfo

type AttrGetType GestureSingleButtonPropertyInfo = Word32

type AttrBaseTypeConstraint GestureSingleButtonPropertyInfo

type AttrBaseTypeConstraint GestureSingleButtonPropertyInfo = IsGestureSingle

type AttrSetTypeConstraint GestureSingleButtonPropertyInfo

type AttrSetTypeConstraint GestureSingleButtonPropertyInfo = * ~ Word32

type AttrAllowedOps GestureSingleButtonPropertyInfo

type AttrAllowedOps GestureSingleButtonPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructGestureSingleButton :: IsGestureSingle o => Word32 -> IO (GValueConstruct o)

gestureSingleButton :: AttrLabelProxy "button"

getGestureSingleButton :: (MonadIO m, IsGestureSingle o) => o -> m Word32

setGestureSingleButton :: (MonadIO m, IsGestureSingle o) => o -> Word32 -> m ()

exclusive

data GestureSingleExclusivePropertyInfo

Instances

AttrInfo GestureSingleExclusivePropertyInfo

Associated Types

type AttrAllowedOps GestureSingleExclusivePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint GestureSingleExclusivePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint GestureSingleExclusivePropertyInfo :: * -> Constraint

type AttrGetType GestureSingleExclusivePropertyInfo :: *

type AttrLabel GestureSingleExclusivePropertyInfo :: Symbol

type AttrOrigin GestureSingleExclusivePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint GestureSingleExclusivePropertyInfo o => Proxy * GestureSingleExclusivePropertyInfo -> o -> IO (AttrGetType GestureSingleExclusivePropertyInfo)

attrSet :: (AttrBaseTypeConstraint GestureSingleExclusivePropertyInfo o, AttrSetTypeConstraint GestureSingleExclusivePropertyInfo b) => Proxy * GestureSingleExclusivePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint GestureSingleExclusivePropertyInfo o => Proxy * GestureSingleExclusivePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint GestureSingleExclusivePropertyInfo o, AttrSetTypeConstraint GestureSingleExclusivePropertyInfo b) => Proxy * GestureSingleExclusivePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin GestureSingleExclusivePropertyInfo

type AttrOrigin GestureSingleExclusivePropertyInfo = GestureSingle

type AttrLabel GestureSingleExclusivePropertyInfo

type AttrLabel GestureSingleExclusivePropertyInfo = "exclusive"

type AttrGetType GestureSingleExclusivePropertyInfo

type AttrGetType GestureSingleExclusivePropertyInfo = Bool

type AttrBaseTypeConstraint GestureSingleExclusivePropertyInfo

type AttrBaseTypeConstraint GestureSingleExclusivePropertyInfo = IsGestureSingle

type AttrSetTypeConstraint GestureSingleExclusivePropertyInfo

type AttrSetTypeConstraint GestureSingleExclusivePropertyInfo = * ~ Bool

type AttrAllowedOps GestureSingleExclusivePropertyInfo

type AttrAllowedOps GestureSingleExclusivePropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructGestureSingleExclusive :: IsGestureSingle o => Bool -> IO (GValueConstruct o)

gestureSingleExclusive :: AttrLabelProxy "exclusive"

getGestureSingleExclusive :: (MonadIO m, IsGestureSingle o) => o -> m Bool

setGestureSingleExclusive :: (MonadIO m, IsGestureSingle o) => o -> Bool -> m ()

touchOnly

data GestureSingleTouchOnlyPropertyInfo

Instances

AttrInfo GestureSingleTouchOnlyPropertyInfo

Associated Types

type AttrAllowedOps GestureSingleTouchOnlyPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint GestureSingleTouchOnlyPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint GestureSingleTouchOnlyPropertyInfo :: * -> Constraint

type AttrGetType GestureSingleTouchOnlyPropertyInfo :: *

type AttrLabel GestureSingleTouchOnlyPropertyInfo :: Symbol

type AttrOrigin GestureSingleTouchOnlyPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint GestureSingleTouchOnlyPropertyInfo o => Proxy * GestureSingleTouchOnlyPropertyInfo -> o -> IO (AttrGetType GestureSingleTouchOnlyPropertyInfo)

attrSet :: (AttrBaseTypeConstraint GestureSingleTouchOnlyPropertyInfo o, AttrSetTypeConstraint GestureSingleTouchOnlyPropertyInfo b) => Proxy * GestureSingleTouchOnlyPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint GestureSingleTouchOnlyPropertyInfo o => Proxy * GestureSingleTouchOnlyPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint GestureSingleTouchOnlyPropertyInfo o, AttrSetTypeConstraint GestureSingleTouchOnlyPropertyInfo b) => Proxy * GestureSingleTouchOnlyPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin GestureSingleTouchOnlyPropertyInfo

type AttrOrigin GestureSingleTouchOnlyPropertyInfo = GestureSingle

type AttrLabel GestureSingleTouchOnlyPropertyInfo

type AttrLabel GestureSingleTouchOnlyPropertyInfo = "touch-only"

type AttrGetType GestureSingleTouchOnlyPropertyInfo

type AttrGetType GestureSingleTouchOnlyPropertyInfo = Bool

type AttrBaseTypeConstraint GestureSingleTouchOnlyPropertyInfo

type AttrBaseTypeConstraint GestureSingleTouchOnlyPropertyInfo = IsGestureSingle

type AttrSetTypeConstraint GestureSingleTouchOnlyPropertyInfo

type AttrSetTypeConstraint GestureSingleTouchOnlyPropertyInfo = * ~ Bool

type AttrAllowedOps GestureSingleTouchOnlyPropertyInfo

type AttrAllowedOps GestureSingleTouchOnlyPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructGestureSingleTouchOnly :: IsGestureSingle o => Bool -> IO (GValueConstruct o)

gestureSingleTouchOnly :: AttrLabelProxy "touchOnly"

getGestureSingleTouchOnly :: (MonadIO m, IsGestureSingle o) => o -> m Bool

setGestureSingleTouchOnly :: (MonadIO m, IsGestureSingle o) => o -> Bool -> m ()