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 #ifndef __GDK_KEYS_H__
  28 #define __GDK_KEYS_H__
  29
  30 #include <gdk/gdktypes.h>
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif /* __cplusplus */
  35
  36 typedef struct _GdkKeymapKey GdkKeymapKey;
  37
  38 /* GdkKeymapKey is a hardware key that can be mapped to a keyval */
  39 struct _GdkKeymapKey
  40 {
  41   guint keycode;
  42   gint  group;
  43   gint  level;
  44 };
  45
  46 /* A GdkKeymap defines the translation from keyboard state
  47  * (including a hardware key, a modifier mask, and active keyboard group)
  48  * to a keyval. This translation has two phases. The first phase is
  49  * to determine the effective keyboard group and level for the keyboard
  50  * state; the second phase is to look up the keycode/group/level triplet
  51  * in the keymap and see what keyval it corresponds to.
  52  */
  53
  54 typedef struct _GdkKeymap      GdkKeymap;
  55 typedef struct _GdkKeymapClass GdkKeymapClass;
  56
  57 #define GDK_TYPE_KEYMAP              (gdk_keymap_get_type ())
  58 #define GDK_KEYMAP(object)           (G_TYPE_CHECK_INSTANCE_CAST ((object), GDK_TYPE_KEYMAP, GdkKeymap))
  59 #define GDK_KEYMAP_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GDK_TYPE_KEYMAP, GdkKeymapClass))
  60 #define GDK_IS_KEYMAP(object)        (G_TYPE_CHECK_INSTANCE_TYPE ((object), GDK_TYPE_KEYMAP))
  61 #define GDK_IS_KEYMAP_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GDK_TYPE_KEYMAP))
  62 #define GDK_KEYMAP_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GDK_TYPE_KEYMAP, GdkKeymapClass))
  63
  64
  65 struct _GdkKeymap
  66 {
  67   GObject parent_instance;
  68 };
  69
  70 struct _GdkKeymapClass
  71 {
  72   GObjectClass parent_class;
  73 };
  74
  75 GType gdk_keymap_get_type (void) G_GNUC_CONST;
  76
  77 GdkKeymap* gdk_keymap_get_default (void);
  78
  79
  80 guint    gdk_keymap_lookup_key               (GdkKeymap           *keymap,
  81                                               const GdkKeymapKey  *key);
  82 gboolean gdk_keymap_translate_keyboard_state (GdkKeymap           *keymap,
  83                                               guint                hardware_keycode,
  84                                               GdkModifierType      state,
  85                                               gint                 group,
  86                                               guint               *keyval,
  87                                               gint                *effective_group,
  88                                               gint                *level,
  89                                               GdkModifierType     *unused_modifiers);
  90 gboolean gdk_keymap_get_entries_for_keyval   (GdkKeymap           *keymap,
  91                                               guint                keyval,
  92                                               GdkKeymapKey       **keys,
  93                                               gint                *n_keys);
  94 gboolean gdk_keymap_get_entries_for_keycode  (GdkKeymap           *keymap,
  95                                               guint                hardware_keycode,
  96                                               GdkKeymapKey       **keys,
  97                                               guint              **keyvals,
  98                                               gint                *n_entries);
  99
 100 /* Key values
 101  */
 102 gchar*   gdk_keyval_name         (guint        keyval) G_GNUC_CONST;
 103 guint    gdk_keyval_from_name    (const gchar *keyval_name);
 104 void     gdk_keyval_convert_case (guint        symbol,
 105                                   guint       *lower,
 106                                   guint       *upper);
 107 guint    gdk_keyval_to_upper     (guint        keyval) G_GNUC_CONST;
 108 guint    gdk_keyval_to_lower     (guint        keyval) G_GNUC_CONST;
 109 gboolean gdk_keyval_is_upper     (guint        keyval) G_GNUC_CONST;
 110 gboolean gdk_keyval_is_lower     (guint        keyval) G_GNUC_CONST;
 111
 112 guint32  gdk_keyval_to_unicode   (guint        keyval) G_GNUC_CONST;
 113 guint    gdk_unicode_to_keyval   (guint32      wc) G_GNUC_CONST;
 114
 115
 116 #ifdef __cplusplus
 117 }
 118 #endif /* __cplusplus */
 119
 120 #endif /* __GDK_KEYS_H__ */