forked from mirrors/qmk_userspace
		
	Deprecate ONESHOT_* keycodes for QK_ONE_SHOT_* (#18844)
		
	* Deprecate `ONESHOT_*` keycodes for `QK_ONE_SHOT_*` * Docs
This commit is contained in:
		
					parent
					
						
							
								1d34f380eb
							
						
					
				
			
			
				commit
				
					
						812001de7f
					
				
			
		
					 4 changed files with 20 additions and 16 deletions
				
			
		| 
						 | 
				
			
			@ -736,13 +736,13 @@ See also: [US ANSI Shifted Symbols](keycodes_us_ansi_shifted.md)
 | 
			
		|||
 | 
			
		||||
See also: [One Shot Keys](one_shot_keys.md)
 | 
			
		||||
 | 
			
		||||
|Key         |Description                       |
 | 
			
		||||
|------------|----------------------------------|
 | 
			
		||||
|`OSM(mod)`  |Hold `mod` for one keypress       |
 | 
			
		||||
|`OSL(layer)`|Switch to `layer` for one keypress|
 | 
			
		||||
|`OS_ON`     |Turns One Shot keys on            |
 | 
			
		||||
|`OS_OFF`    |Turns One Shot keys off           |
 | 
			
		||||
|`OS_TOGG`   |Toggles One Shot keys status      |
 | 
			
		||||
|Key                 |Aliases  |Description                       |
 | 
			
		||||
|--------------------|---------|----------------------------------|
 | 
			
		||||
|`OSM(mod)`          |         |Hold `mod` for one keypress       |
 | 
			
		||||
|`OSL(layer)`        |         |Switch to `layer` for one keypress|
 | 
			
		||||
|`QK_ONE_SHOT_TOGGLE`|`OS_TOGG`|Toggles One Shot keys status      |
 | 
			
		||||
|`QK_ONE_SHOT_ON`    |`OS_ON`  |Turns One Shot keys on            |
 | 
			
		||||
|`QK_ONE_SHOT_OFF`   |`OS_OFF` |Turns One Shot keys off           |
 | 
			
		||||
 | 
			
		||||
## Programmable Button Support :id=programmable-button
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -395,13 +395,13 @@ bool process_record_quantum(keyrecord_t *record) {
 | 
			
		|||
                return false;
 | 
			
		||||
#endif
 | 
			
		||||
#ifndef NO_ACTION_ONESHOT
 | 
			
		||||
            case ONESHOT_TOGGLE:
 | 
			
		||||
            case QK_ONE_SHOT_TOGGLE:
 | 
			
		||||
                oneshot_toggle();
 | 
			
		||||
                break;
 | 
			
		||||
            case ONESHOT_ENABLE:
 | 
			
		||||
            case QK_ONE_SHOT_ON:
 | 
			
		||||
                oneshot_enable();
 | 
			
		||||
                break;
 | 
			
		||||
            case ONESHOT_DISABLE:
 | 
			
		||||
            case QK_ONE_SHOT_OFF:
 | 
			
		||||
                oneshot_disable();
 | 
			
		||||
                break;
 | 
			
		||||
#endif
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -505,9 +505,9 @@ enum quantum_keycodes {
 | 
			
		|||
#define SQ_T(n) (n < SEQUENCER_TRACKS ? SEQUENCER_TRACK_MIN + n : KC_NO)
 | 
			
		||||
 | 
			
		||||
    // One Shot
 | 
			
		||||
    ONESHOT_ENABLE,
 | 
			
		||||
    ONESHOT_DISABLE,
 | 
			
		||||
    ONESHOT_TOGGLE,
 | 
			
		||||
    QK_ONE_SHOT_ON,
 | 
			
		||||
    QK_ONE_SHOT_OFF,
 | 
			
		||||
    QK_ONE_SHOT_TOGGLE,
 | 
			
		||||
 | 
			
		||||
    // RGB underglow/matrix (continued)
 | 
			
		||||
    RGB_MODE_TWINKLE,
 | 
			
		||||
| 
						 | 
				
			
			@ -923,9 +923,9 @@ enum quantum_keycodes {
 | 
			
		|||
#define QK_JOYSTICK_BUTTON_MAX QK_JOYSTICK_BUTTON_31
 | 
			
		||||
 | 
			
		||||
// One Shot aliases
 | 
			
		||||
#define OS_TOGG ONESHOT_TOGGLE
 | 
			
		||||
#define OS_ON ONESHOT_ENABLE
 | 
			
		||||
#define OS_OFF ONESHOT_DISABLE
 | 
			
		||||
#define OS_TOGG QK_ONE_SHOT_TOGGLE
 | 
			
		||||
#define OS_ON QK_ONE_SHOT_ON
 | 
			
		||||
#define OS_OFF QK_ONE_SHOT_OFF
 | 
			
		||||
 | 
			
		||||
// Programmable Button aliases
 | 
			
		||||
#define PB_1 QK_PROGRAMMABLE_BUTTON_1
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -14,6 +14,10 @@
 | 
			
		|||
#define KEY_OVERRIDE_ON QK_KEY_OVERRIDE_ON
 | 
			
		||||
#define KEY_OVERRIDE_OFF QK_KEY_OVERRIDE_OFF
 | 
			
		||||
 | 
			
		||||
#define ONESHOT_ENABLE QK_ONE_SHOT_ON
 | 
			
		||||
#define ONESHOT_DISABLE QK_ONE_SHOT_OFF
 | 
			
		||||
#define ONESHOT_TOGGLE QK_ONE_SHOT_TOGGLE
 | 
			
		||||
 | 
			
		||||
#define PROGRAMMABLE_BUTTON_1 QK_PROGRAMMABLE_BUTTON_1
 | 
			
		||||
#define PROGRAMMABLE_BUTTON_2 QK_PROGRAMMABLE_BUTTON_2
 | 
			
		||||
#define PROGRAMMABLE_BUTTON_3 QK_PROGRAMMABLE_BUTTON_3
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue