GI.Clutter.Structs.KeyEvent

Key event

Since: 0.2

Exported types

newtype KeyEvent

Memory-managed wrapper type.

Constructors

KeyEvent (ManagedPtr KeyEvent)

Instances

Eq KeyEvent

Defined in GI.Clutter.Structs.KeyEvent

Methods

(==) :: KeyEvent -> KeyEvent -> Bool

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

BoxedPtr KeyEvent

Defined in GI.Clutter.Structs.KeyEvent

Methods

boxedPtrCopy :: KeyEvent -> IO KeyEvent

boxedPtrFree :: KeyEvent -> IO ()

CallocPtr KeyEvent

Defined in GI.Clutter.Structs.KeyEvent

Methods

boxedPtrCalloc :: IO (Ptr KeyEvent)

ManagedPtrNewtype KeyEvent

Defined in GI.Clutter.Structs.KeyEvent

Methods

toManagedPtr :: KeyEvent -> ManagedPtr KeyEvent

tag ~ 'AttrSet => Constructible KeyEvent tag

Defined in GI.Clutter.Structs.KeyEvent

Methods

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

newZeroKeyEvent :: MonadIO m => m KeyEvent

Construct a KeyEvent struct initialized to zero.

Methods

Properties

device

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

clearKeyEventDevice :: MonadIO m => KeyEvent -> m ()

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

clear #device

getKeyEventDevice :: MonadIO m => KeyEvent -> m (Maybe InputDevice)

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

get keyEvent #device

setKeyEventDevice :: MonadIO m => KeyEvent -> Ptr InputDevice -> m ()

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

set keyEvent [ #device := value ]

flags

event flags

getKeyEventFlags :: MonadIO m => KeyEvent -> m [EventFlags]

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

get keyEvent #flags

setKeyEventFlags :: MonadIO m => KeyEvent -> [EventFlags] -> m ()

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

set keyEvent [ #flags := value ]

hardwareKeycode

raw hardware key value

getKeyEventHardwareKeycode :: MonadIO m => KeyEvent -> m Word16

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

get keyEvent #hardwareKeycode

setKeyEventHardwareKeycode :: MonadIO m => KeyEvent -> Word16 -> m ()

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

set keyEvent [ #hardwareKeycode := value ]

keyval

raw key value

getKeyEventKeyval :: MonadIO m => KeyEvent -> m Word32

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

get keyEvent #keyval

setKeyEventKeyval :: MonadIO m => KeyEvent -> Word32 -> m ()

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

set keyEvent [ #keyval := value ]

modifierState

key modifiers

getKeyEventModifierState :: MonadIO m => KeyEvent -> m [ModifierType]

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

get keyEvent #modifierState

setKeyEventModifierState :: MonadIO m => KeyEvent -> [ModifierType] -> m ()

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

set keyEvent [ #modifierState := value ]

source

event source actor

clearKeyEventSource :: MonadIO m => KeyEvent -> m ()

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

clear #source

getKeyEventSource :: MonadIO m => KeyEvent -> m (Maybe Actor)

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

get keyEvent #source

setKeyEventSource :: MonadIO m => KeyEvent -> Ptr Actor -> m ()

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

set keyEvent [ #source := value ]

stage

event source stage

clearKeyEventStage :: MonadIO m => KeyEvent -> m ()

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

clear #stage

getKeyEventStage :: MonadIO m => KeyEvent -> m (Maybe Stage)

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

get keyEvent #stage

setKeyEventStage :: MonadIO m => KeyEvent -> Ptr Stage -> m ()

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

set keyEvent [ #stage := value ]

time

event time

getKeyEventTime :: MonadIO m => KeyEvent -> m Word32

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

get keyEvent #time

setKeyEventTime :: MonadIO m => KeyEvent -> Word32 -> m ()

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

set keyEvent [ #time := value ]

type

event type

getKeyEventType :: MonadIO m => KeyEvent -> m EventType

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

get keyEvent #type

setKeyEventType :: MonadIO m => KeyEvent -> EventType -> m ()

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

set keyEvent [ #type := value ]

unicodeValue

Unicode representation

getKeyEventUnicodeValue :: MonadIO m => KeyEvent -> m Char

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

get keyEvent #unicodeValue

setKeyEventUnicodeValue :: MonadIO m => KeyEvent -> Char -> m ()

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

set keyEvent [ #unicodeValue := value ]