gi-gdk-3.0.16: Gdk bindings

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.Gdk.Structs.EventProperty

Contents

- Exported types
- Properties
  - atom
  - sendEvent
  - state
  - time
  - type
  - window

Description

Describes a property change on a window.

Synopsis

- newtype EventProperty = EventProperty (ManagedPtr EventProperty)
- newZeroEventProperty :: MonadIO m => m EventProperty
- noEventProperty :: Maybe EventProperty
- getEventPropertyAtom :: MonadIO m => EventProperty -> m Atom
- getEventPropertySendEvent :: MonadIO m => EventProperty -> m Int8
- setEventPropertySendEvent :: MonadIO m => EventProperty -> Int8 -> m ()
- getEventPropertyState :: MonadIO m => EventProperty -> m PropertyState
- setEventPropertyState :: MonadIO m => EventProperty -> PropertyState -> m ()
- getEventPropertyTime :: MonadIO m => EventProperty -> m Word32
- setEventPropertyTime :: MonadIO m => EventProperty -> Word32 -> m ()
- getEventPropertyType :: MonadIO m => EventProperty -> m EventType
- setEventPropertyType :: MonadIO m => EventProperty -> EventType -> m ()
- clearEventPropertyWindow :: MonadIO m => EventProperty -> m ()
- getEventPropertyWindow :: MonadIO m => EventProperty -> m (Maybe Window)
- setEventPropertyWindow :: MonadIO m => EventProperty -> Ptr Window -> m ()

# Exported types

newtype EventProperty Source #

Memory-managed wrapper type.

Constructors

EventProperty (ManagedPtr EventProperty) |

Instances

WrappedPtr EventProperty Source # |
Instance details Defined in GI.Gdk.Structs.EventProperty Methods wrappedPtrCalloc :: IO (Ptr EventProperty) Source # wrappedPtrCopy :: EventProperty -> IO EventProperty Source # wrappedPtrFree :: Maybe (FunPtr (Ptr EventProperty -> IO ())) Source #
tag ~ AttrSet => Constructible EventProperty tag Source # |
Instance details Defined in GI.Gdk.Structs.EventProperty Methods new :: MonadIO m => (ManagedPtr EventProperty -> EventProperty) -> [AttrOp EventProperty tag] -> m EventProperty Source #

newZeroEventProperty :: MonadIO m => m EventProperty Source #

Construct a `EventProperty` struct initialized to zero.

noEventProperty :: Maybe EventProperty Source #

A convenience alias for `Nothing` :: `Maybe` `EventProperty`.

# Properties

## atom

the property that was changed.

getEventPropertyAtom :: MonadIO m => EventProperty -> m Atom Source #

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

    get eventProperty #atom

## sendEvent

`True` if the event was sent explicitly.

getEventPropertySendEvent :: MonadIO m => EventProperty -> m Int8 Source #

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

    get eventProperty #sendEvent

setEventPropertySendEvent :: MonadIO m => EventProperty -> Int8 -> m () Source #

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

    set eventProperty [ #sendEvent := value ]

## state

whether the property was changed (`PropertyStateNewValue`) or deleted (`PropertyStateDelete`).

getEventPropertyState :: MonadIO m => EventProperty -> m PropertyState Source #

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

    get eventProperty #state

setEventPropertyState :: MonadIO m => EventProperty -> PropertyState -> m () Source #

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

    set eventProperty [ #state := value ]

## time

the time of the event in milliseconds.

getEventPropertyTime :: MonadIO m => EventProperty -> m Word32 Source #

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

    get eventProperty #time

setEventPropertyTime :: MonadIO m => EventProperty -> Word32 -> m () Source #

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

    set eventProperty [ #time := value ]

## type

the type of the event (`EventTypePropertyNotify`).

getEventPropertyType :: MonadIO m => EventProperty -> m EventType Source #

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

    get eventProperty #type

setEventPropertyType :: MonadIO m => EventProperty -> EventType -> m () Source #

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

    set eventProperty [ #type := value ]

## window

the window which received the event.

clearEventPropertyWindow :: MonadIO m => EventProperty -> m () Source #

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

    clear #window

getEventPropertyWindow :: MonadIO m => EventProperty -> m (Maybe Window) Source #

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

    get eventProperty #window

setEventPropertyWindow :: MonadIO m => EventProperty -> Ptr Window -> m () Source #

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

    set eventProperty [ #window := value ]