keyboardio/Kaleidoscope-Escape-OneShot

Name: Kaleidoscope-Escape-OneShot

Owner: Keyboardio

Description: Turn the ESC key into one that can also cancel one-shot effects

Created: 2017-01-21 10:09:20.0

Updated: 2018-05-15 05:08:44.0

Pushed: 2018-05-15 05:08:45.0

Homepage: null

Size: 31

Language: C++

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Kaleidoscope-Escape-OneShot

status Build Status

Turn the Esc key into a special key, that can cancel any active OneShot effect - or act as the normal Esc key if none are active. For those times when one accidentally presses a one-shot key, or change their minds.

Using the plugin

To use the plugin, one needs to include the header, and activate it. No further configuration is necessary.

lude <Kaleidoscope.h>
lude <Kaleidoscope-OneShot.h>
lude <Kaleidoscope-Escape-OneShot.h>

IDOSCOPE_INIT_PLUGINS(OneShot,
                      EscapeOneShot);

 setup () {
leidoscope.setup ();

The plugin only makes sense when using one-shot keys.

Plugin methods

The plugin provides the EscapeOneShot object, which has no public methods.

Dependencies
Further reading

Starting from the example is the recommended way of getting started with the plugin.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.