summaryrefslogtreecommitdiffstats
path: root/docs/keycodes.md
diff options
context:
space:
mode:
authorKonstantin Đorđević <vomindoraan@gmail.com>2019-05-03 18:33:00 +0200
committerDrashna Jaelre <drashna@live.com>2019-05-03 18:33:00 +0200
commitbdc8d89e6b8f49528b716d9bd3343a4f9e9327bd (patch)
tree72673090e6ebc1669df953b83213231d7ffb8375 /docs/keycodes.md
parent41beecfc1847bd0039c508753a212fa18f207e3f (diff)
downloadqmk_firmware-bdc8d89e6b8f49528b716d9bd3343a4f9e9327bd.tar.gz
qmk_firmware-bdc8d89e6b8f49528b716d9bd3343a4f9e9327bd.tar.xz
New keycode macro (XP) for shifted character pairs using UNICODEMAP + bug fixes and improvements (#4803)
* Expose unicode_saved_mods * Add UNICODEMAP shift pair functionality and XS keycode * Add XS to keycode reference documentation * Pick pair index based on both Shift and Caps Lock state * Add XS to Unicode feature docs * Clean up process_unicode* headers * Extract unicode_map index calculation into function * Pick pair index as XOR rather than OR of Shift and Caps states * unicode_input_start() has to be called before the unicode_map index is calculated * Replace unicodemap_input_error() with more generic unicode_input_cancel() * Replace register+tap+unregister with tap_code16(LCTL(LSFT(KC_U))) * UNICODE_OSX_KEY → UNICODE_KEY_OSX, UNICODE_WINC_KEY → UNICODE_KEY_WINC * Make keycode range checks more robust * Fix keycode range checks for different input modes * Add UNICODE_KEY_LNX, update docs * QK_UNICODEMAP_SHIFT → QK_UNICODEMAP_PAIR * XS → XP, update docs * Tweak Unicode docs * Use recently added MOD_MASK_SHIFT and IS_HOST_LED_ON helpers * Update Unicode table in docs/keycodes.md * Update Unicode docs per review comments * Replace references to Mac OS X with macOS in Unicode docs * As of v0.9.0, WinCompose supports all possible code points * Expand descriptions in XP docs * Update keycode table and cycling docs * Further expand cycling docs
Diffstat (limited to 'docs/keycodes.md')
-rw-r--r--docs/keycodes.md16
1 files changed, 12 insertions, 4 deletions
diff --git a/docs/keycodes.md b/docs/keycodes.md
index 91578414d..c0e6aa5c6 100644
--- a/docs/keycodes.md
+++ b/docs/keycodes.md
@@ -450,7 +450,15 @@ This is a reference only. Each group of keys links to the page documenting their
## [Unicode Support](feature_unicode.md)
-|Key |Description |
-|-------|---------------------------------------------------------------------------|
-|`UC(c)`|Send Unicode code point `c` (`UNICODE_ENABLE`) |
-|`X(i)` |Send Unicode code point at index `i` in `unicode_map` (`UNICODEMAP_ENABLE`)|
+|Key |Aliases |Description |
+|----------------------|---------|----------------------------------------------------------------|
+|`UC(c)` | |Send Unicode code point `c` |
+|`X(i)` | |Send Unicode code point at index `i` in `unicode_map` |
+|`XP(i, j)` | |Send Unicode code point at index `i`, or `j` if Shift/Caps is on|
+|`UNICODE_MODE_FORWARD`|`UC_MOD` |Cycle through selected input modes |
+|`UNICODE_MODE_REVERSE`|`UC_RMOD`|Cycle through selected input modes in reverse |
+|`UNICODE_MODE_OSX` |`UC_M_OS`|Switch to macOS input |
+|`UNICODE_MODE_LNX` |`UC_M_LN`|Switch to Linux input |
+|`UNICODE_MODE_WIN` |`UC_M_WI`|Switch to Windows input |
+|`UNICODE_MODE_BSD` |`UC_M_BS`|Switch to BSD input (not implemented) |
+|`UNICODE_MODE_WINC` |`UC_M_WC`|Switch to Windows input using WinCompose |