@illgrenoble/webx-client 1.8.1 → 1.9.1

package/dist/input/WebXKeyboard.d.ts

@@ -1,4 +1,3 @@
-import { WebXKeyboardModifierState } from './keyboard';
 /**
  * Represents the keyboard input device in the WebX client.
  *
@@ -6,83 +5,14 @@ import { WebXKeyboardModifierState } from './keyboard';
  * and provides methods to interact with the keyboard state.
  */
 export declare class WebXKeyboard {
-    private static _NEXT_ID;
-    /**
-     * All modifiers and their states.
-     */
-    static modifiers: WebXKeyboardModifierState;
-    /**
-     * Set of known platform-specific or browser-specific quirks which must be
-     * accounted for to properly interpret key events, even if the only way to
-     * reliably detect that quirk is to platform/browser-sniff.
-     */
-    static quirks: {
-        /**
-         * Whether keyup events are universally unreliable.
-         */
-        keyupUnreliable: boolean;
-        /**
-         * Whether the Alt key is actually a modifier for typable keys and is
-         * thus never used for keyboard shortcuts.
-         */
-        altIsTypableOnly: boolean;
-        /**
-         * Whether we can rely on receiving a keyup event for the Caps Lock
-         * key.
-         */
-        capsLockKeyupUnreliable: boolean;
-    };
-    private readonly _keyboardId;
-    private readonly _eventMarker;
-    /**
-     * The element to use to provide keyboard events
-     */
-    private readonly _element;
-    /**
-     * The state of every key, indexed by keysym. If a particular key is
-     * pressed, the value of pressed for that keysym will be true. If a key
-     * is not currently pressed, it will not be defined.
-     */
-    private _pressed;
-    /**
-     * The state of every key, indexed by keysym, for strictly those keys whose
-     * status has been indirectly determined through observation of other key
-     * events. If a particular key is implicitly pressed, the value of
-     * implicitlyPressed for that keysym will be true. If a key
-     * is not currently implicitly pressed (the key is not pressed OR the state
-     * of the key is explicitly known), it will not be defined.
-     */
-    private _implicitlyPressed;
-    /**
-     * The last result of calling the onkeydown handler for each key, indexed
-     * by keysym. This is used to prevent/allow default actions for key events,
-     * even when the onkeydown handler cannot be called again because the key
-     * is (theoretically) still pressed.
-     */
-    private _lastKeydownResult;
-    /**
-     * The keysym most recently associated with a given keycode when keydown
-     * fired. This object maps keycodes to keysyms.
-     */
-    private _recentKeysym;
-    /**
-     * Timeout before key repeat starts.
-     */
-    private _keyRepeatTimeout;
-    /**
-     * Interval which presses and releases the last key pressed while that
-     * key is still being held down.
-     */
-    private _keyRepeatInterval;
-    private _events;
-    private _keyDownHandler;
-    private _keyPressHandler;
-    private _keyUpHandler;
-    get pressed(): {
-        [index: number]: boolean;
-    };
+    private _keyboard;
+    private _onKeyDown;
+    private _onKeyUp;
+    set onKeyDown(onKeyDown: (key: any) => void);
+    set onKeyUp(onKeyUp: (key: any) => void);
     /**
      * Constructs a new WebXKeyboard instance.
+     * This creates a Guacamole.Keyboard instance and attaches event listeners.
      *
      * @param element The HTML element to attach the keyboard events to.
      */
@@ -92,174 +22,22 @@ export declare class WebXKeyboard {
      */
     dispose(): void;
     /**
-     * Set quirk flags depending on platform/browser, if such information is available
-     */
-    private _handleQuirks;
-    /**
-     * Adds a keyboard event to the internal event queue.
-     *
-     * @param event The keyboard event to add.
-     */
-    private _addEvent;
-    /**
-     * Bind the keyboard listeners to the given element
-     */
-    private _bindListeners;
-    /**
-     * Unbinds the keyboard listeners from the associated element.
-     */
-    private _unbindListeners;
-    /**
-     * Handles the keydown event by interpreting and processing it.
-     *
-     * @param event The keyboard event to handle.
-     */
-    private _bindKeyDownListener;
-    /**
-     * Handles the keypress event by interpreting and processing it.
-     *
-     * @param event The keyboard event to handle.
-     */
-    private _bindKeyPressListener;
-    /**
-     * Handles the keyup event by interpreting and processing it.
-     *
-     * @param event The keyboard event to handle.
-     */
-    private _bindKeyUpListener;
-    /**
-     * Returns the keyboard location of the key associated with the given
-     * keyboard event. The location differentiates key events which otherwise
-     * have the same keycode, such as left shift vs. right shift.
-     *
-     * @param event A JavaScript keyboard event, as received through the DOM via a "keydown", "keyup", or "keypress" handler.
-     *
-     * @returns {number}
-     *     The location of the key event on the keyboard, as defined at:
-     *     http://www.w3.org/TR/DOM-Level-3-Events/#events-KeyboardEvent
-     */
-    private static _getEventLocation;
-    /**
-     * Attempts to mark the given Event as having been handled by this
-     * keyboard. If the Event has already been marked as handled,
-     * false is returned.
-     *
-     * @param event The Event to mark.
-     * @returns true if the given Event was successfully marked, false if the given
-     *     Event was already marked.
-     */
-    private _markEvent;
-    /**
-     * Reads through the event log, removing events from the head of the log
-     * when the corresponding true key presses are known (or as known as they
-     * can be).
-     *
-     */
-    private _interpretEvents;
-    /**
-     * Reads through the event log, interpreting the first event, if possible,
-     * and returning that event. If no events can be interpreted, due to a
-     * total lack of events or the need for more events, null is returned. Any
-     * interpreted events are automatically removed from the log.
-     *
-     * The first key event in the log, if it can be interpreted, or null
-     * otherwise.
-     */
-    private _interpretEvent;
-    /**
-     * Releases Ctrl+Alt, if both are currently pressed and the given keysym
-     * looks like a key that may require AltGr.
-     *
-     * @param keysym The key that was just pressed.
-     */
-    private _releaseSimulatedAltgr;
-    /**
-     * Returns whether all currently pressed keys were implicitly pressed. A
-     * key is implicitly pressed if its status was inferred indirectly from
-     * inspection of other key events.
-     *
-     * @returns {boolean}
-     *     true if all currently pressed keys were implicitly pressed, false
-     *     otherwise.
-     */
-    private _isStateImplicit;
-    /**
-     * Check if a key is implicitly pressed
-     * @param keysym the keysym to check
-     */
-    private _isImplicitlyPressed;
-    /**
-     * Given a keyboard event, updates the local modifier state and remote
-     * key state based on the modifier flags within the event. This function
-     * pays no attention to keycodes.
-     *
-     * @param event The keyboard event containing the flags to update.
-     *
-     * @param keyEvent Current best interpretation of the key event being processed.
-     */
-    private _syncModifierStates;
-    /**
-     * Given the remote and local state of a particular key, resynchronises the
-     * remote state of that key with the local state through pressing or
-     * releasing keysyms.
-     *
-     * @param remoteState Whether the key is currently pressed remotely.
-     * @param localState  Whether the key is currently pressed locally. If the state
-     *                    of the key is not known, this may be undefined.
-     * @param keysyms     The keysyms which represent the key being updated.
-     * @param keyEvent    Best interpretation of the key event being processed.
-     */
-    private _updateModifierState;
-    /**
-     * Handle keydown event
-     * @param keysym the key symbol
-     */
-    private _handleKeyDown;
-    /**
-     * Clears the timers used for key repeat functionality.
-     */
-    private _clearKeyRepeatTimers;
-    /**
-     * Checks if a key is currently pressed.
-     *
-     * @param keysym The keysym of the key to check.
-     * @returns true if the key is pressed, false otherwise.
-     */
-    private _isKeyPressed;
-    /**
-     * Resets the state of this keyboard
+     * Resets the keyboard state.
+     * This clears any pressed keys and resets the keyboard to its initial state.
      */
     reset(): void;
-    /**
-     * Presses and releases the keys necessary to tpe the given string of characters
-     * @param message the string to type
-     */
-    type(message: string): void;
-    /**
-     * Marks a key as pressed, firing the keydown event if registered. Key repeat for the pressed
-     * key will start after a delay if that key is not a modifier.
-     * The return value of this function depends on the return value of the keydown event handler, if any.
-     * @param keysym the keysym of the key to press
-     * @return {boolean} true if event should not be canceled, false otherwise.
-     */
-    press(keysym: number): boolean;
-    /**
-     * Marks a key as released, firing the keyup event if registered
-     * @param keysym the keysym of the key to release.
-     */
-    release(keysym: number): void;
     /**
      * Fired whenever the user presses a key with the element associated
      * with this keyboard in focus.
      *
      * @param key The key being pressed
      */
-    onKeyDown: (key: any) => void;
+    private onKeyDownHandler;
     /**
      * Fired whenever the user releases a key with the element associated
      * with this keyboard in focus.
      *
      * @param key The key being released
      */
-    onKeyUp: (key: any) => void;
+    private onKeyUpHandler;
 }