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

GI.Gdk.Structs.EventScroll

Contents

Exported types
Methods
Properties
- deltaX
- deltaY
- device
- direction
- isStop
- sendEvent
- state
- time
- type
- window
- x
- xRoot
- y
- yRoot

Description

Generated from button presses for the buttons 4 to 7. Wheel mice are usually configured to generate button press events for buttons 4 and 5 when the wheel is turned.

Some GDK backends can also generate “smooth” scroll events, which can be recognized by the ScrollDirectionSmooth scroll direction. For these, the scroll deltas can be obtained with eventGetScrollDeltas.

Synopsis

newtype EventScroll = EventScroll (ManagedPtr EventScroll)
newZeroEventScroll :: MonadIO m => m EventScroll
getEventScrollDeltaX :: MonadIO m => EventScroll -> m Double
setEventScrollDeltaX :: MonadIO m => EventScroll -> Double -> m ()
getEventScrollDeltaY :: MonadIO m => EventScroll -> m Double
setEventScrollDeltaY :: MonadIO m => EventScroll -> Double -> m ()
clearEventScrollDevice :: MonadIO m => EventScroll -> m ()
getEventScrollDevice :: MonadIO m => EventScroll -> m (Maybe Device)
setEventScrollDevice :: MonadIO m => EventScroll -> Ptr Device -> m ()
getEventScrollDirection :: MonadIO m => EventScroll -> m ScrollDirection
setEventScrollDirection :: MonadIO m => EventScroll -> ScrollDirection -> m ()
getEventScrollIsStop :: MonadIO m => EventScroll -> m Word32
setEventScrollIsStop :: MonadIO m => EventScroll -> Word32 -> m ()
getEventScrollSendEvent :: MonadIO m => EventScroll -> m Int8
setEventScrollSendEvent :: MonadIO m => EventScroll -> Int8 -> m ()
getEventScrollState :: MonadIO m => EventScroll -> m [ModifierType]
setEventScrollState :: MonadIO m => EventScroll -> [ModifierType] -> m ()
getEventScrollTime :: MonadIO m => EventScroll -> m Word32
setEventScrollTime :: MonadIO m => EventScroll -> Word32 -> m ()
getEventScrollType :: MonadIO m => EventScroll -> m EventType
setEventScrollType :: MonadIO m => EventScroll -> EventType -> m ()
clearEventScrollWindow :: MonadIO m => EventScroll -> m ()
getEventScrollWindow :: MonadIO m => EventScroll -> m (Maybe Window)
setEventScrollWindow :: MonadIO m => EventScroll -> Ptr Window -> m ()
getEventScrollX :: MonadIO m => EventScroll -> m Double
setEventScrollX :: MonadIO m => EventScroll -> Double -> m ()
getEventScrollXRoot :: MonadIO m => EventScroll -> m Double
setEventScrollXRoot :: MonadIO m => EventScroll -> Double -> m ()
getEventScrollY :: MonadIO m => EventScroll -> m Double
setEventScrollY :: MonadIO m => EventScroll -> Double -> m ()
getEventScrollYRoot :: MonadIO m => EventScroll -> m Double
setEventScrollYRoot :: MonadIO m => EventScroll -> Double -> m ()

Exported types

newtype EventScroll Source #

Memory-managed wrapper type.

Constructors

EventScroll (ManagedPtr EventScroll)

Instances

Instances details

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

newZeroEventScroll :: MonadIO m => m EventScroll Source #

Construct a EventScroll struct initialized to zero.

Methods

Properties

deltaX

the x coordinate of the scroll delta

getEventScrollDeltaX :: MonadIO m => EventScroll -> m Double Source #

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

get eventScroll #deltaX

setEventScrollDeltaX :: MonadIO m => EventScroll -> Double -> m () Source #

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

set eventScroll [ #deltaX := value ]

deltaY

the y coordinate of the scroll delta

getEventScrollDeltaY :: MonadIO m => EventScroll -> m Double Source #

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

get eventScroll #deltaY

setEventScrollDeltaY :: MonadIO m => EventScroll -> Double -> m () Source #

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

set eventScroll [ #deltaY := value ]

device

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

clearEventScrollDevice :: MonadIO m => EventScroll -> m () Source #

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

clear #device

getEventScrollDevice :: MonadIO m => EventScroll -> m (Maybe Device) Source #

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

get eventScroll #device

setEventScrollDevice :: MonadIO m => EventScroll -> Ptr Device -> m () Source #

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

set eventScroll [ #device := value ]

direction

the direction to scroll to (one of ScrollDirectionUp, ScrollDirectionDown, ScrollDirectionLeft, ScrollDirectionRight or ScrollDirectionSmooth).

getEventScrollDirection :: MonadIO m => EventScroll -> m ScrollDirection Source #

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

get eventScroll #direction

setEventScrollDirection :: MonadIO m => EventScroll -> ScrollDirection -> m () Source #

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

set eventScroll [ #direction := value ]

isStop

No description available in the introspection data.

getEventScrollIsStop :: MonadIO m => EventScroll -> m Word32 Source #

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

get eventScroll #isStop

setEventScrollIsStop :: MonadIO m => EventScroll -> Word32 -> m () Source #

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

set eventScroll [ #isStop := value ]

sendEvent

True if the event was sent explicitly.

getEventScrollSendEvent :: MonadIO m => EventScroll -> m Int8 Source #

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

get eventScroll #sendEvent

setEventScrollSendEvent :: MonadIO m => EventScroll -> Int8 -> m () Source #

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

set eventScroll [ #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.

getEventScrollState :: MonadIO m => EventScroll -> m [ModifierType] Source #

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

get eventScroll #state

setEventScrollState :: MonadIO m => EventScroll -> [ModifierType] -> m () Source #

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

set eventScroll [ #state := value ]

time

the time of the event in milliseconds.

getEventScrollTime :: MonadIO m => EventScroll -> m Word32 Source #

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

get eventScroll #time

setEventScrollTime :: MonadIO m => EventScroll -> Word32 -> m () Source #

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

set eventScroll [ #time := value ]

type

the type of the event (EventTypeScroll).

getEventScrollType :: MonadIO m => EventScroll -> m EventType Source #

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

get eventScroll #type

setEventScrollType :: MonadIO m => EventScroll -> EventType -> m () Source #

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

set eventScroll [ #type := value ]

window

the window which received the event.

clearEventScrollWindow :: MonadIO m => EventScroll -> m () Source #

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

clear #window

getEventScrollWindow :: MonadIO m => EventScroll -> m (Maybe Window) Source #

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

get eventScroll #window

setEventScrollWindow :: MonadIO m => EventScroll -> Ptr Window -> m () Source #

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

set eventScroll [ #window := value ]

x

the x coordinate of the pointer relative to the window.

getEventScrollX :: MonadIO m => EventScroll -> m Double Source #

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

get eventScroll #x

setEventScrollX :: MonadIO m => EventScroll -> Double -> m () Source #

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

set eventScroll [ #x := value ]

xRoot

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

getEventScrollXRoot :: MonadIO m => EventScroll -> m Double Source #

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

get eventScroll #xRoot

setEventScrollXRoot :: MonadIO m => EventScroll -> Double -> m () Source #

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

set eventScroll [ #xRoot := value ]

y

the y coordinate of the pointer relative to the window.

getEventScrollY :: MonadIO m => EventScroll -> m Double Source #

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

get eventScroll #y

setEventScrollY :: MonadIO m => EventScroll -> Double -> m () Source #

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

set eventScroll [ #y := value ]

yRoot

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

getEventScrollYRoot :: MonadIO m => EventScroll -> m Double Source #

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

get eventScroll #yRoot

setEventScrollYRoot :: MonadIO m => EventScroll -> Double -> m () Source #

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

set eventScroll [ #yRoot := value ]