qmk_firmware

QMK firmware for my keyboards (Corne, Sweep Ferris) and trackball (Ploopy Adept)
Log | Files | Refs | Submodules | LICENSE

process_caps_word.h (1301B)


      1 // Copyright 2021-2022 Google LLC
      2 //
      3 // Licensed under the Apache License, Version 2.0 (the "License");
      4 // you may not use this file except in compliance with the License.
      5 // You may obtain a copy of the License at
      6 //
      7 //     https://www.apache.org/licenses/LICENSE-2.0
      8 //
      9 // Unless required by applicable law or agreed to in writing, software
     10 // distributed under the License is distributed on an "AS IS" BASIS,
     11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     12 // See the License for the specific language governing permissions and
     13 // limitations under the License.
     14 
     15 #pragma once
     16 
     17 #include <stdint.h>
     18 #include <stdbool.h>
     19 #include "action.h"
     20 
     21 /**
     22  * @brief Process handler for Caps Word feature.
     23  *
     24  * @param keycode  Keycode registered by matrix press, per keymap
     25  * @param record   keyrecord_t structure
     26  * @return true    Continue processing keycodes, and send to host
     27  * @return false   Stop processing keycodes, and don't send to host
     28  */
     29 bool process_caps_word(uint16_t keycode, keyrecord_t* record);
     30 
     31 /**
     32  * @brief Weak function for user-level Caps Word press modification.
     33  *
     34  * @param keycode   Keycode registered by matrix press, per keymap
     35  * @return true     Continue Caps Word
     36  * @return false    Stop Caps Word
     37  */
     38 bool caps_word_press_user(uint16_t keycode);