143921ff2fa927e667d40aa5792a32d08e9e6ad8
[dana/openbox.git] / obt / keyboard.h
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    obt/keyboard.h for the Openbox window manager
4    Copyright (c) 2007        Dana Jansens
5
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 2 of the License, or
9    (at your option) any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    See the COPYING file for a copy of the GNU General Public License.
17 */
18
19 #ifndef __obt_keyboard_h
20 #define __obt_keyboard_h
21
22 #include <glib.h>
23 #include <X11/Xlib.h>
24 #include <X11/keysym.h>
25
26 G_BEGIN_DECLS
27
28 /*! These keys are bound to the modifier masks in any fashion,
29   except for CapsLock, Shift, and Control. */
30 typedef enum {
31     OBT_KEYBOARD_MODKEY_CAPSLOCK,
32     OBT_KEYBOARD_MODKEY_NUMLOCK,
33     OBT_KEYBOARD_MODKEY_SCROLLLOCK,
34     OBT_KEYBOARD_MODKEY_SHIFT,
35     OBT_KEYBOARD_MODKEY_CONTROL,
36     OBT_KEYBOARD_MODKEY_SUPER,
37     OBT_KEYBOARD_MODKEY_HYPER,
38     OBT_KEYBOARD_MODKEY_META,
39     OBT_KEYBOARD_MODKEY_ALT,
40
41     OBT_KEYBOARD_NUM_MODKEYS
42 } ObtModkeysKey;
43
44 typedef struct _ObtIC ObtIC;
45
46 void obt_keyboard_reload(void);
47
48 /*! Get the modifier mask(s) for a KeyCode. (eg. a keycode bound to Alt_L could
49   return a mask of (Mod1Mask | Mask3Mask)) */
50 guint obt_keyboard_keycode_to_modmask(guint keycode);
51
52 /*! Strip off all modifiers except for the modifier keys. This strips stuff
53   like Button1Mask, and also LockMask, NumlockMask, and ScrolllockMask */
54 guint obt_keyboard_only_modmasks(guint mask);
55
56 /*! Get the modifier masks for a modifier key. This includes both the left and
57   right keys when there are both. */
58 guint obt_keyboard_modkey_to_modmask(ObtModkeysKey key);
59
60 /*! Convert a KeySym to all the KeyCodes which generate it. */
61 KeyCode* obt_keyboard_keysym_to_keycode(KeySym sym);
62
63 /*! Translate a KeyPress event to the unicode character it represents */
64 gunichar obt_keyboard_keypress_to_unichar(ObtIC *ic, XEvent *ev);
65
66 /*! Translate a KeyPress event to the KeySym that it represents.  Use this
67  for control keys, not for getting text input! */
68 KeySym obt_keyboard_keypress_to_keysym(XEvent *ev);
69
70 /*! Create an input context for a window.
71     @client The top-level client window for the input context.
72     @focus The subwindow within the client for the input context.
73 */
74 ObtIC* obt_keyboard_context_new(Window client, Window focus);
75
76 void obt_keyboard_context_ref(ObtIC *ic);
77 void obt_keyboard_context_unref(ObtIC *ic);
78
79 G_END_DECLS
80
81 #endif /* __obt_keyboard_h */