Diffstat (limited to 'README')
1 files changed, 42 insertions, 3 deletions
@@ -1,6 +1,6 @@
-Keyboard-python is a simple module for parsing keyboard input.
-It is useful because it can tell you keypresses without the need
-for the Enter key to be pressed and can parse the following:
+Keyboard-python is a simple module for parsing keyboard input. It is useful
+because it can tell you keypresses without the need for the Enter key to be
+pressed and can parse the following:
@@ -14,6 +14,45 @@ Escape
Alt modified keys
Ctrl modified keys
+ Takes a string name.
+ Takes either instances of Key or strings which are given to new Key
+ instances as a name. If given only one Key it is considered
+ equivelent to that Key, e.g. KeyCombination('j') == Key('j') is true
+ return boolean determined by whether key is in the combination of
+ add copy of key to the combination of self
+ for each key in the instance given as an argument, add that key to
+ if the combination includes a key which shares a name with the key
+ given to the function then remove it from the combination
+ return a list of copies of keys that appear in exactly one of self
+ and the argument given
+ waits for keypress and returns returns KeyCombination containing all
+ keys pressed.
+ takes a Queue q, a mutable with boolean value signal. While signal is
+ true it listens for keypresses putting them in q.