Back to Seed Clases

Gdk

Classes

Interfaces

Structs

Unions

Event

Enums

GObject.Object
parent-child marker Gdk.Keymap

Class Gdk.Keymap

Import line:	Gdk = imports.gi.Gdk;
GIR File:	Gdk-3.0.gir
C documentation:	GdkKeymap
Class :	Keymap
Extends:	GObject.Object

A GdkKeymap 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.

Properties
None

Methods / Constructors
Method / Constructor		Defined By
	new Gdk.Keymap () Create a new Gdk.Keymap Create a new Gdk.Keymap
	Gdk.Keymap.get_default () : Gdk.Keymap Returns the GdkKeymap attached to the default display. Returns the GdkKeymap attached to the default display. Returns: Gdk.Keymap the GdkKeymap attached to the default display.	Gdk.Keymap
	Gdk.Keymap.get_for_display (Display *display) : Gdk.Keymap Returns the GdkKeymap* attached to display. Returns the GdkKeymap attached to display. Parameters: Gdk.Display display Required (not null) the GdkDisplay. Returns: Gdk.Keymap the GdkKeymap attached to display.	Gdk.Keymap
	add_virtual_modifiers () : Gdk.ModifierType Adds virtual modifiers (i.e. Adds virtual modifiers (i.e. Super, Hyper and Meta) which correspond to the real modifiers (i.e Mod2, Mod3, ...) in modifiers. are set in state to their non-virtual counterparts (i.e. Mod2, Mod3,...) 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. Returns: Gdk.ModifierType	Gdk.Keymap
	get_caps_lock_state () : gboolean Returns whether the Caps Lock modifer is locked. Returns whether the Caps Lock modifer is locked. Returns: gboolean TRUE if Caps Lock is on	Gdk.Keymap
	get_direction () : Pango.Direction Returns the direction of the keymap. Returns the direction of the keymap. PANGO_DIRECTION_RTL. Returns: Pango.Direction the direction of the keymap, PANGO_DIRECTION_LTR or	Gdk.Keymap
	get_entries_for_keycode (guint32 *hardware_keycode, Object out_values) : gboolean Returns the keyvals bound to hardware_keycode. Returns the keyvals bound to hardware_keycode. The Nth GdkKeymapKey* in keys is bound to the Nth keyval in keyvals. Free the returned arrays with g_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 gdk_keymap_translate_keyboard_state(). Parameters: guint32 hardware_keycode Required (not null) a keycode Object out_values Array keys Array keyvals gint32 n_entries Returns: gboolean TRUE if there were any entries	Gdk.Keymap
	get_entries_for_keyval (guint32 *keyval, Object out_values) : gboolean Obtains a list of keycode/group/level combinations that will generate keyval. 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. GdkEventKey* 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 g_free(). Parameters: guint32 keyval Required (not null) a keyval, such as GDK_a, GDK_Up, GDK_Return, etc. Object out_values Array keys gint32 n_keys Returns: gboolean TRUE if keys were found and returned	Gdk.Keymap
	get_num_lock_state () : gboolean Returns whether the Num Lock modifer is locked. Returns whether the Num Lock modifer is locked. Returns: gboolean TRUE if Num Lock is on	Gdk.Keymap
	have_bidi_layouts () : gboolean Determines if keyboard layouts for both right-to-left and left-to-right languages are in use. Determines if keyboard layouts for both right-to-left and left-to-right languages are in use. Returns: gboolean TRUE if there are layouts in both directions, FALSE otherwise	Gdk.Keymap
	lookup_key (KeymapKey *key) : guint32 Looks up the keyval mapped to a keycode/group/level triplet. 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 gdk_keymap_translate_keyboard_state() instead of this function, since the effective group/level may not be the same as the current keyboard state. Parameters: Gdk.KeymapKey key* Required (not null) a GdkKeymapKey with keycode, group, and level initialized Returns: guint32 a keyval, or 0 if none was mapped to the given key	Gdk.Keymap
	map_virtual_modifiers (Object *out_values) : gboolean Maps the virtual modifiers (i.e. 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. 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. Parameters: Object out_values Gdk.ModifierType state Returns: gboolean TRUE if no virtual modifiers were mapped to the	Gdk.Keymap
	translate_keyboard_state (guint32 *hardware_keycode, ModifierType state, gint32 group, Object out_values) : gboolean Translates the contents of a GdkEventKey* into a keyval, effective group, and level. Translates the contents of a GdkEventKey into a keyval, effective group, and level. Modifiers that affected the translation and are thus unavailable for application use are returned in See for an explanation of groups and levels. The effective_group 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 keyval, so this function isn't as useful as you might think. from 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. /* 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 consumed_modifiers* 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: /* 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 consumed_modifiers; 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, Parameters: guint32 hardware_keycode* Required (not null) a keycode Gdk.ModifierType state Required (not null) a modifier state gint32 group Required (not null) active keyboard group Object out_values guint32 keyval gint32 effective_group gint32 level Gdk.ModifierType consumed_modifiers Returns: gboolean TRUE if there was a keyval bound to the keycode/state/group	Gdk.Keymap

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	direction_changed (Keymap *self) : none The ::direction-changed signal gets emitted when the direction of the keymap changes. The ::direction-changed signal gets emitted when the direction of the keymap changes. Parameters: Gdk.Keymap self* Returns: {none}	Gdk.Keymap
	keys_changed (Keymap *self) : none The ::keys-changed signal is emitted when the mapping represented by The ::keys-changed signal is emitted when the mapping represented by Parameters: Gdk.Keymap self* Returns: {none}	Gdk.Keymap
	state_changed (Keymap *self) : none The ::state-changed signal is emitted when the state of the keyboard changes, e.g when Caps Lock is turned on or off. The ::state-changed signal is emitted when the state of the keyboard changes, e.g when Caps Lock is turned on or off. See gdk_keymap_get_caps_lock_state(). Parameters: Gdk.Keymap self* Returns: {none}	Gdk.Keymap