make the modifier key code a lot better...
[mikachu/openbox.git] / openbox / modkeys.h
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    masks.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 ob__modkeys_h
20 #define ob__modkeys_h
21
22 #include <glib.h>
23
24 /*! These keys are bound to the modifier masks in any fashion */
25 typedef enum {
26     OB_MODKEY_KEY_CAPSLOCK,
27     OB_MODKEY_KEY_NUMLOCK,
28     OB_MODKEY_KEY_SCROLLLOCK,
29     OB_MODKEY_KEY_SHIFT,
30     OB_MODKEY_KEY_CONTROL,
31     OB_MODKEY_KEY_SUPER,
32     OB_MODKEY_KEY_HYPER,
33     OB_MODKEY_KEY_META,
34     OB_MODKEY_KEY_ALT,
35
36     OB_MODKEY_NUM_KEYS
37 } ObModkeysKey;
38
39 void modkeys_startup(gboolean reconfigure);
40 void modkeys_shutdown(gboolean reconfigure);
41
42 /*! Get the modifier masks for a keycode. (eg. a keycode bound to Alt_L could
43   return a mask of (Mod1Mask | Mask3Mask)) */
44 guint modkeys_keycode_to_mask(guint keycode);
45
46 /*! Strip off all modifiers except for the modifier keys. This strips stuff
47   like Button1Mask, and also LockMask, NumLockMask, and ScrollLockMask */
48 guint modkeys_only_modifier_masks(guint mask);
49
50 /*! Get the modifier masks for a modifier key. This includes both the left and
51   right keys when there are both. */
52 guint modkeys_key_to_mask(ObModkeysKey key);
53
54 #endif