summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBen Konrath <ben@bagu.org>2009-11-30 13:28:48 -0500
committerBen Konrath <ben@bagu.org>2009-11-30 13:28:48 -0500
commitc9e49ca26686934e2a76f4d19420b2bff4622844 (patch)
tree9928e306835ea9ea7109c50f371450b9060d9a02
parent057b049defa81fd11bf4076d357bf62e353d844f (diff)
downloadcaribou-c9e49ca26686934e2a76f4d19420b2bff4622844.tar.gz
add better comments to qwerty.py
-rw-r--r--src/qwerty.py24
1 files changed, 19 insertions, 5 deletions
diff --git a/src/qwerty.py b/src/qwerty.py
index ebb3f8d..73b1134 100644
--- a/src/qwerty.py
+++ b/src/qwerty.py
@@ -27,7 +27,12 @@ import keysyms
# TODO ensure keyboard doesn't change size when changing layers
# TODO finish numbers and punctuation layout
-# key format ("label", keysym)
+###############################################################################
+# keys with keysyms - use known keysyms from keysyms.py or used hex code
+# format: ("label", keysym)
+###############################################################################
+
+# backspace
bs = ("⌫", keysyms.backspace)
# enter
en = ("↲", keysyms.enter)
@@ -43,7 +48,11 @@ le = ("←", keysyms.left)
ri = ("→", keysyms.right)
-# define keys to switch layers here
+###############################################################################
+# keys to switch layers
+# format: ("label", "name of layer to switch to")
+###############################################################################
+
# shift up
su = ("⇧", "uppercase")
# shift down
@@ -53,8 +62,10 @@ np = (".?12", "num_punct")
# letters
lt = ("abc", "lowercase")
-
+###############################################################################
# keyboard layouts - put a single utf-8 character or a tuple defined above
+###############################################################################
+
lowercase = ( ("?", "q", "w", "e", "r", "t", "y", "u", "i", "o", "p"),
( np, "a", "s", "d", "f", "g", "h", "j", "k", "l", bs),
( su, "z", "x", "c", "v", "b", "n", "m", sp, ".", en) )
@@ -67,6 +78,9 @@ num_punct = ( ("!", "1", "2", "3", "4", "5", "6", "7", "8", "9", "0"),
( lt, "@", "$", "/", "+", "-", up, "\"", ",", "#", bs),
("'", "(", ")", ";", ":", le, dn, ri, sp, ".", en) )
-# the layout that appears in position 0 will be visible
-# when the keyboard is first created
+###############################################################################
+# list of keyboard layouts - the layout in position 0 will be active when the
+# keyboard is first created
+###############################################################################
+
layouts = ( "lowercase", "uppercase", "num_punct" )