Keymap

Object Hierarchy:

Description:

[ CCode ( type_id = "gdk_keymap_get_type ()" ) ]
public sealed class Keymap : Object

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.

Namespace: Gdk

Package: gdk-3.0

Content:

Static methods:

public static unowned Keymap get_default ()
Returns the Keymap attached to the default display.
public static unowned Keymap get_for_display (Display display)
Returns the Keymap attached to display.

Creation methods:

protected Keymap ()

Methods:

public void add_virtual_modifiers (ref ModifierType state)
Maps the non-virtual modifiers (i.
public bool get_caps_lock_state ()
Returns whether the Caps Lock modifer is locked.
public Direction get_direction ()
Returns the direction of effective layout of the keymap.
public bool get_entries_for_keycode (uint hardware_keycode, out KeymapKey[] keys, out uint[] keyvals)
Returns the keyvals bound to hardware_keycode.
public bool get_entries_for_keyval (uint keyval, out KeymapKey[] keys)
Obtains a list of keycode/group/level combinations that will generate keyval.
public ModifierType get_modifier_mask (ModifierIntent intent)
Returns the modifier mask the this’s windowing system backend uses for a particular purpose.
public uint get_modifier_state ()
Returns the current modifier state.
public bool get_num_lock_state ()
Returns whether the Num Lock modifer is locked.
public bool get_scroll_lock_state ()
Returns whether the Scroll Lock modifer is locked.
public bool have_bidi_layouts ()
Determines if keyboard layouts for both right-to-left and left-to-right languages are in use.
public uint lookup_key (KeymapKey key)
Looks up the keyval mapped to a keycode/group/level triplet.
public bool map_virtual_modifiers (ref ModifierType state)
Maps the virtual modifiers (i.
public bool translate_keyboard_state (uint hardware_keycode, ModifierType state, int group, out uint keyval, out int effective_group, out int level, out ModifierType consumed_modifiers)
Translates the contents of a EventKey into a keyval, effective group, and level.

Signals:

public signal void direction_changed ()
The direction_changed signal gets emitted when the direction of the keymap changes.
public signal void keys_changed ()
The keys_changed signal is emitted when the mapping represented by keymap changes.
public signal void state_changed ()
The state_changed signal is emitted when the state of the keyboard changes, e.

Inherited Members:

All known members inherited from class GLib.Object