Add swap hands toggle functions (#20381)

master
Albert Y 2023-04-10 00:37:31 +08:00 committed by GitHub
parent 5d6d959421
commit f5b7491883
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 33 additions and 3 deletions

View File

@ -47,6 +47,11 @@ const uint8_t PROGMEM encoder_hand_swap_config[NUM_ENCODERS] = { 1, 0 };
### Functions :id=functions
| Function | Description |
|----------------------|---------------------------------------------|
| `is_swap_hands_on()` | Returns true if Swap-Hands is currently on. |
User callback functions to manipulate Swap-Hands:
| Function | Description |
|-----------------------|---------------------------------------------|
| `swap_hands_on()` | Turns Swap-Hands on. |
| `swap_hands_off()` | Turns Swap-Hands off. |
| `swap_hands_toggle()` | Toggles Swap-Hands. |
| `is_swap_hands_on()` | Returns true if Swap-Hands is currently on. |

View File

@ -165,6 +165,18 @@ void set_swap_hands_state(size_t index, uint8_t *swap_state, bool on) {
}
}
void swap_hands_on(void) {
swap_hands = true;
}
void swap_hands_off(void) {
swap_hands = false;
}
void swap_hands_toggle(void) {
swap_hands = !swap_hands;
}
bool is_swap_hands_on(void) {
return swap_hands;
}

View File

@ -84,6 +84,18 @@ typedef uint32_t swap_state_row_t;
# error "MATRIX_COLS: invalid value"
# endif
/**
* @brief Enable swap hands
*/
void swap_hands_on(void);
/**
* @brief Disable swap hands
*/
void swap_hands_off(void);
/**
* @brief Toggle swap hands enable state
*/
void swap_hands_toggle(void);
/**
* @brief Get the swap hands enable state
*
@ -91,6 +103,7 @@ typedef uint32_t swap_state_row_t;
* @return false
*/
bool is_swap_hands_on(void);
void process_hand_swap(keyevent_t *record);
#endif