M docs/feature_key_overrides.md => docs/feature_key_overrides.md +6 -8
@@ 150,15 150,13 @@ const key_override_t fn_override = {.trigger_mods = MOD_BIT(KC_RGUI) |
.enabled = NULL};
```
-## Keycodes
+## Keycodes
-You can enable, disable and toggle all key overrides on the fly.
-
-|Keycode |Description |Function Equivalent|
-|----------|---------------------------------|--------|
-|`KEY_OVERRIDE_ON` |Turns on Key Override feature | `key_override_on(void)`|
-|`KEY_OVERRIDE_OFF` |Turns off Key Override feature |`key_override_off(void)`|
-|`KEY_OVERRIDE_TOGGLE` |Toggles Key Override feature on and off |`key_override_toggle(void)`|
+|Keycode |Aliases |Description |
+|------------------------|---------|----------------------|
+|`QK_KEY_OVERRIDE_TOGGLE`|`KO_TOGG`|Toggle key overrides |
+|`QK_KEY_OVERRIDE_ON` |`KO_ON` |Turn on key overrides |
+|`QK_KEY_OVERRIDE_OFF` |`KO_OFF` |Turn off key overrides|
## Reference for `key_override_t`
M quantum/process_keycode/process_key_override.c => quantum/process_keycode/process_key_override.c +3 -3
@@ 406,15 406,15 @@ bool process_key_override(const uint16_t keycode, const keyrecord_t *const recor
if (key_down) {
switch (keycode) {
- case KEY_OVERRIDE_TOGGLE:
+ case QK_KEY_OVERRIDE_TOGGLE:
key_override_toggle();
return false;
- case KEY_OVERRIDE_ON:
+ case QK_KEY_OVERRIDE_ON:
key_override_on();
return false;
- case KEY_OVERRIDE_OFF:
+ case QK_KEY_OVERRIDE_OFF:
key_override_off();
return false;
M quantum/quantum_keycodes.h => quantum/quantum_keycodes.h +8 -3
@@ 513,9 513,9 @@ enum quantum_keycodes {
RGB_MODE_TWINKLE,
// Key Overrides
- KEY_OVERRIDE_TOGGLE,
- KEY_OVERRIDE_ON,
- KEY_OVERRIDE_OFF,
+ QK_KEY_OVERRIDE_TOGGLE,
+ QK_KEY_OVERRIDE_ON,
+ QK_KEY_OVERRIDE_OFF,
// Additional magic key
MAGIC_TOGGLE_GUI,
@@ 852,6 852,11 @@ enum quantum_keycodes {
// Caps Word
#define CW_TOGG QK_CAPS_WORD_TOGGLE
+// Key Overrides
+#define KO_TOGG QK_KEY_OVERRIDE_TOGGLE
+#define KO_ON QK_KEY_OVERRIDE_ON
+#define KO_OFF QK_KEY_OVERRIDE_OFF
+
// Swap Hands
#define SH_T(kc) (QK_SWAP_HANDS | (kc))
#define SH_TG (QK_SWAP_HANDS | OP_SH_TOGGLE)
M quantum/quantum_keycodes_legacy.h => quantum/quantum_keycodes_legacy.h +4 -0
@@ 10,6 10,10 @@
#define CAPSWRD QK_CAPS_WORD_TOGGLE
#define CAPS_WORD QK_CAPS_WORD_TOGGLE
+#define KEY_OVERRIDE_TOGGLE QK_KEY_OVERRIDE_TOGGLE
+#define KEY_OVERRIDE_ON QK_KEY_OVERRIDE_ON
+#define KEY_OVERRIDE_OFF QK_KEY_OVERRIDE_OFF
+
#define PROGRAMMABLE_BUTTON_1 QK_PROGRAMMABLE_BUTTON_1
#define PROGRAMMABLE_BUTTON_2 QK_PROGRAMMABLE_BUTTON_2
#define PROGRAMMABLE_BUTTON_3 QK_PROGRAMMABLE_BUTTON_3