gi-gdk-3.0.23: Gdk bindings

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

GI.Gdk.Structs.EventCrossing

Contents

- Exported types
- Methods
  - Overloaded methods
- Properties
  - detail
  - focus
  - mode
  - sendEvent
  - state
  - subwindow
  - time
  - type
  - window
  - x
  - xRoot
  - y
  - yRoot

Description

Generated when the pointer enters or leaves a window.

Synopsis

- newtype EventCrossing = EventCrossing (ManagedPtr EventCrossing)
- newZeroEventCrossing :: MonadIO m => m EventCrossing
- getEventCrossingDetail :: MonadIO m => EventCrossing -> m NotifyType
- setEventCrossingDetail :: MonadIO m => EventCrossing -> NotifyType -> m ()
- getEventCrossingFocus :: MonadIO m => EventCrossing -> m Bool
- setEventCrossingFocus :: MonadIO m => EventCrossing -> Bool -> m ()
- getEventCrossingMode :: MonadIO m => EventCrossing -> m CrossingMode
- setEventCrossingMode :: MonadIO m => EventCrossing -> CrossingMode -> m ()
- getEventCrossingSendEvent :: MonadIO m => EventCrossing -> m Int8
- setEventCrossingSendEvent :: MonadIO m => EventCrossing -> Int8 -> m ()
- getEventCrossingState :: MonadIO m => EventCrossing -> m [ModifierType]
- setEventCrossingState :: MonadIO m => EventCrossing -> [ModifierType] -> m ()
- clearEventCrossingSubwindow :: MonadIO m => EventCrossing -> m ()
- getEventCrossingSubwindow :: MonadIO m => EventCrossing -> m (Maybe Window)
- setEventCrossingSubwindow :: MonadIO m => EventCrossing -> Ptr Window -> m ()
- getEventCrossingTime :: MonadIO m => EventCrossing -> m Word32
- setEventCrossingTime :: MonadIO m => EventCrossing -> Word32 -> m ()
- getEventCrossingType :: MonadIO m => EventCrossing -> m EventType
- setEventCrossingType :: MonadIO m => EventCrossing -> EventType -> m ()
- clearEventCrossingWindow :: MonadIO m => EventCrossing -> m ()
- getEventCrossingWindow :: MonadIO m => EventCrossing -> m (Maybe Window)
- setEventCrossingWindow :: MonadIO m => EventCrossing -> Ptr Window -> m ()
- getEventCrossingX :: MonadIO m => EventCrossing -> m Double
- setEventCrossingX :: MonadIO m => EventCrossing -> Double -> m ()
- getEventCrossingXRoot :: MonadIO m => EventCrossing -> m Double
- setEventCrossingXRoot :: MonadIO m => EventCrossing -> Double -> m ()
- getEventCrossingY :: MonadIO m => EventCrossing -> m Double
- setEventCrossingY :: MonadIO m => EventCrossing -> Double -> m ()
- getEventCrossingYRoot :: MonadIO m => EventCrossing -> m Double
- setEventCrossingYRoot :: MonadIO m => EventCrossing -> Double -> m ()

# Exported types

newtype EventCrossing Source #

Memory-managed wrapper type.

Constructors

EventCrossing (ManagedPtr EventCrossing) |

#### Instances

Instances details

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

newZeroEventCrossing :: MonadIO m => m EventCrossing Source #

Construct a `EventCrossing` struct initialized to zero.

# Methods

## Overloaded methods

# Properties

## detail

the kind of crossing that happened (`NotifyTypeInferior`, `NotifyTypeAncestor`, `NotifyTypeVirtual`, `NotifyTypeNonlinear` or `NotifyTypeNonlinearVirtual`).

getEventCrossingDetail :: MonadIO m => EventCrossing -> m NotifyType Source #

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

    get eventCrossing #detail

setEventCrossingDetail :: MonadIO m => EventCrossing -> NotifyType -> m () Source #

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

    set eventCrossing [ #detail := value ]

## focus

`True` if `window` is the focus window or an inferior.

getEventCrossingFocus :: MonadIO m => EventCrossing -> m Bool Source #

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

    get eventCrossing #focus

setEventCrossingFocus :: MonadIO m => EventCrossing -> Bool -> m () Source #

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

    set eventCrossing [ #focus := value ]

## mode

the crossing mode (`CrossingModeNormal`, `CrossingModeGrab`, `CrossingModeUngrab`, `CrossingModeGtkGrab`, `CrossingModeGtkUngrab` or `CrossingModeStateChanged`). `CrossingModeGtkGrab`, `CrossingModeGtkUngrab`, and `CrossingModeStateChanged` were added in 2.14 and are always synthesized, never native.

getEventCrossingMode :: MonadIO m => EventCrossing -> m CrossingMode Source #

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

    get eventCrossing #mode

setEventCrossingMode :: MonadIO m => EventCrossing -> CrossingMode -> m () Source #

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

    set eventCrossing [ #mode := value ]

## sendEvent

`True` if the event was sent explicitly.

getEventCrossingSendEvent :: MonadIO m => EventCrossing -> m Int8 Source #

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

    get eventCrossing #sendEvent

setEventCrossingSendEvent :: MonadIO m => EventCrossing -> Int8 -> m () Source #

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

    set eventCrossing [ #sendEvent := value ]

## state

a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt) and the pointer buttons. See `ModifierType`.

getEventCrossingState :: MonadIO m => EventCrossing -> m [ModifierType] Source #

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

    get eventCrossing #state

setEventCrossingState :: MonadIO m => EventCrossing -> [ModifierType] -> m () Source #

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

    set eventCrossing [ #state := value ]

## subwindow

the window that was entered or left.

clearEventCrossingSubwindow :: MonadIO m => EventCrossing -> m () Source #

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

    clear #subwindow

getEventCrossingSubwindow :: MonadIO m => EventCrossing -> m (Maybe Window) Source #

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

    get eventCrossing #subwindow

setEventCrossingSubwindow :: MonadIO m => EventCrossing -> Ptr Window -> m () Source #

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

    set eventCrossing [ #subwindow := value ]

## time

the time of the event in milliseconds.

getEventCrossingTime :: MonadIO m => EventCrossing -> m Word32 Source #

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

    get eventCrossing #time

setEventCrossingTime :: MonadIO m => EventCrossing -> Word32 -> m () Source #

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

    set eventCrossing [ #time := value ]

## type

the type of the event (`EventTypeEnterNotify` or `EventTypeLeaveNotify`).

getEventCrossingType :: MonadIO m => EventCrossing -> m EventType Source #

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

    get eventCrossing #type

setEventCrossingType :: MonadIO m => EventCrossing -> EventType -> m () Source #

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

    set eventCrossing [ #type := value ]

## window

the window which received the event.

clearEventCrossingWindow :: MonadIO m => EventCrossing -> m () Source #

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

    clear #window

getEventCrossingWindow :: MonadIO m => EventCrossing -> m (Maybe Window) Source #

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

    get eventCrossing #window

setEventCrossingWindow :: MonadIO m => EventCrossing -> Ptr Window -> m () Source #

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

    set eventCrossing [ #window := value ]

## x

the x coordinate of the pointer relative to the window.

getEventCrossingX :: MonadIO m => EventCrossing -> m Double Source #

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

    get eventCrossing #x

setEventCrossingX :: MonadIO m => EventCrossing -> Double -> m () Source #

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

    set eventCrossing [ #x := value ]

## xRoot

the x coordinate of the pointer relative to the root of the screen.

getEventCrossingXRoot :: MonadIO m => EventCrossing -> m Double Source #

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

    get eventCrossing #xRoot

setEventCrossingXRoot :: MonadIO m => EventCrossing -> Double -> m () Source #

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

    set eventCrossing [ #xRoot := value ]

## y

the y coordinate of the pointer relative to the window.

getEventCrossingY :: MonadIO m => EventCrossing -> m Double Source #

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

    get eventCrossing #y

setEventCrossingY :: MonadIO m => EventCrossing -> Double -> m () Source #

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

    set eventCrossing [ #y := value ]

## yRoot

the y coordinate of the pointer relative to the root of the screen.

getEventCrossingYRoot :: MonadIO m => EventCrossing -> m Double Source #

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

    get eventCrossing #yRoot

setEventCrossingYRoot :: MonadIO m => EventCrossing -> Double -> m () Source #

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

    set eventCrossing [ #yRoot := value ]