1 /* GDK - The GIMP Drawing Kit
2 * Copyright (C) 2000 Red Hat, Inc.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
19 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
20 * file for a list of people on the GTK+ Team. See the ChangeLog
21 * files for a list of changes. These files are distributed with
22 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
25 #if !defined (__GDK_H_INSIDE__) && !defined (GDK_COMPILATION)
26 #error "Only <gdk/gdk.h> can be included directly."
29 #ifndef __GDK_KEYS_H__
30 #define __GDK_KEYS_H__
32 #include <gdk/gdkversionmacros.h>
33 #include <gdk/gdktypes.h>
38 typedef struct _GdkKeymapKey GdkKeymapKey;
42 * @keycode: the hardware keycode. This is an identifying number for a
44 * @group: indicates movement in a horizontal direction. Usually groups are used
45 * for two different languages. In group 0, a key might have two English
46 * characters, and in group 1 it might have two Hebrew characters. The Hebrew
47 * characters will be printed on the key next to the English characters.
48 * @level: indicates which symbol on the key will be used, in a vertical direction.
49 * So on a standard US keyboard, the key with the number "1" on it also has the
50 * exclamation point ("!") character on it. The level indicates whether to use
51 * the "1" or the "!" symbol. The letter keys are considered to have a lowercase
52 * letter at level 0, and an uppercase letter at level 1, though only the
53 * uppercase letter is printed.
55 * A #GdkKeymapKey is a hardware key that can be mapped to a keyval.
65 #define GDK_TYPE_KEYMAP (gdk_keymap_get_type ())
66 #define GDK_KEYMAP(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), GDK_TYPE_KEYMAP, GdkKeymap))
67 #define GDK_IS_KEYMAP(object) (G_TYPE_CHECK_INSTANCE_TYPE ((object), GDK_TYPE_KEYMAP))
72 * A #GdkKeymap defines the translation from keyboard state
73 * (including a hardware key, a modifier mask, and active keyboard group)
74 * to a keyval. This translation has two phases. The first phase is
75 * to determine the effective keyboard group and level for the keyboard
76 * state; the second phase is to look up the keycode/group/level triplet
77 * in the keymap and see what keyval it corresponds to.
80 GType gdk_keymap_get_type (void) G_GNUC_CONST;
82 #ifndef GDK_MULTIHEAD_SAFE
83 GdkKeymap* gdk_keymap_get_default (void);
85 GdkKeymap* gdk_keymap_get_for_display (GdkDisplay *display);
88 guint gdk_keymap_lookup_key (GdkKeymap *keymap,
89 const GdkKeymapKey *key);
90 gboolean gdk_keymap_translate_keyboard_state (GdkKeymap *keymap,
91 guint hardware_keycode,
92 GdkModifierType state,
95 gint *effective_group,
97 GdkModifierType *consumed_modifiers);
98 gboolean gdk_keymap_get_entries_for_keyval (GdkKeymap *keymap,
102 gboolean gdk_keymap_get_entries_for_keycode (GdkKeymap *keymap,
103 guint hardware_keycode,
108 PangoDirection gdk_keymap_get_direction (GdkKeymap *keymap);
109 gboolean gdk_keymap_have_bidi_layouts (GdkKeymap *keymap);
110 gboolean gdk_keymap_get_caps_lock_state (GdkKeymap *keymap);
111 gboolean gdk_keymap_get_num_lock_state (GdkKeymap *keymap);
113 guint gdk_keymap_get_modifier_state (GdkKeymap *keymap);
114 void gdk_keymap_add_virtual_modifiers (GdkKeymap *keymap,
115 GdkModifierType *state);
116 gboolean gdk_keymap_map_virtual_modifiers (GdkKeymap *keymap,
117 GdkModifierType *state);
119 GdkModifierType gdk_keymap_get_modifier_mask (GdkKeymap *keymap,
120 GdkModifierIntent intent);
125 gchar* gdk_keyval_name (guint keyval) G_GNUC_CONST;
127 guint gdk_keyval_from_name (const gchar *keyval_name);
128 void gdk_keyval_convert_case (guint symbol,
131 guint gdk_keyval_to_upper (guint keyval) G_GNUC_CONST;
132 guint gdk_keyval_to_lower (guint keyval) G_GNUC_CONST;
133 gboolean gdk_keyval_is_upper (guint keyval) G_GNUC_CONST;
134 gboolean gdk_keyval_is_lower (guint keyval) G_GNUC_CONST;
136 guint32 gdk_keyval_to_unicode (guint keyval) G_GNUC_CONST;
137 guint gdk_unicode_to_keyval (guint32 wc) G_GNUC_CONST;
142 #endif /* __GDK_KEYS_H__ */