GI.Gtk.Objects.EventController

EventController is a base, low-level implementation for event controllers. Those react to a series of GdkEvents, and possibly trigger actions as a consequence of those.

Exported types

newtype EventController

Constructors

EventController (ManagedPtr EventController)

Instances

GObject EventController

Methods

gobjectType :: EventController -> IO GType

IsObject EventController

IsEventController EventController

((~) * info (ResolveEventControllerMethod t EventController), MethodInfo * info EventController p) => IsLabel t (EventController -> p)

Methods

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

((~) * info (ResolveEventControllerMethod t EventController), MethodInfo * info EventController p) => IsLabelProxy t (EventController -> p)

Methods

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

HasAttributeList * EventController

type AttributeList EventController

type AttributeList EventController

type SignalList EventController

type SignalList EventController

class GObject o => IsEventController o

Instances

(GObject a, UnknownAncestorError Constraint EventController a) => IsEventController a

IsEventController GestureSingle

IsEventController GestureDrag

IsEventController Gesture

IsEventController EventController

IsEventController GestureLongPress

IsEventController GestureMultiPress

IsEventController GestureRotate

IsEventController GestureSwipe

IsEventController GestureZoom

IsEventController GesturePan

IsEventController PadController

toEventController :: IsEventController o => o -> IO EventController

noEventController :: Maybe EventController

Methods

getPropagationPhase

data EventControllerGetPropagationPhaseMethodInfo

Instances

((~) * signature (m PropagationPhase), MonadIO m, IsEventController a) => MethodInfo * EventControllerGetPropagationPhaseMethodInfo a signature

Methods

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

eventControllerGetPropagationPhase

Arguments

:: (HasCallStack, MonadIO m, IsEventController a)

=> a

controller: a EventController

-> m PropagationPhase

Returns: the propagation phase

Gets the propagation phase at which controller handles events.

Since: 3.14

getWidget

data EventControllerGetWidgetMethodInfo

Instances

((~) * signature (m Widget), MonadIO m, IsEventController a) => MethodInfo * EventControllerGetWidgetMethodInfo a signature

Methods

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

eventControllerGetWidget

Arguments

:: (HasCallStack, MonadIO m, IsEventController a)

=> a

controller: a EventController

-> m Widget

Returns: a Widget

Returns the Widget this controller relates to.

Since: 3.14

handleEvent

data EventControllerHandleEventMethodInfo

Instances

((~) * signature (Event -> m Bool), MonadIO m, IsEventController a) => MethodInfo * EventControllerHandleEventMethodInfo a signature

Methods

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

eventControllerHandleEvent

Arguments

:: (HasCallStack, MonadIO m, IsEventController a)

=> a

controller: a EventController

-> Event

event: a Event

-> m Bool

Returns: True if the event was potentially useful to trigger the controller action

Feeds an events into controller, so it can be interpreted and the controller actions triggered.

Since: 3.14

reset

data EventControllerResetMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsEventController a) => MethodInfo * EventControllerResetMethodInfo a signature

Methods

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

eventControllerReset

Arguments

:: (HasCallStack, MonadIO m, IsEventController a)

=> a

controller: a EventController

-> m ()

Resets the controller to a clean state. Every interaction the controller did through EventController::handle-event will be dropped at this point.

Since: 3.14

setPropagationPhase

data EventControllerSetPropagationPhaseMethodInfo

Instances

((~) * signature (PropagationPhase -> m ()), MonadIO m, IsEventController a) => MethodInfo * EventControllerSetPropagationPhaseMethodInfo a signature

Methods

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

eventControllerSetPropagationPhase

Arguments

:: (HasCallStack, MonadIO m, IsEventController a)

=> a

controller: a EventController

-> PropagationPhase

phase: a propagation phase

-> m ()

Sets the propagation phase at which a controller handles events.

If phase is PropagationPhaseNone, no automatic event handling will be performed, but other additional gesture maintenance will. In that phase, the events can be managed by calling eventControllerHandleEvent.

Since: 3.14

Properties

propagationPhase

data EventControllerPropagationPhasePropertyInfo

Instances

AttrInfo EventControllerPropagationPhasePropertyInfo

Associated Types

type AttrAllowedOps EventControllerPropagationPhasePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint EventControllerPropagationPhasePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint EventControllerPropagationPhasePropertyInfo :: * -> Constraint

type AttrGetType EventControllerPropagationPhasePropertyInfo :: *

type AttrLabel EventControllerPropagationPhasePropertyInfo :: Symbol

type AttrOrigin EventControllerPropagationPhasePropertyInfo :: *

Methods

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

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

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

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

type AttrOrigin EventControllerPropagationPhasePropertyInfo

type AttrOrigin EventControllerPropagationPhasePropertyInfo = EventController

type AttrLabel EventControllerPropagationPhasePropertyInfo

type AttrLabel EventControllerPropagationPhasePropertyInfo = "propagation-phase"

type AttrGetType EventControllerPropagationPhasePropertyInfo

type AttrGetType EventControllerPropagationPhasePropertyInfo = PropagationPhase

type AttrBaseTypeConstraint EventControllerPropagationPhasePropertyInfo

type AttrBaseTypeConstraint EventControllerPropagationPhasePropertyInfo = IsEventController

type AttrSetTypeConstraint EventControllerPropagationPhasePropertyInfo

type AttrSetTypeConstraint EventControllerPropagationPhasePropertyInfo = * ~ PropagationPhase

type AttrAllowedOps EventControllerPropagationPhasePropertyInfo

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

constructEventControllerPropagationPhase :: IsEventController o => PropagationPhase -> IO (GValueConstruct o)

eventControllerPropagationPhase :: AttrLabelProxy "propagationPhase"

getEventControllerPropagationPhase :: (MonadIO m, IsEventController o) => o -> m PropagationPhase

setEventControllerPropagationPhase :: (MonadIO m, IsEventController o) => o -> PropagationPhase -> m ()

widget

data EventControllerWidgetPropertyInfo

Instances

AttrInfo EventControllerWidgetPropertyInfo

Associated Types

type AttrAllowedOps EventControllerWidgetPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint EventControllerWidgetPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint EventControllerWidgetPropertyInfo :: * -> Constraint

type AttrGetType EventControllerWidgetPropertyInfo :: *

type AttrLabel EventControllerWidgetPropertyInfo :: Symbol

type AttrOrigin EventControllerWidgetPropertyInfo :: *

Methods

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

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

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

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

type AttrOrigin EventControllerWidgetPropertyInfo

type AttrOrigin EventControllerWidgetPropertyInfo = EventController

type AttrLabel EventControllerWidgetPropertyInfo

type AttrLabel EventControllerWidgetPropertyInfo = "widget"

type AttrGetType EventControllerWidgetPropertyInfo

type AttrGetType EventControllerWidgetPropertyInfo = Widget

type AttrBaseTypeConstraint EventControllerWidgetPropertyInfo

type AttrBaseTypeConstraint EventControllerWidgetPropertyInfo = IsEventController

type AttrSetTypeConstraint EventControllerWidgetPropertyInfo

type AttrSetTypeConstraint EventControllerWidgetPropertyInfo = IsWidget

type AttrAllowedOps EventControllerWidgetPropertyInfo

type AttrAllowedOps EventControllerWidgetPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

constructEventControllerWidget :: (IsEventController o, IsWidget a) => a -> IO (GValueConstruct o)

eventControllerWidget :: AttrLabelProxy "widget"

getEventControllerWidget :: (MonadIO m, IsEventController o) => o -> m Widget