Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
The GdkEvent struct contains only private fields and should not be accessed directly.
Synopsis
- newtype Event = Event (ManagedPtr Event)
- class (BoxedPtr o, TypedObject o, IsDescendantOf Event o) => IsEvent o
- toEvent :: (MonadIO m, IsEvent o) => o -> m Event
- eventGetAxes :: (HasCallStack, MonadIO m, IsEvent a) => a -> m (Bool, [Double])
- eventGetAxis :: (HasCallStack, MonadIO m, IsEvent a) => a -> AxisUse -> m (Bool, Double)
- eventGetDevice :: (HasCallStack, MonadIO m, IsEvent a) => a -> m (Maybe Device)
- eventGetDeviceTool :: (HasCallStack, MonadIO m, IsEvent a) => a -> m (Maybe DeviceTool)
- eventGetDisplay :: (HasCallStack, MonadIO m, IsEvent a) => a -> m (Maybe Display)
- eventGetEventSequence :: (HasCallStack, MonadIO m, IsEvent a) => a -> m EventSequence
- eventGetEventType :: (HasCallStack, MonadIO m, IsEvent a) => a -> m EventType
- eventGetHistory :: (HasCallStack, MonadIO m, IsEvent a) => a -> m (Maybe [TimeCoord])
- eventGetModifierState :: (HasCallStack, MonadIO m, IsEvent a) => a -> m [ModifierType]
- eventGetPointerEmulated :: (HasCallStack, MonadIO m, IsEvent a) => a -> m Bool
- eventGetPosition :: (HasCallStack, MonadIO m, IsEvent a) => a -> m (Bool, Double, Double)
- eventGetSeat :: (HasCallStack, MonadIO m, IsEvent a) => a -> m (Maybe Seat)
- eventGetSurface :: (HasCallStack, MonadIO m, IsEvent a) => a -> m Surface
- eventGetTime :: (HasCallStack, MonadIO m, IsEvent a) => a -> m Word32
- eventRef :: (HasCallStack, MonadIO m, IsEvent a) => a -> m Event
- eventTriggersContextMenu :: (HasCallStack, MonadIO m, IsEvent a) => a -> m Bool
- eventUnref :: (HasCallStack, MonadIO m, IsEvent a) => a -> m ()
Exported types
Memory-managed wrapper type.
Instances
Eq Event Source # | |
BoxedPtr Event Source # | |
Defined in GI.Gdk.Objects.Event boxedPtrCopy :: Event -> IO Event boxedPtrFree :: Event -> IO () | |
ManagedPtrNewtype Event Source # | |
Defined in GI.Gdk.Objects.Event toManagedPtr :: Event -> ManagedPtr Event | |
TypedObject Event Source # | |
Defined in GI.Gdk.Objects.Event | |
HasParentTypes Event Source # | |
Defined in GI.Gdk.Objects.Event | |
type ParentTypes Event Source # | |
Defined in GI.Gdk.Objects.Event |
class (BoxedPtr o, TypedObject o, IsDescendantOf Event o) => IsEvent o Source #
Instances
(BoxedPtr o, TypedObject o, IsDescendantOf Event o) => IsEvent o Source # | |
Defined in GI.Gdk.Objects.Event |
Methods
Click to display all available methods, including inherited ones
Methods
ref, triggersContextMenu, unref.
Getters
getAxes, getAxis, getDevice, getDeviceTool, getDisplay, getEventSequence, getEventType, getHistory, getModifierState, getPointerEmulated, getPosition, getSeat, getSurface, getTime.
Setters
None.
getAxes
Extracts all axis values from an event.
getAxis
:: (HasCallStack, MonadIO m, IsEvent a) | |
=> a |
|
-> AxisUse |
|
-> m (Bool, Double) | Returns: |
Extract the axis value for a particular axis use from an event structure.
getDevice
Returns the device of an event.
getDeviceTool
:: (HasCallStack, MonadIO m, IsEvent a) | |
=> a |
|
-> m (Maybe DeviceTool) | Returns: The current device tool, or |
If the event was generated by a device that supports
different tools (eg. a tablet), this function will
return a DeviceTool
representing the tool that
caused the event. Otherwise, Nothing
will be returned.
Note: the GdkDeviceTools
will be constant during
the application lifetime, if settings must be stored
persistently across runs, see deviceToolGetSerial
getDisplay
Retrieves the Display
associated to the event
.
getEventSequence
eventGetEventSequence Source #
:: (HasCallStack, MonadIO m, IsEvent a) | |
=> a |
|
-> m EventSequence | Returns: the event sequence that the event belongs to |
If event
is a touch event, returns the EventSequence
to which the event belongs. Otherwise, return Nothing
.
getEventType
Retrieves the type of the event.
getHistory
:: (HasCallStack, MonadIO m, IsEvent a) | |
=> a |
|
-> m (Maybe [TimeCoord]) | Returns: an array of time and coordinates |
Retrieves the history of the event
, as a list of time and coordinates.
The history includes events that are not delivered to the application
because they occurred in the same frame as event
.
Note that only motion and scroll events record history, and motion events only if one of the mouse buttons is down.
getModifierState
eventGetModifierState Source #
:: (HasCallStack, MonadIO m, IsEvent a) | |
=> a |
|
-> m [ModifierType] | Returns: the modifier state of |
Returns the modifier state field of an event.
getPointerEmulated
eventGetPointerEmulated Source #
:: (HasCallStack, MonadIO m, IsEvent a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether this event is an 'emulated' pointer event (typically from a touch event), as opposed to a real one.
getPosition
Extract the event surface relative x/y coordinates from an event.
getSeat
Returns the seat that originated the event.
getSurface
:: (HasCallStack, MonadIO m, IsEvent a) | |
=> a |
|
-> m Surface | Returns: The |
Extracts the Surface
associated with an event.
getTime
:: (HasCallStack, MonadIO m, IsEvent a) | |
=> a |
|
-> m Word32 | Returns: time stamp field from |
Returns the time stamp from event
, if there is one; otherwise
returns CURRENT_TIME
.
ref
:: (HasCallStack, MonadIO m, IsEvent a) | |
=> a |
|
-> m Event | Returns: |
Increase the ref count of event
.
triggersContextMenu
eventTriggersContextMenu Source #
:: (HasCallStack, MonadIO m, IsEvent a) | |
=> a |
|
-> m Bool | Returns: |
This function returns whether a Event
should trigger a
context menu, according to platform conventions. The right
mouse button always triggers context menus.
This function should always be used instead of simply checking for
event->button == BUTTON_SECONDARY
.
unref
:: (HasCallStack, MonadIO m, IsEvent a) | |
=> a |
|
-> m () |
Decrease the ref count of event
, and free it
if the last reference is dropped.