gi-gtk-3.0.37: Gtk bindings
CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Gtk.Objects.EventControllerKey

Description

EventControllerKey is an event controller meant for situations where you need access to key events.

This object was added in 3.24.

Synopsis

Exported types

newtype EventControllerKey Source #

Memory-managed wrapper type.

Constructors

EventControllerKey (ManagedPtr EventControllerKey) 

Instances

Instances details
Eq EventControllerKey Source # 
Instance details

Defined in GI.Gtk.Objects.EventControllerKey

GObject EventControllerKey Source # 
Instance details

Defined in GI.Gtk.Objects.EventControllerKey

ManagedPtrNewtype EventControllerKey Source # 
Instance details

Defined in GI.Gtk.Objects.EventControllerKey

TypedObject EventControllerKey Source # 
Instance details

Defined in GI.Gtk.Objects.EventControllerKey

Methods

glibType :: IO GType

HasParentTypes EventControllerKey Source # 
Instance details

Defined in GI.Gtk.Objects.EventControllerKey

IsGValue (Maybe EventControllerKey) Source #

Convert EventControllerKey to and from GValue. See toGValue and fromGValue.

Instance details

Defined in GI.Gtk.Objects.EventControllerKey

type ParentTypes EventControllerKey Source # 
Instance details

Defined in GI.Gtk.Objects.EventControllerKey

class (GObject o, IsDescendantOf EventControllerKey o) => IsEventControllerKey o Source #

Type class for types which can be safely cast to EventControllerKey, for instance with toEventControllerKey.

Instances

Instances details
(GObject o, IsDescendantOf EventControllerKey o) => IsEventControllerKey o Source # 
Instance details

Defined in GI.Gtk.Objects.EventControllerKey

toEventControllerKey :: (MonadIO m, IsEventControllerKey o) => o -> m EventControllerKey Source #

Cast to EventControllerKey, for types for which this is known to be safe. For general casts, use castTo.

Methods

forward

eventControllerKeyForward :: (HasCallStack, MonadIO m, IsEventControllerKey a, IsWidget b) => a -> b -> m Bool Source #

No description available in the introspection data.

getGroup

eventControllerKeyGetGroup :: (HasCallStack, MonadIO m, IsEventControllerKey a) => a -> m Word32 Source #

No description available in the introspection data.

getImContext

eventControllerKeyGetImContext Source #

Arguments

:: (HasCallStack, MonadIO m, IsEventControllerKey a) 
=> a

controller: a EventControllerKey

-> m IMContext

Returns: the IM context

Gets the IM context of a key controller.

Since: 3.24

new

eventControllerKeyNew :: (HasCallStack, MonadIO m, IsWidget a) => a -> m EventControllerKey Source #

No description available in the introspection data.

setImContext

eventControllerKeySetImContext :: (HasCallStack, MonadIO m, IsEventControllerKey a, IsIMContext b) => a -> b -> m () Source #

No description available in the introspection data.

Signals

focusIn

type C_EventControllerKeyFocusInCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type EventControllerKeyFocusInCallback = IO () Source #

No description available in the introspection data.

afterEventControllerKeyFocusIn :: (IsEventControllerKey a, MonadIO m) => a -> EventControllerKeyFocusInCallback -> m SignalHandlerId Source #

Connect a signal handler for the focusIn signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after eventControllerKey #focusIn callback

onEventControllerKeyFocusIn :: (IsEventControllerKey a, MonadIO m) => a -> EventControllerKeyFocusInCallback -> m SignalHandlerId Source #

Connect a signal handler for the focusIn signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on eventControllerKey #focusIn callback

focusOut

type C_EventControllerKeyFocusOutCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type EventControllerKeyFocusOutCallback = IO () Source #

No description available in the introspection data.

afterEventControllerKeyFocusOut :: (IsEventControllerKey a, MonadIO m) => a -> EventControllerKeyFocusOutCallback -> m SignalHandlerId Source #

Connect a signal handler for the focusOut signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after eventControllerKey #focusOut callback

onEventControllerKeyFocusOut :: (IsEventControllerKey a, MonadIO m) => a -> EventControllerKeyFocusOutCallback -> m SignalHandlerId Source #

Connect a signal handler for the focusOut signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on eventControllerKey #focusOut callback

imUpdate

type C_EventControllerKeyImUpdateCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type EventControllerKeyImUpdateCallback = IO () Source #

No description available in the introspection data.

afterEventControllerKeyImUpdate :: (IsEventControllerKey a, MonadIO m) => a -> EventControllerKeyImUpdateCallback -> m SignalHandlerId Source #

Connect a signal handler for the imUpdate signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after eventControllerKey #imUpdate callback

onEventControllerKeyImUpdate :: (IsEventControllerKey a, MonadIO m) => a -> EventControllerKeyImUpdateCallback -> m SignalHandlerId Source #

Connect a signal handler for the imUpdate signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on eventControllerKey #imUpdate callback

keyPressed

type C_EventControllerKeyKeyPressedCallback = Ptr () -> Word32 -> Word32 -> CUInt -> Ptr () -> IO CInt Source #

Type for the callback on the (unwrapped) C side.

type EventControllerKeyKeyPressedCallback Source #

Arguments

 = Word32

keyval: the pressed key.

-> Word32

keycode: the raw code of the pressed key.

-> [ModifierType]

state: the bitmask, representing the state of modifier keys and pointer buttons. See ModifierType.

-> IO Bool

Returns: True if the key press was handled, False otherwise.

This signal is emitted whenever a key is pressed.

Since: 3.24

afterEventControllerKeyKeyPressed :: (IsEventControllerKey a, MonadIO m) => a -> EventControllerKeyKeyPressedCallback -> m SignalHandlerId Source #

Connect a signal handler for the keyPressed signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after eventControllerKey #keyPressed callback

onEventControllerKeyKeyPressed :: (IsEventControllerKey a, MonadIO m) => a -> EventControllerKeyKeyPressedCallback -> m SignalHandlerId Source #

Connect a signal handler for the keyPressed signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on eventControllerKey #keyPressed callback

keyReleased

type C_EventControllerKeyKeyReleasedCallback = Ptr () -> Word32 -> Word32 -> CUInt -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type EventControllerKeyKeyReleasedCallback Source #

Arguments

 = Word32

keyval: the released key.

-> Word32

keycode: the raw code of the released key.

-> [ModifierType]

state: the bitmask, representing the state of modifier keys and pointer buttons. See ModifierType.

-> IO () 

This signal is emitted whenever a key is released.

Since: 3.24

afterEventControllerKeyKeyReleased :: (IsEventControllerKey a, MonadIO m) => a -> EventControllerKeyKeyReleasedCallback -> m SignalHandlerId Source #

Connect a signal handler for the keyReleased signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after eventControllerKey #keyReleased callback

onEventControllerKeyKeyReleased :: (IsEventControllerKey a, MonadIO m) => a -> EventControllerKeyKeyReleasedCallback -> m SignalHandlerId Source #

Connect a signal handler for the keyReleased signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on eventControllerKey #keyReleased callback

modifiers

type C_EventControllerKeyModifiersCallback = Ptr () -> CUInt -> Ptr () -> IO CInt Source #

Type for the callback on the (unwrapped) C side.

type EventControllerKeyModifiersCallback = [ModifierType] -> IO Bool Source #

No description available in the introspection data.

afterEventControllerKeyModifiers :: (IsEventControllerKey a, MonadIO m) => a -> EventControllerKeyModifiersCallback -> m SignalHandlerId Source #

Connect a signal handler for the modifiers signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after eventControllerKey #modifiers callback

onEventControllerKeyModifiers :: (IsEventControllerKey a, MonadIO m) => a -> EventControllerKeyModifiersCallback -> m SignalHandlerId Source #

Connect a signal handler for the modifiers signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on eventControllerKey #modifiers callback