902f95b87d16c6b46fb4c6d23419ebce17a45e7e
[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
25 G_BEGIN_DECLS
26
27 /*! These keys are bound to the modifier masks in any fashion,
28   except for CapsLock, Shift, and Control. */
29 typedef enum {
30     OBT_KEYBOARD_MODKEY_CAPSLOCK,
31     OBT_KEYBOARD_MODKEY_NUMLOCK,
32     OBT_KEYBOARD_MODKEY_SCROLLLOCK,
33     OBT_KEYBOARD_MODKEY_SHIFT,
34     OBT_KEYBOARD_MODKEY_CONTROL,
35     OBT_KEYBOARD_MODKEY_SUPER,
36     OBT_KEYBOARD_MODKEY_HYPER,
37     OBT_KEYBOARD_MODKEY_META,
38     OBT_KEYBOARD_MODKEY_ALT,
39
40     OBT_KEYBOARD_NUM_MODKEYS
41 } ObtModkeysKey;
42
43 typedef struct _ObtIC ObtIC;
44
45 void obt_keyboard_reload(void);
46
47 /*! Get the modifier mask(s) for a KeyCode. (eg. a keycode bound to Alt_L could
48   return a mask of (Mod1Mask | Mask3Mask)) */
49 guint obt_keyboard_keycode_to_modmask(guint keycode);
50
51 /*! Strip off all modifiers except for the modifier keys. This strips stuff
52   like Button1Mask, and also LockMask, NumlockMask, and ScrolllockMask */
53 guint obt_keyboard_only_modmasks(guint mask);
54
55 /*! Get the modifier masks for a modifier key. This includes both the left and
56   right keys when there are both. */
57 guint obt_keyboard_modkey_to_modmask(ObtModkeysKey key);
58
59 /*! Convert a KeySym to all the KeyCodes which generate it. */
60 KeyCode* obt_keyboard_keysym_to_keycode(KeySym sym);
61
62 /*! Translate a KeyPress event to the unicode character it represents */
63 gunichar obt_keyboard_keypress_to_unichar(ObtIC *ic, XKeyPressedEvent *ev);
64
65 /*! Create an input context for a window.
66     @client The top-level client window for the input context.
67     @focus The subwindow within the client for the input context.
68 */
69 ObtIC* obt_keyboard_context_new(Window client, Window focus);
70
71 void obt_keyboard_context_ref(ObtIC *ic);
72 void obt_keyboard_context_unref(ObtIC *ic);
73
74 G_END_DECLS
75
76 #endif /* __obt_keyboard_h */