diff options
author | Joshua Diamond <josh@windowoffire.com> | 2022-08-31 19:39:16 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-08-31 16:39:16 -0700 |
commit | e4bf8323688b56cd5fc0f4f27c531f3406d40f6d (patch) | |
tree | 7a94a4e85177d12b4f5561969214094943da111b /docs | |
parent | b9effc94db6011e226a7a1f410214eca9666734f (diff) |
Add unicode mode change callbacks (#18235)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/feature_unicode.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/feature_unicode.md b/docs/feature_unicode.md index 2389cb735c..94873d2827 100644 --- a/docs/feature_unicode.md +++ b/docs/feature_unicode.md @@ -206,6 +206,17 @@ The functions for starting and finishing Unicode input on your platform can be o You can find the default implementations of these functions in [`process_unicode_common.c`](https://github.com/qmk/qmk_firmware/blob/master/quantum/process_keycode/process_unicode_common.c). +### Input Mode Callbacks + +There are callbacks functions available that are called whenever the unicode input mode changes. The new input mode is passed to the function. + +|Callback |Description | +|---------------------------------------------------|-----------------------------------------------------| +| `unicode_input_mode_set_kb(uint8_t input_mode)` | Callback for unicode input mode set, for keyboard. | +| `unicode_input_mode_set_user(uint8_t input_mode)` | Callback for unicode input mode set, for users. | + +This feature can be used, for instance, to implement LED indicators for the current unicode input mode. + ### Input Key Configuration You can customize the keys used to trigger Unicode input for macOS, Linux and WinCompose by adding corresponding defines to your `config.h`. The default values match the platforms' default settings, so you shouldn't need to change this unless Unicode input isn't working, or you want to use a different key (e.g. in order to free up left or right Alt). |