chromex.ext.accessibility-private — binaryage/chromex 0.8.1

clj

• available since Chrome 36

api-table clj

darken-screen clj/s macro

(darken-screen enabled)

Darkens or undarkens the screen.

|enabled| - True to darken screen; false to undarken screen.

darken-screen* cljs

(darken-screen* config enabled)

enable-chrome-vox-mouse-events clj/s macro

(enable-chrome-vox-mouse-events enabled)

Enables or disables mouse events in ChromeVox.

|enabled| - True if ChromeVox should receive mouse events.

enable-chrome-vox-mouse-events* cljs

(enable-chrome-vox-mouse-events* config enabled)

forward-key-events-to-switch-access clj/s macro

(forward-key-events-to-switch-access should-forward)

When enabled, forwards key events to the Switch Access extension

|should-forward| - ?

forward-key-events-to-switch-access* cljs

(forward-key-events-to-switch-access* config should-forward)

gen-call clj

gen-wrap clj/s macro

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

get-battery-description clj/s macro

(get-battery-description)

Called to request battery status from Chrome OS system.

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

|battery-description| - ?

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-battery-description* cljs

(get-battery-description* config)

on-accessibility-gesture* cljs

(on-accessibility-gesture* config channel & args)

on-announce-for-accessibility* cljs

(on-announce-for-accessibility* config channel & args)

on-introduce-chrome-vox* cljs

(on-introduce-chrome-vox* config channel & args)

on-select-to-speak-state-change-requested* cljs

(on-select-to-speak-state-change-requested* config channel & args)

on-select-to-speak-state-changed clj/s macro

(on-select-to-speak-state-changed state)

Called by the Select-to-Speak extension when Select-to-Speak has changed states, between selecting with the mouse, speaking, and inactive.

|state| - ?

on-select-to-speak-state-changed* cljs

(on-select-to-speak-state-changed* config state)

on-switch-access-command* cljs

(on-switch-access-command* config channel & args)

on-two-finger-touch-start* cljs

(on-two-finger-touch-start* config channel & args)

on-two-finger-touch-stop* cljs

(on-two-finger-touch-stop* config channel & args)

send-synthetic-key-event clj/s macro

(send-synthetic-key-event key-event)

Sends a fabricated key event.

|key-event| - The event to send.

send-synthetic-key-event* cljs

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

send-synthetic-mouse-event clj/s macro

(send-synthetic-mouse-event mouse-event)

Sends a fabricated mouse event.

|mouse-event| - The event to send.

send-synthetic-mouse-event* cljs

(send-synthetic-mouse-event* config mouse-event)

set-focus-rings clj/s macro

(set-focus-rings focus-rings)

Sets the given accessibility focus rings for this extension.

|focus-rings| - Array of focus rings to draw.

set-focus-rings* cljs

(set-focus-rings* config focus-rings)

set-highlights clj/s macro

(set-highlights rects color)

Sets the bounds of the accessibility highlight.

|rects| - Array of rectangles to draw the highlight around. |color| - CSS-style hex color string beginning with # like #FF9982 or #EEE.

set-highlights* cljs

(set-highlights* config rects color)

set-keyboard-listener clj/s macro

(set-keyboard-listener enabled capture)

Sets the calling extension as a listener of all keyboard events optionally allowing the calling extension to capture/swallow the key event via DOM apis. Returns false via callback when unable to set the listener.

|enabled| - True if the caller wants to listen to key events; false to stop listening to events. Note that there is only ever one extension listening to key events. |capture| - True if key events should be swallowed natively and not propagated if preventDefault() gets called by the extension's background page.

set-keyboard-listener* cljs

(set-keyboard-listener* config enabled capture)

set-native-accessibility-enabled clj/s macro

(set-native-accessibility-enabled enabled)

Enables or disables native accessibility support. Once disabled, it is up to the calling extension to provide accessibility for web contents.

|enabled| - True if native accessibility support should be enabled.

set-native-accessibility-enabled* cljs

(set-native-accessibility-enabled* config enabled)

set-native-chrome-vox-arc-support-for-current-app clj/s macro

(set-native-chrome-vox-arc-support-for-current-app enabled)

Sets current ARC app to use native ARC support.

|enabled| - True for ChromeVox (native), false for TalkBack.

set-native-chrome-vox-arc-support-for-current-app* cljs

(set-native-chrome-vox-arc-support-for-current-app* config enabled)

set-switch-access-keys clj/s macro

(set-switch-access-keys key-codes)

Change the keyboard keys captured by Switch Access.

|key-codes| - The key codes for the keys that will be captured.

set-switch-access-keys* cljs

(set-switch-access-keys* config key-codes)

set-switch-access-menu-state clj/s macro

(set-switch-access-menu-state show element-bounds item-count)

Shows or hides the Switch Access menu. If shown, it is at the indicated location.

|show| - If true, show the menu. If false, hide the menu. |element-bounds| - Position of an element, in global screen coordinates, to place the menu next to. |item-count| - The number of items that need to be shown in the menu.

set-switch-access-menu-state* cljs

(set-switch-access-menu-state* config show element-bounds item-count)

set-virtual-keyboard-visible clj/s macro

(set-virtual-keyboard-visible is-visible)

Shows or hides the virtual keyboard.

|is-visible| - ?

set-virtual-keyboard-visible* cljs

(set-virtual-keyboard-visible* config is-visible)

tap-all-events clj/s macro

(tap-all-events chan)

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

tap-on-accessibility-gesture-events clj/s macro

(tap-on-accessibility-gesture-events channel & args)

Fired when an accessibility gesture is detected by the touch exploration controller.

Events will be put on the |channel| with signature [::on-accessibility-gesture [gesture]] where:

|gesture| - ?

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

tap-on-announce-for-accessibility-events clj/s macro

(tap-on-announce-for-accessibility-events channel & args)

Called when an internal component within accessibility wants to force speech output for an accessibility extension. Do not use without approval from accessibility owners.

Events will be put on the |channel| with signature [::on-announce-for-accessibility [announce-text]] where:

|announce-text| - Text to be announced.

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

tap-on-introduce-chrome-vox-events clj/s macro

(tap-on-introduce-chrome-vox-events channel & args)

Fired whenever ChromeVox should output introduction.

Events will be put on the |channel| with signature [::on-introduce-chrome-vox []].

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

tap-on-select-to-speak-state-change-requested-events clj/s macro

(tap-on-select-to-speak-state-change-requested-events channel & args)

Called when Chrome OS wants to change the Select-to-Speak state, between selecting with the mouse, speaking, and inactive.

Events will be put on the |channel| with signature [::on-select-to-speak-state-change-requested []].

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

tap-on-switch-access-command-events clj/s macro

(tap-on-switch-access-command-events channel & args)

Called when Chrome OS has received a key event corresponding to a Switch Access command.

Events will be put on the |channel| with signature [::on-switch-access-command [command]] where:

|command| - ?

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

tap-on-two-finger-touch-start-events clj/s macro

(tap-on-two-finger-touch-start-events channel & args)

Fired when we first detect two fingers are held down, which can be used to toggle spoken feedback on some touch-only devices.

Events will be put on the |channel| with signature [::on-two-finger-touch-start []].

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

tap-on-two-finger-touch-stop-events clj/s macro

(tap-on-two-finger-touch-stop-events channel & args)

Fired when the user is no longer holding down two fingers (including releasing one, holding down three, or moving them).

Events will be put on the |channel| with signature [::on-two-finger-touch-stop []].

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

toggle-dictation clj/s macro

(toggle-dictation)

Toggles dictation between active and inactive states.

toggle-dictation* cljs

(toggle-dictation* config)