chromex.app.virtual-keyboard-private — binaryage/chromex 0.9.1

clj

• available since Chrome 35

api-table clj

gen-call clj

gen-wrap clj/s macro

(gen-wrap kind item-id config & args)

get-keyboard-config clj/s macro

(get-keyboard-config)

Gets the virtual keyboard configuration.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [config] where:

|config| - ?

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

get-keyboard-config* cljs

(get-keyboard-config* config)

hide-keyboard clj/s macro

(hide-keyboard)

Hides the virtual keyboard.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [].

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

hide-keyboard* cljs

(hide-keyboard* config)

insert-text clj/s macro

(insert-text text)

Inserts text into the currently focused text field.

|text| - The text that will be inserted.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [].

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

insert-text* cljs

(insert-text* config text)

keyboard-loaded clj/s macro

(keyboard-loaded)

Inform the system that the keyboard has loaded.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [].

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

keyboard-loaded* cljs

(keyboard-loaded* config)

lock-keyboard clj/s macro

(lock-keyboard lock)

Sets the lock state of the virtual keyboard. A locked keyboard remains visible even after a text area loses input focus.

|lock| - ?

lock-keyboard* cljs

(lock-keyboard* config lock)

on-bounds-changed* cljs

(on-bounds-changed* config channel & args)

on-keyboard-closed* cljs

(on-keyboard-closed* config channel & args)

on-keyboard-config-changed* cljs

(on-keyboard-config-changed* config channel & args)

open-settings clj/s macro

(open-settings)

Opens chrome://settings/languages page.

open-settings* cljs

(open-settings* config)

send-key-event clj/s macro

(send-key-event key-event)

Sends a fabricated key event to the focused input field.

|key-event| - ?

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [].

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

send-key-event* cljs

(send-key-event* config key-event)

set-area-to-remain-on-screen clj/s macro

(set-area-to-remain-on-screen bounds)

Sets the area of the keyboard window that should not move off screen. Any area outside of this can be moved off the user's screen.

|bounds| - The bounds of the area inside the keyboard window, relative to the window origin, that should not be moved off screen. Any area outside of this bounds can be moved off screen.

set-area-to-remain-on-screen* cljs

(set-area-to-remain-on-screen* config bounds)

set-container-behavior clj/s macro

(set-container-behavior options)

Sets the virtual keyboard container behavior

|options| - Optional parameters for new container behavior.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [success] where:

|success| - Whether the container mode changed successfully

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

set-container-behavior* cljs

(set-container-behavior* config options)

set-draggable-area clj/s macro

(set-draggable-area bounds)

Sets the virtual keyboard draggable area bounds.

|bounds| - The value of draggable rect area of floating keyboard.

set-draggable-area* cljs

(set-draggable-area* config bounds)

set-hit-test-bounds clj/s macro

(set-hit-test-bounds bounds-list)

Sets the areas on the keyboard window where events are handled. Any event outside of these areas are passed on to the window behind it.

|bounds-list| - List of rectangles representing regions where events targeting the keyboard should be handled.

set-hit-test-bounds* cljs

(set-hit-test-bounds* config bounds-list)

set-hotrod-keyboard clj/s macro

(set-hotrod-keyboard enable)

Sets the state of the hotrod virtual keyboard. This API should only be used by hotrod.

|enable| - ?

set-hotrod-keyboard* cljs

(set-hotrod-keyboard* config enable)

set-keyboard-state clj/s macro

(set-keyboard-state state)

Requests the virtual keyboard to change state.

|state| - The value of the virtual keyboard state to change to.

set-keyboard-state* cljs

(set-keyboard-state* config state)

set-occluded-bounds clj/s macro

(set-occluded-bounds bounds-list)

Sets the areas on the screen that are blocked by the virtual keyboard.

|bounds-list| - List of rectangles representing regions occluded by the keyboard.

set-occluded-bounds* cljs

(set-occluded-bounds* config bounds-list)

set-window-bounds-in-screen clj/s macro

(set-window-bounds-in-screen bounds)

Sets the bounds of the keyboard window in screen coordinates.

|bounds| - A rectangle defining the new bounds of the window in screen coordinates.

set-window-bounds-in-screen* cljs

(set-window-bounds-in-screen* config bounds)

tap-all-events clj/s macro

(tap-all-events chan)

Taps all valid non-deprecated events in chromex.app.virtual-keyboard-private namespace.

tap-on-bounds-changed-events clj/s macro

(tap-on-bounds-changed-events channel & args)

This event is sent when virtual keyboard bounds changed and overscroll/resize is enabled.

Events will be put on the |channel| with signature [::on-bounds-changed [bounds]] where:

|bounds| - The virtual keyboard bounds

Note: |args| will be passed as additional parameters into Chrome event's .addListener call.

tap-on-keyboard-closed-events clj/s macro

(tap-on-keyboard-closed-events channel & args)

Fired when the virtual keyboard window has been closed. For example, this can happen when turning off on-screen keyboard or exiting tablet mode.

Events will be put on the |channel| with signature [::on-keyboard-closed []].

Note: |args| will be passed as additional parameters into Chrome event's .addListener call.

tap-on-keyboard-config-changed-events clj/s macro

(tap-on-keyboard-config-changed-events channel & args)

Fired when a configuration for virtual keyboard IME has changed, e.g. auto complete disabled.

Events will be put on the |channel| with signature [::on-keyboard-config-changed [config]] where:

|config| - The virtual keyboard config

Note: |args| will be passed as additional parameters into Chrome event's .addListener call.