mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-07 09:25:33 +00:00
62796e3489
Fixes #3620. Implements the Caps Lock layer support and the double-tap gesture on the shift key to access it. The double-tap gesture has been implemented with a view to extension to support other multi-tap gestures in the future. However, for now, it is limited to supporting the Shift key, if and only if the keyboard includes a Caps layer. The reason for this v15 limitation is that multi-tap on regular keys would involve either rewinding the previous keystroke (the first tap), or forcing keyboard developers to consider 'rota' style rules in their keyboards to support the multi-tap gestures, as we need to make sure that the first tap is accepted and processed for immediate feedback. This needs more design, to avoid unnecessary complexity in the keyboards and/or the rewinding of the keystroke (even though that is conceptually supported in Keyman Engine for Web already). Basically, we don't want to constrain the way that a keyboard author may use the multi-tap gesture by hard-coding the rewind, but neither do we want to make all multi-tap gestures needlessly complex to author. The shift key (and other modifiers, potentially in future) needs special support for multi-tap as the key that is being tapped changes with the layer change. This is currently managed through recognising `K_SHIFT` in the key id. I have tried to follow the `PendingGesture` pattern for multi-tap, and the gesture itself supports a series of taps, not just a double-tap. The maximum time to complete the tap series is 125msec * number-of-taps, so for a double-tap is 250msec. The changes to support a Caps Lock layer itself were minimal; just adding the `text.KeyboardProcessor.getStateFromLayer` function and calling it during `KeyEvent` construction. The remaining changes relate to the multi-tap gesture. Minor changes: * I moved `constructNullKeyEvent` to `KeyEvent` in order to make it more accessible to other classes. * The multi-tap gesture does not have a promise to complete, so that is now an optional member of the `PendingGesture` interface.
45 lines
No EOL
2 KiB
TypeScript
45 lines
No EOL
2 KiB
TypeScript
namespace com.keyman.osk {
|
|
/**
|
|
* Used for evaluating potential gestures. Classes adhering to this interface
|
|
* should be instantiated whenever the (implied) state-machine allows a new
|
|
* touch event to mark the start of a potential new gesture.
|
|
*
|
|
* For example, whenever a user touches a base key and there are no "realized"
|
|
* (fully-completed, but as-of-yet unresolved) gestures, that state allows the
|
|
* start of a potential new longpress event.
|
|
*
|
|
* The role of the `PendingGesture` is complete whenever all touch-events and
|
|
* conditions necessary for a modeled gesture have been met. As this point,
|
|
* it should be `resolve`d, fulfilling its `promise`. This results in a
|
|
* `RealizedGesture` appropriate for the gesture type that is used to obtain
|
|
* the final `KeyEvent` for the overall gesture sequence.
|
|
*
|
|
* For example, a "longpress" is considered resolved once the user has maintained
|
|
* an active, stationary touch point on the same key for a sufficiently long
|
|
* period without releasing it.
|
|
* * Were it released earlier, that would result in selection of a base key.
|
|
*
|
|
* Alternatively, a "flick" might be considered resolved if:
|
|
* * a user has rapidly moved a touch point in a consistent direction
|
|
* * for a long enough distance
|
|
* * and _then_ releases that touch point within a short timeframe.
|
|
*
|
|
* The pending gesture should only `resolve` to a realized gesture once
|
|
* _all_ such conditions are met, confirming that this specific gesture,
|
|
* and _only_ this specific gesture, could have resulted from the active
|
|
* touch sequence.
|
|
*
|
|
* The `RealizedGesture` that results and is 'returned' via the Promise will
|
|
* be handled by the `VisualKeyboard` class, which will retrieve and forward
|
|
* any `KeyEvent` that results from the overall gesture input sequence.
|
|
*
|
|
* @see `RealizedGesture`
|
|
*/
|
|
export interface PendingGesture {
|
|
readonly baseKey: KeyElement;
|
|
readonly promise?: Promise<RealizedGesture>;
|
|
|
|
cancel(): void;
|
|
resolve?(): void;
|
|
}
|
|
} |