sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Use return value of pre-press/pre-release callbacks

Browse Source 
When the return value evaluates to False, the key press or key
release is ignored. This allows for implementation of elaborate
keyboard behaviors.
This commit is contained in:
Elvis Pfützenreuter 2019-04-26 11:21:12 -03:00
parent b494857f21
commit 9c4a136989
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
kmk/keys.py
View File

@ -60,7 +60,8 @@ class Key:
def _on_press(self, state, coord_int, coord_raw): def _on_press(self, state, coord_int, coord_raw):
for fn in self._pre_press_handlers: for fn in self._pre_press_handlers:
fn(self, state, KC, coord_int, coord_raw) if not fn(self, state, KC, coord_int, coord_raw):
return None
ret = self._handle_press(self, state, KC, coord_int, coord_raw) ret = self._handle_press(self, state, KC, coord_int, coord_raw)
@ -71,7 +72,8 @@ class Key:
def _on_release(self, state, coord_int, coord_raw): def _on_release(self, state, coord_int, coord_raw):
for fn in self._pre_release_handlers: for fn in self._pre_release_handlers:
fn(self, state, KC, coord_int, coord_raw) if not fn(self, state, KC, coord_int, coord_raw):
return None
ret = self._handle_release(self, state, KC, coord_int, coord_raw) ret = self._handle_release(self, state, KC, coord_int, coord_raw)
@ -110,8 +112,9 @@ class Key:
provided for consistency with the internal handlers) provided for consistency with the internal handlers)
- coord_raw (an X,Y tuple of the matrix coordinate - also likely not useful) - coord_raw (an X,Y tuple of the matrix coordinate - also likely not useful)
The return value of the provided callback is discarded. Exceptions are _not_ If return value of the provided callback is evaluated to False, press
caught, and will likely crash KMK if not handled within your function. processing is cancelled. Exceptions are _not_ caught, and will likely
crash KMK if not handled within your function.
These handlers are run in attachment order: handlers provided by earlier These handlers are run in attachment order: handlers provided by earlier
calls of this method will be executed before those provided by later calls. calls of this method will be executed before those provided by later calls.
@ -156,8 +159,9 @@ class Key:
provided for consistency with the internal handlers) provided for consistency with the internal handlers)
- coord_raw (an X,Y tuple of the matrix coordinate - also likely not useful) - coord_raw (an X,Y tuple of the matrix coordinate - also likely not useful)
The return value of the provided callback is discarded. Exceptions are _not_ If return value of the provided callback evaluates to False, the release
caught, and will likely crash KMK if not handled within your function. processing is cancelled. Exceptions are _not_ caught, and will likely crash
KMK if not handled within your function.
These handlers are run in attachment order: handlers provided by earlier These handlers are run in attachment order: handlers provided by earlier
calls of this method will be executed before those provided by later calls. calls of this method will be executed before those provided by later calls.