Liking cljdoc? Tell your friends :D

chromex.ext.input.ime

clj

Use the chrome.input.ime API to implement a custom IME for Chrome OS. This allows your extension to handle keystrokes, set the composition, and manage the candidate window.

Use the chrome.input.ime API to implement a custom IME for Chrome OS. This allows your extension to handle keystrokes, set
the composition, and manage the candidate window.

  * available since Chrome 34
  * https://developer.chrome.com/extensions/input.ime
raw docstring

activateclj/smacro

(activate)

Activates the IME extension so that it can receive events.

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.

https://developer.chrome.com/extensions/input.ime#method-activate.

Activates the IME extension so that it can receive events.

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.

https://developer.chrome.com/extensions/input.ime#method-activate.
sourceraw docstring

activate*cljs

(activate* config)
source

api-tableclj

source

clear-compositionclj/smacro

(clear-composition parameters)

Clear the current composition. If this extension does not own the active IME, this fails.

|parameters| - https://developer.chrome.com/extensions/input.ime#property-clearComposition-parameters.

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| - https://developer.chrome.com/extensions/input.ime#property-callback-success.

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.

https://developer.chrome.com/extensions/input.ime#method-clearComposition.

Clear the current composition. If this extension does not own the active IME, this fails.

  |parameters| - https://developer.chrome.com/extensions/input.ime#property-clearComposition-parameters.

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| - https://developer.chrome.com/extensions/input.ime#property-callback-success.

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.

https://developer.chrome.com/extensions/input.ime#method-clearComposition.
sourceraw docstring

clear-composition*cljs

(clear-composition* config parameters)
source

commit-textclj/smacro

(commit-text parameters)

Commits the provided text to the current input.

|parameters| - https://developer.chrome.com/extensions/input.ime#property-commitText-parameters.

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| - https://developer.chrome.com/extensions/input.ime#property-callback-success.

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.

https://developer.chrome.com/extensions/input.ime#method-commitText.

Commits the provided text to the current input.

  |parameters| - https://developer.chrome.com/extensions/input.ime#property-commitText-parameters.

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| - https://developer.chrome.com/extensions/input.ime#property-callback-success.

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.

https://developer.chrome.com/extensions/input.ime#method-commitText.
sourceraw docstring

commit-text*cljs

(commit-text* config parameters)
source

create-windowclj/smacro

(create-window options)

Creates IME window.

|options| - The options of the newly created IME window.

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

|window-object| - The JavaScript 'window' object of the newly created IME window. It contains the additional 'id' property for the parameters of the other functions like showWindow/hideWindow.

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.

https://developer.chrome.com/extensions/input.ime#method-createWindow.

Creates IME window.

  |options| - The options of the newly created IME window.

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

  |window-object| - The JavaScript 'window' object of the newly created IME window. It contains the additional 'id'
                    property for the parameters of the other functions like showWindow/hideWindow.

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.

https://developer.chrome.com/extensions/input.ime#method-createWindow.
sourceraw docstring

create-window*cljs

(create-window* config options)
source

deactivateclj/smacro

(deactivate)

Deactivates the IME extension so that it cannot receive events.

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.

https://developer.chrome.com/extensions/input.ime#method-deactivate.

Deactivates the IME extension so that it cannot receive events.

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.

https://developer.chrome.com/extensions/input.ime#method-deactivate.
sourceraw docstring

deactivate*cljs

(deactivate* config)
source

delete-surrounding-textclj/smacro

(delete-surrounding-text parameters)

Deletes the text around the caret.

|parameters| - https://developer.chrome.com/extensions/input.ime#property-deleteSurroundingText-parameters.

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.

https://developer.chrome.com/extensions/input.ime#method-deleteSurroundingText.

Deletes the text around the caret.

  |parameters| - https://developer.chrome.com/extensions/input.ime#property-deleteSurroundingText-parameters.

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.

https://developer.chrome.com/extensions/input.ime#method-deleteSurroundingText.
sourceraw docstring

delete-surrounding-text*cljs

(delete-surrounding-text* config parameters)
source

gen-callclj

source

gen-wrapclj/smacro

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

hide-input-viewclj/smacro

(hide-input-view)

Hides the input view window, which is popped up automatically by system. If the input view window is already hidden, this function will do nothing.

https://developer.chrome.com/extensions/input.ime#method-hideInputView.

Hides the input view window, which is popped up automatically by system. If the input view window is already hidden, this
function will do nothing.

https://developer.chrome.com/extensions/input.ime#method-hideInputView.
sourceraw docstring

hide-input-view*cljs

(hide-input-view* config)
source

hide-windowclj/smacro

(hide-window window-id)

Hides the IME window. This doesn't close the window. Instead, it makes the window invisible. The extension can cache the window and show/hide it for better performance.

|window-id| - The ID of the IME window.

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.

https://developer.chrome.com/extensions/input.ime#method-hideWindow.

Hides the IME window. This doesn't close the window. Instead, it makes the window invisible. The extension can cache the
window and show/hide it for better performance.

  |window-id| - The ID of the IME window.

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.

https://developer.chrome.com/extensions/input.ime#method-hideWindow.
sourceraw docstring

hide-window*cljs

(hide-window* config window-id)
source

key-event-handledclj/smacro

(key-event-handled request-id response)

Indicates that the key event received by onKeyEvent is handled. This should only be called if the onKeyEvent listener is asynchronous.

|request-id| - Request id of the event that was handled. This should come from keyEvent.requestId |response| - True if the keystroke was handled, false if not

https://developer.chrome.com/extensions/input.ime#method-keyEventHandled.

Indicates that the key event received by onKeyEvent is handled.  This should only be called if the onKeyEvent listener is
asynchronous.

  |request-id| - Request id of the event that was handled.  This should come from keyEvent.requestId
  |response| - True if the keystroke was handled, false if not

https://developer.chrome.com/extensions/input.ime#method-keyEventHandled.
sourceraw docstring

key-event-handled*cljs

(key-event-handled* config request-id response)
source

on-activate*cljs

(on-activate* config channel & args)
source

on-blur*cljs

(on-blur* config channel & args)
source

on-candidate-clicked*cljs

(on-candidate-clicked* config channel & args)
source

on-composition-bounds-changed*cljs

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

on-deactivated*cljs

(on-deactivated* config channel & args)
source

on-focus*cljs

(on-focus* config channel & args)
source

on-input-context-update*cljs

(on-input-context-update* config channel & args)
source

on-key-event*cljs

(on-key-event* config channel & args)
source

on-menu-item-activated*cljs

(on-menu-item-activated* config channel & args)
source

on-reset*cljs

(on-reset* config channel & args)
source

on-surrounding-text-changed*cljs

(on-surrounding-text-changed* config channel & args)
source

send-key-eventsclj/smacro

(send-key-events parameters)

Sends the key events. This function is expected to be used by virtual keyboards. When key(s) on a virtual keyboard is pressed by a user, this function is used to propagate that event to the system.

|parameters| - https://developer.chrome.com/extensions/input.ime#property-sendKeyEvents-parameters.

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.

https://developer.chrome.com/extensions/input.ime#method-sendKeyEvents.

Sends the key events.  This function is expected to be used by virtual keyboards.  When key(s) on a virtual keyboard is
pressed by a user, this function is used to propagate that event to the system.

  |parameters| - https://developer.chrome.com/extensions/input.ime#property-sendKeyEvents-parameters.

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.

https://developer.chrome.com/extensions/input.ime#method-sendKeyEvents.
sourceraw docstring

send-key-events*cljs

(send-key-events* config parameters)
source

set-candidate-window-propertiesclj/smacro

(set-candidate-window-properties parameters)

Sets the properties of the candidate window. This fails if the extension doesn't own the active IME

|parameters| - https://developer.chrome.com/extensions/input.ime#property-setCandidateWindowProperties-parameters.

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| - https://developer.chrome.com/extensions/input.ime#property-callback-success.

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.

https://developer.chrome.com/extensions/input.ime#method-setCandidateWindowProperties.

Sets the properties of the candidate window. This fails if the extension doesn't own the active IME

  |parameters| - https://developer.chrome.com/extensions/input.ime#property-setCandidateWindowProperties-parameters.

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| - https://developer.chrome.com/extensions/input.ime#property-callback-success.

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.

https://developer.chrome.com/extensions/input.ime#method-setCandidateWindowProperties.
sourceraw docstring

set-candidate-window-properties*cljs

(set-candidate-window-properties* config parameters)
source

set-candidatesclj/smacro

(set-candidates parameters)

Sets the current candidate list. This fails if this extension doesn't own the active IME

|parameters| - https://developer.chrome.com/extensions/input.ime#property-setCandidates-parameters.

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| - https://developer.chrome.com/extensions/input.ime#property-callback-success.

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.

https://developer.chrome.com/extensions/input.ime#method-setCandidates.

Sets the current candidate list. This fails if this extension doesn't own the active IME

  |parameters| - https://developer.chrome.com/extensions/input.ime#property-setCandidates-parameters.

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| - https://developer.chrome.com/extensions/input.ime#property-callback-success.

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.

https://developer.chrome.com/extensions/input.ime#method-setCandidates.
sourceraw docstring

set-candidates*cljs

(set-candidates* config parameters)
source

set-compositionclj/smacro

(set-composition parameters)

Set the current composition. If this extension does not own the active IME, this fails.

|parameters| - https://developer.chrome.com/extensions/input.ime#property-setComposition-parameters.

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| - https://developer.chrome.com/extensions/input.ime#property-callback-success.

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.

https://developer.chrome.com/extensions/input.ime#method-setComposition.

Set the current composition. If this extension does not own the active IME, this fails.

  |parameters| - https://developer.chrome.com/extensions/input.ime#property-setComposition-parameters.

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| - https://developer.chrome.com/extensions/input.ime#property-callback-success.

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.

https://developer.chrome.com/extensions/input.ime#method-setComposition.
sourceraw docstring

set-composition*cljs

(set-composition* config parameters)
source

set-cursor-positionclj/smacro

(set-cursor-position parameters)

Set the position of the cursor in the candidate window. This is a no-op if this extension does not own the active IME.

|parameters| - https://developer.chrome.com/extensions/input.ime#property-setCursorPosition-parameters.

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| - https://developer.chrome.com/extensions/input.ime#property-callback-success.

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.

https://developer.chrome.com/extensions/input.ime#method-setCursorPosition.

Set the position of the cursor in the candidate window. This is a no-op if this extension does not own the active IME.

  |parameters| - https://developer.chrome.com/extensions/input.ime#property-setCursorPosition-parameters.

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| - https://developer.chrome.com/extensions/input.ime#property-callback-success.

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.

https://developer.chrome.com/extensions/input.ime#method-setCursorPosition.
sourceraw docstring

set-cursor-position*cljs

(set-cursor-position* config parameters)
source

set-menu-itemsclj/smacro

(set-menu-items parameters)

Adds the provided menu items to the language menu when this IME is active.

|parameters| - https://developer.chrome.com/extensions/input.ime#property-setMenuItems-parameters.

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.

https://developer.chrome.com/extensions/input.ime#method-setMenuItems.

Adds the provided menu items to the language menu when this IME is active.

  |parameters| - https://developer.chrome.com/extensions/input.ime#property-setMenuItems-parameters.

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.

https://developer.chrome.com/extensions/input.ime#method-setMenuItems.
sourceraw docstring

set-menu-items*cljs

(set-menu-items* config parameters)
source

show-windowclj/smacro

(show-window window-id)

Shows the IME window. This makes the hidden window visible.

|window-id| - The ID of the IME window.

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.

https://developer.chrome.com/extensions/input.ime#method-showWindow.

Shows the IME window. This makes the hidden window visible.

  |window-id| - The ID of the IME window.

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.

https://developer.chrome.com/extensions/input.ime#method-showWindow.
sourceraw docstring

show-window*cljs

(show-window* config window-id)
source

tap-all-eventsclj/smacro

(tap-all-events chan)

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

Taps all valid non-deprecated events in chromex.ext.input.ime namespace.
sourceraw docstring

tap-on-activate-eventsclj/smacro

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

This event is sent when an IME is activated. It signals that the IME will be receiving onKeyPress events.

Events will be put on the |channel| with signature [::on-activate [engine-id screen]] where:

|engine-id| - ID of the engine receiving the event |screen| - The screen type under which the IME is activated.

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

https://developer.chrome.com/extensions/input.ime#event-onActivate.

This event is sent when an IME is activated. It signals that the IME will be receiving onKeyPress events.

Events will be put on the |channel| with signature [::on-activate [engine-id screen]] where:

  |engine-id| - ID of the engine receiving the event
  |screen| - The screen type under which the IME is activated.

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

https://developer.chrome.com/extensions/input.ime#event-onActivate.
sourceraw docstring

tap-on-blur-eventsclj/smacro

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

This event is sent when focus leaves 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-blur [context-id]] where:

|context-id| - The ID of the text field that has lost focus. The ID is invalid after this call

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

https://developer.chrome.com/extensions/input.ime#event-onBlur.

This event is sent when focus leaves 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-blur [context-id]] where:

  |context-id| - The ID of the text field that has lost focus. The ID is invalid after this call

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

https://developer.chrome.com/extensions/input.ime#event-onBlur.
sourceraw docstring

tap-on-candidate-clicked-eventsclj/smacro

(tap-on-candidate-clicked-events channel & args)

This event is sent if this extension owns the active IME.

Events will be put on the |channel| with signature [::on-candidate-clicked [engine-id candidate-id button]] where:

|engine-id| - ID of the engine receiving the event |candidate-id| - ID of the candidate that was clicked. |button| - Which mouse buttons was clicked.

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

https://developer.chrome.com/extensions/input.ime#event-onCandidateClicked.

This event is sent if this extension owns the active IME.

Events will be put on the |channel| with signature [::on-candidate-clicked [engine-id candidate-id button]] where:

  |engine-id| - ID of the engine receiving the event
  |candidate-id| - ID of the candidate that was clicked.
  |button| - Which mouse buttons was clicked.

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

https://developer.chrome.com/extensions/input.ime#event-onCandidateClicked.
sourceraw docstring

tap-on-composition-bounds-changed-eventsclj/smacro

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

Triggered when the bounds of the IME composition text or cursor are changed. The IME composition text is the instance of text produced in the input method editor.

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

|bounds-list| - List of bounds information for each character on IME composition text. If there's no composition text in the editor, this array contains the bound information of the cursor.

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

https://developer.chrome.com/extensions/input.ime#event-onCompositionBoundsChanged.

Triggered when the bounds of the IME composition text or cursor are changed. The IME composition text is the instance of
text produced in the input method editor.

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

  |bounds-list| - List of bounds information for each character on IME composition text. If there's no composition text in
                  the editor, this array contains the bound information of the cursor.

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

https://developer.chrome.com/extensions/input.ime#event-onCompositionBoundsChanged.
sourceraw docstring

tap-on-deactivated-eventsclj/smacro

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

This event is sent when an IME is deactivated. It signals that the IME will no longer be receiving onKeyPress events.

Events will be put on the |channel| with signature [::on-deactivated [engine-id]] where:

|engine-id| - ID of the engine receiving the event

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

https://developer.chrome.com/extensions/input.ime#event-onDeactivated.

This event is sent when an IME is deactivated. It signals that the IME will no longer be receiving onKeyPress events.

Events will be put on the |channel| with signature [::on-deactivated [engine-id]] where:

  |engine-id| - ID of the engine receiving the event

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

https://developer.chrome.com/extensions/input.ime#event-onDeactivated.
sourceraw docstring

tap-on-focus-eventsclj/smacro

(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.

https://developer.chrome.com/extensions/input.ime#event-onFocus.

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.

https://developer.chrome.com/extensions/input.ime#event-onFocus.
sourceraw docstring

tap-on-input-context-update-eventsclj/smacro

(tap-on-input-context-update-events channel & args)

This event is sent when the properties of the current InputContext change, such as the the type. 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-input-context-update [context]] where:

|context| - An InputContext object describing the text field that has changed.

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

https://developer.chrome.com/extensions/input.ime#event-onInputContextUpdate.

This event is sent when the properties of the current InputContext change, such as the the type. 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-input-context-update [context]] where:

  |context| - An InputContext object describing the text field that has changed.

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

https://developer.chrome.com/extensions/input.ime#event-onInputContextUpdate.
sourceraw docstring

tap-on-key-event-eventsclj/smacro

(tap-on-key-event-events channel & args)

Fired when a key event is sent from the operating system. The event will be sent to the extension if this extension owns the active IME. The listener function should return true if the event was handled false if it was not. If the event will be evaluated asynchronously, this function must return undefined and the IME must later call keyEventHandled() with the result.

Events will be put on the |channel| with signature [::on-key-event [engine-id key-data request-id]] where:

|engine-id| - ID of the engine receiving the event |key-data| - Data on the key event |request-id| - ID of the request. If the event listener returns undefined, then keyEventHandled must be called later with this requestId.

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

https://developer.chrome.com/extensions/input.ime#event-onKeyEvent.

Fired when a key event is sent from the operating system. The event will be sent to the extension if this extension owns
the active IME. The listener function should return true if the event was handled false if it was not.  If the event will
be evaluated asynchronously, this function must return undefined and the IME must later call keyEventHandled() with the
result.

Events will be put on the |channel| with signature [::on-key-event [engine-id key-data request-id]] where:

  |engine-id| - ID of the engine receiving the event
  |key-data| - Data on the key event
  |request-id| - ID of the request. If the event listener returns undefined, then keyEventHandled must be called later with
                 this requestId.

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

https://developer.chrome.com/extensions/input.ime#event-onKeyEvent.
sourceraw docstring

tap-on-menu-item-activated-eventsclj/smacro

(tap-on-menu-item-activated-events channel & args)

Called when the user selects a menu item

Events will be put on the |channel| with signature [::on-menu-item-activated [engine-id name]] where:

|engine-id| - ID of the engine receiving the event |name| - Name of the MenuItem which was activated

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

https://developer.chrome.com/extensions/input.ime#event-onMenuItemActivated.

Called when the user selects a menu item

Events will be put on the |channel| with signature [::on-menu-item-activated [engine-id name]] where:

  |engine-id| - ID of the engine receiving the event
  |name| - Name of the MenuItem which was activated

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

https://developer.chrome.com/extensions/input.ime#event-onMenuItemActivated.
sourceraw docstring

tap-on-reset-eventsclj/smacro

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

This event is sent when chrome terminates ongoing text input session.

Events will be put on the |channel| with signature [::on-reset [engine-id]] where:

|engine-id| - ID of the engine receiving the event

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

https://developer.chrome.com/extensions/input.ime#event-onReset.

This event is sent when chrome terminates ongoing text input session.

Events will be put on the |channel| with signature [::on-reset [engine-id]] where:

  |engine-id| - ID of the engine receiving the event

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

https://developer.chrome.com/extensions/input.ime#event-onReset.
sourceraw docstring

tap-on-surrounding-text-changed-eventsclj/smacro

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

Called when the editable string around caret is changed or when the caret position is moved. The text length is limited to 100 characters for each back and forth direction.

Events will be put on the |channel| with signature [::on-surrounding-text-changed [engine-id surrounding-info]] where:

|engine-id| - ID of the engine receiving the event |surrounding-info| - The surrounding information.

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

https://developer.chrome.com/extensions/input.ime#event-onSurroundingTextChanged.

Called when the editable string around caret is changed or when the caret position is moved. The text length is limited to
100 characters for each back and forth direction.

Events will be put on the |channel| with signature [::on-surrounding-text-changed [engine-id surrounding-info]] where:

  |engine-id| - ID of the engine receiving the event
  |surrounding-info| - The surrounding information.

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

https://developer.chrome.com/extensions/input.ime#event-onSurroundingTextChanged.
sourceraw docstring

update-menu-itemsclj/smacro

(update-menu-items parameters)

Updates the state of the MenuItems specified

|parameters| - https://developer.chrome.com/extensions/input.ime#property-updateMenuItems-parameters.

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.

https://developer.chrome.com/extensions/input.ime#method-updateMenuItems.

Updates the state of the MenuItems specified

  |parameters| - https://developer.chrome.com/extensions/input.ime#property-updateMenuItems-parameters.

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.

https://developer.chrome.com/extensions/input.ime#method-updateMenuItems.
sourceraw docstring

update-menu-items*cljs

(update-menu-items* config parameters)
source

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close