aboutsummaryrefslogtreecommitdiff
path: root/maps
diff options
context:
space:
mode:
Diffstat (limited to 'maps')
-rw-r--r--maps/maps.h13
1 files changed, 10 insertions, 3 deletions
diff --git a/maps/maps.h b/maps/maps.h
index 37497bc..c6e3095 100644
--- a/maps/maps.h
+++ b/maps/maps.h
@@ -3,20 +3,27 @@
*
* Each map is an array where the content of each position is the key value
* associated with the event code (index). An special/unknown key is represented
- * as a dot ('.'). The dot key itself is registered with its own macro (KEY_DOT).
+ * as a dot ('.'). The dot key itself is registered with its own macro, KEY_DOT.
*
* Maps are imported from files named map_XX.h, where XX is the layout code.
*
* Each file declares a char array called map, where the content of each
* position is the key value associated with the event code (index). It also
* defines a function called init_shiftmap that can register any number of shift
- * keys to be parsed when shift or capslock has been pressed.
+ * keys to be parsed when shift or capslock has been pressed, and exit_shiftmap,
+ * that cleans up the map (by default, it just destroys the hashmap used by the
+ * previous function).
*
* For example,
* EVS_SHIFT(KEY_7, "/");
* associates the key of number 7 to the slash character when shift is pressed.
* Yeah, the character associated is a string: this is because of the hashmap
- * implementation, that maps an integer to a (void *).
+ * implementation, [int -> (void *)].
+ *
+ * From version 0.3 up, you can also define how evspy should register AltGr-key
+ * combinations, in keyboard layouts that support it, the same way that with
+ * shift. The functions are [init,exit]_altgrmap. To enable this you should
+ * define the macro EVS_ALTGR_ENABLED somewhere in your map layout file.
*
* By the moment, evspy does not support non-ascii characters.
*