| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Gtk.Objects.EventController
Contents
Description
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.
Synopsis
- newtype EventController = EventController (ManagedPtr EventController)
- class GObject o => IsEventController o
- toEventController :: (MonadIO m, IsEventController o) => o -> m EventController
- noEventController :: Maybe EventController
- eventControllerGetPropagationPhase :: (HasCallStack, MonadIO m, IsEventController a) => a -> m PropagationPhase
- eventControllerGetWidget :: (HasCallStack, MonadIO m, IsEventController a) => a -> m Widget
- eventControllerHandleEvent :: (HasCallStack, MonadIO m, IsEventController a) => a -> Event -> m Bool
- eventControllerReset :: (HasCallStack, MonadIO m, IsEventController a) => a -> m ()
- eventControllerSetPropagationPhase :: (HasCallStack, MonadIO m, IsEventController a) => a -> PropagationPhase -> m ()
- constructEventControllerPropagationPhase :: IsEventController o => PropagationPhase -> IO (GValueConstruct o)
- getEventControllerPropagationPhase :: (MonadIO m, IsEventController o) => o -> m PropagationPhase
- setEventControllerPropagationPhase :: (MonadIO m, IsEventController o) => o -> PropagationPhase -> m ()
- constructEventControllerWidget :: (IsEventController o, IsWidget a) => a -> IO (GValueConstruct o)
- getEventControllerWidget :: (MonadIO m, IsEventController o) => o -> m Widget
Exported types
newtype EventController Source #
Memory-managed wrapper type.
Constructors
| EventController (ManagedPtr EventController) |
Instances
| GObject EventController Source # | |
Defined in GI.Gtk.Objects.EventController Methods gobjectType :: EventController -> IO GType # | |
| IsObject EventController Source # | |
Defined in GI.Gtk.Objects.EventController | |
| IsEventController EventController Source # | |
Defined in GI.Gtk.Objects.EventController | |
class GObject o => IsEventController o Source #
Type class for types which can be safely cast to EventController, for instance with toEventController.
Instances
toEventController :: (MonadIO m, IsEventController o) => o -> m EventController Source #
Cast to EventController, for types for which this is known to be safe. For general casts, use castTo.
noEventController :: Maybe EventController Source #
A convenience alias for Nothing :: Maybe EventController.
Methods
getPropagationPhase
eventControllerGetPropagationPhase Source #
Arguments
| :: (HasCallStack, MonadIO m, IsEventController a) | |
| => a |
|
| -> m PropagationPhase | Returns: the propagation phase |
Gets the propagation phase at which controller handles events.
Since: 3.14
getWidget
eventControllerGetWidget Source #
Arguments
| :: (HasCallStack, MonadIO m, IsEventController a) | |
| => a |
|
| -> m Widget | Returns: a |
Returns the Widget this controller relates to.
Since: 3.14
handleEvent
eventControllerHandleEvent Source #
Arguments
| :: (HasCallStack, MonadIO m, IsEventController a) | |
| => a |
|
| -> Event |
|
| -> m Bool | Returns: |
Feeds an events into controller, so it can be interpreted
and the controller actions triggered.
Since: 3.14
reset
Arguments
| :: (HasCallStack, MonadIO m, IsEventController a) | |
| => a |
|
| -> 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
eventControllerSetPropagationPhase Source #
Arguments
| :: (HasCallStack, MonadIO m, IsEventController a) | |
| => a |
|
| -> PropagationPhase |
|
| -> 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
The propagation phase at which this controller will handle events.
Since: 3.14
constructEventControllerPropagationPhase :: IsEventController o => PropagationPhase -> IO (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “propagation-phase” property. This is rarely needed directly, but it is used by new.
getEventControllerPropagationPhase :: (MonadIO m, IsEventController o) => o -> m PropagationPhase Source #
Get the value of the “propagation-phase” property.
When overloading is enabled, this is equivalent to
get eventController #propagationPhase
setEventControllerPropagationPhase :: (MonadIO m, IsEventController o) => o -> PropagationPhase -> m () Source #
Set the value of the “propagation-phase” property.
When overloading is enabled, this is equivalent to
seteventController [ #propagationPhase:=value ]
widget
The widget receiving the GdkEvents that the controller will handle.
Since: 3.14
constructEventControllerWidget :: (IsEventController o, IsWidget a) => a -> IO (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “widget” property. This is rarely needed directly, but it is used by new.
getEventControllerWidget :: (MonadIO m, IsEventController o) => o -> m Widget Source #
Get the value of the “widget” property.
When overloading is enabled, this is equivalent to
get eventController #widget