GI.Clutter.Structs.ScrollEvent

Scroll wheel (or similar device) event

Since: 0.2

Exported types

newtype ScrollEvent

Memory-managed wrapper type.

Constructors

ScrollEvent (ManagedPtr ScrollEvent)

Instances

Eq ScrollEvent

Defined in GI.Clutter.Structs.ScrollEvent

Methods

(==) :: ScrollEvent -> ScrollEvent -> Bool

(/=) :: ScrollEvent -> ScrollEvent -> Bool

BoxedPtr ScrollEvent

Defined in GI.Clutter.Structs.ScrollEvent

Methods

boxedPtrCopy :: ScrollEvent -> IO ScrollEvent

boxedPtrFree :: ScrollEvent -> IO ()

CallocPtr ScrollEvent

Defined in GI.Clutter.Structs.ScrollEvent

Methods

boxedPtrCalloc :: IO (Ptr ScrollEvent)

ManagedPtrNewtype ScrollEvent

Defined in GI.Clutter.Structs.ScrollEvent

Methods

toManagedPtr :: ScrollEvent -> ManagedPtr ScrollEvent

tag ~ 'AttrSet => Constructible ScrollEvent tag

Defined in GI.Clutter.Structs.ScrollEvent

Methods

new :: MonadIO m => (ManagedPtr ScrollEvent -> ScrollEvent) -> [AttrOp ScrollEvent tag] -> m ScrollEvent

newZeroScrollEvent :: MonadIO m => m ScrollEvent

Construct a ScrollEvent struct initialized to zero.

Methods

Properties

axes

reserved for future use

getScrollEventAxes :: MonadIO m => ScrollEvent -> m Double

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

get scrollEvent #axes

setScrollEventAxes :: MonadIO m => ScrollEvent -> Double -> m ()

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

set scrollEvent [ #axes := value ]

device

the device that originated the event. If you want the physical device the event originated from, use eventGetSourceDevice

clearScrollEventDevice :: MonadIO m => ScrollEvent -> m ()

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

clear #device

getScrollEventDevice :: MonadIO m => ScrollEvent -> m (Maybe InputDevice)

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

get scrollEvent #device

setScrollEventDevice :: MonadIO m => ScrollEvent -> Ptr InputDevice -> m ()

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

set scrollEvent [ #device := value ]

direction

direction of the scrolling

getScrollEventDirection :: MonadIO m => ScrollEvent -> m ScrollDirection

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

get scrollEvent #direction

setScrollEventDirection :: MonadIO m => ScrollEvent -> ScrollDirection -> m ()

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

set scrollEvent [ #direction := value ]

finishFlags

the axes that were stopped in this event. This field is available since 1.26

getScrollEventFinishFlags :: MonadIO m => ScrollEvent -> m [ScrollFinishFlags]

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

get scrollEvent #finishFlags

setScrollEventFinishFlags :: MonadIO m => ScrollEvent -> [ScrollFinishFlags] -> m ()

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

set scrollEvent [ #finishFlags := value ]

flags

event flags

getScrollEventFlags :: MonadIO m => ScrollEvent -> m [EventFlags]

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

get scrollEvent #flags

setScrollEventFlags :: MonadIO m => ScrollEvent -> [EventFlags] -> m ()

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

set scrollEvent [ #flags := value ]

modifierState

button modifiers

getScrollEventModifierState :: MonadIO m => ScrollEvent -> m [ModifierType]

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

get scrollEvent #modifierState

setScrollEventModifierState :: MonadIO m => ScrollEvent -> [ModifierType] -> m ()

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

set scrollEvent [ #modifierState := value ]

scrollSource

the source of scroll events. This field is available since 1.26

getScrollEventScrollSource :: MonadIO m => ScrollEvent -> m ScrollSource

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

get scrollEvent #scrollSource

setScrollEventScrollSource :: MonadIO m => ScrollEvent -> ScrollSource -> m ()

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

set scrollEvent [ #scrollSource := value ]

source

event source actor

clearScrollEventSource :: MonadIO m => ScrollEvent -> m ()

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

clear #source

getScrollEventSource :: MonadIO m => ScrollEvent -> m (Maybe Actor)

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

get scrollEvent #source

setScrollEventSource :: MonadIO m => ScrollEvent -> Ptr Actor -> m ()

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

set scrollEvent [ #source := value ]

stage

event source stage

clearScrollEventStage :: MonadIO m => ScrollEvent -> m ()

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

clear #stage

getScrollEventStage :: MonadIO m => ScrollEvent -> m (Maybe Stage)

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

get scrollEvent #stage

setScrollEventStage :: MonadIO m => ScrollEvent -> Ptr Stage -> m ()

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

set scrollEvent [ #stage := value ]

time

event time

getScrollEventTime :: MonadIO m => ScrollEvent -> m Word32

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

get scrollEvent #time

setScrollEventTime :: MonadIO m => ScrollEvent -> Word32 -> m ()

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

set scrollEvent [ #time := value ]

type

event type

getScrollEventType :: MonadIO m => ScrollEvent -> m EventType

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

get scrollEvent #type

setScrollEventType :: MonadIO m => ScrollEvent -> EventType -> m ()

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

set scrollEvent [ #type := value ]

x

event X coordinate

getScrollEventX :: MonadIO m => ScrollEvent -> m Float

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

get scrollEvent #x

setScrollEventX :: MonadIO m => ScrollEvent -> Float -> m ()

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

set scrollEvent [ #x := value ]

y

event Y coordinate

getScrollEventY :: MonadIO m => ScrollEvent -> m Float

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

get scrollEvent #y

setScrollEventY :: MonadIO m => ScrollEvent -> Float -> m ()

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

set scrollEvent [ #y := value ]