46 Star 176 Fork 4.8K

OpenHarmony/interface_sdk-js

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.accessibility.d.ts 51.95 KB
一键复制 编辑 原始数据 按行查看 历史
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846
/*
* Copyright (C) 2021-2025 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit AccessibilityKit
*/
import type { AsyncCallback } from './@ohos.base';
import type { Callback } from './@ohos.base';
import { Resource } from './global/resource';
/**
* Accessibility action that the ability can execute.
*
* @enum { number }
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
export enum AccessibilityAction {
/**
* AccessibilityFocus
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
ACCESSIBILITY_FOCUS = 0,
/**
* ClearAccessibilityFocus
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
CLEAR_ACCESSIBILITY_FOCUS = 1,
/**
* Focus
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
FOCUS = 2,
/**
* ClearFocus
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
CLEAR_FOCUS = 3,
/**
* Click
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
CLICK = 4,
/**
* LongClick
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
LONG_CLICK = 5,
/**
* Cut
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
CUT = 6,
/**
* Copy
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
COPY = 7,
/**
* Paste
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
PASTE = 8,
/**
* Select
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
SELECT = 9,
/**
* SetText
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
SET_TEXT = 10,
/**
* ScrollForward
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
SCROLL_FORWARD = 11,
/**
* ScrollBackward
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
SCROLL_BACKWARD = 12,
/**
* SetSelection
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
SET_SELECTION = 13,
/**
* SetCursorPosition
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
SET_CURSOR_POSITION = 14,
/**
* Home
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
HOME = 15,
/**
* Back
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
BACK = 16,
/**
* RecentTask
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
RECENT_TASK = 17,
/**
* NotificationCenter
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
NOTIFICATION_CENTER = 18,
/**
* ControlCenter
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
CONTROL_CENTER = 19,
/**
* SpanClick
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
SPAN_CLICK = 20
}
/**
* AccessibilityEvent type
*
* @enum { number }
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
export enum AccessibilityEventType {
//EventType
/**
* AccessibilityFocus type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_ACCESSIBILITY_FOCUS = 0,
/**
* AccessibilityFocusClear type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_ACCESSIBILITY_FOCUS_CLEAR = 1,
/**
* Click type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_CLICK = 2,
/**
* LongClick type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_LONG_CLICK = 3,
/**
* Select type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_SELECT = 4,
/**
* HoverEnter type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_HOVER_ENTER = 5,
/**
* HoverExit type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_HOVER_EXIT = 6,
/**
* Focus type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_FOCUS = 7,
/**
* TextUpdate type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_TEXT_UPDATE = 8,
/**
* TextSelectionUpdate type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_TEXT_SELECTION_UPDATE = 9,
/**
* Scroll type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_SCROLL = 10,
/**
* RequestFocusForAccessibility type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_REQUEST_FOCUS_FOR_ACCESSIBILITY = 11,
/**
* AnnounceForAccessibility type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_ANNOUNCE_FOR_ACCESSIBILITY = 12,
/**
* RequestFocusForAccessibilityNotInterrupt type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_REQUEST_FOCUS_FOR_ACCESSIBILITY_NOT_INTERRUPT = 13,
/**
* AnnounceForAccessibilityNotInterrupt type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_ANNOUNCE_FOR_ACCESSIBILITY_NOT_INTERRUPT = 14,
/**
* ElementInfoChange type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_ELEMENT_INFO_CHANGE = 15,
/**
* Scrolling type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_SCROLLING = 16,
// WindowUpdateType
/**
* Window add type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_WINDOW_ADD = 17,
/**
* Window remove type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_WINDOW_REMOVE = 18,
/**
* Window bounds type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_WINDOW_BOUNDS = 19,
/**
* Window active type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_WINDOW_ACTIVE = 20,
/**
* Window focus type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_WINDOW_FOCUS = 21,
/**
* Window property type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_WINDOW_PROPERTY = 22,
/**
* Window layer type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_WINDOW_LAYER = 23,
//TouchGuideType
/**
* TouchBegin type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_TOUCH_BEGIN = 24,
/**
* TouchEnd type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_TOUCH_END = 25,
//PageUpdateType
/**
* PageContentUpdate type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_PAGE_CONTENT_UPDATE = 26,
/**
* PageStateUpdate type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_PAGE_STATE_UPDATE = 27,
/**
* PageOpen type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_PAGE_OPEN = 28,
/**
* PageClose type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_PAGE_CLOSE = 29,
//GestureType
/**
* left type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_SWIPE_LEFT = 30,
/**
* leftThenRight type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_SWIPE_LEFT_THEN_RIGHT = 31,
/**
* leftThenUp type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_SWIPE_LEFT_THEN_UP = 32,
/**
* leftThenDown type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_SWIPE_LEFT_THEN_DOWN = 33,
/**
* right type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_SWIPE_RIGHT = 34,
/**
* rightThenLeft type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_SWIPE_RIGHT_THEN_LEFT = 35,
/**
* rightThenUp type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_SWIPE_RIGHT_THEN_UP = 36,
/**
* rightThenDown type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_SWIPE_RIGHT_THEN_DOWN = 37,
/**
* up type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_SWIPE_UP = 38,
/**
* upThenLeft type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_SWIPE_UP_THEN_LEFT = 39,
/**
* upThenRight type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_SWIPE_UP_THEN_RIGHT = 40,
/**
* upThenDown type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_SWIPE_UP_THEN_DOWN = 41,
/**
* down type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_SWIPE_DOWN = 42,
/**
* downThenLeft type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_SWIPE_DOWN_THEN_LEFT = 43,
/**
* downThenRight type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_SWIPE_DOWN_THEN_RIGHT = 44,
/**
* downThenUp type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_SWIPE_DOWN_THEN_UP = 45,
/**
* twoFingerSingleTap type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_TWO_FINGER_SINGLE_TAP = 46,
/**
* twoFingerDoubleTap type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_TWO_FINGER_DOUBLE_TAP = 47,
/**
* twoFingerDoubleTapAndHold type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_TWO_FINGER_DOUBLE_TAP_AND_HOLD = 48,
/**
* twoFingerTripleTap type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_TWO_FINGER_TRIPLE_TAP = 49,
/**
* twoFingerTripleTapAndHold type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_TWO_FINGER_TRIPLE_TAP_AND_HOLD = 50,
/**
* threeFingerSingleTap type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_THREE_FINGER_SINGLE_TAP = 51,
/**
* threeFingerDoubleTap type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_THREE_FINGER_DOUBLE_TAP = 52,
/**
* threeFingerDoubleTapAndHold type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_THREE_FINGER_DOUBLE_TAP_AND_HOLD = 53,
/**
* threeFingerTripleTap type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_THREE_FINGER_TRIPLE_TAP = 54,
/**
* threeFingerTripleTapAndHold type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_THREE_FINGER_TRIPLE_TAP_AND_HOLD = 55,
/**
* fourFingerSingleTap type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_FOUR_FINGER_SINGLE_TAP = 56,
/**
* fourFingerDoubleTap type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_FOUR_FINGER_DOUBLE_TAP = 57,
/**
* fourFingerDoubleTapAndHold type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_FOUR_FINGER_DOUBLE_TAP_AND_HOLD = 58,
/**
* fourFingerTripleTap type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_FOUR_FINGER_TRIPLE_TAP = 59,
/**
* fourFingerTripleTapAndHold type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_FOUR_FINGER_TRIPLE_TAP_AND_HOLD = 60,
/**
* threeFingerSwipeUp type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_THREE_FINGER_SWIPE_UP = 61,
/**
* threeFingerSwipeDown type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_THREE_FINGER_SWIPE_DOWN = 62,
/**
* threeFingerSwipeLeft type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_THREE_FINGER_SWIPE_LEFT = 63,
/**
* threeFingerSwipeRight type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_THREE_FINGER_SWIPE_RIGHT = 64,
/**
* fourFingerSwipeUp type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_FOUR_FINGER_SWIPE_UP = 65,
/**
* fourFingerSwipeDown type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_FOUR_FINGER_SWIPE_DOWN = 66,
/**
* fourFingerSwipeLeft type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_FOUR_FINGER_SWIPE_LEFT = 67,
/**
* fourFingerSwipeRight type
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @systemapi
* @since 20
*/
TYPE_FOUR_FINGER_SWIPE_RIGHT = 68
}
/**
* Accessibility
*
* @namespace accessibility
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
/**
* Accessibility
*
* @namespace accessibility
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @atomicservice
* @since 11
*/
/**
* Accessibility
*
* @namespace accessibility
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.1&1.2
*/
declare namespace accessibility {
/**
* The type of the Ability app.
*
*{ 'audible' | 'generic' | 'haptic' | 'spoken' | 'visual' }
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
/**
* The type of the Ability app.
*
* { 'audible' | 'generic' | 'haptic' | 'spoken' | 'visual' | 'all' }
* @typedef {'audible' | 'generic' | 'haptic' | 'spoken' | 'visual' | 'all'}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 9
*/
type AbilityType = 'audible' | 'generic' | 'haptic' | 'spoken' | 'visual' | 'all';
/**
* The action that the ability can execute.
* value range: { 'accessibilityFocus' | 'clearAccessibilityFocus' | 'focus' | 'clearFocus' | 'clearSelection' |
* 'click' | 'longClick' | 'cut' | 'copy' | 'paste' | 'select' | 'setText' | 'delete' |
* 'scrollForward' | 'scrollBackward' | 'setSelection' }
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
/**
* The action that the ability can execute.
* value range: { 'accessibilityFocus' | 'clearAccessibilityFocus' | 'focus' | 'clearFocus' | 'clearSelection' |
* 'click' | 'longClick' | 'cut' | 'copy' | 'paste' | 'select' | 'setText' | 'delete' |
* 'scrollForward' | 'scrollBackward' | 'setSelection' | 'setCursorPosition' | 'home' |
* 'back' | 'recentTask' | 'notificationCenter' | 'controlCenter' | 'common' }
*
* @typedef {'accessibilityFocus' | 'clearAccessibilityFocus' | 'focus' | 'clearFocus' | 'clearSelection' | 'click' | 'longClick' | 'cut' | 'copy' | 'paste' | 'select' | 'setText' | 'delete' | 'scrollForward' | 'scrollBackward' | 'setSelection' | 'setCursorPosition' | 'home' | 'back' | 'recentTask' | 'notificationCenter' | 'controlCenter' | 'common'}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
type Action = 'accessibilityFocus' | 'clearAccessibilityFocus' | 'focus' | 'clearFocus' | 'clearSelection' |
'click' | 'longClick' | 'cut' | 'copy' | 'paste' | 'select' | 'setText' | 'delete' |
'scrollForward' | 'scrollBackward' | 'setSelection' | 'setCursorPosition' | 'home' |
'back' | 'recentTask' | 'notificationCenter' | 'controlCenter' | 'common';
/**
* The type of the accessibility event.
* windowsChange/windowContentChange/windowStateChange/announcement/notificationChange/textTraversedAtMove
* value range: { 'accessibilityFocus' | 'accessibilityFocusClear' |
* 'click' | 'longClick' | 'focus' | 'select' | 'hoverEnter' | 'hoverExit' |
* 'textUpdate' | 'textSelectionUpdate' | 'scroll' }
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
/**
* The type of the accessibility event.
* windowsChange/windowContentChange/windowStateChange/announcement/notificationChange/textTraversedAtMove
* value range: { 'accessibilityFocus' | 'accessibilityFocusClear' |
* 'click' | 'longClick' | 'focus' | 'select' | 'hoverEnter' | 'hoverExit' |
* 'textUpdate' | 'textSelectionUpdate' | 'scroll' | 'requestFocusForAccessibility' |
* 'announceForAccessibility' }
*
* @typedef {'accessibilityFocus' | 'accessibilityFocusClear' | 'click' | 'longClick' | 'focus' | 'select' | 'hoverEnter' | 'hoverExit' | 'textUpdate' | 'textSelectionUpdate' | 'scroll' | 'requestFocusForAccessibility' | 'announceForAccessibility'}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 12
*/
/**
* The type of the accessibility event.
* windowsChange/windowContentChange/windowStateChange/announcement/notificationChange/textTraversedAtMove
* value range: { 'accessibilityFocus' | 'accessibilityFocusClear' |
* 'click' | 'longClick' | 'focus' | 'select' | 'hoverEnter' | 'hoverExit' |
* 'textUpdate' | 'textSelectionUpdate' | 'scroll' | 'requestFocusForAccessibility' |
* 'announceForAccessibility' | 'requestFocusForAccessibilityNotInterrupt' |
* 'announceForAccessibilityNotInterrupt' | 'scrolling' }
*
* @typedef {'accessibilityFocus' | 'accessibilityFocusClear' | 'click' | 'longClick' | 'focus' | 'select' | 'hoverEnter' | 'hoverExit' | 'textUpdate' | 'textSelectionUpdate' | 'scroll' | 'requestFocusForAccessibility' | 'announceForAccessibility' | 'requestFocusForAccessibilityNotInterrupt' | 'announceForAccessibilityNotInterrupt' | 'scrolling'}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
type EventType = 'accessibilityFocus' | 'accessibilityFocusClear' |
'click' | 'longClick' | 'focus' | 'select' | 'hoverEnter' | 'hoverExit' |
'textUpdate' | 'textSelectionUpdate' | 'scroll' | 'requestFocusForAccessibility' |
'announceForAccessibility' | 'requestFocusForAccessibilityNotInterrupt' |
'announceForAccessibilityNotInterrupt' | 'scrolling';
/**
* The change type of the windowsChange event.
* It's used when received the {@code windowsChange} event.
*
* @typedef {'add' | 'remove' | 'bounds' | 'active' | 'focus'}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since arkts {'1.1':'7', '1.2':'20'}
* @arkts 1.1&1.2
*/
type WindowUpdateType = 'add' | 'remove' | 'bounds' | 'active' | 'focus';
/**
* The type of the ability state.
*
* @typedef {'enable' | 'disable' | 'install'}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
type AbilityState = 'enable' | 'disable' | 'install';
/**
* The ability that accessibility subsystem support.
* touchExplorer: Describes the capability to talkback.
* magnification: Describes the capability to request to control the display magnification.
* gesturesSimulation: Describes the capability to request to simulate the gesture.
* windowContent: Describes the capability to search for the content of the active window.
* filterKeyEvents: Describes the capability to request to filter key events.
* fingerprintGesture: Describes the capability to request to fingerprint gesture.
*
* @typedef {'retrieve' | 'touchGuide' | 'keyEventObserver' | 'zoom' | 'gesture'}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
type Capability = 'retrieve' | 'touchGuide' | 'keyEventObserver' | 'zoom' | 'gesture';
/**
* The granularity of text move.
*
* @typedef {'char' | 'word' | 'line' | 'page' | 'paragraph'}
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since arkts {'1.1':'7', '1.2':'20'}
* @arkts 1.1&1.2
*/
type TextMoveUnit = 'char' | 'word' | 'line' | 'page' | 'paragraph';
/**
* Checks whether accessibility ability is enabled.
*
* @param { AsyncCallback<boolean> } callback Asynchronous callback interface.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
* @deprecated since 10
* @useinstead ohos.accessibility#isOpenAccessibilitySync
*/
function isOpenAccessibility(callback: AsyncCallback<boolean>): void;
/**
* Checks whether accessibility ability is enabled.
*
* @returns { Promise<boolean> } Returns {@code true} if the accessibility is enabled; returns {@code false} otherwise.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
* @deprecated since 10
* @useinstead ohos.accessibility#isOpenAccessibilitySync
*/
function isOpenAccessibility(): Promise<boolean>;
/**
* Checks whether accessibility ability is enabled.
*
* @returns { boolean } Returns true if the accessibility is enabled; returns false otherwise.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 10
*/
/**
* Checks whether accessibility ability is enabled.
*
* @returns { boolean } Returns true if the accessibility is enabled; returns false otherwise.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @atomicservice
* @since 11
*/
/**
* Checks whether accessibility ability is enabled.
*
* @returns { boolean } Returns true if the accessibility is enabled; returns false otherwise.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.1&1.2
*/
function isOpenAccessibilitySync(): boolean;
/**
* Checks touch browser ability (which is used by talkback) is enabled.
*
* @param { AsyncCallback<boolean> } callback Asynchronous callback interface.
* @syscap SystemCapability.BarrierFree.Accessibility.Vision
* @since 7
* @deprecated since 10
* @useinstead ohos.accessibility#isOpenTouchGuideSync
*/
function isOpenTouchGuide(callback: AsyncCallback<boolean>): void;
/**
* Checks touch browser ability (which is used by talkback) is enabled.
*
* @returns { Promise<boolean> } Returns {@code true} if the touch browser is enabled; returns {@code false} otherwise.
* @syscap SystemCapability.BarrierFree.Accessibility.Vision
* @since 7
* @deprecated since 10
* @useinstead ohos.accessibility#isOpenTouchGuideSync
*/
function isOpenTouchGuide(): Promise<boolean>;
/**
* Checks touch browser ability (which is used by talkback) is enabled.
*
* @returns { boolean } Returns true if the touch browser is enabled; returns false otherwise.
* @syscap SystemCapability.BarrierFree.Accessibility.Vision
* @since 10
*/
/**
* Checks touch browser ability (which is used by talkback) is enabled.
*
* @returns { boolean } Returns true if the touch browser is enabled; returns false otherwise.
* @syscap SystemCapability.BarrierFree.Accessibility.Vision
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
function isOpenTouchGuideSync(): boolean;
/**
* Checks screen reader ability (which is used by talkback) is enabled.
* @returns { boolean } Returns true if the screen reader is enabled; return false otherwise.
* @syscap SystemCapability.BarrierFree.Accessibility.Vision
* @since 18
*/
function isScreenReaderOpenSync(): boolean;
/**
* Queries the list of accessibility abilities.
*
* @param { AbilityType } abilityType The type of the accessibility ability. {@code AbilityType} eg.spoken
* @param { AbilityState } stateType The state of the accessibility ability. {@code AbilityState} eg.installed
* @param { AsyncCallback<Array<AccessibilityAbilityInfo>> } callback
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
* @deprecated since 9
* @useinstead ohos.accessibility#getAccessibilityExtensionList
*/
function getAbilityLists(
abilityType: AbilityType,
stateType: AbilityState,
callback: AsyncCallback<Array<AccessibilityAbilityInfo>>
): void;
/**
* Queries the list of accessibility abilities.
*
* @param { AbilityType } abilityType The type of the accessibility ability. {@code AbilityType} eg.spoken
* @param { AbilityState } stateType The state of the accessibility ability. {@code AbilityState} eg.installed
* @returns { Promise<Array<AccessibilityAbilityInfo>> } Returns the list of abilityInfos.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
* @deprecated since 9
* @useinstead ohos.accessibility#getAccessibilityExtensionList
*/
function getAbilityLists(abilityType: AbilityType, stateType: AbilityState): Promise<Array<AccessibilityAbilityInfo>>;
/**
* Queries the list of accessibility abilities.
*
* @param { AbilityType } abilityType The type of the accessibility ability. {@code AbilityType} eg.spoken
* @param { AbilityState } stateType The state of the accessibility ability. {@code AbilityState} eg.installed
* @returns { Promise<Array<AccessibilityAbilityInfo>> } Returns the list of abilityInfos.
* @throws { BusinessError } 401 - Input parameter error. Possible causes:
* 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types;
* 3. Parameter verification failed.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 9
*/
function getAccessibilityExtensionList(
abilityType: AbilityType,
stateType: AbilityState
): Promise<Array<AccessibilityAbilityInfo>>;
/**
* Queries the list of accessibility abilities.
*
* @param { AbilityType } abilityType The type of the accessibility ability. {@code AbilityType} eg.spoken
* @param { AbilityState } stateType The state of the accessibility ability. {@code AbilityState} eg.installed
* @param { AsyncCallback<Array<AccessibilityAbilityInfo>> } callback
* @throws { BusinessError } 401 - Input parameter error. Possible causes:
* 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types;
* 3. Parameter verification failed.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 9
*/
function getAccessibilityExtensionList(
abilityType: AbilityType,
stateType: AbilityState,
callback: AsyncCallback<Array<AccessibilityAbilityInfo>>
): void;
/**
* Queries the list of accessibility abilities.
*
* @param { AbilityType } abilityType The type of the accessibility ability. {@code AbilityType} eg.spoken
* @param { AbilityState } stateType The state of the accessibility ability. {@code AbilityState} eg.installed
* @returns { Array<AccessibilityAbilityInfo> } Returns the list of abilityInfos.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 12
*/
function getAccessibilityExtensionListSync(
abilityType: AbilityType,
stateType: AbilityState
): Array<AccessibilityAbilityInfo>;
/**
* Send accessibility Event.
*
* @param { EventInfo } event The object of the accessibility {@code EventInfo} .
* @param { AsyncCallback<void> } callback Asynchronous callback interface.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
* @deprecated since 9
* @useinstead ohos.accessibility#sendAccessibilityEvent
*/
function sendEvent(event: EventInfo, callback: AsyncCallback<void>): void;
/**
* Send accessibility Event.
*
* @param { EventInfo } event The object of the accessibility {@code EventInfo} .
* @returns { Promise<void> } Returns {@code true} if success ; returns {@code false} otherwise.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
* @deprecated since 9
* @useinstead ohos.accessibility#sendAccessibilityEvent
*/
function sendEvent(event: EventInfo): Promise<void>;
/**
* Send accessibility event.
*
* @param { EventInfo } event The object of the accessibility {@code EventInfo} .
* @param { AsyncCallback<void> } callback Asynchronous callback interface.
* @throws { BusinessError } 401 - Input parameter error. Possible causes:
* 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types;
* 3. Parameter verification failed.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
function sendAccessibilityEvent(event: EventInfo, callback: AsyncCallback<void>): void;
/**
* Send accessibility event.
*
* @param { EventInfo } event The object of the accessibility {@code EventInfo} .
* @returns { Promise<void> } Returns {@code true} if success ; returns {@code false} otherwise.
* @throws { BusinessError } 401 - Input parameter error. Possible causes:
* 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types;
* 3. Parameter verification failed.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
function sendAccessibilityEvent(event: EventInfo): Promise<void>;
/**
* Gets touch mode type.
* @returns { string } Returns touch mode type, include 'singleTouchMode', 'doubleTouchMode', and 'none'.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 20
*/
function getTouchModeSync(): string;
/**
* Register the observe of the accessibility state changed.
*
* @param { 'accessibilityStateChange' } type state event type.
* @param { Callback<boolean> } callback Asynchronous callback interface.
* @throws { BusinessError } 401 - Input parameter error. Possible causes:
* 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types;
* 3. Parameter verification failed.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
/**
* Register the observe of the accessibility state changed.
*
* @param { 'accessibilityStateChange' } type state event type.
* @param { Callback<boolean> } callback Asynchronous callback interface.
* @throws { BusinessError } 401 - Input parameter error. Possible causes:
* 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types;
* 3. Parameter verification failed.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @crossplatform
* @since 20
* @arkts 1.1&1.2
*/
function on(type: 'accessibilityStateChange', callback: Callback<boolean>): void;
/**
* Register the observe of the touchGuide state changed.
*
* @param { 'touchGuideStateChange' } type state event type.
* @param { Callback<boolean> } callback Asynchronous callback interface.
* @throws { BusinessError } 401 - Input parameter error. Possible causes:
* 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types;
* 3. Parameter verification failed.
* @syscap SystemCapability.BarrierFree.Accessibility.Vision
* @since arkts {'1.1':'7', '1.2':'20'}
* @arkts 1.1&1.2
*/
function on(type: 'touchGuideStateChange', callback: Callback<boolean>): void;
/**
* Register the observe of the screen reader state changed.
* @param { 'screenReaderStateChange' } type state event type.
* @param { Callback<boolean> } callback callback Asynchronous callback interface.
* @throws { BusinessError } 401 Input parameter error. Possible causes:
* 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types;
* 3. Parameter verification failed.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
function on(type: 'screenReaderStateChange', callback: Callback<boolean>): void;
/**
* Register the observe of the touch mode changed.
* @param { 'touchModeChange' } type touch mode change.
* @param { Callback<string> } callback callback Asynchronous callback interface.
* @throws { BusinessError } 401 Parameter error. Possible causes:
* 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types;
* 3. Parameter verification failed.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 20
* @arkts 1.1&1.2
*/
function on(type: 'touchModeChange', callback: Callback<string>): void;
/**
* Unregister the observe of the accessibility state changed.
*
* @param { 'accessibilityStateChange' } type state event type
* @param { Callback<boolean> } callback Asynchronous callback interface.
* @throws { BusinessError } 401 - Input parameter error. Possible causes:
* 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types;
* 3. Parameter verification failed.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
/**
* Unregister the observe of the accessibility state changed.
*
* @param { 'accessibilityStateChange' } type state event type
* @param { Callback<boolean> } callback Asynchronous callback interface.
* @throws { BusinessError } 401 - Input parameter error. Possible causes:
* 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types;
* 3. Parameter verification failed.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @crossplatform
* @since 20
* @arkts 1.1&1.2
*/
function off(type: 'accessibilityStateChange', callback?: Callback<boolean>): void;
/**
* Unregister the observe of the touchGuide state changed.
*
* @param { 'touchGuideStateChange' } type state event type
* @param { Callback<boolean> } callback Asynchronous callback interface.
* @throws { BusinessError } 401 - Input parameter error. Possible causes:
* 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types;
* 3. Parameter verification failed.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since arkts {'1.1':'7', '1.2':'20'}
* @arkts 1.1&1.2
*/
function off(type: 'touchGuideStateChange', callback?: Callback<boolean>): void;
/**
* Unregister the observe of the screen reader state changed.
* @param { 'screenReaderStateChange' } type state event type
* @param { Callback<boolean> } callback callback Asynchronous callback interface.
* @throws { BusinessError } 401 - Input parameter error. Possible causes:
* 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types;
* 3. Parameter verification failed.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
function off(type: 'screenReaderStateChange', callback?: Callback<boolean>): void;
/**
* Unregister the observe of the touch mode changed.
* @param { 'touchModeChange' } type touch mode change.
* @param { Callback<string> } callback callback Asynchronous callback interface.
* @throws { BusinessError } 401 Parameter error. Possible causes:
* 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types;
* 3. Parameter verification failed.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 20
* @arkts 1.1&1.2
*/
function off(type: 'touchModeChange', callback?: Callback<string>): void;
/**
* Get the captions manager.
*
* @returns { CaptionsManager } Returns the captions manager.
* @syscap SystemCapability.BarrierFree.Accessibility.Hearing
* @since 8
* @deprecated since 12
*/
function getCaptionsManager(): CaptionsManager;
/**
* Indicates the captions manager.
*
* @typedef CaptionsManager
* @syscap SystemCapability.BarrierFree.Accessibility.Hearing
* @since 8
*/
interface CaptionsManager {
/**
* Indicates whether captions are enabled.
*
* @type {boolean}
* @syscap SystemCapability.BarrierFree.Accessibility.Hearing
* @since 8
*/
enabled: boolean;
/**
* Indicates the style of captions.
*
* @type {CaptionsStyle}
* @syscap SystemCapability.BarrierFree.Accessibility.Hearing
* @since 8
*/
style: CaptionsStyle;
/**
* Register the observe of the enable state.
*
* @param { 'enableChange' } type
* @param { Callback<boolean> } callback
* @throws { BusinessError } 401 - Input parameter error. Possible causes:
* 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types;
* 3. Parameter verification failed.
* @syscap SystemCapability.BarrierFree.Accessibility.Hearing
* @since 8
* @deprecated since 12
*/
on(type: 'enableChange', callback: Callback<boolean>): void;
/**
* Register the observer of the style.
*
* @param { 'styleChange' } type
* @param { Callback<CaptionsStyle> } callback
* @throws { BusinessError } 401 - Input parameter error. Possible causes:
* 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types;
* 3. Parameter verification failed.
* @syscap SystemCapability.BarrierFree.Accessibility.Hearing
* @since 8
* @deprecated since 12
*/
on(type: 'styleChange', callback: Callback<CaptionsStyle>): void;
/**
* Unregister the observe of the enable state.
*
* @param { 'enableChange' } type
* @param { Callback<boolean> } callback
* @throws { BusinessError } 401 - Input parameter error. Possible causes:
* 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types;
* 3. Parameter verification failed.
* @syscap SystemCapability.BarrierFree.Accessibility.Hearing
* @since 8
* @deprecated since 12
*/
off(type: 'enableChange', callback?: Callback<boolean>): void;
/**
* Unregister the observer of the style.
*
* @param { 'styleChange' } type
* @param { Callback<CaptionsStyle> } callback
* @throws { BusinessError } 401 - Input parameter error. Possible causes:
* 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types;
* 3. Parameter verification failed.
* @syscap SystemCapability.BarrierFree.Accessibility.Hearing
* @since 8
* @deprecated since 12
*/
off(type: 'styleChange', callback?: Callback<CaptionsStyle>): void;
}
/**
* Indicates the edge type of the captions font.
*
* @typedef {'none' | 'raised' | 'depressed' | 'uniform' | 'dropShadow'}
* @syscap SystemCapability.BarrierFree.Accessibility.Hearing
* @since 8
*/
type CaptionsFontEdgeType = 'none' | 'raised' | 'depressed' | 'uniform' | 'dropShadow';
/**
* Indicates the font family of captions.
*
* @typedef {'default' | 'monospacedSerif' | 'serif' | 'monospacedSansSerif' | 'sansSerif' | 'casual' | 'cursive' | 'smallCapitals'}
* @syscap SystemCapability.BarrierFree.Accessibility.Hearing
* @since 8
*/
type CaptionsFontFamily = 'default' | 'monospacedSerif' | 'serif' |
'monospacedSansSerif' | 'sansSerif' | 'casual' | 'cursive' | 'smallCapitals';
/**
* Indicates the style of captions.
*
* @typedef CaptionsStyle
* @syscap SystemCapability.BarrierFree.Accessibility.Hearing
* @since 8
*/
interface CaptionsStyle {
/**
* Indicates the font family of captions.
*
* @type {CaptionsFontFamily}
* @syscap SystemCapability.BarrierFree.Accessibility.Hearing
* @since 8
*/
fontFamily: CaptionsFontFamily;
/**
* Indicates the font scaling of captions.
* @type { number }
* @syscap SystemCapability.BarrierFree.Accessibility.Hearing
* @since 8
*/
fontScale: number;
/**
* Indicates the font color of captions.
* @type { number | string }
* @syscap SystemCapability.BarrierFree.Accessibility.Hearing
* @since 8
*/
fontColor: number | string;
/**
* Indicates the edge type of the captions font.
* @type { CaptionsFontEdgeType }
* @syscap SystemCapability.BarrierFree.Accessibility.Hearing
* @since 8
*/
fontEdgeType: CaptionsFontEdgeType;
/**
* Indicates the background color of captions.
* @type { number | string }
* @syscap SystemCapability.BarrierFree.Accessibility.Hearing
* @since 8
*/
backgroundColor: number | string;
/**
* Indicates the window color of captions.
* @type { number | string }
* @syscap SystemCapability.BarrierFree.Accessibility.Hearing
* @since 8
*/
windowColor: number | string;
}
/**
* Indicates the info of accessibility.
*
* @typedef AccessibilityAbilityInfo
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
interface AccessibilityAbilityInfo {
/**
* The ability id.
* @type { string }
* @readonly
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
readonly id: string;
/**
* The ability name.
* @type { string }
* @readonly
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
readonly name: string;
/**
* The bundle name of the ability.
* @type { string }
* @readonly
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
readonly bundleName: string;
/**
* The target bundle name for the observation.
* @type { Array<string> }
* @readonly
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 9
*/
readonly targetBundleNames: Array<string>;
/**
* The type of the ability.
* @type { Array<AbilityType> }
* @readonly
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
readonly abilityTypes: Array<AbilityType>;
/**
* The capabilities of the ability.
* @type { Array<Capability> }
* @readonly
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
readonly capabilities: Array<Capability>;
/**
* The description of the ability.
* @type { string }
* @readonly
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
readonly description: string;
/**
* The events which the accessibility ability wants to observe.
* @type { Array<EventType> }
* @readonly
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
readonly eventTypes: Array<EventType>;
/**
* Indicates whether the extended service needs to be hidden.
* @type { boolean }
* @readonly
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 12
*/
readonly needHide: boolean;
/**
* The label of the ability.
* @type { string }
* @readonly
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 12
*/
readonly label: string;
}
/**
* Indicates the info of events.
*
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since arkts {'1.1':'7', '1.2':'20'}
* @arkts 1.1&1.2
*/
class EventInfo {
/**
* A constructor used to create a EventInfo object.
*
* @param { Object } jsonObject - Character string in JSON format required for creating an object.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
constructor(jsonObject: Object);
/**
* A constructor used to create a EventInfo object.
*
* @param { EventType } type - The type of the accessibility event.
* @param { string } bundleName - The name of the bundle.
* @param { Action } triggerAction - The action that the ability can execute.
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
constructor(type: EventType, bundleName: string, triggerAction: Action);
/**
* The type of an accessibility event.
* @type { EventType }
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since arkts {'1.1':'7', '1.2':'20'}
* @arkts 1.1&1.2
*/
type: EventType;
/**
* The type of the window change event.
* @type { ?WindowUpdateType }
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since arkts {'1.1':'7', '1.2':'20'}
* @arkts 1.1&1.2
*/
windowUpdateType?: WindowUpdateType;
/**
* The bundle name of the target application.
* @type { string }
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since arkts {'1.1':'7', '1.2':'20'}
* @arkts 1.1&1.2
*/
bundleName: string;
/**
* The type of the event source component,such as button, chart.
* @type { ?string }
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since arkts {'1.1':'7', '1.2':'20'}
* @arkts 1.1&1.2
*/
componentType?: string;
/**
* The page id of the event source.
* @type { ?number }
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
pageId?: number;
/**
* The accessibility event description.
* @type { ?string }
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since arkts {'1.1':'7', '1.2':'20'}
* @arkts 1.1&1.2
*/
description?: string;
/**
* The action that triggers the accessibility event, for example, clicking or focusing a view.
* @type { Action }
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since arkts {'1.1':'7', '1.2':'20'}
* @arkts 1.1&1.2
*/
triggerAction: Action;
/**
* The movement step used for reading texts.
* @type { ?TextMoveUnit }
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since arkts {'1.1':'7', '1.2':'20'}
* @arkts 1.1&1.2
*/
textMoveUnit?: TextMoveUnit;
/**
* The content list.
* @type { ?Array<string> }
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since arkts {'1.1':'7', '1.2':'20'}
* @arkts 1.1&1.2
*/
contents?: Array<string>;
/**
* The content changed before.
* @type { ?string }
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since arkts {'1.1':'7', '1.2':'20'}
* @arkts 1.1&1.2
*/
lastContent?: string;
/**
* The start index of listed items on the screen.
* @type { ?number }
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
beginIndex?: number;
/**
* The index of the current item on the screen.
* @type { ?number }
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
currentIndex?: number;
/**
* The end index of listed items on the screen.
* @type { ?number }
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
endIndex?: number;
/**
* The total of the items, talkback used it when scroll.
* @type { ?number }
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 7
*/
itemCount?: number;
/**
* The id of element.
* @type { ?number }
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 12
*/
elementId?: number;
/**
* The content of announce accessibility text.
* @type { ?string }
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
textAnnouncedForAccessibility?: string;
/**
* The content of announce accessibility text.
* @type { ?Resource }
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since 18
*/
textResourceAnnouncedForAccessibility?: Resource;
/**
* The customized element id.
* @type { ?string }
* @syscap SystemCapability.BarrierFree.Accessibility.Core
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
customId?: string;
}
}
export default accessibility;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/openharmony/interface_sdk-js.git
git@gitee.com:openharmony/interface_sdk-js.git
openharmony
interface_sdk-js
interface_sdk-js
master

搜索帮助