gi-gdk-3.0.29: Gdk bindings

Copyright | Will Thompson and Iñaki García Etxebarria
License | LGPL-2.1
Maintainer | Iñaki García Etxebarria
Safe Haskell | None
Language | Haskell2010

GI.Gdk.Structs.EventProximity

Contents

- Exported types
- Methods
- Properties
  - device
  - sendEvent
  - time
  - type
  - window

Description

Proximity events are generated when using GDK’s wrapper for the XInput extension. The XInput extension is an add-on for standard X that allows you to use nonstandard devices such as graphics tablets. A proximity event indicates that the stylus has moved in or out of contact with the tablet, or perhaps that the user’s finger has moved in or out of contact with a touch screen.

This event type will be used pretty rarely. It only is important for XInput aware programs that are drawing their own cursor.

Synopsis

- newtype EventProximity = EventProximity (ManagedPtr EventProximity)
- newZeroEventProximity :: MonadIO m => m EventProximity
- clearEventProximityDevice :: MonadIO m => EventProximity -> m ()
- getEventProximityDevice :: MonadIO m => EventProximity -> m (Maybe Device)
- setEventProximityDevice :: MonadIO m => EventProximity -> Ptr Device -> m ()
- getEventProximitySendEvent :: MonadIO m => EventProximity -> m Int8
- setEventProximitySendEvent :: MonadIO m => EventProximity -> Int8 -> m ()
- getEventProximityTime :: MonadIO m => EventProximity -> m Word32
- setEventProximityTime :: MonadIO m => EventProximity -> Word32 -> m ()
- getEventProximityType :: MonadIO m => EventProximity -> m EventType
- setEventProximityType :: MonadIO m => EventProximity -> EventType -> m ()
- clearEventProximityWindow :: MonadIO m => EventProximity -> m ()
- getEventProximityWindow :: MonadIO m => EventProximity -> m (Maybe Window)
- setEventProximityWindow :: MonadIO m => EventProximity -> Ptr Window -> m ()

# Exported types

newtype EventProximity Source #

Memory-managed wrapper type.

Constructors

EventProximity (ManagedPtr EventProximity) |

#### Instances

Instances details

Eq EventProximity Source # |
Instance details Defined in GI.Gdk.Structs.EventProximity Methods (==) :: EventProximity -> EventProximity -> Bool Source # (/=) :: EventProximity -> EventProximity -> Bool Source #
BoxedPtr EventProximity Source # |
Instance details Defined in GI.Gdk.Structs.EventProximity Methods boxedPtrCopy :: EventProximity -> IO EventProximity Source # boxedPtrFree :: EventProximity -> IO () Source #
CallocPtr EventProximity Source # |
Instance details Defined in GI.Gdk.Structs.EventProximity Methods boxedPtrCalloc :: IO (Ptr EventProximity) Source #
ManagedPtrNewtype EventProximity Source # |
Instance details Defined in GI.Gdk.Structs.EventProximity Methods toManagedPtr :: EventProximity -> ManagedPtr EventProximity Source #
tag ~ 'AttrSet => Constructible EventProximity tag Source # |
Instance details Defined in GI.Gdk.Structs.EventProximity Methods new :: MonadIO m => (ManagedPtr EventProximity -> EventProximity) -> [AttrOp EventProximity tag] -> m EventProximity Source #

newZeroEventProximity :: MonadIO m => m EventProximity Source #

Construct a `EventProximity` struct initialized to zero.

# Methods

# Properties

## device

the master device that the event originated from. Use `eventGetSourceDevice` to get the slave device.

clearEventProximityDevice :: MonadIO m => EventProximity -> m () Source #

Set the value of the “`device`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #device

getEventProximityDevice :: MonadIO m => EventProximity -> m (Maybe Device) Source #

Get the value of the “`device`” field. When overloading is enabled, this is equivalent to

    get eventProximity #device

setEventProximityDevice :: MonadIO m => EventProximity -> Ptr Device -> m () Source #

Set the value of the “`device`” field. When overloading is enabled, this is equivalent to

    set eventProximity [ #device := value ]

## sendEvent

`True` if the event was sent explicitly.

getEventProximitySendEvent :: MonadIO m => EventProximity -> m Int8 Source #

Get the value of the “`send_event`” field. When overloading is enabled, this is equivalent to

    get eventProximity #sendEvent

setEventProximitySendEvent :: MonadIO m => EventProximity -> Int8 -> m () Source #

Set the value of the “`send_event`” field. When overloading is enabled, this is equivalent to

    set eventProximity [ #sendEvent := value ]

## time

the time of the event in milliseconds.

getEventProximityTime :: MonadIO m => EventProximity -> m Word32 Source #

Get the value of the “`time`” field. When overloading is enabled, this is equivalent to

    get eventProximity #time

setEventProximityTime :: MonadIO m => EventProximity -> Word32 -> m () Source #

Set the value of the “`time`” field. When overloading is enabled, this is equivalent to

    set eventProximity [ #time := value ]

## type

the type of the event (`EventTypeProximityIn` or `EventTypeProximityOut`).

getEventProximityType :: MonadIO m => EventProximity -> m EventType Source #

Get the value of the “`type`” field. When overloading is enabled, this is equivalent to

    get eventProximity #type

setEventProximityType :: MonadIO m => EventProximity -> EventType -> m () Source #

Set the value of the “`type`” field. When overloading is enabled, this is equivalent to

    set eventProximity [ #type := value ]

## window

the window which received the event.

clearEventProximityWindow :: MonadIO m => EventProximity -> m () Source #

Set the value of the “`window`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #window

getEventProximityWindow :: MonadIO m => EventProximity -> m (Maybe Window) Source #

Get the value of the “`window`” field. When overloading is enabled, this is equivalent to

    get eventProximity #window

setEventProximityWindow :: MonadIO m => EventProximity -> Ptr Window -> m () Source #

Set the value of the “`window`” field. When overloading is enabled, this is equivalent to

    set eventProximity [ #window := value ]