Pileus Git - ~andy/gtk/blob - gdk/gdkkeys.h

   1 /* GDK - The GIMP Drawing Kit
   2  * Copyright (C) 2000 Red Hat, Inc.
   3  *
   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.
   8  *
   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.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GTK+ Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #if !defined (__GDK_H_INSIDE__) && !defined (GDK_COMPILATION)
  28 #error "Only <gdk/gdk.h> can be included directly."
  29 #endif
  30
  31 #ifndef __GDK_KEYS_H__
  32 #define __GDK_KEYS_H__
  33
  34 #include <gdk/gdktypes.h>
  35
  36 G_BEGIN_DECLS
  37
  38
  39 typedef struct _GdkKeymapKey GdkKeymapKey;
  40
  41 /**
  42  * GdkKeymapKey:
  43  * @keycode: the hardware keycode. This is an identifying number for a
  44  *   physical key.
  45  * @group: indicates movement in a horizontal direction. Usually groups are used
  46  *   for two different languages. In group 0, a key might have two English
  47  *   characters, and in group 1 it might have two Hebrew characters. The Hebrew
  48  *   characters will be printed on the key next to the English characters.
  49  * @level: indicates which symbol on the key will be used, in a vertical direction.
  50  *   So on a standard US keyboard, the key with the number "1" on it also has the
  51  *   exclamation point ("!") character on it. The level indicates whether to use
  52  *   the "1" or the "!" symbol. The letter keys are considered to have a lowercase
  53  *   letter at level 0, and an uppercase letter at level 1, though only the
  54  *   uppercase letter is printed.
  55  *
  56  * A #GdkKeymapKey is a hardware key that can be mapped to a keyval.
  57  */
  58 struct _GdkKeymapKey
  59 {
  60   guint keycode;
  61   gint  group;
  62   gint  level;
  63 };
  64
  65
  66 #define GDK_TYPE_KEYMAP              (gdk_keymap_get_type ())
  67 #define GDK_KEYMAP(object)           (G_TYPE_CHECK_INSTANCE_CAST ((object), GDK_TYPE_KEYMAP, GdkKeymap))
  68 #define GDK_KEYMAP_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GDK_TYPE_KEYMAP, GdkKeymapClass))
  69 #define GDK_IS_KEYMAP(object)        (G_TYPE_CHECK_INSTANCE_TYPE ((object), GDK_TYPE_KEYMAP))
  70 #define GDK_IS_KEYMAP_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GDK_TYPE_KEYMAP))
  71 #define GDK_KEYMAP_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GDK_TYPE_KEYMAP, GdkKeymapClass))
  72
  73 typedef struct _GdkKeymapClass GdkKeymapClass;
  74
  75 /**
  76  * GdkKeymap:
  77  *
  78  * A #GdkKeymap defines the translation from keyboard state
  79  * (including a hardware key, a modifier mask, and active keyboard group)
  80  * to a keyval. This translation has two phases. The first phase is
  81  * to determine the effective keyboard group and level for the keyboard
  82  * state; the second phase is to look up the keycode/group/level triplet
  83  * in the keymap and see what keyval it corresponds to.
  84  */
  85
  86 GType gdk_keymap_get_type (void) G_GNUC_CONST;
  87
  88 #ifndef GDK_MULTIHEAD_SAFE
  89 GdkKeymap* gdk_keymap_get_default     (void);
  90 #endif
  91 GdkKeymap* gdk_keymap_get_for_display (GdkDisplay *display);
  92
  93
  94 guint          gdk_keymap_lookup_key               (GdkKeymap           *keymap,
  95                                                     const GdkKeymapKey  *key);
  96 gboolean       gdk_keymap_translate_keyboard_state (GdkKeymap           *keymap,
  97                                                     guint                hardware_keycode,
  98                                                     GdkModifierType      state,
  99                                                     gint                 group,
 100                                                     guint               *keyval,
 101                                                     gint                *effective_group,
 102                                                     gint                *level,
 103                                                     GdkModifierType     *consumed_modifiers);
 104 gboolean       gdk_keymap_get_entries_for_keyval   (GdkKeymap           *keymap,
 105                                                     guint                keyval,
 106                                                     GdkKeymapKey       **keys,
 107                                                     gint                *n_keys);
 108 gboolean       gdk_keymap_get_entries_for_keycode  (GdkKeymap           *keymap,
 109                                                     guint                hardware_keycode,
 110                                                     GdkKeymapKey       **keys,
 111                                                     guint              **keyvals,
 112                                                     gint                *n_entries);
 113
 114 /**
 115  * gdk_keymap_get_direction:
 116  * @keymap: a #GdkKeymap or %NULL to use the default keymap.
 117  *
 118  * Returns the direction of the keymap.
 119  *
 120  * Returns: the direction of the keymap, %PANGO_DIRECTION_LTR or
 121  *   %PANGO_DIRECTION_RTL.
 122  */
 123 PangoDirection gdk_keymap_get_direction            (GdkKeymap           *keymap);
 124 gboolean       gdk_keymap_have_bidi_layouts        (GdkKeymap           *keymap);
 125 gboolean       gdk_keymap_get_caps_lock_state      (GdkKeymap           *keymap);
 126 gboolean       gdk_keymap_get_num_lock_state       (GdkKeymap           *keymap);
 127 void           gdk_keymap_add_virtual_modifiers    (GdkKeymap           *keymap,
 128                                                     GdkModifierType     *state);
 129 gboolean       gdk_keymap_map_virtual_modifiers    (GdkKeymap           *keymap,
 130                                                     GdkModifierType     *state);
 131
 132 /* Key values
 133  */
 134 gchar*   gdk_keyval_name         (guint        keyval) G_GNUC_CONST;
 135
 136 /**
 137  * gdk_keyval_from_name:
 138  * @keyval_name: a key name.
 139  *
 140  * Converts a key name to a key value.
 141  *
 142  * Returns: the corresponding key value, or %GDK_VoidSymbol if the key name is
 143  *  not a valid key.
 144  */
 145 guint    gdk_keyval_from_name    (const gchar *keyval_name);
 146 void     gdk_keyval_convert_case (guint        symbol,
 147                                   guint       *lower,
 148                                   guint       *upper);
 149 guint    gdk_keyval_to_upper     (guint        keyval) G_GNUC_CONST;
 150 guint    gdk_keyval_to_lower     (guint        keyval) G_GNUC_CONST;
 151 gboolean gdk_keyval_is_upper     (guint        keyval) G_GNUC_CONST;
 152 gboolean gdk_keyval_is_lower     (guint        keyval) G_GNUC_CONST;
 153
 154 guint32  gdk_keyval_to_unicode   (guint        keyval) G_GNUC_CONST;
 155 guint    gdk_unicode_to_keyval   (guint32      wc) G_GNUC_CONST;
 156
 157
 158 G_END_DECLS
 159
 160 #endif /* __GDK_KEYS_H__ */