qmk_keymaps/keyboards/crkbd/keymaps/sajenim/features/select_word.h

67 lines
2 KiB
C
Raw Normal View History

2024-03-14 23:25:39 +08:00
// Copyright 2021-2023 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.
/**
* @file select_word.h
* @brief Select word/line macro.
*
* Overview
* --------
*
* Implements a button that selects the current word, assuming conventional text
* editor hotkeys. Pressing it again extends the selection to the following
* word. The effect is similar to word selection (W) in the Kakoune editor.
*
* Pressing the button with shift selects the current line, and pressing the
* button again extends the selection to the following line.
*
* @note Note for Mac users: Windows/Linux editing hotkeys are assumed by
* default. Uncomment the `#define MAC_HOTKEYS` line in select_word.c for Mac
* hotkeys. The Mac implementation is untested, let me know if it has problems.
*
* For full documentation, see
* <https://getreuer.info/posts/keyboards/select-word>
*/
#pragma once
#include "quantum.h"
#ifdef __cplusplus
extern "C" {
#endif
/** Handler function for select word. */
bool process_select_word(uint16_t keycode, keyrecord_t* record,
uint16_t sel_keycode);
/**
* @fn select_word_task(void)
* Matrix task function for Select Word.
*
* If using `SELECT_WORD_TIMEOUT`, call this function from your
* `matrix_scan_user()` function in keymap.c. (If no timeout is set, calling
* `select_word_task()` has no effect.)
*/
#if SELECT_WORD_TIMEOUT > 0
void select_word_task(void);
#else
static inline void select_word_task(void) {}
#endif // SELECT_WORD_TIMEOUT > 0
#ifdef __cplusplus
}
#endif