Types & classes — github.com/TyberiusPrime/KeyToKey

CodeHub MCPcopy Create free account

hub / github.com/TyberiusPrime/KeyToKey / types & classes

Types & classes53 in github.com/TyberiusPrime/KeyToKey

⨍ Functions 160◇ Types & classes 53

InterfaceAcceptsKeycode

Trait for things that can be converted to a u32 keycode ie. various integers and (usb) KeyCodes themselves

src/key_codes.rs:345

InterfaceAction

A callback used when one single action is needed examples: Leader invocations. Notably implemented on &str, so you can just pass in a &str to be sen

src/handlers/mod.rs:58

ClassActionAbort

src/premade.rs:288

ClassActionHandler

Enable/disable handler (layer) on activation/deactivation for use with PressRelease, StickyKeys, OneShot, SpaceCadet Can also be used with Modifier::

src/premade.rs:89

ClassActionNone

Abort all event handling, throw away remaining events, unset all modifiers and enable/disable handers as requested by handler_overwrite

src/premade.rs:283

ClassActionToggleHandler

toggle a handler on activate do noting on deactivate probably only usefull with PressReleaseMacro used by toggle_handler()

src/premade.rs:12

src/handlers/layer.rs:20

Shift keys if they're pressend beyond threshold_ms supposedly for RSI sufferers - this implementation has not been used in daily usage yet.

src/handlers/autoshift.rs:11

InterfaceChecks

src/test_helpers.rs:169

Handler for turing Copy/Paste/Cut Keycodes into 'universal' Ctrl-Insert, Shift-insert, shift-delete keystrokes for dedicated copy paste keys 0

src/premade.rs:238

ClassDebugStream

Debug a keystream at any point in the handling by adding a DebugStream with a callback that knows how to write something. Omits Timeout Events, does

src/handlers/debug_handlers.rs:81

src/test_helpers.rs:147

src/key_stream.rs:26

EnumEventStatus

src/key_stream.rs:32

EnumHandlerResult

src/handlers/mod.rs:45

ClassInverseActionHandler

Disable/enable handler (layer) on activation/deactivation for use with PressRelease, StickyKeys, OneShot, SpaceCadet Can also be used with Modifier::

src/premade.rs:111

src/key_stream.rs:3

src/key_codes.rs:10

InterfaceKeyCodeInfo

src/key_codes.rs:382

ClassKeyOutCatcher

src/test_helpers.rs:11

the main keyboard struct add handlers wit add_handler, then call add_keypress/add_key_release/add_timeout to start processing keys.

ClassKeyboardState

A layer either rewrites a key to another one or outputs a string upon key release. It does this for multiple mappings at once, and it can consider th

src/handlers/layer.rs:46

EnumLayerAction

src/handlers/layer.rs:9

src/handlers/longtap.rs:85

Handler that does one thing on a short tab, and another on a long tab with a configurable threshold Action happens on release Note that this is a si

src/handlers/longtap.rs:16

src/handlers/oneshot.rs:386

InterfaceNonLayerAction

an Action For example by a leader sequence or a tap dance. Contrast with LayerAction which is a superset of Action Notably implemented on &str, so y

src/handlers/mod.rs:106

A trait for callbacks when an on/off action is needed Used by PressReleaseMacros, StickyMacros, OneShots see PressReleaseMacro, StickyMacro

src/handlers/mod.rs:92

A OneShot key. Press it, on_activate will be called. on_deactivate will be called after the next non-oneshot key release or if the OneShot trigger is

src/handlers/oneshot.rs:39

EnumOneShotStatus

src/handlers/oneshot.rs:10

ClassPressCounter

src/test_helpers.rs:122

ClassPressMacro

The simplest callback - call on_trigger on press, nothing on release trigger may be any keycode, but consider using the constants in UserKey:: which i

src/handlers/macros.rs:13

ClassPressReleaseMacro

A simple callback - call on_press(output: impl USBKeyOut) on key press and on_release(output) on release)) trigger may be any keycode, but consider us

src/handlers/macros.rs:56

InterfaceProcessKeys

Handlers are defined by this trait they process the events, set their status to either Handled or Ignored (if more data is necessary), and send input

src/handlers/mod.rs:36

ClassRewriteLayer

A layer that *only* supports replacing key codes with other key codes. The advantage of this is that you can/must use it with a const array (slice),

src/handlers/rewrite_layer.rs:14

A sequence is a series of keystrokes (press and release) that upon finish (ie. the release of the last key) sends first a (configurable) number of bac

src/handlers/sequence.rs:25

src/handlers/longtap.rs:84

ClassSpaceCadet

SpaceCadet Keys are keys that do one Action on tap, and an OnOff if depressed while the next key is pressed. There is a minimum time the key needs to

src/handlers/spacecadet.rs:37

EnumSpaceCadetState

src/handlers/spacecadet.rs:9

ClassStickyMacro

a macro that is called 'on' on the the first keypress and off on the second keyrelease. Using this you can implement e.g. sticky modifiers

src/handlers/macros.rs:95

Depending on how often a key has ben pressed repeatedly (within a timeout), do different things. You will need to implement a TapDanceAction

src/handlers/tapdance.rs:22

InterfaceTapDanceAction

call backs for completed tap dances

src/handlers/tapdance.rs:13

EnumTapDanceEnd

src/handlers/tapdance.rs:7

ClassTapDanceLogger

src/handlers/tapdance.rs:90

ClassTimeoutLogger

send a key whenever a time out occurs

src/test_helpers.rs:93

ClassTranslationHelper

this handler helps you build a translation table for MatrixToStream by outputing the keycode observed as .into()<Enter>Hex-Keycode\tKeyCode:: so you c

src/handlers/debug_handlers.rs:50

InterfaceUSBKeyOut

the handlers use this trait to generate their output

ClassUSBKeyboard

src/handlers/usbkeyboard.rs:18

ClassUnicodeKeyboard

src/handlers/unicodekeyboard.rs:14

EnumUnicodeSendMode

src/key_codes.rs:233