GI.Gdk.Objects.Keymap

A Keymap defines the translation from keyboard state (including a hardware key, a modifier mask, and active keyboard group) to a keyval. This translation has two phases. The first phase is to determine the effective keyboard group and level for the keyboard state; the second phase is to look up the keycode/group/level triplet in the keymap and see what keyval it corresponds to.

Exported types

newtype Keymap

Memory-managed wrapper type.

Constructors

Keymap (ManagedPtr Keymap)

Instances

GObject Keymap

Defined in GI.Gdk.Objects.Keymap

Methods

gobjectType :: IO GType

HasParentTypes Keymap

Defined in GI.Gdk.Objects.Keymap

type ParentTypes Keymap

Defined in GI.Gdk.Objects.Keymap

type ParentTypes Keymap = Object ': ([] :: [Type])

class (GObject o, IsDescendantOf Keymap o) => IsKeymap o

Type class for types which can be safely cast to Keymap, for instance with toKeymap.

Instances

(GObject o, IsDescendantOf Keymap o) => IsKeymap o

Defined in GI.Gdk.Objects.Keymap

toKeymap :: (MonadIO m, IsKeymap o) => o -> m Keymap

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

noKeymap :: Maybe Keymap

A convenience alias for Nothing :: Maybe Keymap.

Methods

addVirtualModifiers

keymapAddVirtualModifiers

Arguments

:: (HasCallStack, MonadIO m, IsKeymap a)

=> a

keymap: a Keymap

-> [ModifierType]

state: pointer to the modifier mask to change

-> m [ModifierType]

Maps the non-virtual modifiers (i.e Mod2, Mod3, ...) which are set in state to the virtual modifiers (i.e. Super, Hyper and Meta) and set the corresponding bits in state.

GDK already does this before delivering key events, but for compatibility reasons, it only sets the first virtual modifier it finds, whereas this function sets all matching virtual modifiers.

This function is useful when matching key events against accelerators.

Since: 2.20

getCapsLockState

keymapGetCapsLockState

Arguments

:: (HasCallStack, MonadIO m, IsKeymap a)

=> a

keymap: a Keymap

-> m Bool

Returns: True if Caps Lock is on

Returns whether the Caps Lock modifer is locked.

Since: 2.16

getDefault

keymapGetDefault

Arguments

:: (HasCallStack, MonadIO m)

=> m Keymap

Returns: the Keymap attached to the default display.

Deprecated: (Since version 3.22)Use keymapGetForDisplay instead

Returns the Keymap attached to the default display.

getDirection

keymapGetDirection

Arguments

:: (HasCallStack, MonadIO m, IsKeymap a)

=> a

keymap: a Keymap

-> m Direction

Returns: DirectionLtr or DirectionRtl if it can determine the direction. DirectionNeutral otherwise.

Returns the direction of effective layout of the keymap.

getEntriesForKeycode

keymapGetEntriesForKeycode

Arguments

:: (HasCallStack, MonadIO m, IsKeymap a)

=> a

keymap: a Keymap

-> Word32

hardwareKeycode: a keycode

-> m (Bool, [KeymapKey], [Word32])

Returns: True if there were any entries

Returns the keyvals bound to hardwareKeycode. The Nth KeymapKey in keys is bound to the Nth keyval in keyvals. Free the returned arrays with free. When a keycode is pressed by the user, the keyval from this list of entries is selected by considering the effective keyboard group and level. See keymapTranslateKeyboardState.

getEntriesForKeyval

keymapGetEntriesForKeyval

Arguments

:: (HasCallStack, MonadIO m, IsKeymap a)

=> a

keymap: a Keymap

-> Word32

keyval: a keyval, such as KEY_a, KEY_Up, KEY_Return, etc.

-> m (Bool, [KeymapKey])

Returns: True if keys were found and returned

Obtains a list of keycode/group/level combinations that will generate keyval. Groups and levels are two kinds of keyboard mode; in general, the level determines whether the top or bottom symbol on a key is used, and the group determines whether the left or right symbol is used. On US keyboards, the shift key changes the keyboard level, and there are no groups. A group switch key might convert a keyboard between Hebrew to English modes, for example. EventKey contains a group field that indicates the active keyboard group. The level is computed from the modifier mask. The returned array should be freed with free.

getForDisplay

keymapGetForDisplay

Arguments

:: (HasCallStack, MonadIO m, IsDisplay a)

=> a

display: the Display.

-> m Keymap

Returns: the Keymap attached to display.

Returns the Keymap attached to display.

Since: 2.2

getModifierMask

keymapGetModifierMask

Arguments

:: (HasCallStack, MonadIO m, IsKeymap a)

=> a

keymap: a Keymap

-> ModifierIntent

intent: the use case for the modifier mask

-> m [ModifierType]

Returns: the modifier mask used for intent.

Returns the modifier mask the keymap’s windowing system backend uses for a particular purpose.

Note that this function always returns real hardware modifiers, not virtual ones (e.g. it will return GDK_MOD1_MASK rather than GDK_META_MASK if the backend maps MOD1 to META), so there are use cases where the return value of this function has to be transformed by keymapAddVirtualModifiers in order to contain the expected result.

Since: 3.4

getModifierState

keymapGetModifierState

Arguments

:: (HasCallStack, MonadIO m, IsKeymap a)

=> a

keymap: a Keymap

-> m Word32

Returns: the current modifier state.

Returns the current modifier state.

Since: 3.4

getNumLockState

keymapGetNumLockState

Arguments

:: (HasCallStack, MonadIO m, IsKeymap a)

=> a

keymap: a Keymap

-> m Bool

Returns: True if Num Lock is on

Returns whether the Num Lock modifer is locked.

Since: 3.0

getScrollLockState

keymapGetScrollLockState

Arguments

:: (HasCallStack, MonadIO m, IsKeymap a)

=> a

keymap: a Keymap

-> m Bool

Returns: True if Scroll Lock is on

Returns whether the Scroll Lock modifer is locked.

Since: 3.18

haveBidiLayouts

keymapHaveBidiLayouts

Arguments

:: (HasCallStack, MonadIO m, IsKeymap a)

=> a

keymap: a Keymap

-> m Bool

Returns: True if there are layouts in both directions, False otherwise

Determines if keyboard layouts for both right-to-left and left-to-right languages are in use.

Since: 2.12

lookupKey

keymapLookupKey

Arguments

:: (HasCallStack, MonadIO m, IsKeymap a)

=> a

keymap: a Keymap

-> KeymapKey

key: a KeymapKey with keycode, group, and level initialized

-> m Word32

Returns: a keyval, or 0 if none was mapped to the given key

Looks up the keyval mapped to a keycode/group/level triplet. If no keyval is bound to key, returns 0. For normal user input, you want to use keymapTranslateKeyboardState instead of this function, since the effective group/level may not be the same as the current keyboard state.

mapVirtualModifiers

keymapMapVirtualModifiers

Arguments

:: (HasCallStack, MonadIO m, IsKeymap a)

=> a

keymap: a Keymap

-> [ModifierType]

state: pointer to the modifier state to map

-> m (Bool, [ModifierType])

Returns: False if two virtual modifiers were mapped to the same non-virtual modifier. Note that False is also returned if a virtual modifier is mapped to a non-virtual modifier that was already set in state.

Maps the virtual modifiers (i.e. Super, Hyper and Meta) which are set in state to their non-virtual counterparts (i.e. Mod2, Mod3,...) and set the corresponding bits in state.

This function is useful when matching key events against accelerators.

Since: 2.20

translateKeyboardState

keymapTranslateKeyboardState

Arguments

:: (HasCallStack, MonadIO m, IsKeymap a)

=> a

keymap: a Keymap

-> Word32

hardwareKeycode: a keycode

-> [ModifierType]

state: a modifier state

-> Int32

group: active keyboard group

-> m (Bool, Word32, Int32, Int32, [ModifierType])

Returns: True if there was a keyval bound to the keycode/state/group

Translates the contents of a EventKey into a keyval, effective group, and level. Modifiers that affected the translation and are thus unavailable for application use are returned in consumedModifiers. See [Groups][key-group-explanation] for an explanation of groups and levels. The effectiveGroup is the group that was actually used for the translation; some keys such as Enter are not affected by the active keyboard group. The level is derived from state. For convenience, EventKey already contains the translated keyval, so this function isn’t as useful as you might think.

consumedModifiers gives modifiers that should be masked outfrom state when comparing this key press to a hot key. For instance, on a US keyboard, the plus symbol is shifted, so when comparing a key press to a <Control>plus accelerator <Shift> should be masked out.

C code

// We want to ignore irrelevant modifiers like ScrollLock
#define ALL_ACCELS_MASK (GDK_CONTROL_MASK | GDK_SHIFT_MASK | GDK_MOD1_MASK)
gdk_keymap_translate_keyboard_state (keymap, event->hardware_keycode,
                                     event->state, event->group,
                                     &keyval, NULL, NULL, &consumed);
if (keyval == GDK_PLUS &&
    (event->state & ~consumed & ALL_ACCELS_MASK) == GDK_CONTROL_MASK)
  // Control was pressed

An older interpretation consumedModifiers was that it contained all modifiers that might affect the translation of the key; this allowed accelerators to be stored with irrelevant consumed modifiers, by doing:

C code

// XXX Don’t do this XXX
if (keyval == accel_keyval &&
    (event->state & ~consumed & ALL_ACCELS_MASK) == (accel_mods & ~consumed))
  // Accelerator was pressed

However, this did not work if multi-modifier combinations were used in the keymap, since, for instance, <Control> would be masked out even if only <Control><Alt> was used in the keymap. To support this usage as well as well as possible, all single modifier combinations that could affect the key for any combination of modifiers will be returned in consumedModifiers; multi-modifier combinations are returned only when actually found in state. When you store accelerators, you should always store them with consumed modifiers removed. Store <Control>plus, not <Control><Shift>plus,

Signals

directionChanged

type C_KeymapDirectionChangedCallback = Ptr () -> Ptr () -> IO ()

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

type KeymapDirectionChangedCallback = IO ()

The ::direction-changed signal gets emitted when the direction of the keymap changes.

Since: 2.0

afterKeymapDirectionChanged :: (IsKeymap a, MonadIO m) => a -> KeymapDirectionChangedCallback -> m SignalHandlerId

Connect a signal handler for the “direction-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after keymap #directionChanged callback

genClosure_KeymapDirectionChanged :: MonadIO m => KeymapDirectionChangedCallback -> m (GClosure C_KeymapDirectionChangedCallback)

Wrap the callback into a GClosure.

mk_KeymapDirectionChangedCallback :: C_KeymapDirectionChangedCallback -> IO (FunPtr C_KeymapDirectionChangedCallback)

Generate a function pointer callable from C code, from a C_KeymapDirectionChangedCallback.

noKeymapDirectionChangedCallback :: Maybe KeymapDirectionChangedCallback

A convenience synonym for Nothing :: Maybe KeymapDirectionChangedCallback.

onKeymapDirectionChanged :: (IsKeymap a, MonadIO m) => a -> KeymapDirectionChangedCallback -> m SignalHandlerId

Connect a signal handler for the “direction-changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on keymap #directionChanged callback

wrap_KeymapDirectionChangedCallback :: KeymapDirectionChangedCallback -> C_KeymapDirectionChangedCallback

Wrap a KeymapDirectionChangedCallback into a C_KeymapDirectionChangedCallback.

keysChanged

type C_KeymapKeysChangedCallback = Ptr () -> Ptr () -> IO ()

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

type KeymapKeysChangedCallback = IO ()

The ::keys-changed signal is emitted when the mapping represented by keymap changes.

Since: 2.2

afterKeymapKeysChanged :: (IsKeymap a, MonadIO m) => a -> KeymapKeysChangedCallback -> m SignalHandlerId

Connect a signal handler for the “keys-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after keymap #keysChanged callback

genClosure_KeymapKeysChanged :: MonadIO m => KeymapKeysChangedCallback -> m (GClosure C_KeymapKeysChangedCallback)

Wrap the callback into a GClosure.

mk_KeymapKeysChangedCallback :: C_KeymapKeysChangedCallback -> IO (FunPtr C_KeymapKeysChangedCallback)

Generate a function pointer callable from C code, from a C_KeymapKeysChangedCallback.

noKeymapKeysChangedCallback :: Maybe KeymapKeysChangedCallback

A convenience synonym for Nothing :: Maybe KeymapKeysChangedCallback.

onKeymapKeysChanged :: (IsKeymap a, MonadIO m) => a -> KeymapKeysChangedCallback -> m SignalHandlerId

Connect a signal handler for the “keys-changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on keymap #keysChanged callback

wrap_KeymapKeysChangedCallback :: KeymapKeysChangedCallback -> C_KeymapKeysChangedCallback

Wrap a KeymapKeysChangedCallback into a C_KeymapKeysChangedCallback.

stateChanged

type C_KeymapStateChangedCallback = Ptr () -> Ptr () -> IO ()

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

type KeymapStateChangedCallback = IO ()

The ::state-changed signal is emitted when the state of the keyboard changes, e.g when Caps Lock is turned on or off. See keymapGetCapsLockState.

Since: 2.16

afterKeymapStateChanged :: (IsKeymap a, MonadIO m) => a -> KeymapStateChangedCallback -> m SignalHandlerId

Connect a signal handler for the “state-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after keymap #stateChanged callback

genClosure_KeymapStateChanged :: MonadIO m => KeymapStateChangedCallback -> m (GClosure C_KeymapStateChangedCallback)

Wrap the callback into a GClosure.

mk_KeymapStateChangedCallback :: C_KeymapStateChangedCallback -> IO (FunPtr C_KeymapStateChangedCallback)

Generate a function pointer callable from C code, from a C_KeymapStateChangedCallback.

noKeymapStateChangedCallback :: Maybe KeymapStateChangedCallback

A convenience synonym for Nothing :: Maybe KeymapStateChangedCallback.

onKeymapStateChanged :: (IsKeymap a, MonadIO m) => a -> KeymapStateChangedCallback -> m SignalHandlerId

Connect a signal handler for the “state-changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on keymap #stateChanged callback

wrap_KeymapStateChangedCallback :: KeymapStateChangedCallback -> C_KeymapStateChangedCallback

Wrap a KeymapStateChangedCallback into a C_KeymapStateChangedCallback.