chromex.ext.input-method-private — binaryage/chromex 0.6.5

clj

• available since Chrome 27

add-word-to-dictionary clj/s macro

(add-word-to-dictionary word)

Adds a single word to be stored in the dictionary.

|word| - A new word to add to the dictionary.

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.

add-word-to-dictionary* cljs

(add-word-to-dictionary* config word)

api-table clj

fetch-all-dictionary-words clj/s macro

(fetch-all-dictionary-words)

Fetches a list of all the words currently in the dictionary.

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 [words] where:

|words| - List of dictionary words.

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.

fetch-all-dictionary-words* cljs

(fetch-all-dictionary-words* config)

gen-call clj

gen-wrap clj/s macro

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

get-composition-bounds clj/s macro

(get-composition-bounds)

Gets the composition bounds

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 [bounds-list] where:

|bounds-list| - List of bounds information.

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-composition-bounds* cljs

(get-composition-bounds* config)

get-current-input-method clj/s macro

(get-current-input-method)

Gets the current input method.

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 [input-method-id] where:

|input-method-id| - Current input method.

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-current-input-method* cljs

(get-current-input-method* config)

get-encrypt-sync-enabled clj/s macro

(get-encrypt-sync-enabled)

Gets whether the encrypt sync is enabled.

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 [enabled] where:

|enabled| - The result of whether enabled.

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-encrypt-sync-enabled* cljs

(get-encrypt-sync-enabled* config)

get-input-method-config clj/s macro

(get-input-method-config)

Gets configurations for input methods.

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| - The input method config object.

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-input-method-config* cljs

(get-input-method-config* config)

get-input-methods clj/s macro

(get-input-methods)

Gets all whitelisted input methods.

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 [input-methods] where:

|input-methods| - Whitelisted input method objects.

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-input-methods* cljs

(get-input-methods* config)

get-surrounding-text clj/s macro

(get-surrounding-text before-length after-length)

Gets the surrounding text of the current selection

|before-length| - The number of characters before the current selection. |after-length| - The number of characters after the current selection.

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 [surrounding-info] where:

|surrounding-info| - The surrouding text info.

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-surrounding-text* cljs

(get-surrounding-text* config before-length after-length)

notify-ime-menu-item-activated clj/s macro

(notify-ime-menu-item-activated engine-id name)

Fires the input.ime.onMenuItemActivated event.

|engine-id| - ID of the engine to use. |name| - Name of the MenuItem which was activated

notify-ime-menu-item-activated* cljs

(notify-ime-menu-item-activated* config engine-id name)

on-changed* cljs

(on-changed* config channel & args)

on-composition-bounds-changed* cljs

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

on-dictionary-changed* cljs

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

on-dictionary-loaded* cljs

(on-dictionary-loaded* config channel & args)

on-focus* cljs

(on-focus* config channel & args)

on-ime-menu-activation-changed* cljs

(on-ime-menu-activation-changed* config channel & args)

on-ime-menu-items-changed* cljs

(on-ime-menu-items-changed* config channel & args)

on-ime-menu-list-changed* cljs

(on-ime-menu-list-changed* config channel & args)

open-options-page clj/s macro

(open-options-page input-method-id)

Opens the options page for the input method extension. If the input method does not have options, this function will do nothing.

|input-method-id| - ID of the input method to open options for.

open-options-page* cljs

(open-options-page* config input-method-id)

set-current-input-method clj/s macro

(set-current-input-method input-method-id)

Sets the current input method.

|input-method-id| - The input method ID to be set as current input method.

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.

set-current-input-method* cljs

(set-current-input-method* config input-method-id)

set-xkb-layout clj/s macro

(set-xkb-layout xkb-name)

Sets the XKB layout for the given input method.

|xkb-name| - The XKB layout name.

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.

set-xkb-layout* cljs

(set-xkb-layout* config xkb-name)

show-input-view clj/s macro

(show-input-view)

Shows the input view window. If the input view window is already shown, this function will do nothing.

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.

show-input-view* cljs

(show-input-view* config)

tap-all-events clj/s macro

(tap-all-events chan)

Taps all valid non-deprecated events in chromex.ext.input-method-private namespace.

tap-on-changed-events clj/s macro

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

Fired when the input method is changed.

Events will be put on the |channel| with signature [::on-changed [new-input-method-id]] where:

|new-input-method-id| - New input method which is being used.

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

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

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

Fired when the composition bounds or cursor bounds are changed.

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

|first-bounds| - The bounds information for the first character in composition. |bounds-list| - List of bounds information.

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

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

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

Fired when words are added or removed from the custom spelling dictionary.

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

|added| - List of added words. |removed| - List of removed words.

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

tap-on-dictionary-loaded-events clj/s macro

(tap-on-dictionary-loaded-events channel & args)

Fired when the custom spelling dictionary is loaded.

Events will be put on the |channel| with signature [::on-dictionary-loaded []].

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

tap-on-focus-events clj/s macro

(tap-on-focus-events channel & args)

This event is sent when focus enters a text box. It is sent to all extensions that are listening to this event, and enabled by the user.

Events will be put on the |channel| with signature [::on-focus [context]] where:

|context| - Describes the text field that has acquired focus.

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

tap-on-ime-menu-activation-changed-events clj/s macro

(tap-on-ime-menu-activation-changed-events channel & args)

Fired when the IME menu is activated or deactivated.

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

|activation| - Whether the IME menu is currently active.

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

tap-on-ime-menu-items-changed-events clj/s macro

(tap-on-ime-menu-items-changed-events channel & args)

Fired when the input.ime.setMenuItems or input.ime.updateMenuItems API is called.

Events will be put on the |channel| with signature [::on-ime-menu-items-changed [engine-id items]] where:

|engine-id| - ID of the engine to use |items| - MenuItems to add or update.

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

tap-on-ime-menu-list-changed-events clj/s macro

(tap-on-ime-menu-list-changed-events channel & args)

Fired when the input method or the list of active input method IDs is changed.

Events will be put on the |channel| with signature [::on-ime-menu-list-changed []].

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