summaryrefslogtreecommitdiff
path: root/keyboards/planck/keymaps/ariccb/features/caps_word.h
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/planck/keymaps/ariccb/features/caps_word.h')
-rw-r--r--keyboards/planck/keymaps/ariccb/features/caps_word.h101
1 files changed, 0 insertions, 101 deletions
diff --git a/keyboards/planck/keymaps/ariccb/features/caps_word.h b/keyboards/planck/keymaps/ariccb/features/caps_word.h
deleted file mode 100644
index 523c815157..0000000000
--- a/keyboards/planck/keymaps/ariccb/features/caps_word.h
+++ /dev/null
@@ -1,101 +0,0 @@
-// Copyright 2021-2022 Google LLC
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// https://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-//
-// Caps Word, activated by pressing both shift keys at the same time.
-//
-// This library implements "Caps Word", which is like conventional Caps Lock,
-// but automatically disables itself at the end of the word. This is useful for
-// typing all-caps identifiers like `MOD_MASK_ALT`.
-//
-// Caps Word is activated by pressing the left and right shift keys at the same
-// time. This way you don't need a dedicated key for using Caps Word. I've
-// tested that this works as expected with one-shot mods and Space Cadet Shift.
-// If your shift keys are mod-taps, activate Caps Word by holding both shift
-// mod-tap keys until the tapping term, release them, then begin typing.
-//
-// For full documentation, see
-// https://getreuer.info/posts/keyboards/caps-word
-
-#pragma once
-
-#include QMK_KEYBOARD_H
-
-// Call this function from `process_record_user()` to implement Caps Word.
-bool process_caps_word(uint16_t keycode, keyrecord_t* record);
-
-// Activates or deactivates Caps Word. For instance activate Caps Word with a
-// combo by defining a `COMBO_ACTION` that calls `caps_word_set(true)`:
-//
-// void process_combo_event(uint16_t combo_index, bool pressed) {
-// switch(combo_index) {
-// case CAPS_COMBO:
-// if (pressed) {
-// caps_word_set(true); // Activate Caps Word.
-// }
-// break;
-//
-// // Other combos...
-// }
-// }
-void caps_word_set(bool active);
-
-// Returns whether Caps Word is currently active.
-bool caps_word_get(void);
-
-// An optional callback that gets called when Caps Word turns on or off. This is
-// useful to represent the current Caps Word state, e.g. by setting an LED or
-// playing a sound. In your keymap, define
-//
-// void caps_word_set_user(bool active) {
-// if (active) {
-// // Do something when Caps Word activates.
-// } else {
-// // Do something when Caps Word deactivates.
-// }
-// }
-void caps_word_set_user(bool active);
-
-// An optional callback which is called on every key press while Caps Word is
-// active. When the key should be shifted (that is, a letter key), the callback
-// should call `add_weak_mods(MOD_BIT(KC_LSFT))` to shift the key. The callback
-// also determines whether the key should continue Caps Word. Returning true
-// continues the current "word", while returning false is "word breaking" and
-// deactivates Caps Word. The default callback is
-//
-// bool caps_word_press_user(uint16_t keycode) {
-// switch (keycode) {
-// // Keycodes that continue Caps Word, with shift applied.
-// case KC_A ... KC_Z:
-// add_weak_mods(MOD_BIT(KC_LSFT)); // Apply shift to the next key.
-// return true;
-//
-// // Keycodes that continue Caps Word, without shifting.
-// case KC_1 ... KC_0:
-// case KC_BSPC:
-// case KC_MINS:
-// case KC_UNDS:
-// return true;
-//
-// default:
-// return false; // Deactivate Caps Word.
-// }
-// }
-//
-// To customize, copy the above function into your keymap and add/remove
-// keycodes to the above cases.
-//
-// NOTE: Outside of this callback, you can use `caps_word_set(false)` to
-// deactivate Caps Word.
-bool caps_word_press_user(uint16_t keycode); \ No newline at end of file