| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Gtk.Objects.EventControllerKey
Description
EventControllerKey is an event controller meant for situations
where you need access to key events.
Synopsis
- newtype EventControllerKey = EventControllerKey (ManagedPtr EventControllerKey)
- class (GObject o, IsDescendantOf EventControllerKey o) => IsEventControllerKey o
- toEventControllerKey :: (MonadIO m, IsEventControllerKey o) => o -> m EventControllerKey
- eventControllerKeyForward :: (HasCallStack, MonadIO m, IsEventControllerKey a, IsWidget b) => a -> b -> m Bool
- eventControllerKeyGetGroup :: (HasCallStack, MonadIO m, IsEventControllerKey a) => a -> m Word32
- eventControllerKeyGetImContext :: (HasCallStack, MonadIO m, IsEventControllerKey a) => a -> m IMContext
- eventControllerKeyNew :: (HasCallStack, MonadIO m) => m EventControllerKey
- eventControllerKeySetImContext :: (HasCallStack, MonadIO m, IsEventControllerKey a, IsIMContext b) => a -> b -> m ()
- type C_EventControllerKeyImUpdateCallback = Ptr () -> Ptr () -> IO ()
- type EventControllerKeyImUpdateCallback = IO ()
- afterEventControllerKeyImUpdate :: (IsEventControllerKey a, MonadIO m) => a -> EventControllerKeyImUpdateCallback -> m SignalHandlerId
- genClosure_EventControllerKeyImUpdate :: MonadIO m => EventControllerKeyImUpdateCallback -> m (GClosure C_EventControllerKeyImUpdateCallback)
- mk_EventControllerKeyImUpdateCallback :: C_EventControllerKeyImUpdateCallback -> IO (FunPtr C_EventControllerKeyImUpdateCallback)
- noEventControllerKeyImUpdateCallback :: Maybe EventControllerKeyImUpdateCallback
- onEventControllerKeyImUpdate :: (IsEventControllerKey a, MonadIO m) => a -> EventControllerKeyImUpdateCallback -> m SignalHandlerId
- wrap_EventControllerKeyImUpdateCallback :: EventControllerKeyImUpdateCallback -> C_EventControllerKeyImUpdateCallback
- type C_EventControllerKeyKeyPressedCallback = Ptr () -> Word32 -> Word32 -> CUInt -> Ptr () -> IO CInt
- type EventControllerKeyKeyPressedCallback = Word32 -> Word32 -> [ModifierType] -> IO Bool
- afterEventControllerKeyKeyPressed :: (IsEventControllerKey a, MonadIO m) => a -> EventControllerKeyKeyPressedCallback -> m SignalHandlerId
- genClosure_EventControllerKeyKeyPressed :: MonadIO m => EventControllerKeyKeyPressedCallback -> m (GClosure C_EventControllerKeyKeyPressedCallback)
- mk_EventControllerKeyKeyPressedCallback :: C_EventControllerKeyKeyPressedCallback -> IO (FunPtr C_EventControllerKeyKeyPressedCallback)
- noEventControllerKeyKeyPressedCallback :: Maybe EventControllerKeyKeyPressedCallback
- onEventControllerKeyKeyPressed :: (IsEventControllerKey a, MonadIO m) => a -> EventControllerKeyKeyPressedCallback -> m SignalHandlerId
- wrap_EventControllerKeyKeyPressedCallback :: EventControllerKeyKeyPressedCallback -> C_EventControllerKeyKeyPressedCallback
- type C_EventControllerKeyKeyReleasedCallback = Ptr () -> Word32 -> Word32 -> CUInt -> Ptr () -> IO ()
- type EventControllerKeyKeyReleasedCallback = Word32 -> Word32 -> [ModifierType] -> IO ()
- afterEventControllerKeyKeyReleased :: (IsEventControllerKey a, MonadIO m) => a -> EventControllerKeyKeyReleasedCallback -> m SignalHandlerId
- genClosure_EventControllerKeyKeyReleased :: MonadIO m => EventControllerKeyKeyReleasedCallback -> m (GClosure C_EventControllerKeyKeyReleasedCallback)
- mk_EventControllerKeyKeyReleasedCallback :: C_EventControllerKeyKeyReleasedCallback -> IO (FunPtr C_EventControllerKeyKeyReleasedCallback)
- noEventControllerKeyKeyReleasedCallback :: Maybe EventControllerKeyKeyReleasedCallback
- onEventControllerKeyKeyReleased :: (IsEventControllerKey a, MonadIO m) => a -> EventControllerKeyKeyReleasedCallback -> m SignalHandlerId
- wrap_EventControllerKeyKeyReleasedCallback :: EventControllerKeyKeyReleasedCallback -> C_EventControllerKeyKeyReleasedCallback
- type C_EventControllerKeyModifiersCallback = Ptr () -> CUInt -> Ptr () -> IO CInt
- type EventControllerKeyModifiersCallback = [ModifierType] -> IO Bool
- afterEventControllerKeyModifiers :: (IsEventControllerKey a, MonadIO m) => a -> EventControllerKeyModifiersCallback -> m SignalHandlerId
- genClosure_EventControllerKeyModifiers :: MonadIO m => EventControllerKeyModifiersCallback -> m (GClosure C_EventControllerKeyModifiersCallback)
- mk_EventControllerKeyModifiersCallback :: C_EventControllerKeyModifiersCallback -> IO (FunPtr C_EventControllerKeyModifiersCallback)
- noEventControllerKeyModifiersCallback :: Maybe EventControllerKeyModifiersCallback
- onEventControllerKeyModifiers :: (IsEventControllerKey a, MonadIO m) => a -> EventControllerKeyModifiersCallback -> m SignalHandlerId
- wrap_EventControllerKeyModifiersCallback :: EventControllerKeyModifiersCallback -> C_EventControllerKeyModifiersCallback
Exported types
newtype EventControllerKey Source #
Memory-managed wrapper type.
Constructors
| EventControllerKey (ManagedPtr EventControllerKey) |
Instances
| Eq EventControllerKey Source # | |
Defined in GI.Gtk.Objects.EventControllerKey Methods (==) :: EventControllerKey -> EventControllerKey -> Bool (/=) :: EventControllerKey -> EventControllerKey -> Bool | |
| GObject EventControllerKey Source # | |
Defined in GI.Gtk.Objects.EventControllerKey | |
| ManagedPtrNewtype EventControllerKey Source # | |
Defined in GI.Gtk.Objects.EventControllerKey Methods toManagedPtr :: EventControllerKey -> ManagedPtr EventControllerKey | |
| TypedObject EventControllerKey Source # | |
Defined in GI.Gtk.Objects.EventControllerKey Methods glibType :: IO GType | |
| IsGValue EventControllerKey Source # | Convert |
Defined in GI.Gtk.Objects.EventControllerKey | |
| HasParentTypes EventControllerKey Source # | |
Defined in GI.Gtk.Objects.EventControllerKey | |
| type ParentTypes EventControllerKey Source # | |
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
| (GObject o, IsDescendantOf EventControllerKey o) => IsEventControllerKey o Source # | |
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
Overloaded methods
forward
eventControllerKeyForward Source #
Arguments
| :: (HasCallStack, MonadIO m, IsEventControllerKey a, IsWidget b) | |
| => a |
|
| -> b |
|
| -> m Bool | Returns: whether the |
Forwards the current event of this controller to a widget.
This function can only be used in handlers for the keyPressed, keyReleased or modifiers signals.
getGroup
eventControllerKeyGetGroup Source #
Arguments
| :: (HasCallStack, MonadIO m, IsEventControllerKey a) | |
| => a |
|
| -> m Word32 | Returns: the key group |
Gets the key group of the current event of this controller.
See gdk_key_event_get_group().
getImContext
eventControllerKeyGetImContext Source #
Arguments
| :: (HasCallStack, MonadIO m, IsEventControllerKey a) | |
| => a |
|
| -> m IMContext | Returns: the |
Gets the input method context of the key controller.
new
eventControllerKeyNew Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => m EventControllerKey | Returns: a new |
Creates a new event controller that will handle key events.
setImContext
eventControllerKeySetImContext Source #
Arguments
| :: (HasCallStack, MonadIO m, IsEventControllerKey a, IsIMContext b) | |
| => a |
|
| -> b |
|
| -> m () |
Sets the input method context of the key controller.
Signals
imUpdate
type C_EventControllerKeyImUpdateCallback = Ptr () -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type EventControllerKeyImUpdateCallback = IO () Source #
This signal is emitted whenever the input method context filters away a
keypress and prevents the controller receiving it. See
eventControllerKeySetImContext and
iMContextFilterKeypress.
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
genClosure_EventControllerKeyImUpdate :: MonadIO m => EventControllerKeyImUpdateCallback -> m (GClosure C_EventControllerKeyImUpdateCallback) Source #
Wrap the callback into a GClosure.
mk_EventControllerKeyImUpdateCallback :: C_EventControllerKeyImUpdateCallback -> IO (FunPtr C_EventControllerKeyImUpdateCallback) Source #
Generate a function pointer callable from C code, from a C_EventControllerKeyImUpdateCallback.
noEventControllerKeyImUpdateCallback :: Maybe EventControllerKeyImUpdateCallback Source #
A convenience synonym for .Nothing :: Maybe EventControllerKeyImUpdateCallback
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
wrap_EventControllerKeyImUpdateCallback :: EventControllerKeyImUpdateCallback -> C_EventControllerKeyImUpdateCallback Source #
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 |
|
| -> Word32 |
|
| -> [ModifierType] |
|
| -> IO Bool | Returns: |
This signal is emitted whenever a key is pressed.
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
genClosure_EventControllerKeyKeyPressed :: MonadIO m => EventControllerKeyKeyPressedCallback -> m (GClosure C_EventControllerKeyKeyPressedCallback) Source #
Wrap the callback into a GClosure.
mk_EventControllerKeyKeyPressedCallback :: C_EventControllerKeyKeyPressedCallback -> IO (FunPtr C_EventControllerKeyKeyPressedCallback) Source #
Generate a function pointer callable from C code, from a C_EventControllerKeyKeyPressedCallback.
noEventControllerKeyKeyPressedCallback :: Maybe EventControllerKeyKeyPressedCallback Source #
A convenience synonym for .Nothing :: Maybe EventControllerKeyKeyPressedCallback
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
wrap_EventControllerKeyKeyPressedCallback :: EventControllerKeyKeyPressedCallback -> C_EventControllerKeyKeyPressedCallback Source #
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 |
|
| -> Word32 |
|
| -> [ModifierType] |
|
| -> IO () |
This signal is emitted whenever a key is released.
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
genClosure_EventControllerKeyKeyReleased :: MonadIO m => EventControllerKeyKeyReleasedCallback -> m (GClosure C_EventControllerKeyKeyReleasedCallback) Source #
Wrap the callback into a GClosure.
mk_EventControllerKeyKeyReleasedCallback :: C_EventControllerKeyKeyReleasedCallback -> IO (FunPtr C_EventControllerKeyKeyReleasedCallback) Source #
Generate a function pointer callable from C code, from a C_EventControllerKeyKeyReleasedCallback.
noEventControllerKeyKeyReleasedCallback :: Maybe EventControllerKeyKeyReleasedCallback Source #
A convenience synonym for .Nothing :: Maybe EventControllerKeyKeyReleasedCallback
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
wrap_EventControllerKeyKeyReleasedCallback :: EventControllerKeyKeyReleasedCallback -> C_EventControllerKeyKeyReleasedCallback Source #
modifiers
type C_EventControllerKeyModifiersCallback = Ptr () -> CUInt -> Ptr () -> IO CInt Source #
Type for the callback on the (unwrapped) C side.
type EventControllerKeyModifiersCallback Source #
Arguments
| = [ModifierType] |
|
| -> IO Bool |
This signal is emitted whenever the state of modifier keys and pointer buttons change.
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
genClosure_EventControllerKeyModifiers :: MonadIO m => EventControllerKeyModifiersCallback -> m (GClosure C_EventControllerKeyModifiersCallback) Source #
Wrap the callback into a GClosure.
mk_EventControllerKeyModifiersCallback :: C_EventControllerKeyModifiersCallback -> IO (FunPtr C_EventControllerKeyModifiersCallback) Source #
Generate a function pointer callable from C code, from a C_EventControllerKeyModifiersCallback.
noEventControllerKeyModifiersCallback :: Maybe EventControllerKeyModifiersCallback Source #
A convenience synonym for .Nothing :: Maybe EventControllerKeyModifiersCallback
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