Use the KeyCode to directly find the modifier mask. (Fix bug 5173)
[mikachu/openbox.git] / obt / keyboard.h
index dd28cb8..8f2badf 100644 (file)
 
 #include <glib.h>
 #include <X11/Xlib.h>
+#include <X11/keysym.h>
 
 G_BEGIN_DECLS
 
 /*! These keys are bound to the modifier masks in any fashion,
   except for CapsLock, Shift, and Control. */
 typedef enum {
+    OBT_KEYBOARD_MODKEY_NONE,
     OBT_KEYBOARD_MODKEY_CAPSLOCK,
     OBT_KEYBOARD_MODKEY_NUMLOCK,
     OBT_KEYBOARD_MODKEY_SCROLLLOCK,
@@ -40,11 +42,14 @@ typedef enum {
     OBT_KEYBOARD_NUM_MODKEYS
 } ObtModkeysKey;
 
+typedef struct _ObtIC ObtIC;
+
 void obt_keyboard_reload(void);
 
-/*! Get the modifier mask(s) for a KeyCode. (eg. a keycode bound to Alt_L could
-  return a mask of (Mod1Mask | Mask3Mask)) */
-guint obt_keyboard_keycode_to_modmask(guint keycode);
+/*! Get the modifier mask(s) for a keyboard event.
+  (eg. a keycode bound to Alt_L could return a mask of (Mod1Mask | Mask3Mask))
+*/
+guint obt_keyboard_keyevent_to_modmask(XEvent *e);
 
 /*! Strip off all modifiers except for the modifier keys. This strips stuff
   like Button1Mask, and also LockMask, NumlockMask, and ScrolllockMask */
@@ -54,16 +59,24 @@ guint obt_keyboard_only_modmasks(guint mask);
   right keys when there are both. */
 guint obt_keyboard_modkey_to_modmask(ObtModkeysKey key);
 
-/*! Convert a KeySym to a KeyCode, because the X function is terrible - says
-  valgrind. */
-KeyCode obt_keyboard_keysym_to_keycode(KeySym sym);
+/*! Convert a KeySym to all the KeyCodes which generate it. */
+KeyCode* obt_keyboard_keysym_to_keycode(KeySym sym);
 
-/*! Give the string form of a KeyCode */
-gchar *obt_keyboard_keycode_to_string(guint keycode);
+/*! Translate a KeyPress event to the unicode character it represents */
+gunichar obt_keyboard_keypress_to_unichar(ObtIC *ic, XEvent *ev);
 
-/*! Translate a KeyCode to the unicode character it represents */
-gunichar obt_keyboard_keycode_to_unichar(guint keycode);
+/*! Translate a KeyPress event to the KeySym that it represents.  Use this
+ for control keys, not for getting text input! */
+KeySym obt_keyboard_keypress_to_keysym(XEvent *ev);
+
+/*! Create an input context for a window.
+    @client The top-level client window for the input context.
+    @focus The subwindow within the client for the input context.
+*/
+ObtIC* obt_keyboard_context_new(Window client, Window focus);
 
+void obt_keyboard_context_ref(ObtIC *ic);
+void obt_keyboard_context_unref(ObtIC *ic);
 
 G_END_DECLS