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 #include <X11/Xlib.h>
  24
  25 /*! These keys are bound to the modifier masks in any fashion,
  26   except for CapsLock, Shift, and Control. */
  27 typedef enum {
  28     OB_MODKEY_KEY_CAPSLOCK,
  29     OB_MODKEY_KEY_NUMLOCK,
  30     OB_MODKEY_KEY_SCROLLLOCK,
  31     OB_MODKEY_KEY_SHIFT,
  32     OB_MODKEY_KEY_CONTROL,
  33     OB_MODKEY_KEY_SUPER,
  34     OB_MODKEY_KEY_HYPER,
  35     OB_MODKEY_KEY_META,
  36     OB_MODKEY_KEY_ALT,
  37
  38     OB_MODKEY_NUM_KEYS
  39 } ObModkeysKey;
  40
  41 void modkeys_startup(gboolean reconfigure);
  42 void modkeys_shutdown(gboolean reconfigure);
  43
  44 /*! Get the modifier masks for a keycode. (eg. a keycode bound to Alt_L could
  45   return a mask of (Mod1Mask | Mask3Mask)) */
  46 guint modkeys_keycode_to_mask(guint keycode);
  47
  48 /*! Strip off all modifiers except for the modifier keys. This strips stuff
  49   like Button1Mask, and also LockMask, NumLockMask, and ScrollLockMask */
  50 guint modkeys_only_modifier_masks(guint mask);
  51
  52 /*! Get the modifier masks for a modifier key. This includes both the left and
  53   right keys when there are both. */
  54 guint modkeys_key_to_mask(ObModkeysKey key);
  55
  56 /*! Convert a KeySym to a KeyCode, because the X function is terrible - says
  57   valgrind. */
  58 KeyCode modkeys_sym_to_code(KeySym sym);
  59
  60 #endif